Kea 3.3.1
isc::config::CmdResponseCreatorFactory Class Reference

HTTP response creator factory for an API listener. More...

#include <cmd_response_creator_factory.h>

Inheritance diagram for isc::config::CmdResponseCreatorFactory:

Public Member Functions

 CmdResponseCreatorFactory (http::HttpAuthConfigPtr http_auth_config, std::unordered_set< std::string > command_accept_list)
 Constructor.
virtual http::HttpResponseCreatorPtr create () const
 Returns an instance of the CmdResponseCreator which is used by HTTP server to generate responses to commands.
Public Member Functions inherited from isc::http::HttpResponseCreatorFactory
virtual ~HttpResponseCreatorFactory ()
 Virtual destructor.

Detailed Description

HTTP response creator factory for an API listener.

See the documentation of the isc::http::HttpResponseCreatorFactory for the details how the response factory object is used by the isc::http::HttpListener.

This class always returns the same instance of the CmdResponseCreator which isc::http::HttpListener and isc::http::HttpConnection classes use to generate HTTP response messages which allow backward compatibility.

Definition at line 26 of file cmd_response_creator_factory.h.

Constructor & Destructor Documentation

◆ CmdResponseCreatorFactory()

isc::config::CmdResponseCreatorFactory::CmdResponseCreatorFactory ( http::HttpAuthConfigPtr http_auth_config,
std::unordered_set< std::string > command_accept_list )
inline

Constructor.

Creates sole instance of the CmdResponseCreator object returned by the CmdResponseCreatorFactory::create.

Parameters
http_auth_configAuthentication configuration.
command_accept_listCommand accept list.

Definition at line 36 of file cmd_response_creator_factory.h.

Member Function Documentation

◆ create()

virtual http::HttpResponseCreatorPtr isc::config::CmdResponseCreatorFactory::create ( ) const
inlinevirtual

Returns an instance of the CmdResponseCreator which is used by HTTP server to generate responses to commands.

Returns
Pointer to the CmdResponseCreator object.

Implements isc::http::HttpResponseCreatorFactory.

Definition at line 46 of file cmd_response_creator_factory.h.


The documentation for this class was generated from the following file: