mir/kea
2
0
Fork 0
mirror of https://gitlab.isc.org/isc-projects/kea synced 2025-08-31 14:05:33 +00:00
Code Issues Releases Wiki Activity

[master] Finised merge of trac4234 (doxygen warnings)

Browse Source
This commit is contained in:
Francis Dupont
2015-12-22 18:05:59 +01:00
parent 09595a8d6d 2bee003c2c
commit b67910a389
37 changed files with 760 additions and 172 deletions
Download Patch File Download Diff File Expand all files Collapse all files

4
ChangeLog
View File

@@ -1,3 +1,7 @@
1075. [bug] fdupont
Removed warnings emitted during generation of Doxygen documentation.
(Trac #4234, git xxx)
1074. [bug] marcin
Addressed regression in distcheck after merge of #4224.
Before the changes one of the lease files produced by

680
doc/Doxyfile
View File

File diff suppressed because it is too large Load Diff

2
doc/devel/mainpage.dox
View File

@@ -103,7 +103,7 @@
* - @subpage configBackendAdding
* - @subpage perfdhcpInternals
*
* @section qa Quality Assurance
* @section qualityAssurance Quality Assurance
* - @subpage qaUnitTests
*
* @section miscellaneousTopics Miscellaneous Topics

0
doc/images/.gitignore vendored Normal file
View File

2
src/bin/d2/d_controller.h
View File

@@ -111,7 +111,7 @@ public:
virtual ~DControllerBase();
/// @brief returns Kea version on stdout and exit.
/// redeclaration/redefinition. @ref Daemon::getVersion()
/// redeclaration/redefinition. @ref isc::dhcp::Daemon::getVersion()
static std::string getVersion(bool extended);
/// @brief Acts as the primary entry point into the controller execution

2
src/bin/dhcp4/dhcp4.dox
View File

@@ -31,7 +31,7 @@ from the common configuration parsers and customize their behavior. For
example: the @c Subnet4ConfigParser is used to parse parameters
describing a single subnet. It derives from the @c
isc::dhcp::SubnetConfigParser, which implements the common base for both
DHCPv4 and DHCPv6 subnets. The @ref isc::dhcp::Subnet4ConfigParser
DHCPv4 and DHCPv6 subnets. The @ref Subnet4ConfigParser
implements the @c initSubnet abstract method, which creates an instance of
the DHCPv4 subnet. This method is invoked by the parent class.

6
src/bin/dhcp4/dhcp4_srv.h
View File

@@ -558,6 +558,7 @@ private:
/// server's response.
void processHostnameOption(Dhcpv4Exchange& ex);
/// @public
/// @brief Marks lease as declined.
///
/// This method moves a lease to declined state with all the steps involved:
@@ -569,8 +570,7 @@ private:
///
/// @param lease lease to be declined
/// @param decline client's message
void
declineLease(const Lease4Ptr& lease, const Pkt4Ptr& decline);
void declineLease(const Lease4Ptr& lease, const Pkt4Ptr& decline);
protected:
@@ -751,6 +751,7 @@ protected:
private:
/// @public
/// @brief Assign class using vendor-class-identifier option
///
/// @note This is the first part of @ref classifyPacket
@@ -759,6 +760,7 @@ private:
/// @param classes a reference to added class names for logging
void classifyByVendor(const Pkt4Ptr& pkt, std::string& classes);
/// @private
/// @brief Constructs netmask option based on subnet4
/// @param subnet subnet for which the netmask will be calculated
///

1
src/bin/dhcp4/json_config_parser.cc
View File

@@ -100,6 +100,7 @@ protected:
}
};
/// @anchor Subnet4ConfigParser
/// @brief This class parses a single IPv4 subnet.
///
/// This is the IPv4 derivation of the SubnetConfigParser class and it parses

4
src/bin/dhcp6/dhcp6.dox
View File

@@ -31,7 +31,7 @@ from the common configuration parsers and customize their behavior. For
example: the @c Subnet6ConfigParser is used to parse parameters
describing a single subnet. It derives from the @c
isc::dhcp::SubnetConfigParser, which implements the common base for both
DHCPv4 and DHCPv6 subnets. The @ref isc::dhcp::Subnet6ConfigParser
DHCPv4 and DHCPv6 subnets. The @ref Subnet6ConfigParser
implements the @c initSubnet abstract method, which creates an instance of
the DHCPv6 subnet. This method is invoked by the parent class.
@@ -261,7 +261,7 @@ to evaluate the next class.
@subsection dhcpv6ClassifierUsage How client classification information is used in DHCPv6
Currently there is no class behavior coded in DHCPv6, hence no v6 equivalent of
@ref isc::dhcp::Dhcpv6Srv::vendorClassSpecificProcessing. Should any need for such a code arise,
@ref isc::dhcp::Dhcpv4Srv::vendorClassSpecificProcessing. Should any need for such a code arise,
it will be conducted in an external hooks library.
It is possible to define class restrictions in subnet, so a given subnet is only

4
src/bin/dhcp6/dhcp6_srv.h
View File

@@ -670,7 +670,7 @@ protected:
///
/// @param decline Decline messege sent by a client
/// @param reply Server's response (IA_NA with status will be added here)
/// @param client context
/// @param ctx context
/// @return true when expected to continue, false when hooks told us to drop
/// the packet
bool declineLeases(const Pkt6Ptr& decline, Pkt6Ptr& reply,
@@ -721,6 +721,7 @@ protected:
private:
/// @public
/// @brief Assign class using vendor-class-identifier option
///
/// @note This is the first part of @ref classifyPacket
@@ -729,6 +730,7 @@ private:
/// @param classes a reference to added class names for logging
void classifyByVendor(const Pkt6Ptr& pkt, std::string& classes);
/// @private
/// @brief Generate FQDN to be sent to a client if none exists.
///
/// This function is meant to be called by the functions which process

1
src/bin/dhcp6/json_config_parser.cc
View File

@@ -305,6 +305,7 @@ private:
PoolStoragePtr pools_;
};
/// @anchor Subnet6ConfigParser
/// @brief This class parses a single IPv6 subnet.
///
/// This is the IPv6 derivation of the SubnetConfigParser class and it parses

12
src/lib/asiodns/io_fetch.h
View File

@@ -136,8 +136,20 @@ public:
/// with above constructor which has only question section. All
/// other parameters are same.
///
/// \param protocol Fetch protocol, either IOFetch::TCP or IOFetch::UDP
/// \param service I/O Service object to handle the asynchronous
/// operations.
/// \param query_message the shared_ptr to a full query message
/// got from a query client.
/// \param address IP address of upstream server
/// \param port Port to which to connect on the upstream server
/// \param buff Output buffer into which the response (in wire format)
/// is written (if a response is received).
/// \param cb Callback object containing the callback to be called when we
/// terminate. The caller is responsible for managing this object
/// and deleting it if necessary.
/// \param wait Timeout for the fetch (in ms). The default value of
/// -1 indicates no timeout.
IOFetch(Protocol protocol, isc::asiolink::IOService& service,
isc::dns::ConstMessagePtr query_message,
const isc::asiolink::IOAddress& address,

2
src/lib/asiolink/io_address.h
View File

@@ -238,8 +238,10 @@ public:
/// @brief Subtracts one address from another (a - b)
///
/// Treats addresses as integers and subtracts them. For example:
/// @code
/// 192.0.2.5 - 192.0.2.0 = 0.0.0.5
/// fe80::abcd - fe80:: = ::abcd
/// @endcode
///
/// It is possible to subtract greater from lesser address, e.g.
/// 192.168.56.10 - 192.168.67.20, but please do understand that

2
src/lib/asiolink/io_asio_socket.h
View File

@@ -270,8 +270,6 @@ public:
};
#include "io_socket.h"
/// \brief The \c DummyAsioSocket class is a concrete derived class of
/// \c IOAsioSocket that is not associated with any real socket.
///

4
src/lib/config/command_socket_factory.cc
View File

@@ -126,6 +126,8 @@ private:
return (fd);
}
/// @public
/// @brief Connection acceptor, a callback used to accept incoming connections.
///
/// This callback is used on a control socket. Once called, it will accept
@@ -172,6 +174,8 @@ private:
.arg(sockfd_);
}
/// @private
// This method is called when we shutdown the connection.
void close() {
LOG_INFO(command_logger, COMMAND_SOCKET_UNIX_CLOSE).arg(sockfd_)

17
src/lib/dhcpsrv/alloc_engine.h
View File

@@ -389,7 +389,7 @@ public:
/// response to SOLICIT).
///
/// This method uses host reservation if ctx.host_ is set. The easy way to
/// set it is to call @ref isc::dhcp::AllocEngine::findReservation(ctx).
/// set it is to call @ref findReservationDecl.
/// The host reservation is convenient, but incurs performance penalty,
/// so it can be tweaked on a per subnet basis. There are three possible modes:
/// 1. disabled (no host reservation at all). This is the most performant one
@@ -516,9 +516,9 @@ public:
/// declined state). Therefore remove_leases parameter is ignored for
/// declined leases. They are always removed.
///
/// Also, for declined leases @ref reclaimDeclined is called. It conducts
/// several declined specific operation (extra log entry, stats dump,
/// hooks).
/// Also, for declined leases @ref reclaimDeclinedLease6 is
/// called. It conducts several declined specific operation (extra log
/// entry, stats dump, hooks).
///
/// @param max_leases Maximum number of leases to be reclaimed.
/// @param timeout Maximum amount of time that the reclaimation routine
@@ -574,9 +574,9 @@ public:
/// declined state). Therefore remove_leases parameter is ignored for
/// declined leases. They are always removed.
///
/// Also, for declined leases @ref reclaimDeclined is called. It conducts
/// several declined specific operation (extra log entry, stats dump,
/// hooks).
/// Also, for declined leases @ref reclaimDeclinedLease4 is
/// called. It conductsseveral declined specific operation (extra log
/// entry, stats dump, hooks).
///
/// @param max_leases Maximum number of leases to be reclaimed.
/// @param timeout Maximum amount of time that the reclaimation routine
@@ -600,6 +600,7 @@ public:
void deleteExpiredReclaimedLeases4(const uint32_t secs);
/// @anchor findReservationDecl
/// @brief Attempts to find appropriate host reservation.
///
/// Attempts to find appropriate host reservation in HostMgr. If found, it
@@ -868,6 +869,7 @@ private:
const boost::function<void (const LeasePtrType&)>&
lease_update_fun) const;
/// @anchor reclaimDeclinedLease4
/// @brief Conducts steps necessary for reclaiming declined IPv4 lease.
///
/// These are the additional steps required when recoving a declined lease:
@@ -880,6 +882,7 @@ private:
/// to keep it)
bool reclaimDeclined(const Lease4Ptr& lease);
/// @anchor reclaimDeclinedLease6
/// @brief Conducts steps necessary for reclaiming declined IPv6 lease.
///
/// These are the additional steps required when recoving a declined lease:

2
src/lib/dhcpsrv/alloc_engine_log.cc
View File

@@ -4,7 +4,7 @@
// License, v. 2.0. If a copy of the MPL was not distributed with this
// file, You can obtain one at http://mozilla.org/MPL/2.0/.
/// @file Defines the logger used by the @c isc::dhcp::HostMgr
/// @brief Defines the logger used by the @c isc::dhcp::AllocEngine
#include "dhcpsrv/alloc_engine_log.h"

4
src/lib/dhcpsrv/alloc_engine_log.h
View File

@@ -14,7 +14,7 @@ namespace isc {
namespace dhcp {
//@{
/// \brief Logging levels for the @c AllocEngine.
/// @brief Logging levels for the @c AllocEngine.
///
/// Defines the levels used to output debug messages from the @c AllocEngine.
@@ -39,7 +39,7 @@ const int ALLOC_ENGINE_DBG_TRACE_DETAIL_DATA = DBGLVL_TRACE_DETAIL_DATA;
//@}
/// @brief Logger for the @c AllocEngine..
/// @brief Logger for the @c AllocEngine.
///
/// Define the logger used to log messages in @c AllocEngine.
extern isc::log::Logger alloc_engine_logger;

71
src/lib/dhcpsrv/cfg_iface.h
View File

@@ -89,6 +89,42 @@ public:
/// but it doesn't verify that the address family value passed as @c uint16_t
/// parameter is equal to one of them. It is a callers responsibility to
/// guarantee that the address family value is correct.
///
/// The interface name is passed as an argument of the @ref CfgIface::use
/// function which controls the selection of the interface on which the
/// DHCP queries should be received by the server. The interface name
/// passed as the argument of this function may appear in one of the following
/// formats:
/// - interface-name, e.g. eth0
/// - interface-name/address, e.g. eth0/2001:db8:1::1 or eth0/192.168.8.1
///
/// Extraneous spaces surrounding the interface name and/or address
/// are accepted. For example: eth0 / 2001:db8:1::1 will be accepted.
///
/// When only interface name is specified (without an address) it is allowed
/// to use the "wildcard" interface name (*) which indicates that the server
/// should open sockets on all interfaces. When IPv6 is in use, the sockets
/// will be bound to the link local addresses. Wildcard interface names are
/// not allowed when specifying a unicast address. For example:
/// */2001:db8:1::1 is not allowed.
///
/// The DHCPv6 configuration accepts simultaneous use of the "interface-name"
/// and "interface-name/address" tuple for the same interface, e.g.
/// "eth0", "eth0/2001:db8:1::1" specifies that the server should open a
/// socket and bind to link local address as well as open a socket bound to
/// the specified unicast address.
///
/// The DHCPv4 configuration doesn't accept the simulatenous use of the
/// "interface-name" and the "interface-name/address" tuple for the
/// given interface. When the "interface-name" is specified it implies
/// that the sockets will be opened on for all addresses configured on
/// this interface. If the tuple of "interface-name/address" is specified
/// there will be only one socket opened and bound to the specified address.
/// This socket will be configured to listen to the broadcast messages
/// reaching the interface as well as unicast messages sent to the address
/// to which it is bound. It is allowed to select multiple addresses on the
/// particular interface explicitly, e.g. "eth0/192.168.8.1",
/// "eth0/192.168.8.2".
class CfgIface {
public:
@@ -141,40 +177,7 @@ public:
/// @brief Select interface to be used to receive DHCP traffic.
///
/// This function controls the selection of the interface on which the
/// DHCP queries should be received by the server. The interface name
/// passed as the argument of this function may appear in one of the following
/// formats:
/// - interface-name, e.g. eth0
/// - interface-name/address, e.g. eth0/2001:db8:1::1 or eth0/192.168.8.1
///
/// Extraneous spaces surrounding the interface name and/or address
/// are accepted. For example: eth0 / 2001:db8:1::1 will be accepted.
///
/// When only interface name is specified (without an address) it is allowed
/// to use the "wildcard" interface name (*) which indicates that the server
/// should open sockets on all interfaces. When IPv6 is in use, the sockets
/// will be bound to the link local addresses. Wildcard interface names are
/// not allowed when specifying a unicast address. For example:
/// */2001:db8:1::1 is not allowed.
///
/// The DHCPv6 configuration accepts simultaneous use of the "interface-name"
/// and "interface-name/address" tuple for the same interface, e.g.
/// "eth0", "eth0/2001:db8:1::1" specifies that the server should open a
/// socket and bind to link local address as well as open a socket bound to
/// the specified unicast address.
///
/// The DHCPv4 configuration doesn't accept the simulatenous use of the
/// "interface-name" and the "interface-name/address" tuple for the
/// given interface. When the "interface-name" is specified it implies
/// that the sockets will be opened on for all addresses configured on
/// this interface. If the tuple of "interface-name/address" is specified
/// there will be only one socket opened and bound to the specified address.
/// This socket will be configured to listen to the broadcast messages
/// reaching the interface as well as unicast messages sent to the address
/// to which it is bound. It is allowed to select multiple addresses on the
/// particular interface explicitly, e.g. "eth0/192.168.8.1",
/// "eth0/192.168.8.2".
/// @ref CfgIface for a detail explaination of the interface name argument.
///
/// @param family Address family (AF_INET or AF_INET6).
/// @param iface_name Explicit interface name, a wildcard name (*) of

2
src/lib/dhcpsrv/client_class_def.h
View File

@@ -75,7 +75,7 @@ public:
/// @brief Sets the class's option collection
///
/// @param options the option collection to assign the class
/// @param cfg_option the option collection to assign the class
void setCfgOption(const CfgOptionPtr& cfg_option);
/// @brief Compares two @c ClientClassDef objects for equality.

2
src/lib/dhcpsrv/hosts_log.cc
View File

@@ -4,7 +4,7 @@
// License, v. 2.0. If a copy of the MPL was not distributed with this
// file, You can obtain one at http://mozilla.org/MPL/2.0/.
/// @file Defines the logger used by the @c isc::dhcp::HostMgr
/// @brief Defines the logger used by the @c isc::dhcp::HostMgr
#include "dhcpsrv/hosts_log.h"

4
src/lib/dhcpsrv/lease.cc
View File

@@ -220,7 +220,7 @@ Lease4::operator=(const Lease4& other) {
return (*this);
}
Lease6::Lease6(Type type, const isc::asiolink::IOAddress& addr,
Lease6::Lease6(Lease::Type type, const isc::asiolink::IOAddress& addr,
DuidPtr duid, uint32_t iaid, uint32_t preferred, uint32_t valid,
uint32_t t1, uint32_t t2, SubnetID subnet_id,
const HWAddrPtr& hwaddr, uint8_t prefixlen)
@@ -234,7 +234,7 @@ Lease6::Lease6(Type type, const isc::asiolink::IOAddress& addr,
cltt_ = time(NULL);
}
Lease6::Lease6(Type type, const isc::asiolink::IOAddress& addr,
Lease6::Lease6(Lease::Type type, const isc::asiolink::IOAddress& addr,
DuidPtr duid, uint32_t iaid, uint32_t preferred, uint32_t valid,
uint32_t t1, uint32_t t2, SubnetID subnet_id,
const bool fqdn_fwd, const bool fqdn_rev,

6
src/lib/dhcpsrv/lease.h
View File

@@ -422,7 +422,7 @@ struct Lease6 : public Lease {
/// @brief Lease type
///
/// One of normal address, temporary address, or prefix.
Type type_;
Lease::Type type_;
/// @brief IPv6 prefix length
///
@@ -459,7 +459,7 @@ struct Lease6 : public Lease {
/// @param subnet_id A Subnet identifier.
/// @param hwaddr hardware/MAC address (optional)
/// @param prefixlen An address prefix length (optional, defaults to 128)
Lease6(Type type, const isc::asiolink::IOAddress& addr, DuidPtr duid,
Lease6(Lease::Type type, const isc::asiolink::IOAddress& addr, DuidPtr duid,
uint32_t iaid, uint32_t preferred, uint32_t valid, uint32_t t1,
uint32_t t2, SubnetID subnet_id, const HWAddrPtr& hwaddr = HWAddrPtr(),
uint8_t prefixlen = 128);
@@ -480,7 +480,7 @@ struct Lease6 : public Lease {
/// @param hostname FQDN of the client which gets the lease.
/// @param hwaddr hardware address (MAC), may be NULL
/// @param prefixlen An address prefix length.
Lease6(Type type, const isc::asiolink::IOAddress& addr, DuidPtr duid,
Lease6(Lease::Type type, const isc::asiolink::IOAddress& addr, DuidPtr duid,
uint32_t iaid, uint32_t preferred, uint32_t valid, uint32_t t1,
uint32_t t2, SubnetID subnet_id, const bool fqdn_fwd,
const bool fqdn_rev, const std::string& hostname,

4
src/lib/dhcpsrv/parsers/client_class_def_parser.h
View File

@@ -38,7 +38,7 @@
///
/// -# "option-data" - a list which defines the options that should be
/// assigned to memebers of the class. This element is optional and parsed
/// using the @ref dhcp::OptionDataListParser.
/// using the @ref isc::dhcp::OptionDataListParser.
///
/// ExpressionParser - creates an eval::Expression from a string element,
/// using the Eval Parser.
@@ -163,7 +163,7 @@ public:
/// @param class_def_list pointer to an element that holds entries
/// for client class definitions.
/// @throw DhcpConfigError if configuration parsing fails.
void build(isc::data::ConstElementPtr option_def_list);
void build(isc::data::ConstElementPtr class_def_list);
/// @brief Commits class definitions to CfgMgr's global storage.
void commit();

1
src/lib/dhcpsrv/parsers/dhcp_parsers.h
View File

@@ -1075,7 +1075,6 @@ protected:
///
/// @throw BadValue if the text cannot be converted.
///
/// @param text representation for conversion
/// @return one of allowed HRMode values
static Subnet::HRMode hrModeFromText(const std::string& txt);

2
src/lib/dns/rdata/generic/opt_41.h
View File

@@ -65,7 +65,7 @@ public:
/// \param data The OPTION-DATA field of the pseudo RR.
/// \param length The size of the \c data argument. OPTION-LENGTH is
/// set to this size.
/// \throw \c isc::InvalidParameter if this pseudo RR would cause
/// \throw isc::InvalidParameter if this pseudo RR would cause
/// the OPT RDATA to overflow its RDLENGTH.
void appendPseudoRR(uint16_t code, const uint8_t* data, uint16_t length);

6
src/lib/dns/rdataclass.h
View File

@@ -376,7 +376,7 @@ class CAA : public Rdata {
public:
// BEGIN_COMMON_MEMBERS
explicit CAA(const std::string& type_str);
explicit CAA(const std::string& caa_str);
CAA(isc::util::InputBuffer& buffer, size_t rdata_len);
CAA(const CAA& other);
CAA(
@@ -1548,7 +1548,7 @@ public:
/// \param data The OPTION-DATA field of the pseudo RR.
/// \param length The size of the \c data argument. OPTION-LENGTH is
/// set to this size.
/// \throw \c isc::InvalidParameter if this pseudo RR would cause
/// \throw isc::InvalidParameter if this pseudo RR would cause
/// the OPT RDATA to overflow its RDLENGTH.
void appendPseudoRR(uint16_t code, const uint8_t* data, uint16_t length);
@@ -2104,7 +2104,7 @@ class TLSA : public Rdata {
public:
// BEGIN_COMMON_MEMBERS
explicit TLSA(const std::string& type_str);
explicit TLSA(const std::string& tlsa_str);
TLSA(isc::util::InputBuffer& buffer, size_t rdata_len);
TLSA(const TLSA& other);
TLSA(

6
src/lib/dns/rrclass-placeholder.h
View File

@@ -204,7 +204,8 @@ public:
/// If resource allocation in rendering process fails, a corresponding
/// standard exception will be thrown.
///
/// \param buffer An output buffer to store the wire data.
/// \param renderer DNS message rendering context that encapsulates the
/// output buffer in which the RRClass is to be stored.
void toWire(AbstractMessageRenderer& renderer) const;
/// \brief Render the \c RRClass in the wire format.
///
@@ -214,8 +215,7 @@ public:
/// If resource allocation in rendering process fails, a corresponding
/// standard exception will be thrown.
///
/// \param renderer DNS message rendering context that encapsulates the
/// output buffer in which the RRClass is to be stored.
/// \param buffer An output buffer to store the wire data.
void toWire(isc::util::OutputBuffer& buffer) const;
//@}

6
src/lib/dns/rrclass.h
View File

@@ -211,7 +211,8 @@ public:
/// If resource allocation in rendering process fails, a corresponding
/// standard exception will be thrown.
///
/// \param buffer An output buffer to store the wire data.
/// \param renderer DNS message rendering context that encapsulates the
/// output buffer in which the RRClass is to be stored.
void toWire(AbstractMessageRenderer& renderer) const;
/// \brief Render the \c RRClass in the wire format.
///
@@ -221,8 +222,7 @@ public:
/// If resource allocation in rendering process fails, a corresponding
/// standard exception will be thrown.
///
/// \param renderer DNS message rendering context that encapsulates the
/// output buffer in which the RRClass is to be stored.
/// \param buffer An output buffer to store the wire data.
void toWire(isc::util::OutputBuffer& buffer) const;
//@}

6
src/lib/dns/rrset.h
View File

@@ -209,7 +209,7 @@ public:
///
/// \return The length of the wire format representation of the
/// \c AbstractRRset.
/// \throw \c EmptyRRset if the \c AbstractRRset is empty.
/// \throw EmptyRRset if the \c AbstractRRset is empty.
virtual uint16_t getLength() const = 0;
/// \brief Returns the owner name of the \c RRset.
@@ -670,7 +670,7 @@ public:
///
/// \return The length of the wire format representation of the
/// \c BasicRRset.
/// \throw \c EmptyRRset if the \c BasicRRset is empty.
/// \throw EmptyRRset if the \c BasicRRset is empty.
virtual uint16_t getLength() const;
/// \brief Returns the owner name of the \c RRset.
@@ -855,7 +855,7 @@ public:
///
/// \return The length of the wire format representation of the
/// \c RRset.
/// \throw \c EmptyRRset if the \c RRset is empty.
/// \throw EmptyRRset if the \c RRset is empty.
virtual uint16_t getLength() const;
/// \brief Render the RRset in the wire format with name compression and

6
src/lib/dns/rrtype-placeholder.h
View File

@@ -177,7 +177,8 @@ public:
/// If resource allocation in rendering process fails, a corresponding
/// standard exception will be thrown.
///
/// \param buffer An output buffer to store the wire data.
/// \param renderer DNS message rendering context that encapsulates the
/// output buffer in which the RRType is to be stored.
void toWire(AbstractMessageRenderer& renderer) const;
/// \brief Render the \c RRType in the wire format.
///
@@ -187,8 +188,7 @@ public:
/// If resource allocation in rendering process fails, a corresponding
/// standard exception will be thrown.
///
/// \param renderer DNS message rendering context that encapsulates the
/// output buffer in which the RRType is to be stored.
/// \param buffer An output buffer to store the wire data.
void toWire(isc::util::OutputBuffer& buffer) const;
//@}

6
src/lib/dns/rrtype.h
View File

@@ -184,7 +184,8 @@ public:
/// If resource allocation in rendering process fails, a corresponding
/// standard exception will be thrown.
///
/// \param buffer An output buffer to store the wire data.
/// \param renderer DNS message rendering context that encapsulates the
/// output buffer in which the RRType is to be stored.
void toWire(AbstractMessageRenderer& renderer) const;
/// \brief Render the \c RRType in the wire format.
///
@@ -194,8 +195,7 @@ public:
/// If resource allocation in rendering process fails, a corresponding
/// standard exception will be thrown.
///
/// \param renderer DNS message rendering context that encapsulates the
/// output buffer in which the RRType is to be stored.
/// \param buffer An output buffer to store the wire data.
void toWire(isc::util::OutputBuffer& buffer) const;
//@}

2
src/lib/dns/tsigkey.h
View File

@@ -106,6 +106,8 @@ public:
/// \param secret Point to a binary sequence of the shared secret to be
/// used for this key, or \c NULL if the secret is empty.
/// \param secret_len The size of the binary %data (\c secret) in bytes.
/// \param digestbits The number of bits to include in the digest
/// (0 means to include all)
TSIGKey(const Name& key_name, const Name& algorithm_name,
const void* secret, size_t secret_len, size_t digestbits = 0);

2
src/lib/stats/observation.h
View File

@@ -126,7 +126,7 @@ class Observation {
///
/// @param value duration value observed
/// @throw InvalidStatType if statistic is not time duration
void setValue(const StatsDuration& duration);
void setValue(const StatsDuration& value);
/// @brief Records absolute string observation
///

40
src/lib/stats/stats_mgr.h
View File

@@ -55,7 +55,7 @@ namespace stats {
/// either all or nothing. Adding logging entries only when necessary
/// in the code that uses StatsMgr gives better granularity.
///
/// If this decision is revisited in the futere, the most universal places
/// If this decision is revisited in the future, the most universal places
/// for adding logging have been marked in @ref addValueInternal and
/// @ref setValueInternal.
class StatsMgr : public boost::noncopyable {
@@ -117,7 +117,7 @@ class StatsMgr : public boost::noncopyable {
/// @param name name of the observation
/// @param value duration value observed
/// @throw InvalidStatType if statistic is not time duration
void addValue(const std::string& name, const StatsDuration& time);
void addValue(const std::string& name, const StatsDuration& value);
/// @brief Records incremental string observation.
///
@@ -248,12 +248,12 @@ class StatsMgr : public boost::noncopyable {
///
/// @param name name of the command (ignored, should be "statistic-get")
/// @param params structure containing a map that contains "name"
/// @param return answer containing details of specified statistic
/// @return answer containing details of specified statistic
static isc::data::ConstElementPtr
statisticGetHandler(const std::string& name,
const isc::data::ConstElementPtr& params);
/// @param Handles statistic-reset command
/// @brief Handles statistic-reset command
///
/// This method handles statistic-reset command, which resets value
/// of a given statistic. It expects one parameter stored in params map:
@@ -266,12 +266,12 @@ class StatsMgr : public boost::noncopyable {
///
/// @param name name of the command (ignored, should be "statistic-reset")
/// @param params structure containing a map that contains "name"
/// @param return answer containing confirmation
/// @return answer containing confirmation
static isc::data::ConstElementPtr
statisticResetHandler(const std::string& name,
const isc::data::ConstElementPtr& params);
/// @param Handles statistic-remove command
/// @brief Handles statistic-remove command
///
/// This method handles statistic-reset command, which removes a given
/// statistic completely. It expects one parameter stored in params map:
@@ -284,7 +284,7 @@ class StatsMgr : public boost::noncopyable {
///
/// @param name name of the command (ignored, should be "statistic-remove")
/// @param params structure containing a map that contains "name" element
/// @param return answer containing confirmation
/// @return answer containing confirmation
static isc::data::ConstElementPtr
statisticRemoveHandler(const std::string& name,
const isc::data::ConstElementPtr& params);
@@ -296,7 +296,7 @@ class StatsMgr : public boost::noncopyable {
///
/// @param name name of the command (ignored, should be "statistic-get-all")
/// @param params ignored
/// @param return answer containing values of all statistic
/// @return answer containing values of all statistic
static isc::data::ConstElementPtr
statisticGetAllHandler(const std::string& name,
const isc::data::ConstElementPtr& params);
@@ -308,7 +308,7 @@ class StatsMgr : public boost::noncopyable {
///
/// @param name name of the command (ignored, should be "statistic-reset-all")
/// @param params ignored
/// @param return answer confirming success of this operation
/// @return answer confirming success of this operation
static isc::data::ConstElementPtr
statisticResetAllHandler(const std::string& name,
const isc::data::ConstElementPtr& params);
@@ -320,7 +320,7 @@ class StatsMgr : public boost::noncopyable {
///
/// @param name name of the command (ignored, should be "statistic-remove-all")
/// @param params ignored
/// @param return answer confirming success of this operation
/// @return answer confirming success of this operation
static isc::data::ConstElementPtr
statisticRemoveAllHandler(const std::string& name,
const isc::data::ConstElementPtr& params);
@@ -329,6 +329,13 @@ class StatsMgr : public boost::noncopyable {
private:
/// @brief Private constructor.
/// StatsMgr is a singleton. It should be accessed using @ref instance
/// method.
StatsMgr();
/// @public
/// @brief Sets a given statistic to specified value (internal version).
///
/// This template method sets statistic identified by name to a value
@@ -352,6 +359,8 @@ class StatsMgr : public boost::noncopyable {
}
}
/// @public
/// @brief Adds specified value to a given statistic (internal version).
///
/// This template method adds specified value to a given statistic (identified
@@ -380,17 +389,16 @@ class StatsMgr : public boost::noncopyable {
}
}
/// @brief Private constructor.
/// StatsMgr is a singleton. It should be accessed using @ref instance
/// method.
StatsMgr();
/// @public
/// @brief Adds a new observation.
///
/// That's an utility method used by public @ref setValue() and
/// @ref addValue() methods.
/// @param obs observation
void addObservation(const ObservationPtr& o);
/// @param stat observation
void addObservation(const ObservationPtr& stat);
/// @private
/// @brief Tries to delete an observation.
///

2
src/lib/util/csv_file.h
View File

@@ -111,7 +111,7 @@ public:
/// @brief Trims a given number of elements from the end of a row
///
/// @param number of elements to trim
/// @param count number of elements to trim
///
/// @throw CSVFileError if the number to trim is larger than
/// then the number of elements

9
src/lib/util/versioned_csv_file.h
View File

@@ -80,8 +80,8 @@ typedef boost::shared_ptr<VersionedColumn> VersionedColumnPtr;
/// -# If there are fewer columns in the header than in the schema, the file
/// is presumed to be an earlier schema version and will be upgraded as it is
/// read. There is an ability to mark a specific column as being the minimum
/// column which must be present, see @ref VersionedCSVFile::
/// setMinimumValidColumns(). If the header columns do not match up to this
/// column which must be present, see @ref VersionedCSVFile::setMinimumValidColumns().
/// If the header columns do not match up to this
/// minimum column, the file is presumed to be too old to upgrade and the
/// open will fail. A valid, upgradable file will have an input schema
/// state of VersionedCSVFile::NEEDS_UPGRADE.
@@ -144,7 +144,7 @@ public:
/// The name of the column will be placed in the CSV header when new file
/// is created by calling @c recreate or @c open function.
///
/// @param name Name of the column.
/// @param col_name Name of the column.
/// @param version Text representation of the schema version in which
/// this column first appeared.
/// @param default_value value the missing column should be given during
@@ -224,7 +224,6 @@ public:
/// specified by that column's descriptor.
///
/// @param [out] row Object receiving the parsed CSV file.
/// @param skip_validation Do not perform validation.
///
/// @return true if row has been read and validated; false if validation
/// failed.
@@ -247,7 +246,7 @@ public:
///
/// @param index index within the list of columns of the desired column
/// @return a pointer to the VersionedColumn at the given index
/// @trow OutOfRange exception if the index is invalid
/// @throw OutOfRange exception if the index is invalid
const VersionedColumnPtr& getVersionedColumn(const size_t index) const;
/// @brief Fetches the state of the input file's schema