aboutsummaryrefslogtreecommitdiffstats
path: root/extras/vom/vom/pipe_cmds.hpp
blob: 8c26fd60fd3676c33769764a1c19cb40deb552e0 (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
/*
 * 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_PIPE_CMDS_H__
#define __VOM_PIPE_CMDS_H__

#include "vom/dump_cmd.hpp"
#include "vom/pipe.hpp"
#include "vom/rpc_cmd.hpp"

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

namespace VOM {
namespace pipe_cmds {
/**
 * A functor class that creates an interface
 */
class create_cmd : public interface::create_cmd<vapi::Pipe_create>
{
public:
  /**
   * Cstrunctor taking the reference to the parent
   * and the sub-interface's VLAN
   */
  create_cmd(HW::item<handle_t>& item,
             const std::string& name,
             uint32_t instance,
             HW::item<pipe::handle_pair_t>& ends);

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

  virtual vapi_error_e operator()(vapi::Pipe_create& reply);

private:
  HW::item<pipe::handle_pair_t>& m_hdl_pair;
  uint32_t m_instance;
};

/**
 * A cmd class that Delete an interface
 */
class delete_cmd : public interface::delete_cmd<vapi::Pipe_delete>
{
public:
  /**
   * Constructor
   */
  delete_cmd(HW::item<handle_t>& item, HW::item<pipe::handle_pair_t>& end_pair);

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

private:
  HW::item<pipe::handle_pair_t>& m_hdl_pair;
};

/**
 * A cmd class that Dumps all the Vpp interfaces
 */
class dump_cmd : public VOM::dump_cmd<vapi::Pipe_dump>
{
public:
  /**
   * Default Constructor
   */
  dump_cmd() = default;

  /**
   * 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;
};

}; // namespace pipe_cmds
}; // namespace VOM

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

#endif