![]() |
Kea 3.0.0
|
Base class for control socket communication. More...
#include <control_socket.h>
Public Member Functions | |
| ControlSocketBase (CfgControlSocketPtr ctrl_sock) | |
| Constructor. | |
| virtual | ~ControlSocketBase ()=default |
| Destructor (does nothing). | |
| virtual data::ConstElementPtr | configGet (const std::string &service)=0 |
| Get configuration. | |
| virtual data::ConstElementPtr | configSet (data::ElementPtr config, const std::string &service)=0 |
| Set configuration. | |
| virtual data::ConstElementPtr | configTest (data::ElementPtr config, const std::string &service)=0 |
| Test configuration. | |
| const std::string | getName () const |
| Returns the Unix socket name. | |
| CfgControlSocket::Type | getType () const |
| Getter which returns the socket type. | |
| const isc::http::Url | getUrl () const |
| Returns the HTTP server URL. | |
Public Attributes | |
| CfgControlSocketPtr | socket_cfg_ |
| The control socket configuration. | |
Base class for control socket communication.
This class is the base class for control socket communication. Derived classes implement config-get, config-test and config-set using control sockets of different types. Those classes are used to communicate with other Kea daemons.
Definition at line 33 of file control_socket.h.
|
inline |
Constructor.
| ctrl_sock | The control socket configuration. |
| ControlSocketError | if ctrl_sock is null. |
Definition at line 39 of file control_socket.h.
References isc_throw, and socket_cfg_.
Referenced by isc::netconf::HttpControlSocket::HttpControlSocket(), isc::netconf::StdoutControlSocket::StdoutControlSocket(), isc::netconf::StdoutControlSocket::StdoutControlSocket(), and isc::netconf::UnixControlSocket::UnixControlSocket().
|
virtualdefault |
Destructor (does nothing).
|
pure virtual |
Get configuration.
Call config-get over the control socket.
| service | The target service (used by http). |
| ControlSocketError | when a communication error occurs. |
Implemented in isc::netconf::HttpControlSocket, isc::netconf::StdoutControlSocket, and isc::netconf::UnixControlSocket.
Referenced by isc::netconf::NetconfAgent::keaConfig().
|
pure virtual |
Set configuration.
Call config-set over the control socket.
| config | The configuration to set. |
| service | The target service (used by http). |
| ControlSocketError | when a communication error occurs. |
Implemented in isc::netconf::HttpControlSocket, isc::netconf::StdoutControlSocket, and isc::netconf::UnixControlSocket.
Referenced by isc::netconf::NetconfAgent::done(), and isc::netconf::NetconfAgent::yangConfig().
|
pure virtual |
Test configuration.
Call config-test over the control socket.
| config | The configuration to test. |
| service | The target service (used by http). |
| ControlSocketError | when a communication error occurs. |
Implemented in isc::netconf::HttpControlSocket, isc::netconf::StdoutControlSocket, and isc::netconf::UnixControlSocket.
Referenced by isc::netconf::NetconfAgent::change().
|
inline |
Returns the Unix socket name.
Definition at line 59 of file control_socket.h.
References socket_cfg_.
|
inline |
Getter which returns the socket type.
Definition at line 52 of file control_socket.h.
References socket_cfg_.
|
inline |
Returns the HTTP server URL.
Definition at line 66 of file control_socket.h.
References socket_cfg_.
| CfgControlSocketPtr isc::netconf::ControlSocketBase::socket_cfg_ |
The control socket configuration.
Definition at line 102 of file control_socket.h.
Referenced by ControlSocketBase(), getName(), getType(), and getUrl().