src/vpp-api/vom/bridge_domain_entry_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_BRIDGE_DOMAIN_ENTRY_CMDS_H__
  17 #define __VOM_BRIDGE_DOMAIN_ENTRY_CMDS_H__
  18
  19 #include "vom/bridge_domain_entry.hpp"
  20 #include "vom/dump_cmd.hpp"
  21 #include "vom/rpc_cmd.hpp"
  22
  23 #include <vapi/l2.api.vapi.hpp>
  24
  25 namespace VOM {
  26 namespace bridge_domain_entry_cmds {
  27
  28 /**
  29 * A command class that creates or updates the bridge_domain
  30 */
  31 class create_cmd : public rpc_cmd<HW::item<bool>, rc_t, vapi::L2fib_add_del>
  32 {
  33 public:
  34   /**
  35    * Constructor
  36    */
  37   create_cmd(HW::item<bool>& item,
  38              const mac_address_t& mac,
  39              uint32_t id,
  40              handle_t tx_intf);
  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   mac_address_t m_mac;
  59   uint32_t m_bd;
  60   handle_t m_tx_itf;
  61 };
  62
  63 /**
  64  * A cmd class that deletes a bridge_domain
  65  */
  66 class delete_cmd : public rpc_cmd<HW::item<bool>, rc_t, vapi::L2fib_add_del>
  67 {
  68 public:
  69   /**
  70    * Constructor
  71    */
  72   delete_cmd(HW::item<bool>& item, const mac_address_t& mac, uint32_t id);
  73
  74   /**
  75    * Issue the command to VPP/HW
  76    */
  77   rc_t issue(connection& con);
  78
  79   /**
  80    * convert to string format for debug purposes
  81    */
  82   std::string to_string() const;
  83
  84   /**
  85    * Comparison operator - only used for UT
  86    */
  87   bool operator==(const delete_cmd& i) const;
  88
  89 private:
  90   mac_address_t m_mac;
  91   uint32_t m_bd;
  92 };
  93
  94 /**
  95  * A cmd class that Dumps all the interface spans
  96  */
  97 class dump_cmd : public VOM::dump_cmd<vapi::L2_fib_table_dump>
  98 {
  99 public:
 100   /**
 101    * Constructor
 102    */
 103   dump_cmd();
 104   dump_cmd(const dump_cmd& d);
 105
 106   /**
 107    * Issue the command to VPP/HW
 108    */
 109   rc_t issue(connection& con);
 110   /**
 111    * convert to string format for debug purposes
 112    */
 113   std::string to_string() const;
 114
 115   /**
 116    * Comparison operator - only used for UT
 117    */
 118   bool operator==(const dump_cmd& i) const;
 119
 120 private:
 121   /**
 122    * HW reutrn code
 123    */
 124   HW::item<bool> item;
 125 };
 126 };
 127 };
 128
 129 /*
 130  * fd.io coding-style-patch-verification: ON
 131  *
 132  * Local Variables:
 133  * eval: (c-set-style "mozilla")
 134  * End:
 135  */
 136
 137 #endif