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:
7 * http://www.apache.org/licenses/LICENSE-2.0
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.
16 #ifndef __VOM_SUB_INTERFACE_H__
17 #define __VOM_SUB_INTERFACE_H__
19 #include "vom/interface.hpp"
23 * A Sub-interface. e.g. a VLAN sub-interface on an Ethernet interface
25 class sub_interface : public interface
30 typedef uint16_t vlan_id_t;
34 * Construct a new object matching the desried state
36 sub_interface(const interface& parent, admin_state_t state, vlan_id_t vlan);
38 sub_interface(const interface& parent,
40 const route_domain& rd,
50 sub_interface(const sub_interface& o);
53 * comparison operator - for UT
55 bool operator==(const sub_interface& s) const;
58 * Return the matching 'singular instance' of the sub-interface
60 std::shared_ptr<sub_interface> singular() const;
63 * Find a subinterface from its key
65 static std::shared_ptr<sub_interface> find(const key_t& k);
69 * Return the matching 'instance' of the sub-interface
70 * over-ride from the base class
72 std::shared_ptr<interface> singular_i() const;
75 * Virtual functions to construct an interface create commands.
77 virtual std::queue<cmd*>& mk_create_cmd(std::queue<cmd*>& cmds);
80 * Virtual functions to construct an interface delete commands.
82 virtual std::queue<cmd*>& mk_delete_cmd(std::queue<cmd*>& cmds);
85 * From the name of the parent and the vlan,
86 * construct the sub-interface's name
88 static std::string mk_name(const interface& parent, vlan_id_t vlan);
91 * Refernece conter lock on the parent
93 const std::shared_ptr<interface> m_parent;
103 * fd.io coding-style-patch-verification: ON
106 * eval: (c-set-style "mozilla")