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>, rc_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::flood_mode_t& fmode,
  41              const bridge_domain::mac_age_mode_t& mmode);
  42
  43   /**
  44    * Issue the command to VPP/HW
  45    */
  46   rc_t issue(connection& con);
  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   /**
  59    * the learning mode for the bridge
  60    */
  61   bridge_domain::learning_mode_t m_learning_mode;
  62   /**
  63    * the learning mode for the bridge
  64    */
  65   bridge_domain::arp_term_mode_t m_arp_term_mode;
  66   /**
  67    * the flood mode for the bridge
  68    */
  69   bridge_domain::flood_mode_t m_flood_mode;
  70   /**
  71    * the flood mode for the bridge
  72    */
  73   bridge_domain::mac_age_mode_t m_mac_age_mode;
  74 };
  75
  76 /**
  77  * A cmd class that Delete an Bridge-Domain
  78  */
  79 class delete_cmd
  80   : public rpc_cmd<HW::item<uint32_t>, rc_t, vapi::Bridge_domain_add_del>
  81 {
  82 public:
  83   /**
  84    * Constructor
  85    */
  86   delete_cmd(HW::item<uint32_t>& item);
  87
  88   /**
  89    * Issue the command to VPP/HW
  90    */
  91   rc_t issue(connection& con);
  92   /**
  93    * convert to string format for debug purposes
  94    */
  95   std::string to_string() const;
  96
  97   /**
  98    * Comparison operator - only used for UT
  99    */
 100   bool operator==(const delete_cmd& i) const;
 101 };
 102
 103 /**
 104  * A cmd class that Dumps all the bridge domains
 105  */
 106 class dump_cmd : public VOM::dump_cmd<vapi::Bridge_domain_dump>
 107 {
 108 public:
 109   /**
 110    * Constructor
 111    */
 112   dump_cmd();
 113   dump_cmd(const dump_cmd& d);
 114
 115   /**
 116    * Issue the command to VPP/HW
 117    */
 118   rc_t issue(connection& con);
 119   /**
 120    * convert to string format for debug purposes
 121    */
 122   std::string to_string() const;
 123
 124   /**
 125    * Comparison operator - only used for UT
 126    */
 127   bool operator==(const dump_cmd& i) const;
 128
 129 private:
 130   /**
 131    * HW reutrn code
 132    */
 133   HW::item<bool> item;
 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