extras/vom/vom/bridge_domain_arp_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_ARP_ENTRY_CMDS_H__
  17 #define __VOM_BRIDGE_DOMAIN_ARP_ENTRY_CMDS_H__
  18
  19 #include "vom/bridge_domain_arp_entry.hpp"
  20 #include "vom/dump_cmd.hpp"
  21
  22 #include <vapi/l2.api.vapi.hpp>
  23 #include <vapi/vpe.api.vapi.hpp>
  24
  25 namespace VOM {
  26 namespace bridge_domain_arp_entry_cmds {
  27
  28 /**
  29 * A command class that creates or updates the bridge domain ARP Entry
  30 */
  31 class create_cmd : public rpc_cmd<HW::item<bool>, vapi::Bd_ip_mac_add_del>
  32 {
  33 public:
  34   /**
  35    * Constructor
  36    */
  37   create_cmd(HW::item<bool>& item,
  38              uint32_t id,
  39              const mac_address_t& mac,
  40              const boost::asio::ip::address& ip_addr);
  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   uint32_t m_bd;
  59   mac_address_t m_mac;
  60   boost::asio::ip::address m_ip_addr;
  61 };
  62
  63 /**
  64  * A cmd class that deletes a bridge domain ARP entry
  65  */
  66 class delete_cmd : public rpc_cmd<HW::item<bool>, vapi::Bd_ip_mac_add_del>
  67 {
  68 public:
  69   /**
  70    * Constructor
  71    */
  72   delete_cmd(HW::item<bool>& item,
  73              uint32_t id,
  74              const mac_address_t& mac,
  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   uint32_t m_bd;
  94   mac_address_t m_mac;
  95   boost::asio::ip::address m_ip_addr;
  96 };
  97
  98 /**
  99  * A cmd class that Dumps all arp termination tables
 100  */
 101 class dump_cmd : public VOM::dump_cmd<vapi::Bd_ip_mac_dump>
 102 {
 103 public:
 104   /**
 105    * Constructor
 106    */
 107   dump_cmd(uint32_t bd_id);
 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   /**
 131    * The bd_id to get the arp termination table for
 132    */
 133   uint32_t m_bd;
 134 };
 135 };
 136 };
 137
 138 /*
 139  * fd.io coding-style-patch-verification: ON
 140  *
 141  * Local Variables:
 142  * eval: (c-set-style "mozilla")
 143  * End:
 144  */
 145
 146 #endif