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