ctrl_dhcp6_srv.h 6.55 KB
Newer Older
1
// Copyright (C) 2012-2014  Internet Systems Consortium, Inc. ("ISC")
2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18
//
// Permission to use, copy, modify, and/or distribute this software for any
// purpose with or without fee is hereby granted, provided that the above
// copyright notice and this permission notice appear in all copies.
//
// THE SOFTWARE IS PROVIDED "AS IS" AND ISC DISCLAIMS ALL WARRANTIES WITH
// REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY
// AND FITNESS.  IN NO EVENT SHALL ISC BE LIABLE FOR ANY SPECIAL, DIRECT,
// INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM
// LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE
// OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
// PERFORMANCE OF THIS SOFTWARE.

#ifndef CTRL_DHCPV6_SRV_H
#define CTRL_DHCPV6_SRV_H

#include <asiolink/asiolink.h>
19
#include <cc/data.h>
20
#include <cc/command_interpreter.h>
21
#include <dhcp6/dhcp6_srv.h>
22 23 24 25 26 27

namespace isc {
namespace dhcp {

/// @brief Controlled version of the DHCPv6 server
///
Tomek Mrugalski's avatar
Tomek Mrugalski committed
28 29 30 31
/// This is a class that is responsible for DHCPv6 server being controllable.
/// It does various things, depending on the configuration backend.
/// For Bundy backend it establishes a connection with msqg and later receives
/// commands over it. For Kea backend, it reads configuration file from disk.
32 33 34 35 36 37 38 39 40
///
/// For detailed explanation or relations between main(), ControlledDhcpv6Srv,
/// Dhcpv6Srv and other classes, see \ref dhcpv6Session.
class ControlledDhcpv6Srv : public isc::dhcp::Dhcpv6Srv {
public:

    /// @brief Constructor
    ///
    /// @param port UDP port to be opened for DHCP traffic
41
    ControlledDhcpv6Srv(uint16_t port = DHCP6_SERVER_PORT);
42 43

    /// @brief Destructor.
Tomek Mrugalski's avatar
Tomek Mrugalski committed
44
    virtual ~ControlledDhcpv6Srv();
45

46
    /// @brief Initializes the server.
47
    ///
48 49 50
    /// Depending on the configuration backend, it establishes msgq session,
    /// reads the JSON file from disk or may perform any other setup
    /// operation. For specific details, see actual implementation in
Tomek Mrugalski's avatar
Tomek Mrugalski committed
51
    /// *_backend.cc
52
    ///
Tomek Mrugalski's avatar
Tomek Mrugalski committed
53 54
    /// This method may throw if initialization fails. Exception types may be
    /// specific to used configuration backend.
Tomek Mrugalski's avatar
Tomek Mrugalski committed
55
    void init(const std::string& config_file);
56

Tomek Mrugalski's avatar
Tomek Mrugalski committed
57
    /// @brief Performs cleanup, immediately before termination
58
    ///
Tomek Mrugalski's avatar
Tomek Mrugalski committed
59 60 61
    /// This method performs final clean up, just before the Dhcpv6Srv object
    /// is destroyed. The actual behavior is backend dependent. For Bundy
    /// backend, it terminates existing session with msgq. After calling
62
    /// it, no further messages over msgq (commands or configuration updates)
Tomek Mrugalski's avatar
Tomek Mrugalski committed
63
    /// may be received. For JSON backend, it is no-op.
64
    ///
Tomek Mrugalski's avatar
Tomek Mrugalski committed
65
    /// For specific details, see actual implementation in *_backend.cc
66
    void cleanup();
67 68 69 70

    /// @brief Initiates shutdown procedure for the whole DHCPv6 server.
    void shutdown();

Tomek Mrugalski's avatar
Tomek Mrugalski committed
71 72 73 74 75 76 77
    /// @brief command processor
    ///
    /// This method is uniform for all config backends. It processes received
    /// command (as a string + JSON arguments). Internally, it's just a
    /// wrapper that calls process*Command() methods and catches exceptions
    /// in them.
    ///
Tomek Mrugalski's avatar
Tomek Mrugalski committed
78 79 80 81 82
    /// Currently supported commands are:
    /// - shutdown
    /// - libreload
    /// - config-reload
    ///
Tomek Mrugalski's avatar
Tomek Mrugalski committed
83
    /// @note It never throws.
84
    ///
85 86
    /// @param command Text represenation of the command (e.g. "shutdown")
    /// @param args Optional parameters
87 88 89
    ///
    /// @return status of the command
    static isc::data::ConstElementPtr
Tomek Mrugalski's avatar
Tomek Mrugalski committed
90
    processCommand(const std::string& command, isc::data::ConstElementPtr args);
91

Tomek Mrugalski's avatar
Tomek Mrugalski committed
92
    /// @brief configuration processor
93
    ///
Tomek Mrugalski's avatar
Tomek Mrugalski committed
94
    /// This is a method for handling incoming configuration updates.
Tomek Mrugalski's avatar
Tomek Mrugalski committed
95 96
    /// This method should be called by all configuration backends when the
    /// server is starting up or when configuration has changed.
97 98 99 100 101 102 103 104
    ///
    /// As pointer to this method is used a callback in ASIO used in
    /// ModuleCCSession, it has to be static.
    ///
    /// @param new_config textual representation of the new configuration
    ///
    /// @return status of the config update
    static isc::data::ConstElementPtr
Tomek Mrugalski's avatar
Tomek Mrugalski committed
105
    processConfig(isc::data::ConstElementPtr new_config);
106

Tomek Mrugalski's avatar
Tomek Mrugalski committed
107
    /// @brief returns pointer to the sole instance of Dhcpv6Srv
108
    ///
Tomek Mrugalski's avatar
Tomek Mrugalski committed
109
    /// @return server instance (may return NULL, if called before server is spawned)
Tomek Mrugalski's avatar
Tomek Mrugalski committed
110 111 112 113 114 115
    static ControlledDhcpv6Srv* getInstance() {
        return (server_);
    }

protected:
    /// @brief Static pointer to the sole instance of the DHCP server.
116
    ///
Tomek Mrugalski's avatar
Tomek Mrugalski committed
117 118 119
    /// This is required for config and command handlers to gain access to
    /// the server. Some of them need to be static methods.
    static ControlledDhcpv6Srv* server_;
120

Tomek Mrugalski's avatar
Tomek Mrugalski committed
121 122
    /// @brief Callback that will be called from iface_mgr when data
    /// is received over control socket.
123 124
    ///
    /// This static callback method is called from IfaceMgr::receive6() method,
Tomek Mrugalski's avatar
Tomek Mrugalski committed
125 126 127
    /// when there is a new command or configuration sent over control socket
    /// (that was sent from msgq if backend is Bundy, or some yet unspecified
    /// sender if the backend is JSON file).
128 129 130 131 132
    static void sessionReader(void);

    /// @brief IOService object, used for all ASIO operations.
    isc::asiolink::IOService io_service_;

Tomek Mrugalski's avatar
Tomek Mrugalski committed
133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156
    /// @brief handler for processing 'shutdown' command
    ///
    /// This handler processes shutdown command, which initializes shutdown
    /// procedure.
    /// @param command (parameter ignored)
    /// @param args (parameter ignored)
    ///
    /// @return status of the command
    isc::data::ConstElementPtr
    commandShutdownHandler(const std::string& command,
                           isc::data::ConstElementPtr args);

    /// @brief handler for processing 'libreload' command
    ///
    /// This handler processes libreload command, which unloads all hook
    /// libraries and reloads them.
    ///
    /// @param command (parameter ignored)
    /// @param args (parameter ignored)
    ///
    /// @return status of the command
    isc::data::ConstElementPtr
    commandLibReloadHandler(const std::string& command,
                            isc::data::ConstElementPtr args);
157

Tomek Mrugalski's avatar
Tomek Mrugalski committed
158 159 160 161 162 163 164 165 166 167 168 169
    /// @brief handler for processing 'config-reload' command
    ///
    /// This handler processes config-reload command, which processes
    /// configuration specified in args parameter.
    ///
    /// @param command (parameter ignored)
    /// @param args configuration to be processed
    ///
    /// @return status of the command
    isc::data::ConstElementPtr
    commandConfigReloadHandler(const std::string& command,
                               isc::data::ConstElementPtr args);
170 171 172 173 174 175
};

}; // namespace isc::dhcp
}; // namespace isc

#endif