extras/vom/vom/l2_vtr_cmds.hpp

   1 /*
   2  * Copyright (c) 2019 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_L2_VTR_CMDS_H__
  17 #define __VOM_L2_VTR_CMDS_H__
  18
  19 #include "vom/l2_vtr.hpp"
  20 #include "vom/rpc_cmd.hpp"
  21
  22 #include <vapi/l2.api.vapi.hpp>
  23
  24 namespace VOM {
  25 namespace l2_vtr_cmds {
  26 /**
  27  * A cmd class sets the VTR operation
  28  */
  29 class set_cmd : public rpc_cmd<HW::item<l2_vtr::option_t>,
  30                                vapi::L2_interface_vlan_tag_rewrite>
  31 {
  32 public:
  33   /**
  34    * Constructor
  35    */
  36   set_cmd(HW::item<l2_vtr::option_t>& item, const handle_t& itf, uint16_t tag);
  37
  38   /**
  39    * Issue the command to VPP/HW
  40    */
  41   rc_t issue(connection& con);
  42
  43   /**
  44    * convert to string format for debug purposes
  45    */
  46   std::string to_string() const;
  47
  48   /**
  49    * Comparison operator - only used for UT
  50    */
  51   bool operator==(const set_cmd& i) const;
  52
  53 private:
  54   /**
  55    * The interface to bind
  56    */
  57   const handle_t m_itf;
  58
  59   /**
  60    * The tag for the operation
  61    */
  62   uint16_t m_tag;
  63 };
  64
  65 }; // namespace vtr_cmds
  66 }; // namespace VOM
  67
  68 /*
  69  * fd.io coding-style-patch-verification: ON
  70  *
  71  * Local Variables:
  72  * eval: (c-set-style "mozilla")
  73  * End:
  74  */
  75
  76 #endif