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
  21 #include <vapi/l2.api.vapi.hpp>
  22 #include <vapi/vpe.api.vapi.hpp>
  23
  24 namespace VOM {
  25 namespace bridge_domain_arp_entry_cmds {
  26
  27 /**
  28 * A command class that creates or updates the bridge domain ARP Entry
  29 */
  30 class create_cmd : public rpc_cmd<HW::item<bool>, vapi::Bd_ip_mac_add_del>
  31 {
  32 public:
  33   /**
  34    * Constructor
  35    */
  36   create_cmd(HW::item<bool>& item,
  37              uint32_t id,
  38              const mac_address_t& mac,
  39              const boost::asio::ip::address& ip_addr);
  40
  41   /**
  42    * Issue the command to VPP/HW
  43    */
  44   rc_t issue(connection& con);
  45
  46   /**
  47    * convert to string format for debug purposes
  48    */
  49   std::string to_string() const;
  50
  51   /**
  52    * Comparison operator - only used for UT
  53    */
  54   bool operator==(const create_cmd& i) const;
  55
  56 private:
  57   uint32_t m_bd;
  58   mac_address_t m_mac;
  59   boost::asio::ip::address m_ip_addr;
  60 };
  61
  62 /**
  63  * A cmd class that deletes a bridge domain ARP entry
  64  */
  65 class delete_cmd : public rpc_cmd<HW::item<bool>, vapi::Bd_ip_mac_add_del>
  66 {
  67 public:
  68   /**
  69    * Constructor
  70    */
  71   delete_cmd(HW::item<bool>& item,
  72              uint32_t id,
  73              const mac_address_t& mac,
  74              const boost::asio::ip::address& ip_addr);
  75
  76   /**
  77    * Issue the command to VPP/HW
  78    */
  79   rc_t issue(connection& con);
  80
  81   /**
  82    * convert to string format for debug purposes
  83    */
  84   std::string to_string() const;
  85
  86   /**
  87    * Comparison operator - only used for UT
  88    */
  89   bool operator==(const delete_cmd& i) const;
  90
  91 private:
  92   uint32_t m_bd;
  93   mac_address_t m_mac;
  94   boost::asio::ip::address m_ip_addr;
  95 };
  96 };
  97 };
  98
  99 /*
 100  * fd.io coding-style-patch-verification: ON
 101  *
 102  * Local Variables:
 103  * eval: (c-set-style "mozilla")
 104  * End:
 105  */
 106
 107 #endif