-// Copyright (C) 2013-2015,2017 Internet Systems Consortium, Inc. ("ISC")
+// Copyright (C) 2013-2020 Internet Systems Consortium, Inc. ("ISC")
//
// This Source Code Form is subject to the terms of the Mozilla Public
// License, v. 2.0. If a copy of the MPL was not distributed with this
/// @name Copy constructor and assignment operator
///
/// Copy constructor and assignment operator are private because there are
- /// no use cases when @DNSClient instance will need to be copied. Also, it
- /// is desired to avoid copying @DNSClient::impl_ pointer and external
+ /// no use cases when a DNSClient instance will need to be copied. Also, it
+ /// is desired to avoid copying a DNSClient::impl_ pointer and external
/// callbacks.
///
//@{
private:
+ /// @public
/// @brief Assign class using vendor-class-identifier option
///
/// @note This is the first part of @ref classifyPacket
private:
+ /// @public
/// @brief Assign class using vendor-class-identifier option
///
/// @note This is the first part of @ref classifyPacket
/// counters.
///
/// \param clean_report value to generate easy to parse report.
- /// \param sep_ string used as separator if clean_report enabled..
+ /// \param clean_sep string used as separator if clean_report enabled..
void
printIntermediateStats(bool clean_report, std::string clean_sep) const {
std::ostringstream stream_sent;
/// Generate list of addresses and check for uniqueness.
///
/// \param pkt6 object representing received DHCPv6 packet
- /// \param ExhchangeType enum value.
+ /// \param xchg_type ExchangeType enum value.
void address6Uniqueness(const dhcp::Pkt6Ptr& pkt6, ExchangeType xchg_type);
/// \brief Process received v4 addresses uniqueness.
/// Generate list of addresses and check for uniqueness.
///
/// \param pkt4 object representing received DHCPv4 packet
- /// \param ExchangeType enum value.
+ /// \param xchg_type ExchangeType enum value.
void address4Uniqueness(const dhcp::Pkt4Ptr& pkt4, ExchangeType xchg_type);
/// \brief add unique address to already assigned list.
/// Add address and/or prefix to unique set if it's not already there,
/// otherwise increment the number of non unique addresses.
///
- /// \param std::set set of addresses that should be added to unique list
- /// \param ExchangeType enum value.
+ /// \param current set of addresses that should be added to unique list
+ /// \param xchg_type ExchangeType enum value.
void addUniqeAddr(const std::set<std::string>& current, ExchangeType xchg_type) {
switch(xchg_type) {
case ExchangeType::SA: {
/// If address is released we should remove it from both
/// advertised (offered) and assigned sets.
///
- /// \param std::string holding value of unique address.
+ /// \param addr holding value of unique address.
void removeUniqueAddr(const std::set<std::string>& addr) {
for (auto addr_it = addr.begin(); addr_it != addr.end(); ++addr_it) {
auto it = unique_address_.find(*addr_it);
/// flagged as ready to read. It is installed by the invocation to
/// register the socket with IfaceMgr made in @ref clientConnectHandler.
///
- /// The handler calls @c HttpClient::closeIfOutOfBandwidth() to catch
+ /// The handler calls @c http::HttpClient::closeIfOutOfBandwidth() to catch
/// and close any sockets that have gone ready outside of transactions.
///
/// We do this in case the other peer closed the socket (e.g. idle timeout),
/// @brief Fetches an IP address parameter from a map of parameters
/// @param map of parameters in which to look
/// @name name of the parameter desired
- /// @family expected protocol family of the address parameter, AF_INET
- /// or AF_INET6
+ /// @param family expected protocol family of the address parameter,
+ /// AF_INET or AF_INET6
/// @return IOAddress containing the value of the parameter.
/// @throw BadValue if the parameter is missing or invalid
IOAddress getAddressParam(ConstElementPtr params, const std::string name,
/// Fills in the CQL_BIND array for sending data in the Lease4 object to
/// the database. Used for DELETE statements.
///
- /// @param address address of the lease to be deleted
+ /// @param lease Deleted lease information.
/// @param data lease info in CQL format will be stored here
/// @param statement_tag tag identifying the query (optional)
void createBindForDelete(const Lease4Ptr &lease,
/// @brief Sets new store-extended-info
///
- /// @param store-extended-info New value to use.
+ /// @param store_extended_info New value to use.
void setStoreExtendedInfo(const util::Optional<bool>& store_extended_info) {
store_extended_info_ = store_extended_info;
}
-// Copyright (C) 2013-2019 Internet Systems Consortium, Inc. ("ISC")
+// Copyright (C) 2013-2020 Internet Systems Consortium, Inc. ("ISC")
//
// This Source Code Form is subject to the terms of the Mozilla Public
// License, v. 2.0. If a copy of the MPL was not distributed with this
///
/// @param [out] subnets Container where parsed subnets will be stored.
/// @param subnets_list pointer to a list of IPv6 subnets
- /// @param check_iface Check if the specified interface exists in
- /// the system.
/// @return Number of subnets created.
size_t parse(Subnet6Collection& subnets,
data::ConstElementPtr subnets_list);
-// Copyright (C) 2017-2019 Internet Systems Consortium, Inc. ("ISC")
+// Copyright (C) 2017-2020 Internet Systems Consortium, Inc. ("ISC")
//
// This Source Code Form is subject to the terms of the Mozilla Public
// License, v. 2.0. If a copy of the MPL was not distributed with this
///
/// @param shared_network_data Data element holding shared network
/// configuration to be parsed.
- /// @param check_iface Check if the specified interface exists in
- /// the system.
///
/// @return Pointer to an object representing shared network.
/// @throw DhcpConfigError when shared network configuration is invalid.
/// used. Note: although -1 is a valid argument value for
/// @ref isc::hooks::CalloutManager::setLibraryIndex(), in this class
/// it is used as a sentinel to indicate that the library index in
- /// @ref isc::util::CalloutManager should not be set or reset.
+ /// @ref isc::hooks::CalloutManager should not be set or reset.
LibraryHandle(CalloutManager& manager, int index = -1)
: callout_manager_(manager), index_(index) {}
/// method.
StatsMgr();
- /// @private
+ /// @public
/// @brief Sets a given statistic to specified value (internal version).
///
}
}
- /// @private
+ /// @public
/// @brief Adds specified value to a given statistic (internal version).
///
}
}
- /// @private
+ /// @public
/// @brief Adds a new observation.
///
/// @param stat observation
void addObservation(const ObservationPtr& stat);
- /// @private
+ /// @public
/// @brief Adds a new observation in a thread safe context.
///
projects / thirdparty / kea.git / commitdiff
