extras/vom/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 : public rpc_cmd<HW::item<bool>, vapi::Gbp_endpoint_add_del>
  31 {
  32 public:
  33   /**
  34    * Constructor
  35    */
  36   create_cmd(HW::item<bool>& item,
  37              const handle_t& itf,
  38              const boost::asio::ip::address& ip_addr,
  39              const mac_address_t& mac,
  40              epg_id_t epg_id);
  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 private:
  58   const handle_t m_itf;
  59   const boost::asio::ip::address m_ip_addr;
  60   const mac_address_t m_mac;
  61   const epg_id_t m_epg_id;
  62 };
  63
  64 /**
  65  * A cmd class that deletes a GBP endpoint
  66  */
  67 class delete_cmd : public rpc_cmd<HW::item<bool>, vapi::Gbp_endpoint_add_del>
  68 {
  69 public:
  70   /**
  71    * Constructor
  72    */
  73   delete_cmd(HW::item<bool>& item,
  74              const handle_t& itf,
  75              const boost::asio::ip::address& ip_addr);
  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   const handle_t m_itf;
  94   const boost::asio::ip::address m_ip_addr;
  95 };
  96
  97 /**
  98  * A cmd class that Dumps all the GBP endpoints
  99  */
 100 class dump_cmd : public VOM::dump_cmd<vapi::Gbp_endpoint_dump>
 101 {
 102 public:
 103   /**
 104    * Constructor
 105    */
 106   dump_cmd();
 107   dump_cmd(const dump_cmd& d);
 108
 109   /**
 110    * Issue the command to VPP/HW
 111    */
 112   rc_t issue(connection& con);
 113   /**
 114    * convert to string format for debug purposes
 115    */
 116   std::string to_string() const;
 117
 118   /**
 119    * Comparison operator - only used for UT
 120    */
 121   bool operator==(const dump_cmd& i) const;
 122
 123 private:
 124   /**
 125    * HW reutrn code
 126    */
 127   HW::item<bool> item;
 128 };
 129 }; // namespace gbp_enpoint_cms
 130 }; // namespace VOM
 131
 132 /*
 133  * fd.io coding-style-patch-verification: ON
 134  *
 135  * Local Variables:
 136  * eval: (c-set-style "mozilla")
 137  * End:
 138  */
 139
 140 #endif