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 (bool emulate_agent_response=true)
	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.
virtual HttpResponseCreatorPtr	create () const =0
	Returns an instance of the HttpResponseCreator.

Detailed Description

HTTP response creator factory for an API listener.

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 CmdResponseCreator 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 CmdResponseCreator 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 31 of file cmd_response_creator_factory.h.

Constructor & Destructor Documentation

CmdResponseCreatorFactory()

isc::config::CmdResponseCreatorFactory::CmdResponseCreatorFactory ( bool  emulate_agent_response = true )

inline

Constructor.

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

Parameters

emulate_agent_response

if true, responses for normal command outcomes are guaranteed to be wrapped in an Element::list. This emulates how kea-ctrl-agent forms responses. Defaults to true.

Definition at line 42 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 50 of file cmd_response_creator_factory.h.

---

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

• cmd_response_creator_factory.h