src/vpp-api/vom/sub_interface.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_SUB_INTERFACE_H__
  17 #define __VOM_SUB_INTERFACE_H__
  18
  19 #include "vom/interface.hpp"
  20
  21 namespace VOM {
  22 /**
  23  * A Sub-interface. e.g. a VLAN sub-interface on an Ethernet interface
  24  */
  25 class sub_interface : public interface
  26 {
  27   /*
  28    * Typedef for VLAN ID
  29    */
  30   typedef uint16_t vlan_id_t;
  31
  32 public:
  33   /**
  34    * Construct a new object matching the desried state
  35    */
  36   sub_interface(const interface& parent, admin_state_t state, vlan_id_t vlan);
  37   /**
  38    * Destructor
  39    */
  40   ~sub_interface();
  41   /**
  42    * Copy Constructor
  43    */
  44   sub_interface(const sub_interface& o);
  45
  46   /**
  47    * comparison operator - for UT
  48    */
  49   bool operator==(const sub_interface& s) const;
  50
  51   /**
  52    * Return the matching 'singular instance' of the sub-interface
  53    */
  54   std::shared_ptr<sub_interface> singular() const;
  55
  56   /**
  57    * Find a subinterface from its key
  58    */
  59   static std::shared_ptr<sub_interface> find(const key_t& k);
  60
  61 private:
  62   /**
  63    * Return the matching 'instance' of the sub-interface
  64    *  over-ride from the base class
  65    */
  66   std::shared_ptr<interface> singular_i() const;
  67
  68   /**
  69    * Virtual functions to construct an interface create commands.
  70    */
  71   virtual std::queue<cmd*>& mk_create_cmd(std::queue<cmd*>& cmds);
  72
  73   /**
  74    * Virtual functions to construct an interface delete commands.
  75    */
  76   virtual std::queue<cmd*>& mk_delete_cmd(std::queue<cmd*>& cmds);
  77
  78   /**
  79    * From the name of the parent and the vlan,
  80    * construct the sub-interface's name
  81    */
  82   static std::string mk_name(const interface& parent, vlan_id_t vlan);
  83
  84   /**
  85    * Refernece conter lock on the parent
  86    */
  87   const std::shared_ptr<interface> m_parent;
  88
  89   /**
  90    * VLAN ID
  91    */
  92   vlan_id_t m_vlan;
  93 };
  94 };
  95
  96 /*
  97  * fd.io coding-style-patch-verification: ON
  98  *
  99  * Local Variables:
 100  * eval: (c-set-style "mozilla")
 101  * End:
 102  */
 103
 104 #endif