extras/vom/vom/vxlan_tunnel_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_VXLAN_TUNNEL_CMDS_H__
  17 #define __VOM_VXLAN_TUNNEL_CMDS_H__
  18
  19 #include "vom/dump_cmd.hpp"
  20 #include "vom/rpc_cmd.hpp"
  21 #include "vom/vxlan_tunnel.hpp"
  22
  23 #include <vapi/vapi.hpp>
  24 #include <vapi/vxlan.api.vapi.hpp>
  25
  26 namespace VOM {
  27 namespace vxlan_tunnel_cmds {
  28
  29 /**
  30  * A Command class that creates an VXLAN tunnel
  31  */
  32 class create_cmd : public interface::create_cmd<vapi::Vxlan_add_del_tunnel>
  33 {
  34 public:
  35   /**
  36    * Create command constructor taking HW item to update and the
  37    * endpoint values
  38    */
  39   create_cmd(HW::item<handle_t>& item,
  40              const std::string& name,
  41              const vxlan_tunnel::endpoint_t& ep,
  42              handle_t mcast_itf);
  43
  44   /**
  45    * Issue the command to VPP/HW
  46    */
  47   rc_t issue(connection& con);
  48   /**
  49    * convert to string format for debug purposes
  50    */
  51   std::string to_string() const;
  52
  53   /**
  54    * Comparison operator - only used for UT
  55    */
  56   bool operator==(const create_cmd& i) const;
  57
  58 private:
  59   /**
  60    * Enpoint values of the tunnel to be created
  61    */
  62   const vxlan_tunnel::endpoint_t m_ep;
  63   handle_t m_mcast_itf;
  64 };
  65
  66 /**
  67  * A functor class that creates an VXLAN tunnel
  68  */
  69 class delete_cmd : public interface::delete_cmd<vapi::Vxlan_add_del_tunnel>
  70 {
  71 public:
  72   /**
  73    * delete command constructor taking HW item to update and the
  74    * endpoint values
  75    */
  76   delete_cmd(HW::item<handle_t>& item, const vxlan_tunnel::endpoint_t& ep);
  77
  78   /**
  79    * Issue the command to VPP/HW
  80    */
  81   rc_t issue(connection& con);
  82
  83   /**
  84    * convert to string format for debug purposes
  85    */
  86   std::string to_string() const;
  87
  88   /**
  89    * Comparison operator - only used for UT
  90    */
  91   bool operator==(const delete_cmd& i) const;
  92
  93 private:
  94   /**
  95    * Enpoint values of the tunnel to be deleted
  96    */
  97   const vxlan_tunnel::endpoint_t m_ep;
  98 };
  99
 100 /**
 101  * A cmd class that Dumps all the Vpp interfaces
 102  */
 103 class dump_cmd : public VOM::dump_cmd<vapi::Vxlan_tunnel_dump>
 104 {
 105 public:
 106   /**
 107    * Default Constructor
 108    */
 109   dump_cmd();
 110
 111   /**
 112    * Issue the command to VPP/HW
 113    */
 114   rc_t issue(connection& con);
 115   /**
 116    * convert to string format for debug purposes
 117    */
 118   std::string to_string() const;
 119
 120   /**
 121    * Comparison operator - only used for UT
 122    */
 123   bool operator==(const dump_cmd& i) const;
 124 };
 125
 126 }; // namespace vxlan_tunnel_cmds
 127 }; // namespace VOM
 128
 129 /*
 130  * fd.io coding-style-patch-verification: ON
 131  *
 132  * Local Variables:
 133  * eval: (c-set-style "mozilla")
 134  * End:
 135  */
 136
 137 #endif