## Uses of Class
com.h3c.util.ip.BigPortNumber

- Packages that use BigPortNumber
  Package | Description
  --- | ---
  com.h3c.of.ctl | Public API for the OpenFlow Controller.
  com.h3c.of.json | JSON factory and codecs for Openflow structures.
  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.of.lib.mp | Representations of OpenFlow Protocol Multipart Message bodies.
  com.h3c.of.lib.msg | Representations of OpenFlow Protocol Messages.
  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.api | Definitions of services for driving outbound external communications for interacting with peers and integrating with other external applications, e.g.
  com.h3c.sdn.common | Definitions of general services applicable to multiple tiers of the SDN Controller.
  com.h3c.sdn.diag | Definitions of the path diagnostic service.
  com.h3c.sdn.hostManager |
  com.h3c.sdn.linkdisco | Definitions of the services provided by the Link Discovery Application.
  com.h3c.sdn.misc.net |
  com.h3c.sdn.nodemgr | Definitions of the services provided by the Node Manager Application.
  com.h3c.sdn.teamcs | ...
  com.h3c.sdn.topology | Definitions of the interfaces provided by the Topology Services Application.
  com.h3c.util.ip |
  com.h3c.util.pkt |

- - ### Uses of BigPortNumber in com.h3c.of.ctl

    Methods in com.h3c.of.ctl with parameters of type BigPortNumber
    Modifier and Type | Method and Description
    --- | ---
    `MessageFuture` | ControllerService.`enablePort(DataPathId dpid, BigPortNumber port, boolean enable)` Instructs the controller to enable or disable the given port on the specified datapath.
    `MessageFuture` | ControllerServiceAdapter.`enablePort(DataPathId dpid, BigPortNumber port, boolean enable)`
    `MBodyPortStats` | ControllerService.`getPortStats(DataPathId dpid, BigPortNumber portNumber)` Returns the port statistics for the given port, from the specified datapath.
    `MBodyPortStats` | ControllerServiceAdapter.`getPortStats(DataPathId dpid, BigPortNumber portNumber)`

  - ### Uses of BigPortNumber in com.h3c.of.json

    Methods in com.h3c.of.json that return BigPortNumber
    Modifier and Type | Method and Description
    --- | ---
    `static BigPortNumber` | CodecUtils.`decodeBigPort(com.fasterxml.jackson.databind.JsonNode value)` Converts JsonNode into BigPortNumber object.

    Methods in com.h3c.of.json with parameters of type BigPortNumber
    Modifier and Type | Method and Description
    --- | ---
    `static long` | CodecUtils.`encodeBigPort(BigPortNumber bigPort)` Converts BigPortNumber into long that can be used as a JSON value.

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

    Methods in com.h3c.of.lib.instr that return BigPortNumber
    Modifier and Type | Method and Description
    --- | ---
    `BigPortNumber` | ActSetQueue.`getPort()` Returns the port that the queue belongs to; Since 1.0; Dropped at 1.1.
    `BigPortNumber` | ActOutput.`getPort()` Returns the number of the port through which the packet should be sent.

    Methods in com.h3c.of.lib.instr with parameters of type BigPortNumber
    Modifier and Type | Method and Description
    --- | ---
    `static Action` | ActionFactory.`createAction(ProtocolVersion pv, ActionType type, BigPortNumber port)` Creates an OUTPUT action.
    `static Action` | ActionFactory.`createAction(ProtocolVersion pv, ActionType type, BigPortNumber port, int maxLen)` Creates an OUTPUT action.
    `static Action` | ActionFactory.`createAction(ProtocolVersion pv, ActionType type, QueueId id, BigPortNumber port)` Creates a SET_QUEUE action (used to be named ENQUEUE) for version 1.0.

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

    Methods in com.h3c.of.lib.match that return BigPortNumber
    Modifier and Type | Method and Description
    --- | ---
    `BigPortNumber` | MFieldBasicBigPort.`getPort()` Returns the port number.

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

  - ### Uses of BigPortNumber in com.h3c.of.lib.mp

    Methods in com.h3c.of.lib.mp that return BigPortNumber
    Modifier and Type | Method and Description
    --- | ---
    `BigPortNumber` | MBodyFlowStatsRequest.`getOutPort()` Returns the output port that flow entries are required to match; Since 1.0.
    `BigPortNumber` | MBodyPortStats.`getPort()` Returns the port to which the statistics belong; Since 1.0.
    `BigPortNumber` | MBodyQueueStatsRequest.`getPort()` Returns the port for which statistics are requested; Since 1.0.
    `BigPortNumber` | MBodyQueueStats.`getPort()` Returns the port for which queue statistics are requested; Since 1.0.
    `BigPortNumber` | MBodyPortStatsRequest.`getPort()` Returns the port for which stats are requested; Since 1.0.

    Methods in com.h3c.of.lib.mp with parameters of type BigPortNumber
    Modifier and Type | Method and Description
    --- | ---
    `MBodyMutableFlowStatsRequest` | MBodyMutableFlowStatsRequest.`outPort(BigPortNumber outPort)` Sets the requirement that matching flow entries include this as an output port; Since 1.0.
    `MBodyMutableQueueStats` | MBodyMutableQueueStats.`port(BigPortNumber port)` Sets the port number; Since 1.0.
    `MBodyMutableQueueStatsRequest` | MBodyMutableQueueStatsRequest.`port(BigPortNumber port)` Sets the port number for which statistics are requested; Since 1.0.
    `MBodyMutablePortStats` | MBodyMutablePortStats.`port(BigPortNumber port)` Sets the port number; Since 1.0.
    `MBodyMutablePortStatsRequest` | MBodyMutablePortStatsRequest.`port(BigPortNumber port)` Sets the port in the port stats request; Since 1.0.

  - ### Uses of BigPortNumber in com.h3c.of.lib.msg

    Fields in com.h3c.of.lib.msg declared as BigPortNumber
    Modifier and Type | Field and Description
    --- | ---
    `static BigPortNumber` | Port.`ALL` All physical ports except input port; Since 1.0.
    `static BigPortNumber` | Port.`ANY` Wildcard port used only for flow mod (delete) and flow stats requests; Since 1.1.
    `static BigPortNumber` | Port.`CONTROLLER` Send to the Controller; Since 1.0.
    `static BigPortNumber` | Port.`FLOOD` All physical ports in VLAN, except input port and those blocked or link down; Since 1.0.
    `static BigPortNumber` | Port.`IN_PORT` Send the packet out the input port; Since 1.0.
    `static BigPortNumber` | Port.`LOCAL` Local openflow "port"; Since 1.0.
    `static BigPortNumber` | Port.`MAX` Maximum number of physical and logical switch ports; Since 1.0.
    `static BigPortNumber` | Port.`NONE` Not associated with a physical port; Since 1.0.
    `static BigPortNumber` | Port.`NORMAL` Process with normal L2/L3 switching; Since 1.0.
    `static BigPortNumber` | Port.`TABLE` Submit the packet to the first flow table; Since 1.0.

    Methods in com.h3c.of.lib.msg that return BigPortNumber
    Modifier and Type | Method and Description
    --- | ---
    `static BigPortNumber` | Port.`equivalentSpecial(PortNumber pn)` Returns the 1.3 "special" big port number (u32) equivalent to the given 1.0 "special" port number (u16).
    `static BigPortNumber` | Port.`getBigPortNumber(String portNumber)` Returns the port, given its string representation, which can include a logical name or the numeric representation of the port.
    `BigPortNumber` | OfmPacketIn.`getInPhyPort()` Returns the physical port on which the frame was received; Since 1.1.
    `BigPortNumber` | OfmPacketOut.`getInPort()` Returns the packet's input port or Port.CONTROLLER; Since 1.0.
    `BigPortNumber` | OfmPacketIn.`getInPort()` Returns the port on which the frame was received; Since 1.0.
    `BigPortNumber` | OfmFlowMod.`getOutPort()` For `DELETE*` commands, requires matching entries to include this port as an output port; Since 1.0. A value of `Port.ANY` indicates no restriction.
    `BigPortNumber` | Queue.`getPort()` Returns the ID of the port that this queue is attached to.
    `BigPortNumber` | OfmQueueGetConfigReply.`getPort()` Returns the ID of the port that was queried; Since 1.0.
    `BigPortNumber` | OfmQueueGetConfigRequest.`getPort()` Returns the ID of the port to query; Since 1.0.
    `BigPortNumber` | OfmPortMod.`getPort()` Returns the id of the port to be modified; Since 1.0.
    `BigPortNumber` | Port.`getPortNumber()` The port number uniquely identifies a port within a switch; Since 1.0.
    `BigPortNumber` | Bucket.`getWatchPort()` Returns the watch port id; Since 1.1.
    `static BigPortNumber` | PortFactory.`parsePortNumber(OfPacketReader pkt, ProtocolVersion pv)` Parses a port number from the specified buffer, for the given protocol version.

    Methods in com.h3c.of.lib.msg with parameters of type BigPortNumber
    Modifier and Type | Method and Description
    --- | ---
    `static void` | PortFactory.`encodePortNumber(BigPortNumber port, OfPacketWriter pkt, ProtocolVersion pv)` Encodes the given port number, writing it to the specified buffer, for the given protocol version.
    `static PortNumber` | Port.`equivalentSpecial(BigPortNumber bpn)` Returns the 1.0 "special" port number (u16) equivalent to the given 1.3 "special" big port number (u32).
    `OfmMutablePacketOut` | OfmMutablePacketOut.`inPort(BigPortNumber inPort)` Sets the ingress port that must be associated with the packet; Since 1.0.
    `OfmMutablePacketIn` | OfmMutablePacketIn.`inPort(BigPortNumber inPort)` Sets the ingress port; Since 1.0.
    `static boolean` | Port.`isStandardPort(BigPortNumber bpn, ProtocolVersion pv)` Returns true if the given port number is in the range 1 to MAX; false otherwise.
    `static String` | Port.`logicalName(BigPortNumber port, ProtocolVersion pv)` Returns the logical name of the port, or null if the port number is not a special value (for the given protocol version).
    `OfmMutableFlowMod` | OfmMutableFlowMod.`outPort(BigPortNumber outPort)` Sets the out port; Since 1.0.
    `OfmMutablePortMod` | OfmMutablePortMod.`port(BigPortNumber port)` Sets the id of the port to be modified; Since 1.0.
    `MutableQueue` | MutableQueue.`port(BigPortNumber port)` Sets the port number for this queue; Since 1.2.
    `MutablePort` | MutablePort.`portNumber(BigPortNumber portNumber)` Sets the port number for this port; Since 1.0.
    `static String` | Port.`portNumberToString(BigPortNumber port)` Returns a string representation of the port number.
    `static String` | Port.`portNumberToString(BigPortNumber port, ProtocolVersion pv)` Returns a string representation of the port number, for the given protocol version.
    `void` | OfmMutableQueueGetConfigReply.`setPort(BigPortNumber port)` Sets the ID of the port that was queried; Since 1.0.
    `void` | OfmMutableQueueGetConfigRequest.`setPort(BigPortNumber port)` Sets the ID of the port to be queried; Since 1.0.
    `static void` | Port.`validatePortValue(BigPortNumber bpn, ProtocolVersion pv)` Validates that the given port number is an acceptable value for encoding as a port number for the given protocol.
    `MutableBucket` | MutableBucket.`watchPort(BigPortNumber watchPort)` Sets the watch port for this bucket; Since 1.1.

    Constructors in com.h3c.of.lib.msg with parameters of type BigPortNumber
    Constructor and Description
    `OfmPacketIn(OpenflowMessage.Header header, BufferId bufferId, BigPortNumber inPort, BigPortNumber inPhyPort, int totalLen, PacketInReason reason, TableId tableId, long cookie, Match match, byte[] data)`

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

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

    Methods in com.h3c.sdn.adm.dao.model with parameters of type BigPortNumber
    Modifier and Type | Method and Description
    --- | ---
    `void` | HostManagerEntity.`setPort(BigPortNumber port)`

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

  - ### Uses of BigPortNumber in com.h3c.sdn.api

    Methods in com.h3c.sdn.api with parameters of type BigPortNumber
    Modifier and Type | Method and Description
    --- | ---
    `MessageFuture` | RemoteControllerService.`enablePort(SystemInformation system, DataPathId dpid, BigPortNumber port, boolean enable)` Instructs the controller to enable or disable the given port on the specified datapath.
    `MBodyPortStats` | RemoteControllerService.`getPortStats(SystemInformation system, DataPathId dpid, BigPortNumber portNumber)` Returns the port statistics for the given port, from the specified datapath.

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

    Methods in com.h3c.sdn.common that return BigPortNumber
    Modifier and Type | Method and Description
    --- | ---
    `BigPortNumber` | NetworkNode.`connectedPort()` Returns the port on which the end host is connected.
    `BigPortNumber` | ConnectionPoint.`port()` Retrieves the port number associated with the referred connection point.

    Methods in com.h3c.sdn.common that return types with arguments of type BigPortNumber
    Modifier and Type | Method and Description
    --- | ---
    `List<BigPortNumber>` | SuppressedPorts.`ports()` Returns the `port numbers` where lldp traffic is suppressed for a particular datapath.

  - ### Uses of BigPortNumber in com.h3c.sdn.diag

    Methods in com.h3c.sdn.diag with parameters of type BigPortNumber
    Modifier and Type | Method and Description
    --- | ---
    `void` | PathDiagnosticService.`sendPacket(String pid, DataPathId dpid, BigPortNumber outPort)` Sends the packet matching the given packet model ID into the network.

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

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

    Constructors in com.h3c.sdn.hostManager with parameters of type BigPortNumber
    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 BigPortNumber in com.h3c.sdn.linkdisco

    Methods in com.h3c.sdn.linkdisco with parameters of type BigPortNumber
    Modifier and Type | Method and Description
    --- | ---
    `void` | LinkService.`addToSuppressLLDPs(DataPathId dpid, BigPortNumber port)` Adds the given <device,port> tuple to the list of suppressed ports.
    `void` | LinkService.`removeFromSuppressLLDPs(DataPathId dpid, BigPortNumber port)` Removes the given <device,port> tuple from the list of suppressed ports which were previously added.

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

    Methods in com.h3c.sdn.misc.net that return BigPortNumber
    Modifier and Type | Method and Description
    --- | ---
    `BigPortNumber` | NetworkNodeDTO.`connectedPort()`
    `BigPortNumber` | MsgContextDTO.`getInPhyPort()`
    `BigPortNumber` | MsgContextDTO.`getInPort()`
    `BigPortNumber` | ConnectionPointDTO.`port()`
    `BigPortNumber` | Entity.`switchPort()` Returns the port to which the host is connected.

    Methods in com.h3c.sdn.misc.net that return types with arguments of type BigPortNumber
    Modifier and Type | Method and Description
    --- | ---
    `List<BigPortNumber>` | SuppressedPortsDTO.`ports()`

    Constructors in com.h3c.sdn.misc.net with parameters of type BigPortNumber
    Constructor and Description
    `ConnectionPointDTO(DataPathId dpid, BigPortNumber port, ConnectionPoint.Type type)` Creates a DTO representing a connection point on the specified datapath and port, of the specified type.
    `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.
    `LinkDTO(DataPathId srcDpid, BigPortNumber srcPort, ConnectionPoint.Type srcType, DataPathId dstDpid, BigPortNumber dstPort, ConnectionPoint.Type dstType, LinkInfo linkInfo)` Creates a DTO representing a link between two `connection points`.
    `MsgContextDTO(ProtocolVersion pv, int auxId, DataPathId dpid, String openflowType, MessageType type, long xid, BufferId bufferId, BigPortNumber inPort, BigPortNumber inPhyPort, int totalLen, PacketInReason reason, TableId tableId, long cookie, Match match, byte[] data)`
    `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.

    Constructor parameters in com.h3c.sdn.misc.net with type arguments of type BigPortNumber
    Constructor and Description
    `SuppressedPortsDTO(List<BigPortNumber> suppressedPortList)` Default constructor to create a representation of suppressed ports.

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

    Methods in com.h3c.sdn.nodemgr with parameters of type BigPortNumber
    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.`delCfgHost(DataPathId dpId, BigPortNumber port)` Deleting a static configured host
    `List<Entity>` | NodeService.`getAllHost(DataPathId dpId, BigPortNumber port)` get all host entry
    `List<Entity>` | NodeService.`getAllStaticHost(DataPathId dpId, BigPortNumber port)` Get all the static hosts information
    `void` | NodeService.`removeArpbyPort(DataPathId dpId, BigPortNumber portNumber)` remove arp table when port is down or abnormal added by s03140 for 201312110058

  - ### Uses of BigPortNumber in com.h3c.sdn.teamcs

    Methods in com.h3c.sdn.teamcs with parameters of type BigPortNumber
    Modifier and Type | Method and Description
    --- | ---
    `MessageFuture` | TeamControllerService.`enablePort(DataPathId dpid, BigPortNumber port, boolean enable)` Instructs the controller to enable or disable the given port on the specified datapath.
    `Port` | TeamControllerService.`getPort(DataPathId dpid, BigPortNumber portNumber)` Returns the port description for the given port, from the specified datapath.
    `MBodyPortStats` | TeamControllerService.`getPortStats(DataPathId dpid, BigPortNumber portNumber)` Returns the port statistics for the given port, from the specified datapath.

  - ### Uses of BigPortNumber in com.h3c.sdn.topology

    Methods in com.h3c.sdn.topology that return types with arguments of type BigPortNumber
    Modifier and Type | Method and Description
    --- | ---
    `Set<BigPortNumber>` | TopologyService.`getDeviceConnectionPorts(DataPathId dpid)` Return all ports emanating from the given datapath
    `Set<BigPortNumber>` | TopologyService.`ports(DataPathId switchDpid)` List of ports learned by Topology Service for a given switch node.

    Methods in com.h3c.sdn.topology with parameters of type BigPortNumber
    Modifier and Type | Method and Description
    --- | ---
    `void` | TopologyService.`addPortlinkabnormal(DataPathId dpId, BigPortNumber portNumber)` add port with link abnormal state
    `void` | TopologyService.`clearPortlinkabnormal(DataPathId dpId, BigPortNumber portNumber)` delete port with link abnormal state
    `boolean` | TopologyService.`isConnectionPoint(DataPathId switchDpid, BigPortNumber portId)` Indicates if the given port, belonging to the specified node is participating in a interconnect link
    `boolean` | TopologyService.`isPortlinkabnormal(DataPathId dpId, BigPortNumber portNumber)` get port link abnormal state
    `boolean` | TopologyService.`participateInBroadcast(DataPathId switchDpid, BigPortNumber portId)` Indicates if the given switch-port pair can participate in flood action.

  - ### Uses of BigPortNumber in com.h3c.util.ip

    Methods in com.h3c.util.ip that return BigPortNumber
    Modifier and Type | Method and Description
    --- | ---
    `static BigPortNumber` | BigPortNumber.`valueFrom(ByteBuffer buffer)` Reads 4 bytes from the specified byte buffer and creates a port number entity from their value.
    `static BigPortNumber` | BigPortNumber.`valueOf(byte[] bytes)` Returns an object that represents the port number defined by the specified byte array.
    `static BigPortNumber` | BigPortNumber.`valueOf(long port)` Returns an object that represents the big port number defined by the specified long.
    `static BigPortNumber` | BigPortNumber.`valueOf(String portStr)` Returns an object that represents the big port number defined by the specified string.

    Methods in com.h3c.util.ip with parameters of type BigPortNumber
    Modifier and Type | Method and Description
    --- | ---
    `int` | BigPortNumber.`compareTo(BigPortNumber o)` Implements the Comparable interface, to return port numbers in natural order.

  - ### Uses of BigPortNumber in com.h3c.util.pkt

    Methods in com.h3c.util.pkt that return BigPortNumber
    Modifier and Type | Method and Description
    --- | ---
    `BigPortNumber` | PacketReader.`readBigPortNumber()` Reads a (u32) port number from the buffer.

    Methods in com.h3c.util.pkt with parameters of type BigPortNumber
    Modifier and Type | Method and Description
    --- | ---
    `void` | PacketWriter.`write(BigPortNumber pn)` Writes a (u32) port number to the buffer.

Copyright © 2014. All Rights Reserved.