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
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
|
/*
* Copyright (c) 2017 Cisco and/or its affiliates.
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at:
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
#ifndef __VOM_DHCP_CLIENT_CMDS_H__
#define __VOM_DHCP_CLIENT_CMDS_H__
#include "vom/dhcp_client.hpp"
#include "vom/dump_cmd.hpp"
#include "vom/event_cmd.hpp"
#include <vapi/dhcp.api.vapi.hpp>
#include <vapi/vpe.api.vapi.hpp>
namespace VOM {
namespace dhcp_client_cmds {
/**
* A command class that binds the DHCP config to the interface
*/
class bind_cmd : public rpc_cmd<HW::item<bool>, vapi::Dhcp_client_config>
{
public:
/**
* Constructor
*/
bind_cmd(HW::item<bool>& item,
const handle_t& itf,
const std::string& hostname,
const l2_address_t& client_id,
bool set_braodcast_flag,
const ip_dscp_t& dscp);
/**
* Issue the command to VPP/HW
*/
rc_t issue(connection& con);
/**
* convert to string format for debug purposes
*/
std::string to_string() const;
/**
* Comparison operator - only used for UT
*/
bool operator==(const bind_cmd& i) const;
private:
/**
* Reference to the HW::item of the interface to bind
*/
const handle_t& m_itf;
/**
* The DHCP client's hostname
*/
const std::string m_hostname;
/**
* The DHCP client's ID
*/
const l2_address_t m_client_id;
/**
* Flag to control the setting the of DHCP discover's broadcast flag
*/
const bool m_set_broadcast_flag;
/**
* DSCP bits
*/
const ip_dscp_t& m_dscp;
};
/**
* A cmd class that Unbinds Dhcp Config from an interface
*/
class unbind_cmd : public rpc_cmd<HW::item<bool>, vapi::Dhcp_client_config>
{
public:
/**
* Constructor
*/
unbind_cmd(HW::item<bool>& item,
const handle_t& itf,
const std::string& hostname);
/**
* Issue the command to VPP/HW
*/
rc_t issue(connection& con);
/**
* convert to string format for debug purposes
*/
std::string to_string() const;
/**
* Comparison operator - only used for UT
*/
bool operator==(const unbind_cmd& i) const;
private:
/**
* Reference to the HW::item of the interface to unbind
*/
const handle_t& m_itf;
/**
* The DHCP client's hostname
*/
const std::string m_hostname;
};
/**
* A functor class represents our desire to recieve interface events
*/
class events_cmd : public event_cmd<vapi::Control_ping, vapi::Dhcp_compl_event>
{
public:
/**
* Constructor
*/
events_cmd(dhcp_client::event_listener& el);
~events_cmd();
/**
* Issue the command to VPP/HW - subscribe to DHCP events
*/
rc_t issue(connection& con);
/**
* Retire the command - unsubscribe
*/
void retire(connection& con);
/**
* convert to string format for debug purposes
*/
std::string to_string() const;
/**
* Comparison operator - only used for UT
*/
bool operator==(const events_cmd& i) const;
/**
* called in the VAPI RX thread when data is available.
*/
void notify();
private:
void succeeded() {}
/**
* The listner of this command
*/
dhcp_client::event_listener& m_listener;
};
/**
* A cmd class that Dumps all the DHCP clients
*/
class dump_cmd : public VOM::dump_cmd<vapi::Dhcp_client_dump>
{
public:
/**
* Constructor
*/
dump_cmd();
dump_cmd(const dump_cmd& d);
/**
* Issue the command to VPP/HW
*/
rc_t issue(connection& con);
/**
* convert to string format for debug purposes
*/
std::string to_string() const;
/**
* Comparison operator - only used for UT
*/
bool operator==(const dump_cmd& i) const;
private:
/**
* HW reutrn code
*/
HW::item<bool> item;
};
}; // namespace dhcp_client_cmds
}; // namespace VOM
/*
* fd.io coding-style-patch-verification: OFF
*
* Local Variables:
* eval: (c-set-style "mozilla")
* End:
*/
#endif
|
