extras/vom/vom/neighbour_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_NEIGHBOUR_CMDS_H__
  17 #define __VOM_NEIGHBOUR_CMDS_H__
  18
  19 #include "vom/dump_cmd.hpp"
  20 #include "neighbour.hpp"
  21
  22 #include <vapi/ip.api.vapi.hpp>
  23
  24 namespace VOM {
  25 namespace neighbour_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>,
  31                                   vapi::Ip_neighbor_add_del>
  32 {
  33 public:
  34   /**
  35    * Constructor
  36    */
  37   create_cmd(HW::item<bool>& item,
  38              handle_t itf,
  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   handle_t m_itf;
  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>,
  67                                   vapi::Ip_neighbor_add_del>
  68 {
  69 public:
  70   /**
  71    * Constructor
  72    */
  73   delete_cmd(HW::item<bool>& item,
  74              handle_t itf,
  75              const mac_address_t& mac,
  76              const boost::asio::ip::address& ip_addr);
  77
  78   /**
  79    * Issue the command to VPP/HW
  80    */
  81   rc_t issue(connection& con);
  82
  83   /**
  84    * convert to string format for debug purposes
  85    */
  86   std::string to_string() const;
  87
  88   /**
  89    * Comparison operator - only used for UT
  90    */
  91   bool operator==(const delete_cmd& i) const;
  92
  93 private:
  94   handle_t m_itf;
  95   mac_address_t m_mac;
  96   boost::asio::ip::address m_ip_addr;
  97 };
  98
  99 /**
 100  * A cmd class that Dumps all the neighbours
 101  */
 102 class dump_cmd : public VOM::dump_cmd<vapi::Ip_neighbor_dump>
 103 {
 104 public:
 105   /**
 106    * Constructor
 107    */
 108   dump_cmd(const handle_t& itf, const l3_proto_t& proto);
 109   dump_cmd(const dump_cmd& d);
 110
 111   /**
 112    * Issue the command to VPP/HW
 113    */
 114   rc_t issue(connection& con);
 115   /**
 116    * convert to string format for debug purposes
 117    */
 118   std::string to_string() const;
 119
 120   /**
 121    * Comparison operator - only used for UT
 122    */
 123   bool operator==(const dump_cmd& i) const;
 124
 125 private:
 126   /**
 127    * HW reutrn code
 128    */
 129   HW::item<bool> item;
 130
 131   /**
 132    * The interface to dump
 133    */
 134   handle_t m_itf;
 135
 136   /**
 137    * V4 or V6
 138    */
 139   l3_proto_t m_proto;
 140 };
 141
 142 }; // namespace neighbour_cmds
 143 }; // namespace vom
 144 #endif
 145