1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
|
// Copyright (C) 2015-2018 Internet Systems Consortium, Inc. ("ISC")
//
// This Source Code Form is subject to the terms of the Mozilla Public
// License, v. 2.0. If a copy of the MPL was not distributed with this
// file, You can obtain one at http://mozilla.org/MPL/2.0/.
#ifndef COMMAND_MGR_H
#define COMMAND_MGR_H
#include <asiolink/io_service.h>
#include <cc/data.h>
#include <config/hooked_command_mgr.h>
#include <exceptions/exceptions.h>
#include <boost/noncopyable.hpp>
#include <boost/shared_ptr.hpp>
namespace isc {
namespace config {
/// @brief An exception indicating that specified socket parameters are invalid
class BadSocketInfo : public Exception {
public:
BadSocketInfo(const char* file, size_t line, const char* what) :
isc::Exception(file, line, what) { };
};
/// @brief An exception indicating a problem with socket operation
class SocketError : public Exception {
public:
SocketError(const char* file, size_t line, const char* what) :
isc::Exception(file, line, what) { };
};
class CommandMgrImpl;
/// @brief Commands Manager implementation for the Kea servers.
///
/// This class extends @ref BaseCommandMgr with the ability to receive and
/// respond to commands over unix domain sockets.
class CommandMgr : public HookedCommandMgr, public boost::noncopyable {
public:
/// @brief CommandMgr is a singleton class. This method returns reference
/// to its sole instance.
///
/// @return the only existing instance of the manager
static CommandMgr& instance();
/// @brief Sets IO service to be used by the command manager.
///
/// The server should use this method to provide the Command Manager with the
/// common IO service used by the server.
/// @param io_service Pointer to the IO service.
void setIOService(const asiolink::IOServicePtr& io_service);
/// @brief Override default connection timeout.
///
/// @param timeout New connection timeout in milliseconds.
void setConnectionTimeout(const long timeout);
/// @brief Opens control socket with parameters specified in socket_info
///
/// Currently supported types are:
/// - unix (required parameters: socket-type: unix, socket-name:/unix/path)
///
/// @throw BadSocketInfo When socket configuration is invalid.
/// @throw SocketError When socket operation fails.
///
/// @param socket_info Configuration information for the control socket.
void
openCommandSocket(const isc::data::ConstElementPtr& socket_info);
/// @brief Shuts down any open control sockets
void closeCommandSocket();
/// @brief Returns control socket descriptor
///
/// This method should be used only in tests.
int getControlSocketFD();
private:
/// @brief Private constructor
CommandMgr();
/// @brief Pointer to the implementation of the @ref CommandMgr.
boost::shared_ptr<CommandMgrImpl> impl_;
};
}; // end of isc::config namespace
}; // end of isc namespace
#endif
|
