aboutsummaryrefslogtreecommitdiffstats
path: root/extras/vom/vom/tap_interface_cmds.hpp
blob: 5651b7cf193ab64c89996d0e41d2fc5980248c47 (plain)
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
/*
 * 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_TAP_INTERFACE_CMDS_H__
#define __VOM_TAP_INTERFACE_CMDS_H__

#include "vom/interface.hpp"
#include "vom/tap_interface.hpp"
#include "vom/dump_cmd.hpp"
#include "vom/rpc_cmd.hpp"

#include <vapi/interface.api.vapi.hpp>
#include <vapi/tap.api.vapi.hpp>
#include <vapi/tapv2.api.vapi.hpp>

namespace VOM {
namespace tap_interface_cmds {

/**
 * A functor class that creates an interface
 */
class tap_create_cmd : public interface::create_cmd<vapi::Tap_connect>
{
public:
  tap_create_cmd(HW::item<handle_t>& item,
             const std::string& name,
             route::prefix_t& prefix,
             const l2_address_t& l2_address);

  /**
   * Issue the command to VPP/HW
   */
  rc_t issue(connection& con);
  /**
   * convert to string format for debug purposes
   */
  std::string to_string() const;

private:
  route::prefix_t& m_prefix;
  const l2_address_t& m_l2_address;
};

/**
 * A functor class that deletes a Tap interface
 */
class tap_delete_cmd : public interface::delete_cmd<vapi::Tap_delete>
{
public:
  tap_delete_cmd(HW::item<handle_t>& item);

  /**
   * Issue the command to VPP/HW
   */
  rc_t issue(connection& con);
  /**
   * convert to string format for debug purposes
   */
  std::string to_string() const;
};

/**
 * A cmd class that Dumps all the Vpp Interfaces
 */
class tap_dump_cmd : public VOM::dump_cmd<vapi::Sw_interface_tap_dump>
{
public:
  /**
   * Default Constructor
   */
  tap_dump_cmd();

  /**
   * 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 tap_dump_cmd& i) const;
};

/**
 * A functor class that creates an interface
 */
class tapv2_create_cmd : public interface::create_cmd<vapi::Tap_create_v2>
{
public:
  tapv2_create_cmd(HW::item<handle_t>& item,
             const std::string& name,
             route::prefix_t& prefix,
             const l2_address_t& l2_address);

  /**
   * Issue the command to VPP/HW
   */
  rc_t issue(connection& con);
  /**
   * convert to string format for debug purposes
   */
  std::string to_string() const;

private:
  route::prefix_t& m_prefix;
  const l2_address_t& m_l2_address;
};

/**
 * A functor class that deletes a Tap interface
 */
class tapv2_delete_cmd : public interface::delete_cmd<vapi::Tap_delete_v2>
{
public:
  tapv2_delete_cmd(HW::item<handle_t>& item);

  /**
   * Issue the command to VPP/HW
   */
  rc_t issue(connection& con);
  /**
   * convert to string format for debug purposes
   */
  std::string to_string() const;
};

/**
 * A cmd class that Dumps all the Vpp Interfaces
 */
class tapv2_dump_cmd : public VOM::dump_cmd<vapi::Sw_interface_tap_v2_dump>
{
public:
  /**
   * Default Constructor
   */
  tapv2_dump_cmd();

  /**
   * 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 tapv2_dump_cmd& i) const;
};

}; // namespace tap_interface_cmds 
}; // namespace VOM

#endif