extras/vom/vom/bridge_domain_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_CMDS_H__
  17 #define __VOM_BRIDGE_DOMAIN_CMDS_H__
  18
  19 #include "vom/bridge_domain.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_cmds {
  27 /**
  28  * A command class that creates an Bridge-Domain
  29  */
  30 class create_cmd
  31   : public rpc_cmd<HW::item<uint32_t>, vapi::Bridge_domain_add_del>
  32 {
  33 public:
  34   /**
  35    * Constructor
  36    */
  37   create_cmd(HW::item<uint32_t>& item,
  38              const bridge_domain::learning_mode_t& lmode,
  39              const bridge_domain::arp_term_mode_t& amode,
  40              const bridge_domain::arp_ufwd_mode_t& aumode,
  41              const bridge_domain::flood_mode_t& fmode,
  42              const bridge_domain::mac_age_mode_t& mmode);
  43
  44   /**
  45    * Issue the command to VPP/HW
  46    */
  47   rc_t issue(connection& con);
  48   /**
  49    * convert to string format for debug purposes
  50    */
  51   std::string to_string() const;
  52
  53   /**
  54    * Comparison operator - only used for UT
  55    */
  56   bool operator==(const create_cmd& i) const;
  57
  58 private:
  59   /**
  60    * the learning mode for the bridge
  61    */
  62   bridge_domain::learning_mode_t m_learning_mode;
  63   /**
  64    * the learning mode for the bridge
  65    */
  66   bridge_domain::arp_term_mode_t m_arp_term_mode;
  67   /**
  68    * the learning mode for the bridge
  69    */
  70   bridge_domain::arp_ufwd_mode_t m_arp_ufwd_mode;
  71   /**
  72    * the flood mode for the bridge
  73    */
  74   bridge_domain::flood_mode_t m_flood_mode;
  75   /**
  76    * the flood mode for the bridge
  77    */
  78   bridge_domain::mac_age_mode_t m_mac_age_mode;
  79 };
  80
  81 /**
  82  * A cmd class that Delete an Bridge-Domain
  83  */
  84 class delete_cmd
  85   : public rpc_cmd<HW::item<uint32_t>, vapi::Bridge_domain_add_del>
  86 {
  87 public:
  88   /**
  89    * Constructor
  90    */
  91   delete_cmd(HW::item<uint32_t>& item);
  92
  93   /**
  94    * Issue the command to VPP/HW
  95    */
  96   rc_t issue(connection& con);
  97   /**
  98    * convert to string format for debug purposes
  99    */
 100   std::string to_string() const;
 101
 102   /**
 103    * Comparison operator - only used for UT
 104    */
 105   bool operator==(const delete_cmd& i) const;
 106 };
 107
 108 /**
 109  * A cmd class that Dumps all the bridge domains
 110  */
 111 class dump_cmd : public VOM::dump_cmd<vapi::Bridge_domain_dump>
 112 {
 113 public:
 114   /**
 115    * Constructor
 116    */
 117   dump_cmd();
 118   dump_cmd(const dump_cmd& d);
 119
 120   /**
 121    * Issue the command to VPP/HW
 122    */
 123   rc_t issue(connection& con);
 124   /**
 125    * convert to string format for debug purposes
 126    */
 127   std::string to_string() const;
 128
 129   /**
 130    * Comparison operator - only used for UT
 131    */
 132   bool operator==(const dump_cmd& i) const;
 133
 134 private:
 135   /**
 136    * HW reutrn code
 137    */
 138   HW::item<bool> item;
 139 };
 140 };
 141 };
 142
 143 /*
 144  * fd.io coding-style-patch-verification: ON
 145  *
 146  * Local Variables:
 147  * eval: (c-set-style "mozilla")
 148  * End:
 149  */
 150
 151 #endif