Kea 3.1.8
http_control_socket.cc
Go to the documentation of this file.
1// Copyright (C) 2018-2024 Internet Systems Consortium, Inc. ("ISC")
2//
3// This Source Code Form is subject to the terms of the Mozilla Public
4// License, v. 2.0. If a copy of the MPL was not distributed with this
5// file, You can obtain one at http://mozilla.org/MPL/2.0/.
6
9
10#include <config.h>
11
13#include <asiolink/io_service.h>
14#include <asiolink/tls_socket.h>
16#include <config/timeouts.h>
17#include <http/client.h>
19#include <http/response_json.h>
21
22using namespace std;
23using namespace isc::asiolink;
24using namespace isc::config;
25using namespace isc::data;
26using namespace isc::http;
27
28namespace isc {
29namespace netconf {
30
35
39
41HttpControlSocket::configGet(const string& service) {
42 return (sendCommand(createCommand("config-get", service)));
43}
44
47 return (sendCommand(createCommand("config-test", config, service)));
48}
49
52 return (sendCommand(createCommand("config-set", config, service)));
53}
54
56HttpControlSocket::sendCommand(ConstElementPtr command) {
59 "/",
60 HttpVersion(1, 1)));
61 request->setBodyAsJson(command);
62 try {
63 request->finalize();
64 } catch (exception const& ex) {
65 isc_throw(ControlSocketError, "failed to create request: "
66 << ex.what());
67 }
68
69 IOServicePtr io_service(new IOService());
70 HttpClient client(io_service, false);
71 boost::system::error_code received_ec;
72 string receive_errmsg;
74
75 client.asyncSendRequest(getUrl(), TlsContextPtr(), request, response,
76 [&io_service, &received_ec, &receive_errmsg]
77 (const boost::system::error_code& ec,
78 const HttpResponsePtr&, const string& errmsg) {
79 // Capture error code and message.
80 received_ec = ec;
81 receive_errmsg = errmsg;
82 // Got the IO service so stop IO service.
83 // This causes to stop IO service when
84 // all handlers have been invoked.
85 io_service->stopWork();
86 },
87 HttpClient::RequestTimeout(TIMEOUT_DHCP_SERVER_FORWARD_COMMAND));
88
89 // Perform this synchronously.
90 io_service->run();
91
92 client.stop();
93 io_service->stopAndPoll();
94
95 if (received_ec) {
96 // Got an error code.
97 isc_throw(ControlSocketError, "communication error (code): "
98 << received_ec.message());
99 }
100
101 if (!receive_errmsg.empty()) {
102 // Got an error message.
103 isc_throw(ControlSocketError, "communication error (message): "
104 << receive_errmsg);
105 }
106
107 if (!response) {
108 // Failed to get the answer.
109 isc_throw(ControlSocketError, "empty response");
110 }
111
112 try {
113 return (response->getBodyAsJson());
114 } catch (exception const& ex) {
115 isc_throw(ControlSocketError, "unparsable response: " << ex.what());
116 }
117}
118
119} // namespace netconf
120} // namespace isc
HTTP client class.
Represents HTTP response with JSON content.
Represents HTTP POST request with JSON body.
ControlSocketBase(CfgControlSocketPtr ctrl_sock)
Constructor.
const isc::http::Url getUrl() const
Returns the HTTP server URL.
Class for control socket communication over HTTP socket.
data::ConstElementPtr configTest(data::ElementPtr config, const std::string &service) override final
Test configuration.
data::ConstElementPtr configSet(data::ElementPtr config, const std::string &service) override final
Set configuration.
data::ConstElementPtr configGet(const std::string &service) override final
Get configuration.
HttpControlSocket(CfgControlSocketPtr ctrl_sock)
Constructor.
This file contains several functions and constants that are used for handling commands and responses ...
#define isc_throw(type, stream)
A shortcut macro to insert known values into exception arguments.
Contains declarations for HTTP control socket communication.
ConstElementPtr createCommand(const std::string &command)
Creates a standard command message with no argument (of the form { "command": "my_command" }...
constexpr long TIMEOUT_DHCP_SERVER_FORWARD_COMMAND
Timeout for the DHCP server to forward command to a Kea server, e.g.
Definition timeouts.h:27
boost::shared_ptr< const Element > ConstElementPtr
Definition data.h:30
boost::shared_ptr< Element > ElementPtr
Definition data.h:29
boost::shared_ptr< PostHttpRequestJson > PostHttpRequestJsonPtr
Pointer to PostHttpRequestJson.
boost::shared_ptr< HttpResponseJson > HttpResponseJsonPtr
Pointer to the HttpResponseJson object.
boost::shared_ptr< HttpResponse > HttpResponsePtr
Pointer to the HttpResponse object.
Definition response.h:81
std::shared_ptr< HttpControlSocket > HttpControlSocketPtr
Type definition for the pointer to the HttpControlSocket.
std::shared_ptr< ControlSocketBase > ControlSocketBasePtr
Type definition for the pointer to the ControlSocketBase.
ControlSocketBasePtr createControlSocket< CfgControlSocket::Type::HTTP >(CfgControlSocketPtr ctrl_sock)
Factory template specialization for http control sockets.
std::shared_ptr< CfgControlSocket > CfgControlSocketPtr
Defines a pointer for CfgControlSocket instances.
Defines the logger used by the top-level component of kea-lfc.
HTTP protocol version.
Definition http_types.h:14