isc::config::HttpCommandResponseCreatorFactory Class Reference

HTTP response creator factory for HTTP control socket. More...

#include <http_command_response_creator_factory.h>

Inheritance diagram for isc::config::HttpCommandResponseCreatorFactory:

Public Member Functions
	HttpCommandResponseCreatorFactory (HttpCommandConfigPtr config)
	Constructor.
virtual http::HttpResponseCreatorPtr	create () const
	Returns an instance of the HttpCommandResponseCreator 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 HTTP control socket.

Parameters

emulate_agent_response

if true results for normal command outcomes are wrapped in Element::list. This emulates responses generated by kea-ctrl-agent. The value is passed into the HttpCommandResponseCreator when created. Defaults to true.

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 HttpCommandResponseCreator which isc::http::HttpListener and isc::http::HttpConnection classes use to generate HTTP response messages which comply with the formats required by the Control Agent.

Definition at line 32 of file http_command_response_creator_factory.h.

Constructor & Destructor Documentation

HttpCommandResponseCreatorFactory()

isc::config::HttpCommandResponseCreatorFactory::HttpCommandResponseCreatorFactory ( HttpCommandConfigPtr config )

inline

Constructor.

Creates sole instance of the HttpCommandResponseCreator object returned by the HttpCommandResponseCreatorFactory::create.

Parameters

config

The HTTP control socket config.

Definition at line 41 of file http_command_response_creator_factory.h.

Member Function Documentation

create()

virtual http::HttpResponseCreatorPtr isc::config::HttpCommandResponseCreatorFactory::create ( ) const

inlinevirtual

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

Returns

Pointer to the HttpCommandResponseCreator object.

Implements isc::http::HttpResponseCreatorFactory.

Definition at line 49 of file http_command_response_creator_factory.h.

---

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

• http_command_response_creator_factory.h