extras/vom/vom/pipe_cmds.hpp

   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_PIPE_CMDS_H__
  17 #define __VOM_PIPE_CMDS_H__
  18
  19 #include "vom/dump_cmd.hpp"
  20 #include "vom/pipe.hpp"
  21 #include "vom/rpc_cmd.hpp"
  22
  23 #include <vapi/pipe.api.vapi.hpp>
  24
  25 namespace VOM {
  26 namespace pipe_cmds {
  27 /**
  28  * A functor class that creates an interface
  29  */
  30 class create_cmd : public interface::create_cmd<vapi::Pipe_create>
  31 {
  32 public:
  33   /**
  34    * Cstrunctor taking the reference to the parent
  35    * and the sub-interface's VLAN
  36    */
  37   create_cmd(HW::item<handle_t>& item,
  38              const std::string& name,
  39              uint32_t instance,
  40              HW::item<pipe::handle_pair_t>& ends);
  41
  42   /**
  43    * Issue the command to VPP/HW
  44    */
  45   rc_t issue(connection& con);
  46
  47   /**
  48    * convert to string format for debug purposes
  49    */
  50   std::string to_string() const;
  51
  52   /**
  53    * Comparison operator - only used for UT
  54    */
  55   bool operator==(const create_cmd& i) const;
  56
  57   virtual vapi_error_e operator()(vapi::Pipe_create& reply);
  58
  59 private:
  60   HW::item<pipe::handle_pair_t>& m_hdl_pair;
  61   uint32_t m_instance;
  62 };
  63
  64 /**
  65  * A cmd class that Delete an interface
  66  */
  67 class delete_cmd : public interface::delete_cmd<vapi::Pipe_delete>
  68 {
  69 public:
  70   /**
  71    * Constructor
  72    */
  73   delete_cmd(HW::item<handle_t>& item, HW::item<pipe::handle_pair_t>& end_pair);
  74
  75   /**
  76    * Issue the command to VPP/HW
  77    */
  78   rc_t issue(connection& con);
  79
  80   /**
  81    * convert to string format for debug purposes
  82    */
  83   std::string to_string() const;
  84
  85   /**
  86    * Comparison operator - only used for UT
  87    */
  88   bool operator==(const delete_cmd& i) const;
  89
  90 private:
  91   HW::item<pipe::handle_pair_t>& m_hdl_pair;
  92 };
  93
  94 /**
  95  * A cmd class that Dumps all the Vpp interfaces
  96  */
  97 class dump_cmd : public VOM::dump_cmd<vapi::Pipe_dump>
  98 {
  99 public:
 100   /**
 101    * Default Constructor
 102    */
 103   dump_cmd() = default;
 104
 105   /**
 106    * Issue the command to VPP/HW
 107    */
 108   rc_t issue(connection& con);
 109   /**
 110    * convert to string format for debug purposes
 111    */
 112   std::string to_string() const;
 113
 114   /**
 115    * Comparison operator - only used for UT
 116    */
 117   bool operator==(const dump_cmd& i) const;
 118 };
 119
 120 }; // namespace pipe_cmds
 121 }; // namespace VOM
 122
 123 /*
 124  * fd.io coding-style-patch-verification: ON
 125  *
 126  * Local Variables:
 127  * eval: (c-set-style "mozilla")
 128  * End:
 129  */
 130
 131 #endif