ctrl_dhcp4_srv.h 4.5 KB
Newer Older
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
// Copyright (C) 2012  Internet Systems Consortium, Inc. ("ISC")
//
// 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_DHCPV4_SRV_H
#define CTRL_DHCPV4_SRV_H

#include <asiolink/asiolink.h>
19
#include <cc/data.h>
20
21
#include <cc/session.h>
#include <config/ccsession.h>
22
#include <dhcp4/dhcp4_srv.h>
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39

namespace isc {
namespace dhcp {

/// @brief Controlled version of the DHCPv4 server
///
/// This is a class that is responsible for establishing connection
/// with msqg (receving commands and configuration). This is an extended
/// version of Dhcpv4Srv class that is purely a DHCPv4 server, without
/// external control. ControlledDhcpv4Srv should be used in typical BIND10
/// (i.e. featuring msgq) environment, while Dhcpv4Srv should be used in
/// embedded environments.
///
/// For detailed explanation or relations between main(), ControlledDhcpv4Srv,
/// Dhcpv4Srv and other classes, see \ref dhcpv4Session.
class ControlledDhcpv4Srv : public isc::dhcp::Dhcpv4Srv {
public:
40
41
42
43

    /// @brief Constructor
    ///
    /// @param port UDP port to be opened for DHCP traffic
44
    ControlledDhcpv4Srv(uint16_t port = DHCP4_SERVER_PORT);
45

46
47
48
    /// @brief Destructor.
    ~ControlledDhcpv4Srv();

49
50
51
52
53
54
    /// @brief Establishes msgq session.
    ///
    /// Creates session that will be used to receive commands and updated
    /// configuration from boss (or indirectly from user via bindctl).
    void establishSession();

55
    /// @brief Terminates existing msgq session.
56
57
    ///
    /// This method terminates existing session with msgq. After calling
58
    /// it, no further messages over msgq (commands or configuration updates)
59
60
61
62
63
64
65
66
    /// may be received.
    ///
    /// It is ok to call this method when session is disconnected already.
    void disconnectSession();

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

67
68
69
70
71
72
73
74
75
76
    /// @brief Session callback, processes received commands.
    ///
    /// @param command_id text represenation of the command (e.g. "shutdown")
    /// @param args optional parameters
    ///
    /// @return status of the command
    static isc::data::ConstElementPtr
    execDhcpv4ServerCommand(const std::string& command,
                            isc::data::ConstElementPtr args);

77
protected:
78
79
80
81
    /// @brief Static pointer to the sole instance of the DHCP server.
    ///
    /// This is required for config and command handlers to gain access to
    /// the server
82
83
    static ControlledDhcpv4Srv* server_;

84
85
    /// @brief A callback for handling incoming configuration updates.
    ///
86
87
88
    /// As pointer to this method is used a callback in ASIO used in
    /// ModuleCCSession, it has to be static.
    ///
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
    /// @param new_config textual representation of the new configuration
    ///
    /// @return status of the config update
    static isc::data::ConstElementPtr
    dhcp4ConfigHandler(isc::data::ConstElementPtr new_config);

    /// @brief A callback for handling incoming commands.
    ///
    /// @param command textual representation of the command
    /// @param args parameters of the command
    ///
    /// @return status of the processed command
    static isc::data::ConstElementPtr
    dhcp4CommandHandler(const std::string& command, isc::data::ConstElementPtr args);

104
    /// @brief Callback that will be called from iface_mgr when command/config arrives.
105
106
107
108
109
    ///
    /// This static callback method is called from IfaceMgr::receive4() method,
    /// when there is a new command or configuration sent over msgq.
    static void sessionReader(void);

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

113
    /// @brief Helper session object that represents raw connection to msgq.
114
115
116
117
118
119
120
121
122
123
    isc::cc::Session* cc_session_;

    /// @brief Session that receives configuation and commands
    isc::config::ModuleCCSession* config_session_;
};

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

#endif