## Uses of Class
com.h3c.of.lib.dt.VId

- Packages that use VId
  Package | Description
  --- | ---
  com.h3c.of.lib | OpenFlow Protocol Library.
  com.h3c.of.lib.dt | A set of classes representing data values used in the OpenFlow protocol.
  com.h3c.of.lib.instr | Representations of OpenFlow Protocol Instructions and Actions.
  com.h3c.of.lib.match | Representations of OpenFlow Protocol Match Structures.
  com.h3c.sdn.adm.dao.model | Model POJOs implementations used to persist and retrieve information applicable at the Administrator tier of the SDN Controller.
  com.h3c.sdn.common | Definitions of general services applicable to multiple tiers of the SDN Controller.
  com.h3c.sdn.ctlAddrManager |
  com.h3c.sdn.hostManager |
  com.h3c.sdn.misc.net |
  com.h3c.sdn.nodemgr | Definitions of the services provided by the Node Manager Application.

- - ### Uses of VId in com.h3c.of.lib

    Methods in com.h3c.of.lib that return VId
    Modifier and Type | Method and Description
    --- | ---
    `VId` | OfPacketReader.`readVId()` Reads a virtual identifier (u16) from the buffer.

    Methods in com.h3c.of.lib with parameters of type VId
    Modifier and Type | Method and Description
    --- | ---
    `void` | OfPacketWriter.`write(VId id)` Writes a virtual id (u16) to the buffer.

  - ### Uses of VId in com.h3c.of.lib.dt

    Fields in com.h3c.of.lib.dt declared as VId
    Modifier and Type | Field and Description
    --- | ---
    `static VId` | VId.`NONE` A special value denoting the absence of a virtual identifier.
    `static VId` | VId.`PRESENT` A special value denoting the presence of a virtual identifier, without defining the specific value.

    Methods in com.h3c.of.lib.dt that return VId
    Modifier and Type | Method and Description
    --- | ---
    `VId` | DataPathId.`getVid()` Returns the virtual identifier.
    `VId` | VId.`to12Bits()` Returns the virtual identifier equivalent to this one with the top 4 bits zeroed out.
    `static VId` | VId.`valueOf(byte[] bytes)` Returns an object that represents the virtual identifier defined by the specified byte array.
    `static VId` | VId.`valueOf(int vid)` Returns an object that represents the virtual identifier defined by the specified integer.
    `static VId` | VId.`valueOf(String vidStr)` Returns an object that represents the virtual identifier defined by the specified string.

    Methods in com.h3c.of.lib.dt with parameters of type VId
    Modifier and Type | Method and Description
    --- | ---
    `int` | VId.`compareTo(VId o)` Implements the Comparable interface, to return virtual identifiers in natural order.
    `static String` | VId.`specialName(VId v)` Returns the logical name of the given identifier if it is a special value; null otherwise.
    `static DataPathId` | DataPathId.`valueOf(VId vid, MacAddress mac)` Returns a datapath ID instance that encapsulates the given virtual identifier and MAC address.

  - ### Uses of VId in com.h3c.of.lib.instr

    Methods in com.h3c.of.lib.instr with parameters of type VId
    Modifier and Type | Method and Description
    --- | ---
    `static Action` | ActionFactory.`createActionSetField(ProtocolVersion pv, OxmBasicFieldType ft, VId vid)` Creates a set-field action for a VLAN_VID, using the given protocol version.

  - ### Uses of VId in com.h3c.of.lib.match

    Methods in com.h3c.of.lib.match that return VId
    Modifier and Type | Method and Description
    --- | ---
    `VId` | MfbVlanVid.`getVlanId()` Returns the VLAN ID.

    Methods in com.h3c.of.lib.match with parameters of type VId
    Modifier and Type | Method and Description
    --- | ---
    `static MFieldBasic` | FieldFactory.`createBasicField(ProtocolVersion pv, OxmBasicFieldType ft, VId vid)` Creates a basic match field for a VLAN_VID.

  - ### Uses of VId in com.h3c.sdn.adm.dao.model

    Methods in com.h3c.sdn.adm.dao.model that return VId
    Modifier and Type | Method and Description
    --- | ---
    `VId` | CtlAddrManagerEntity.`getVid()`
    `VId` | HostManagerEntity.`getVid()`

    Methods in com.h3c.sdn.adm.dao.model with parameters of type VId
    Modifier and Type | Method and Description
    --- | ---
    `void` | CtlAddrManagerEntity.`setVid(VId vid)`
    `void` | HostManagerEntity.`setVid(VId vid)`

    Constructors in com.h3c.sdn.adm.dao.model with parameters of type VId
    Constructor and Description
    `CtlAddrManagerEntity(UUID uid, UUID sysId, IpAddress ipAddr, IpAddress maskIpAddr, MacAddress macAddr, VId vid)`
    `HostManagerEntity(UUID uid, UUID sysId, IpAddress ipAddr, MacAddress macAddr, VId vid, BigPortNumber portNumber, DataPathId dpid, boolean state, int ctlid)`

  - ### Uses of VId in com.h3c.sdn.common

    Methods in com.h3c.sdn.common that return VId
    Modifier and Type | Method and Description
    --- | ---
    `VId` | ARPTable.`vid()` Returns the VID identifier for the ARP table.
    `VId` | NetworkNode.`vid()` Returns the VID to which the end host belongs.
    `VId` | ARPEntry.`vid()` Returns the VID identifier of the ARP Entry.

  - ### Uses of VId in com.h3c.sdn.ctlAddrManager

    Methods in com.h3c.sdn.ctlAddrManager that return VId
    Modifier and Type | Method and Description
    --- | ---
    `VId` | CtlAddrEntity.`getVid()`

    Constructors in com.h3c.sdn.ctlAddrManager with parameters of type VId
    Constructor and Description
    `CtlAddrEntity(Id<CtlAddrEntity,UUID> id, Id<SystemInformation,UUID> sysId, IpAddress ipAddr, IpAddress maskIpAddr, MacAddress macAddr, VId vid)`
    `CtlAddrEntity(Id<SystemInformation,UUID> sysId, IpAddress ipAddr, IpAddress maskIpAddr, MacAddress macAddr, VId vid)`

  - ### Uses of VId in com.h3c.sdn.hostManager

    Methods in com.h3c.sdn.hostManager that return VId
    Modifier and Type | Method and Description
    --- | ---
    `VId` | HostEntity.`getVid()`

    Constructors in com.h3c.sdn.hostManager with parameters of type VId
    Constructor and Description
    `HostEntity(Id<HostEntity,UUID> id, Id<SystemInformation,UUID> sysId, IpAddress ipAddr, MacAddress macAddr, VId vid, DataPathId dpid, BigPortNumber port, int ctlId, boolean state)`
    `HostEntity(Id<SystemInformation,UUID> sysId, IpAddress ipAddr, MacAddress macAddr, VId vid, DataPathId dpid, BigPortNumber port, int ctlId, boolean state)`

  - ### Uses of VId in com.h3c.sdn.misc.net

    Methods in com.h3c.sdn.misc.net that return VId
    Modifier and Type | Method and Description
    --- | ---
    `VId` | ARPTableDTO.`vid()`
    `VId` | NetworkNodeDTO.`vid()`
    `VId` | Entity.`vid()` Returns the VID on which the host is connected.
    `VId` | ARPEntryDTO.`vid()`

    Constructors in com.h3c.sdn.misc.net with parameters of type VId
    Constructor and Description
    `ARPEntryDTO(IpAddress ip, MacAddress mac, VId vid)` Constructor to create ARP entry using IP, MAC and VID.
    `ARPTableDTO(VId vid)` Constructs an ARP table instance, for the given VID.
    `ARPTableDTO(VId vid, boolean layer2DstMacAddrOnly)` Constructs an ARP table type, for a given VID.
    `ARPTableDTO(VId vid, long size)` Constructs an ARP table instance specified size, for a given VID.
    `Entity(MacAddress mac, VId vid, IpAddress ip, DataPathId dpid, BigPortNumber port, boolean shared, int contollerId)` Constructs a new entity using MAC, VID, IP, data path id, port and shared.
    `Entity(MacAddress mac, VId vid, IpAddress ip, DataPathId dpid, BigPortNumber port, int contollerId)` Constructs a new entity using MAC, VID, IP, data path id and port.
    `Entity(MacAddress mac, VId vid, IpAddress ip, DataPathId dpid, BigPortNumber port, long age, boolean shared, int contollerId)`
    `Entity(MacAddress mac, VId vid, IpAddress ip, DataPathId dpid, BigPortNumber port, long age, int contollerId)` Constructs a new entity using MAC, VID, IP, data path id and port.
    `NetworkNodeDTO(MacAddress mac, VId vid, IpAddress ip, DataPathId dpid, BigPortNumber port)` Constructs a NetworkNode instance using the specified IP, MAC VID, DPID and port.
    `NodeMessage(MacAddress mac, VId vid, IpAddress ip, DataPathId dpid, BigPortNumber port, long age, UpdateType op, int controllerId)`
    `NodeMessage(MacAddress mac, VId vid, IpAddress ip, DataPathId dpid, BigPortNumber port, UpdateType op, int controllerId)` Constructs a new NodeMessage using MAC, VLAN, IP, data path id and port.

  - ### Uses of VId in com.h3c.sdn.nodemgr

    Methods in com.h3c.sdn.nodemgr that return types with arguments of type VId
    Modifier and Type | Method and Description
    --- | ---
    `ConcurrentMap<VId,CtlAddrEntity>` | NodeService.`getAllCtlAddrManager()`
    `Set<VId>` | NodeService.`getVnetIDs()` Returns the set of VLAN identifiers learnt in the network, via the end hosts.

    Methods in com.h3c.sdn.nodemgr with parameters of type VId
    Modifier and Type | Method and Description
    --- | ---
    `boolean` | NodeService.`addCfgHost(MacAddress mac, IpAddress ip, VId vlan, DataPathId dpid, BigPortNumber portNum)` Adding a static host
    `boolean` | NodeService.`addCtlAddrManager(VId vid, IpAddress ipAddr, IpAddress maskIpAddr, MacAddress macAddr)`
    `void` | NodeService.`clearNodeTable(VId vid)` Clears the learned end nodes for the given VLAN.
    `boolean` | NodeService.`delCfgHost(MacAddress mac, VId vlan)` Deleting a static host
    `boolean` | NodeService.`delCtlAddrManager(VId vid, IpAddress ipAddr, IpAddress maskIpAddr, MacAddress macAddr)`
    `ARPTable` | NodeService.`getArpTable(VId vid)` Returns the ARP table for the given VLAN.
    `Entity` | NodeService.`getCfgHost(MacAddress mac, VId vid)` Get a static configured host
    `CtlAddrEntity` | NodeService.`getCtlAddrManager(VId vid)`
    `IpAddress` | NodeService.`getIpAddress(MacAddress mac, VId vid)` Returns the IP Address for the given MAC address and VLAN.
    `MacAddress` | NodeService.`getMacAddress(IpAddress ip, VId vid)` Returns the MAC Address for the given IP address and VLAN.
    `NetworkNode` | NodeService.`getNetworkNode(IpAddress ip, VId vid)` Returns the end host for the given IP address and VLAN.
    `NetworkNode` | NodeService.`getNetworkNode(MacAddress mac, VId vid)` Returns the end host for the given MAC address and VLAN.
    `Set<NetworkNode>` | NodeService.`getNetworkNodes(VId vid)` Returns the set of end hosts for the given VLAN.
    `boolean` | NodeService.`isStaticHost(VId vid, MacAddress macAddr)` decide a host as static host
    `void` | NetworkNodeListener.`vidRemoved(VId vid)` Callback invoked when all end hosts for a VID are deleted.

    Method parameters in com.h3c.sdn.nodemgr with type arguments of type VId
    Modifier and Type | Method and Description
    --- | ---
    `void` | NodeService.`clearNodeTable(Set<VId> vids)` Clears the learned end nodes for the given set of VLANs.

Copyright © 2014. All Rights Reserved.