- @b Description: this callout is executed when Control Agent receives a
control command over the RESTful interface (HTTP).
The "request" argument is a pointer to the request, in fact a
- PostHttpRequestJsonPtr. The "response" argument is the response in
- case of errors. The purpose of this callout is to implement authentication
+ PostHttpRequestJsonPtr. The "response" argument is the response in case
+ of errors. The purpose of this callout is to implement authentication
and authorization. It is called after basic HTTP authentication.
- The next step status is used only to ask to reset the handle : if
- the response is set the processing will stop and the response is
- returned. In particular the command is not forwarded.
+ The next step status is used only to ask to reset the handle: if the
+ response is set the processing will stop and the response is returned.
+ In particular the command is not forwarded.
@subsection agentHooksResponse response
/// @param tuple reference of the tuple to read into
/// @throw isc::dhcp::BadDataTypeCast when the data being read
/// is truncated.
- /// @return tuple being read.
static void readTuple(const std::vector<uint8_t>& buf,
OpaqueDataTuple& tuple);
/// Sets interface name over which packet was received or is
/// going to be transmitted.
///
- /// @return interface name
- void setIface(const std::string& iface ) { iface_ = iface; };
+ /// @param iface The interface name
+ void setIface(const std::string& iface) { iface_ = iface; };
/// @brief Sets remote hardware address.
///
// EAGAIN and EWOULDBLOCK don't indicate an error in this case. All
// other errors should terminate the transaction.
- } if ((ec.value() != boost::asio::error::try_again) &&
- (ec.value() != boost::asio::error::would_block)) {
+ }
+ if ((ec.value() != boost::asio::error::try_again) &&
+ (ec.value() != boost::asio::error::would_block)) {
terminate(ec);
return;
/// @brief Add a string to the vector of expected strings
///
/// @param new_string the string to add to the end of the vector
- /// @return void
void addString(const string& new_string);
vector<string> exp_strings_;
/// @param subnets The subnet list.
/// @param set The reference to the set of assigned IDs.
/// @param next The next ID.
- /// @return True if all subnets have an ID, false otherwise.
static void subnetsAssignID(isc::data::ConstElementPtr subnets,
SubnetIDSet& set, isc::dhcp::SubnetID& next);
/// @param set The reference to the set of assigned IDs.
/// @param next The next ID.
/// @param subsel The subnet list name.
- /// @return True if all subnets have an ID, false otherwise.
static void sharedNetworksAssignID(isc::data::ConstElementPtr networks,
SubnetIDSet& set,
isc::dhcp::SubnetID& next,