![]() |
Kea 3.0.0
|
Represents a Control Socket. More...
#include <netconf_config.h>
Public Types | |
| enum | Type { UNIX , HTTP , STDOUT } |
| Defines the list of possible control socket types. More... | |
Public Member Functions | |
| CfgControlSocket (Type type, const std::string &name, const isc::http::Url &url) | |
| Constructor. | |
| virtual | ~CfgControlSocket ()=default |
| Destructor (doing nothing). | |
| const std::string | getName () const |
| Getter which returns the Unix socket name. | |
| Type | getType () const |
| Getter which returns the socket type. | |
| const isc::http::Url | getUrl () const |
| Getter which returns the HTTP server URL. | |
| isc::data::ElementPtr | toElement () const override final |
| Unparse a configuration object. | |
| Public Member Functions inherited from isc::data::UserContext | |
| void | contextToElement (data::ElementPtr map) const |
| Merge unparse a user_context object. | |
| data::ConstElementPtr | getContext () const |
| Returns const pointer to the user context. | |
| void | setContext (const data::ConstElementPtr &ctx) |
| Sets user context. | |
| Public Member Functions inherited from isc::data::CfgToElement | |
| virtual | ~CfgToElement () |
| Destructor. | |
Static Public Member Functions | |
| static Type | stringToType (const std::string &type) |
| Converts socket type name to CfgControlSocket::Type. | |
| static const std::string | typeToString (CfgControlSocket::Type type) |
| Converts CfgControlSocket::Type to string. | |
| Static Public Member Functions inherited from isc::data::UserContext | |
| static data::ElementPtr | toElement (data::ConstElementPtr map) |
| Copy an Element map. | |
Additional Inherited Members | |
| Protected Attributes inherited from isc::data::UserContext | |
| data::ConstElementPtr | user_context_ |
| Pointer to the user context (may be NULL) | |
Represents a Control Socket.
Acts as a storage class containing the basic attributes which describe a Control Socket.
Definition at line 69 of file netconf_config.h.
Defines the list of possible control socket types.
| Enumerator | |
|---|---|
| UNIX | |
| HTTP | |
| STDOUT | |
Definition at line 73 of file netconf_config.h.
| isc::netconf::CfgControlSocket::CfgControlSocket | ( | Type | type, |
| const std::string & | name, | ||
| const isc::http::Url & | url ) |
Constructor.
| type | The socket type. |
| name | The Unix socket name. |
| url | The HTTP server URL. |
Definition at line 27 of file netconf_config.cc.
|
virtualdefault |
Destructor (doing nothing).
|
inline |
Getter which returns the Unix socket name.
Definition at line 100 of file netconf_config.h.
|
inline |
Getter which returns the socket type.
Definition at line 93 of file netconf_config.h.
Referenced by isc::netconf::controlSocketFactory().
|
inline |
Getter which returns the HTTP server URL.
Definition at line 107 of file netconf_config.h.
|
static |
Converts socket type name to CfgControlSocket::Type.
| type | The type name. Currently supported values are "unix", "http" and "stdout". |
| BadValue | if the type name isn't recognized. |
Definition at line 33 of file netconf_config.cc.
References HTTP, isc_throw, STDOUT, and UNIX.
Referenced by isc::netconf::ControlSocketConfigParser::parse().
|
finaloverridevirtual |
Unparse a configuration object.
Implements isc::data::CfgToElement.
Definition at line 60 of file netconf_config.cc.
References isc::data::UserContext::contextToElement(), Element::create(), Element::createMap(), and typeToString().
|
static |
Converts CfgControlSocket::Type to string.
| type | The CfgControlSocket::Type type. |
Definition at line 46 of file netconf_config.cc.
References HTTP, isc_throw, STDOUT, and UNIX.
Referenced by toElement().