extras/vom/vom/gbp_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_GBP_GLOBAL_CMDS_H__
  17 #define __VOM_GBP_GLOBAL_CMDS_H__
  18
  19 #include "vom/dump_cmd.hpp"
  20 #include "vom/gbp_global.hpp"
  21 #include "vom/rpc_cmd.hpp"
  22
  23 #include <vapi/gbp.api.vapi.hpp>
  24
  25 namespace VOM {
  26 namespace gbp_global_cmds {
  27
  28 /**
  29  * A command class that binds the GBP global to the interface
  30  */
  31 class config_cmd
  32   : public rpc_cmd<HW::item<bool>,
  33                    vapi::Gbp_endpoint_learn_set_inactive_threshold>
  34 {
  35 public:
  36   /**
  37    * Constructor
  38    */
  39   config_cmd(HW::item<bool>& item, uint32_t remote_ep_retention);
  40
  41   /**
  42    * Issue the command to VPP/HW
  43    */
  44   rc_t issue(connection& con);
  45   /**
  46    * convert to string format for debug purposes
  47    */
  48   std::string to_string() const;
  49
  50   /**
  51    * Comparison operator - only used for UT
  52    */
  53   bool operator==(const config_cmd& i) const;
  54
  55 private:
  56   /**
  57    * TX timer configs
  58    */
  59   uint32_t m_remote_ep_retention;
  60 };
  61
  62 }; // namespace gbp_global_cmds
  63 }; // namespace VOM
  64
  65 /*
  66  * fd.io coding-style-patch-verification: ON
  67  *
  68  * Local Variables:
  69  * eval: (c-set-style "mozilla")
  70  * End:
  71  */
  72
  73 #endif