src/vpp-api/vom/gbp_endpoint_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_GBP_ENDPOINT_CMDS_H__
  17 #define __VOM_GBP_ENDPOINT_CMDS_H__
  18
  19 #include "vom/dump_cmd.hpp"
  20 #include "vom/gbp_endpoint.hpp"
  21
  22 #include <vapi/gbp.api.vapi.hpp>
  23
  24 namespace VOM {
  25 namespace gbp_endpoint_cmds {
  26
  27 /**
  28 * A command class that creates or updates the GBP endpoint
  29 */
  30 class create_cmd
  31   : public rpc_cmd<HW::item<bool>, rc_t, vapi::Gbp_endpoint_add_del>
  32 {
  33 public:
  34   /**
  35    * Constructor
  36    */
  37   create_cmd(HW::item<bool>& item,
  38              const handle_t& itf,
  39              const boost::asio::ip::address& ip_addr,
  40              const mac_address_t& mac,
  41              epg_id_t epg_id);
  42
  43   /**
  44    * Issue the command to VPP/HW
  45    */
  46   rc_t issue(connection& con);
  47
  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   const handle_t m_itf;
  60   const boost::asio::ip::address m_ip_addr;
  61   const mac_address_t m_mac;
  62   const epg_id_t m_epg_id;
  63 };
  64
  65 /**
  66  * A cmd class that deletes a GBP endpoint
  67  */
  68 class delete_cmd
  69   : public rpc_cmd<HW::item<bool>, rc_t, vapi::Gbp_endpoint_add_del>
  70 {
  71 public:
  72   /**
  73    * Constructor
  74    */
  75   delete_cmd(HW::item<bool>& item,
  76              const handle_t& itf,
  77              const boost::asio::ip::address& ip_addr);
  78
  79   /**
  80    * Issue the command to VPP/HW
  81    */
  82   rc_t issue(connection& con);
  83
  84   /**
  85    * convert to string format for debug purposes
  86    */
  87   std::string to_string() const;
  88
  89   /**
  90    * Comparison operator - only used for UT
  91    */
  92   bool operator==(const delete_cmd& i) const;
  93
  94 private:
  95   const handle_t m_itf;
  96   const boost::asio::ip::address m_ip_addr;
  97 };
  98
  99 /**
 100  * A cmd class that Dumps all the GBP endpoints
 101  */
 102 class dump_cmd : public VOM::dump_cmd<vapi::Gbp_endpoint_dump>
 103 {
 104 public:
 105   /**
 106    * Constructor
 107    */
 108   dump_cmd();
 109   dump_cmd(const dump_cmd& d);
 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 private:
 126   /**
 127    * HW reutrn code
 128    */
 129   HW::item<bool> item;
 130 };
 131 }; // namespace gbp_enpoint_cms
 132 }; // namespace VOM
 133
 134 /*
 135  * fd.io coding-style-patch-verification: ON
 136  *
 137  * Local Variables:
 138  * eval: (c-set-style "mozilla")
 139  * End:
 140  */
 141
 142 #endif