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 #include <vapi/vpe.api.vapi.hpp>
  24
  25 namespace VOM {
  26
  27 /**
  28  * A cmd class sets the VTR operation
  29  */
  30 class set_vtr_op_cmd
  31   : public rpc_cmd<HW::item<l2_vtr_op_t>, vapi::L2_interface_vlan_tag_rewrite>
  32 {
  33 public:
  34   /**
  35    * Constructor
  36    */
  37   set_vtr_op_cmd(HW::item<l2_vtr_op_t>& item,
  38                  const handle_t& itf,
  39                  uint16_t tag);
  40
  41   /**
  42    * Issue the command to VPP/HW
  43    */
  44   rc_t issue(connection& con);
  45
  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 set_vtr_op_cmd& i) const;
  55
  56 private:
  57   /**
  58    * The interface to bind
  59    */
  60   const handle_t m_itf;
  61
  62   /**
  63    * The tag for the operation
  64    */
  65   uint16_t m_tag;
  66 };
  67
  68 }; // namespace VOM
  69
  70 /*
  71  * fd.io coding-style-patch-verification: ON
  72  *
  73  * Local Variables:
  74  * eval: (c-set-style "mozilla")
  75  * End:
  76  */
  77
  78 #endif