extras/vom/vom/lldp_global_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_LLDP_GLOBAL_CMDS_H__
  17 #define __VOM_LLDP_GLOBAL_CMDS_H__
  18
  19 #include "vom/dump_cmd.hpp"
  20 #include "vom/lldp_global.hpp"
  21 #include "vom/rpc_cmd.hpp"
  22
  23 #include <vapi/lldp.api.vapi.hpp>
  24
  25 namespace VOM {
  26 namespace lldp_global_cmds {
  27
  28 /**
  29  * A command class that binds the LLDP global to the interface
  30  */
  31 class config_cmd : public rpc_cmd<HW::item<bool>, vapi::Lldp_config>
  32 {
  33 public:
  34   /**
  35    * Constructor
  36    */
  37   config_cmd(HW::item<bool>& item,
  38              const std::string& system_name,
  39              uint32_t tx_hold,
  40              uint32_t tx_interval);
  41
  42   /**
  43    * Issue the command to VPP/HW
  44    */
  45   rc_t issue(connection& con);
  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 config_cmd& i) const;
  55
  56 private:
  57   /**
  58    * The system name
  59    */
  60   const std::string m_system_name;
  61
  62   /**
  63    * TX timer configs
  64    */
  65   uint32_t m_tx_hold;
  66   uint32_t m_tx_interval;
  67 };
  68
  69 }; // namespace lldp_global_cmds
  70 }; // namespace VOM
  71
  72 /*
  73  * fd.io coding-style-patch-verification: ON
  74  *
  75  * Local Variables:
  76  * eval: (c-set-style "mozilla")
  77  * End:
  78  */
  79
  80 #endif