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