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
  42   /**
  43    * Issue the command to VPP/HW
  44    */
  45   rc_t issue(connection& con);
  46   /**
  47    * convert to string format for debug purposes
  48    */
  49   std::string to_string() const;
  50
  51   /**
  52    * Comparison operator - only used for UT
  53    */
  54   bool operator==(const create_cmd& i) const;
  55
  56 private:
  57   /**
  58    * Enpoint values of the tunnel to be created
  59    */
  60   const vxlan_tunnel::endpoint_t m_ep;
  61 };
  62
  63 /**
  64  * A functor class that creates an VXLAN tunnel
  65  */
  66 class delete_cmd : public interface::delete_cmd<vapi::Vxlan_gbp_tunnel_add_del>
  67 {
  68 public:
  69   /**
  70    * delete command constructor taking HW item to update and the
  71    * endpoint values
  72    */
  73   delete_cmd(HW::item<handle_t>& item, const vxlan_tunnel::endpoint_t& ep);
  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   /**
  92    * Enpoint values of the tunnel to be deleted
  93    */
  94   const vxlan_tunnel::endpoint_t m_ep;
  95 };
  96
  97 /**
  98  * A cmd class that Dumps all the Vpp interfaces
  99  */
 100 class dump_cmd : public VOM::dump_cmd<vapi::Vxlan_gbp_tunnel_dump>
 101 {
 102 public:
 103   /**
 104    * Default Constructor
 105    */
 106   dump_cmd();
 107
 108   /**
 109    * Issue the command to VPP/HW
 110    */
 111   rc_t issue(connection& con);
 112   /**
 113    * convert to string format for debug purposes
 114    */
 115   std::string to_string() const;
 116
 117   /**
 118    * Comparison operator - only used for UT
 119    */
 120   bool operator==(const dump_cmd& i) const;
 121 };
 122
 123 }; // namespace vxlan_tunnel_cmds
 124 }; // namespace VOM
 125
 126 /*
 127  * fd.io coding-style-patch-verification: ON
 128  *
 129  * Local Variables:
 130  * eval: (c-set-style "mozilla")
 131  * End:
 132  */
 133
 134 #endif