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<handle_t>, vapi::Gbp_endpoint_add>
  31 {
  32 public:
  33   /**
  34    * Constructor
  35    */
  36   create_cmd(HW::item<handle_t>& item,
  37              const handle_t& itf,
  38              const std::vector<boost::asio::ip::address>& ip_addrs,
  39              const mac_address_t& mac,
  40              sclass_t sclass);
  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   virtual vapi_error_e operator()(vapi::Gbp_endpoint_add& reply);
  53
  54   /**
  55    * Comparison operator - only used for UT
  56    */
  57   bool operator==(const create_cmd& i) const;
  58
  59 private:
  60   const handle_t m_itf;
  61   const std::vector<boost::asio::ip::address> m_ip_addrs;
  62   const mac_address_t m_mac;
  63   const sclass_t m_sclass;
  64 };
  65
  66 /**
  67  * A cmd class that deletes a GBP endpoint
  68  */
  69 class delete_cmd : public rpc_cmd<HW::item<handle_t>, vapi::Gbp_endpoint_del>
  70 {
  71 public:
  72   /**
  73    * Constructor
  74    */
  75   delete_cmd(HW::item<handle_t>& item);
  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_hdl;
  94 };
  95
  96 /**
  97  * A cmd class that Dumps all the GBP endpoints
  98  */
  99 class dump_cmd : public VOM::dump_cmd<vapi::Gbp_endpoint_dump>
 100 {
 101 public:
 102   /**
 103    * Constructor
 104    */
 105   dump_cmd();
 106   dump_cmd(const dump_cmd& d);
 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 private:
 123   /**
 124    * HW reutrn code
 125    */
 126   HW::item<bool> item;
 127 };
 128 }; // namespace gbp_enpoint_cms
 129 }; // namespace VOM
 130
 131 /*
 132  * fd.io coding-style-patch-verification: ON
 133  *
 134  * Local Variables:
 135  * eval: (c-set-style "mozilla")
 136  * End:
 137  */
 138
 139 #endif