aboutsummaryrefslogtreecommitdiffstats
path: root/src/vpp-api/vom/nat_static_cmds.hpp
blob: 1db2571a5586f0270ddf2ee58f1c4fa3ac2cde64 (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
/*
 * 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_NAT_STATIC_CMDS_H__
#define __VOM_NAT_STATIC_CMDS_H__

#include "nat_static.hpp"
#include "vom/dump_cmd.hpp"

#include <vapi/nat.api.vapi.hpp>

namespace VOM {
namespace nat_static_cmds {

/**
 * A command class that creates NAT 44 static mapping
 */
class create_44_cmd
  : public rpc_cmd<HW::item<bool>, rc_t, vapi::Nat44_add_del_static_mapping>
{
public:
  /**
   * Constructor
   */
  create_44_cmd(HW::item<bool>& item,
                route::table_id_t id,
                const boost::asio::ip::address_v4& inside,
                const boost::asio::ip::address_v4& outside);

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

private:
  route::table_id_t m_id;
  const boost::asio::ip::address_v4 m_inside;
  const boost::asio::ip::address_v4 m_outside;
};

/**
 * A cmd class that deletes a NAT 44 static mapping
 */
class delete_44_cmd
  : public rpc_cmd<HW::item<bool>, rc_t, vapi::Nat44_add_del_static_mapping>
{
public:
  /**
   * Constructor
   */
  delete_44_cmd(HW::item<bool>& item,
                route::table_id_t id,
                const boost::asio::ip::address_v4& inside,
                const boost::asio::ip::address_v4& outside);

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

private:
  route::table_id_t m_id;
  const boost::asio::ip::address_v4 m_inside;
  const boost::asio::ip::address_v4 m_outside;
};

/**
 * A cmd class that Dumps all the nat_statics
 */
class dump_44_cmd : public dump_cmd<vapi::Nat44_static_mapping_dump>
{
public:
  /**
   * Constructor
   */
  dump_44_cmd();
  dump_44_cmd(const dump_44_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_44_cmd& i) const;

private:
  /**
   * HW reutrn code
   */
  HW::item<bool> item;
};
}; // namespace nat_static_cmds
}; // namespace vom

/*
 * fd.io coding-style-patch-verification: ON
 *
 * Local Variables:
 * eval: (c-set-style "mozilla")
 * End:
 */

#endif