src/vpp-api/vom/acl_ethertype_cmds.hpp

   1 /*
   2  * Copyright (c) 2018 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_ACL_ETHERTYPE_CMDS_H__
  17 #define __VOM_ACL_ETHERTYPE_CMDS_H__
  18
  19 #include "vom/acl_ethertype.hpp"
  20 #include "vom/dump_cmd.hpp"
  21 #include "vom/rpc_cmd.hpp"
  22
  23 #include <vapi/acl.api.vapi.hpp>
  24
  25 namespace VOM {
  26 namespace ACL {
  27 namespace acl_ethertype_cmds {
  28 /**
  29  * A command class that binds the ethertype list to the interface
  30  */
  31 class bind_cmd : public rpc_cmd<HW::item<bool>,
  32                                 rc_t,
  33                                 vapi::Acl_interface_set_etype_whitelist>
  34 {
  35 public:
  36   /**
  37    * Constructor
  38    */
  39   bind_cmd(HW::item<bool>& item,
  40            const handle_t& itf,
  41            const acl_ethertype::ethertype_rules_t& le);
  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 bind_cmd& i) const;
  56
  57 private:
  58   /**
  59    * Reference to the HW::item of the interface to bind
  60    */
  61   const handle_t& m_itf;
  62
  63   /**
  64    * Ethertype list applied to interface
  65    */
  66   const acl_ethertype::ethertype_rules_t& m_le;
  67 };
  68 };
  69 };
  70 };
  71 /*
  72  * fd.io coding-style-patch-verification: ON
  73  *
  74  * Local Variables:
  75  * eval: (c-set-style "mozilla")
  76  * End:
  77  */
  78
  79 #endif