FD.io VPP  v21.10.1-2-g0a485f517
Vector Packet Processing
gbp_route_domain_cmds.hpp
Go to the documentation of this file.
1 /*
2  * Copyright (c) 2017 Cisco and/or its affiliates.
3  * Licensed under the Apache License, Version 2.0 (the "License");
4  * you may not use this file except in compliance with the License.
5  * You may obtain a copy of the License at:
6  *
7  * http://www.apache.org/licenses/LICENSE-2.0
8  *
9  * Unless required by applicable law or agreed to in writing, software
10  * distributed under the License is distributed on an "AS IS" BASIS,
11  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12  * See the License for the specific language governing permissions and
13  * limitations under the License.
14  */
15 
16 #ifndef __VOM_GBP_ROUTE_DOMAIN_CMDS_H__
17 #define __VOM_GBP_ROUTE_DOMAIN_CMDS_H__
18 
19 #include "vom/dump_cmd.hpp"
20 #include "vom/gbp_route_domain.hpp"
21 #include "vom/rpc_cmd.hpp"
22 
23 #include <vapi/gbp.api.vapi.hpp>
24 
25 namespace VOM {
26 namespace gbp_route_domain_cmds {
27 /**
28  * A command class that creates an Route-Domain
29  */
31  : public rpc_cmd<HW::item<uint32_t>, vapi::Gbp_route_domain_add>
32 {
33 public:
34  /**
35  * Constructor
36  */
38  scope_t scope,
39  const handle_t ip4_uu_fwd,
40  const handle_t ip6_uu_fwd);
41 
42  /**
43  * Issue the command to VPP/HW
44  */
46  /**
47  * convert to string format for debug purposes
48  */
49  std::string to_string() const;
50 
51  /**
52  * Comparison operator - only used for UT
53  */
54  bool operator==(const create_cmd& i) const;
55 
56 private:
57  const scope_t m_scope;
58  const handle_t m_ip4_uu_fwd;
59  const handle_t m_ip6_uu_fwd;
60 };
61 
62 /**
63  * A cmd class that Delete an Route-Domain
64  */
66  : public rpc_cmd<HW::item<uint32_t>, vapi::Gbp_route_domain_del>
67 {
68 public:
69  /**
70  * Constructor
71  */
73 
74  /**
75  * Issue the command to VPP/HW
76  */
78  /**
79  * convert to string format for debug purposes
80  */
81  std::string to_string() const;
82 
83  /**
84  * Comparison operator - only used for UT
85  */
86  bool operator==(const delete_cmd& i) const;
87 };
88 
89 /**
90  * A cmd class that Dumps all the route domains
91  */
92 class dump_cmd : public VOM::dump_cmd<vapi::Gbp_route_domain_dump>
93 {
94 public:
95  /**
96  * Constructor
97  */
98  dump_cmd() = default;
99  dump_cmd(const dump_cmd& d) = default;
100 
101  /**
102  * Issue the command to VPP/HW
103  */
105  /**
106  * convert to string format for debug purposes
107  */
108  std::string to_string() const;
109 
110  /**
111  * Comparison operator - only used for UT
112  */
113  bool operator==(const dump_cmd& i) const;
114 
115 private:
116  /**
117  * HW reutrn code
118  */
119  HW::item<bool> item;
120 };
121 
122 }; // gbp_route_domain_cmds
123 }; // VOM
124 
125 /*
126  * fd.io coding-style-patch-verification: OFF
127  *
128  * Local Variables:
129  * eval: (c-set-style "mozilla")
130  * End:
131  */
132 
133 #endif
VOM::HW::item< uint32_t >
VOM::gbp_route_domain_cmds::delete_cmd::issue
rc_t issue(connection &con)
Issue the command to VPP/HW.
Definition: gbp_route_domain_cmds.cpp:82
VOM::gbp_route_domain_cmds::delete_cmd::delete_cmd
delete_cmd(HW::item< uint32_t > &item)
Constructor.
Definition: gbp_route_domain_cmds.cpp:70
VOM
The VPP Object Model (VOM) library.
Definition: acl_binding.cpp:19
VOM::scope_t
uint16_t scope_t
Definition: gbp_types.hpp:28
VOM::gbp_route_domain_cmds::dump_cmd::dump_cmd
dump_cmd()=default
Constructor.
VOM::rpc_cmd
A base class for all RPC commands to VPP.
Definition: rpc_cmd.hpp:40
con
Connection con
Definition: vapi_cpp_test.cpp:56
VOM::gbp_route_domain_cmds::delete_cmd::operator==
bool operator==(const delete_cmd &i) const
Comparison operator - only used for UT.
Definition: gbp_route_domain_cmds.cpp:76
VOM::gbp_route_domain_cmds::delete_cmd
A cmd class that Delete an Route-Domain.
Definition: gbp_route_domain_cmds.hpp:65
VOM::gbp_route_domain_cmds::create_cmd::create_cmd
create_cmd(HW::item< uint32_t > &item, scope_t scope, const handle_t ip4_uu_fwd, const handle_t ip6_uu_fwd)
Constructor.
Definition: gbp_route_domain_cmds.cpp:21
VOM::gbp_route_domain_cmds::create_cmd::to_string
std::string to_string() const
convert to string format for debug purposes
Definition: gbp_route_domain_cmds.cpp:60
VOM::connection
A representation of the connection to VPP.
Definition: connection.hpp:33
scope
vl_api_gbp_scope_t scope
Definition: gbp.api:78
VOM::gbp_route_domain_cmds::create_cmd
A command class that creates an Route-Domain.
Definition: gbp_route_domain_cmds.hpp:30
VOM::handle_t
A type declaration of an interface handle in VPP.
Definition: types.hpp:233
VOM::gbp_route_domain_cmds::delete_cmd::to_string
std::string to_string() const
convert to string format for debug purposes
Definition: gbp_route_domain_cmds.cpp:99
VOM::gbp_route_domain_cmds::dump_cmd
A cmd class that Dumps all the route domains.
Definition: gbp_route_domain_cmds.hpp:92
dump_cmd.hpp
VOM::rpc_cmd< HW::item< uint32_t >, vapi::Gbp_route_domain_add >::item
HW::item< uint32_t > & item()
return the HW item the command updates
Definition: rpc_cmd.hpp:66
VOM::gbp_route_domain_cmds::dump_cmd::operator==
bool operator==(const dump_cmd &i) const
Comparison operator - only used for UT.
Definition: gbp_route_domain_cmds.cpp:108
VOM::gbp_route_domain_cmds::dump_cmd::issue
rc_t issue(connection &con)
Issue the command to VPP/HW.
Definition: gbp_route_domain_cmds.cpp:114
i
int i
Definition: flowhash_template.h:376
VOM::gbp_route_domain_cmds::create_cmd::operator==
bool operator==(const create_cmd &i) const
Comparison operator - only used for UT.
Definition: gbp_route_domain_cmds.cpp:33
VOM::gbp_route_domain_cmds::create_cmd::issue
rc_t issue(connection &con)
Issue the command to VPP/HW.
Definition: gbp_route_domain_cmds.cpp:41
VOM::gbp_route_domain_cmds::dump_cmd::to_string
std::string to_string() const
convert to string format for debug purposes
Definition: gbp_route_domain_cmds.cpp:126
VOM::rc_t
Error codes that VPP will return during a HW write.
Definition: types.hpp:89
VOM::dump_cmd
A base class for VPP dump commands.
Definition: dump_cmd.hpp:43
gbp_route_domain.hpp
rpc_cmd.hpp
string
const char *const string
Definition: cJSON.h:172