mirror of
https://gitlab.isc.org/isc-projects/kea
synced 2025-09-01 22:45:18 +00:00
[master] Added (fixed) src/bin/agent to Doxyfile
This commit is contained in:
@@ -771,7 +771,8 @@ WARN_LOGFILE =
|
|||||||
# spaces. See also FILE_PATTERNS and EXTENSION_MAPPING
|
# spaces. See also FILE_PATTERNS and EXTENSION_MAPPING
|
||||||
# Note: If this tag is empty the current directory is searched.
|
# Note: If this tag is empty the current directory is searched.
|
||||||
|
|
||||||
INPUT = ../src/bin/d2 \
|
INPUT = ../src/bin/agent \
|
||||||
|
../src/bin/d2 \
|
||||||
../src/bin/dhcp4 \
|
../src/bin/dhcp4 \
|
||||||
../src/bin/dhcp6 \
|
../src/bin/dhcp6 \
|
||||||
../src/bin/perfdhcp \
|
../src/bin/perfdhcp \
|
||||||
|
@@ -22,13 +22,13 @@ typedef boost::shared_ptr<CtrlAgentResponseCreator> CtrlAgentResponseCreatorPtr;
|
|||||||
/// @brief Concrete implementation of the HTTP response crator used
|
/// @brief Concrete implementation of the HTTP response crator used
|
||||||
/// by the Control Agent.
|
/// by the Control Agent.
|
||||||
///
|
///
|
||||||
/// See the documentation of the @ref HttpResponseCreator for the basic
|
/// See the documentation of the @ref isc::http::HttpResponseCreator for
|
||||||
/// information how HTTP response creators are utilized by the libkea-http
|
/// the basic information how HTTP response creators are utilized by
|
||||||
/// library to generate HTTP responses.
|
/// the libkea-http library to generate HTTP responses.
|
||||||
///
|
///
|
||||||
/// This creator expects that received requests are encapsulated in the
|
/// This creator expects that received requests are encapsulated in the
|
||||||
/// @ref PostHttpRequestJson objects. The generated responses are
|
/// @ref isc::http::PostHttpRequestJson objects. The generated responses
|
||||||
/// encapsulated in the HttpResponseJson objects.
|
/// are encapsulated in the HttpResponseJson objects.
|
||||||
///
|
///
|
||||||
/// This class uses @ref CtrlAgentCommandMgr singleton to process commands
|
/// This class uses @ref CtrlAgentCommandMgr singleton to process commands
|
||||||
/// conveyed in the HTTP body. The JSON responses returned by the manager
|
/// conveyed in the HTTP body. The JSON responses returned by the manager
|
||||||
@@ -38,17 +38,19 @@ public:
|
|||||||
|
|
||||||
/// @brief Create a new request.
|
/// @brief Create a new request.
|
||||||
///
|
///
|
||||||
/// This method creates a bare instance of the @ref PostHttpRequestJson.
|
/// This method creates a bare instance of the @ref
|
||||||
|
/// isc::http::PostHttpRequestJson.
|
||||||
///
|
///
|
||||||
/// @return Pointer to the new instance of the @ref PostHttpRequestJson.
|
/// @return Pointer to the new instance of the @ref
|
||||||
|
/// isc::http::PostHttpRequestJson.
|
||||||
virtual http::HttpRequestPtr createNewHttpRequest() const;
|
virtual http::HttpRequestPtr createNewHttpRequest() const;
|
||||||
|
|
||||||
/// @brief Creates stock HTTP response.
|
/// @brief Creates stock HTTP response.
|
||||||
///
|
///
|
||||||
/// @param request Pointer to an object representing HTTP request.
|
/// @param request Pointer to an object representing HTTP request.
|
||||||
/// @param status_code Status code of the response.
|
/// @param status_code Status code of the response.
|
||||||
/// @return Pointer to an @ref HttpResponseJson object representing stock
|
/// @return Pointer to an @ref isc::http::HttpResponseJson object
|
||||||
/// HTTP response.
|
/// representing stock HTTP response.
|
||||||
virtual http::HttpResponsePtr
|
virtual http::HttpResponsePtr
|
||||||
createStockHttpResponse(const http::ConstHttpRequestPtr& request,
|
createStockHttpResponse(const http::ConstHttpRequestPtr& request,
|
||||||
const http::HttpStatusCode& status_code) const;
|
const http::HttpStatusCode& status_code) const;
|
||||||
|
@@ -15,14 +15,14 @@ namespace agent {
|
|||||||
|
|
||||||
/// @brief HTTP response creator factory for Control Agent.
|
/// @brief HTTP response creator factory for Control Agent.
|
||||||
///
|
///
|
||||||
/// See the documentation of the @ref HttpResponseCreatorFactory for
|
/// See the documentation of the @ref isc::http::HttpResponseCreatorFactory
|
||||||
/// the details how the response factory object is used by the
|
/// for the details how the response factory object is used by the
|
||||||
/// @ref HttpListener.
|
/// @ref isc::http::HttpListener.
|
||||||
///
|
///
|
||||||
/// This class always returns the same instance of the
|
/// This class always returns the same instance of the
|
||||||
/// @ref CtrlAgentResponseCreator which @ref HttpListener and
|
/// @ref CtrlAgentResponseCreator which @ref isc::http::HttpListener and
|
||||||
/// @ref HttpConnection classes use to generate HTTP response messages
|
/// @ref isc::http::HttpConnection classes use to generate HTTP response
|
||||||
/// which comply with the formats required by the Control Agent.
|
/// messages which comply with the formats required by the Control Agent.
|
||||||
class CtrlAgentResponseCreatorFactory : public http::HttpResponseCreatorFactory {
|
class CtrlAgentResponseCreatorFactory : public http::HttpResponseCreatorFactory {
|
||||||
public:
|
public:
|
||||||
|
|
||||||
|
Reference in New Issue
Block a user