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
95
96
97
98
// Copyright (C) 2024 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 HTTP_COMMAND_MGR_H
#define HTTP_COMMAND_MGR_H

#include <asiolink/io_service.h>
#include <config/http_command_config.h>
#include <http/listener.h>
#include <boost/noncopyable.hpp><--- Include file:  not found. Please note: Cppcheck does not need standard library headers to get proper results.

namespace isc {
namespace config {

/// @brief Declaration of the implementation class.
class HttpCommandMgrImpl;

/// @brief HTTP Commands Manager implementation for the Kea servers.
///
/// Similar to @c UnixCommandMgr but using HTTP/HTTPS instead of UNIX sockets.
class HttpCommandMgr : public boost::noncopyable {
public:

    /// @brief HttpCommandMgr is a singleton class. This method
    /// returns reference to its sole instance.
    ///
    /// @return The only existing instance of the manager.
    static HttpCommandMgr& instance();

    /// @brief Sets IO service to be used by the http 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 Override default idle connection timeout.
    ///
    /// @param timeout New connection timeout in milliseconds.
    void setIdleConnectionTimeout(const long timeout);

    /// @brief Use external sockets flag.
    ///
    /// Add sockets as external sockets of the interface manager
    /// so available I/O on them makes a waiting select to return.
    ///
    /// @param use_external True (default) add external sockets.
    void addExternalSockets(bool use_external = true);

    /// @brief Configure http control socket from configuration.
    ///
    /// @param config Configuration of the control http socket.
    void configure(HttpCommandConfigPtr config);

    /// @brief Close http control socket.
    ///
    /// @note When remove is false @c garbageCollectListeners must
    /// be called after.
    ///
    /// @param remove When true remove the listeners immediately.
    void close(bool remove = true);

    /// @brief Removes listeners which are no longer in use.
    ///
    /// This method should be called after server reconfiguration to
    /// remove listeners used previously (no longer used because the
    /// listening address and port has changed as a result of the
    /// reconfiguration). If there are no listeners additional to the
    /// one that is currently in use, the method has no effect.
    /// This method is reused to remove all listeners at shutdown time.
    void garbageCollectListeners();

    /// @brief Returns a const pointer to the HTTP listener.
    ///
    /// @return Const pointer to the currently used listener or null pointer if
    /// there is no listener.
    isc::http::ConstHttpListenerPtr getHttpListener() const;

private:

    /// @brief Private constructor.
    HttpCommandMgr();

    /// @brief Pointer to the implementation of the @ref HttpCommandMgr.
    boost::shared_ptr<HttpCommandMgrImpl> impl_;
};

} // end of isc::config namespace
} // end of isc namespace
#endif