OFPort (OpenFlowJ-Loxi 3.5.526 API)

java.lang.Object
- org.projectfloodlight.openflow.types.OFPort

All Implemented Interfaces:

Comparable<OFPort>, OFValueType<OFPort>, PrimitiveSinkable
```
public class OFPort
extends Object
implements OFValueType<OFPort>
```
Abstraction of an logical / OpenFlow switch port (ofp_port_no) in OpenFlow. Immutable. Note: Switch port numbers were changed in OpenFlow 1.1 from uint16 to uint32. This class uses a 32 bit representation internally. Port numbers are converted from/to uint16 when constructed / getPortNumberasShort is called. If this port is not representable in OpenFlow 1.0, an IllegalStateException is raised.

Author:

Andreas Wundsam <andreas.wundsam@bigswitch.com>

Field Summary

Fields
Modifier and Type	Field and Description
`static OFPort`	`ALL` All physical ports except input port
`static OFPort`	`ANY` Wildcard port used only for flow mod (delete) and flow stats requests.
`static OFPort`	`CONTROLLER` Send to controller
`static OFPort`	`FLOOD` All physical ports in VLAN, except input port and those blocked or link down
`static OFPort`	`FULL_MASK`
`static OFPort`	`IN_PORT` Send the packet out the input port.
`static OFPort`	`LOCAL` local openflow "port"
`static OFPort`	`MAX` Maximum number of physical and logical switch ports.
`static OFPort`	`NO_MASK`
`static OFPort`	`NORMAL` Process with normal L2/L3 switching.
`static OFPort`	`TABLE` Submit the packet to the first flow table NB: This destination port can only be used in packet-out messages.
`static OFPort`	`ZERO` the wildcarded default for OpenFlow 1.0 (value: 0).

Method Summary

Methods
Modifier and Type	Method and Description
`OFPort`	`applyMask(OFPort mask)`
`int`	`compareTo(OFPort o)`
`boolean`	`equals(Object obj)`
`int`	`getLength()`
`int`	`getPortNumber()` return the port number as a int32
`short`	`getShortPortNumber()` return the port number as int16.
`int`	`hashCode()`
`static OFPort`	`of(int portNumber)` convenience function: delegates to ofInt
`static OFPort`	`ofInt(int portNumber)` get an OFPort object corresponding to a raw 32-bit integer port number.
`static OFPort`	`ofShort(short portNumber)` get an OFPort object corresponding to a raw signed 16-bit integer port number (OF1.0).
`void`	`putTo(com.google.common.hash.PrimitiveSink sink)`
`static OFPort`	`read2Bytes(io.netty.buffer.ByteBuf c)`
`static OFPort`	`read4Bytes(io.netty.buffer.ByteBuf c)`
`String`	`toString()`
`void`	`write2Bytes(io.netty.buffer.ByteBuf c)`
`void`	`write4Bytes(io.netty.buffer.ByteBuf c)`

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

- Field Detail
  - MAX
```
public static final OFPort MAX
```
    Maximum number of physical and logical switch ports.
  - IN_PORT
```
public static final OFPort IN_PORT
```
    Send the packet out the input port. This reserved port must be explicitly used in order to send back out of the input port.
  - TABLE
```
public static final OFPort TABLE
```
    Submit the packet to the first flow table NB: This destination port can only be used in packet-out messages.
  - NORMAL
```
public static final OFPort NORMAL
```
    Process with normal L2/L3 switching.
  - FLOOD
```
public static final OFPort FLOOD
```
    All physical ports in VLAN, except input port and those blocked or link down
  - ALL
```
public static final OFPort ALL
```
    All physical ports except input port
  - CONTROLLER
```
public static final OFPort CONTROLLER
```
    Send to controller
  - LOCAL
```
public static final OFPort LOCAL
```
    local openflow "port"
  - ANY
```
public static final OFPort ANY
```
    Wildcard port used only for flow mod (delete) and flow stats requests. Selects all flows regardless of output port (including flows with no output port). NOTE: OpenFlow 1.0 calls this 'NONE'
  - ZERO
```
public static final OFPort ZERO
```
    the wildcarded default for OpenFlow 1.0 (value: 0). Elsewhere in OpenFlow we need "ANY" as the default
  - NO_MASK
```
public static final OFPort NO_MASK
```
  - FULL_MASK
```
public static final OFPort FULL_MASK
```
- Method Detail
  - ofInt
```
public static OFPort ofInt(int portNumber)
```
    get an OFPort object corresponding to a raw 32-bit integer port number. NOTE: The port object may either be newly allocated or cached. Do not rely on either behavior.
    
    Parameters:
    portNumber - the integer port number
    
    Returns:
    a corresponding OFPort
  - of
```
public static OFPort of(int portNumber)
```
    convenience function: delegates to ofInt
    
    Parameters:
    portNumber - the integer port number
    
    Returns:
    a corresponding OFPort
  - ofShort
```
public static OFPort ofShort(short portNumber)
```
    get an OFPort object corresponding to a raw signed 16-bit integer port number (OF1.0). Note that the port returned will have the corresponding 32-bit integer value allocated as its port number. NOTE: The port object may either be newly allocated or cached. Do not rely on either behavior.
    
    Parameters:
    portNumber - the short port number
    
    Returns:
    a corresponding OFPort
  - getPortNumber
```
public int getPortNumber()
```
    return the port number as a int32
    
    Returns:
    the port number as an integer
  - getShortPortNumber
```
public short getShortPortNumber()
```
    return the port number as int16. Special ports as defined by the OpenFlow spec will be converted to their OpenFlow 1.0 equivalent. port numbers >= FF00 will cause a IllegalArgumentException to be thrown
    
    Returns:
    the port number as a short
    
    Throws:
    
    IllegalArgumentException - if a regular port number exceeds the maximum value in OF1.0
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - getLength
```
public int getLength()
```
    Specified by:
    
    getLength in interface OFValueType<OFPort>
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - write2Bytes
```
public void write2Bytes(io.netty.buffer.ByteBuf c)
```
  - read2Bytes
```
public static OFPort read2Bytes(io.netty.buffer.ByteBuf c)
                         throws OFParseError
```
    Throws:
    
    OFParseError
  - write4Bytes
```
public void write4Bytes(io.netty.buffer.ByteBuf c)
```
  - read4Bytes
```
public static OFPort read4Bytes(io.netty.buffer.ByteBuf c)
                         throws OFParseError
```
    Throws:
    
    OFParseError
  - applyMask
```
public OFPort applyMask(OFPort mask)
```
    Specified by:
    
    applyMask in interface OFValueType<OFPort>
  - compareTo
```
public int compareTo(OFPort o)
```
    Specified by:
    
    compareTo in interface Comparable<OFPort>
  - putTo
```
public void putTo(com.google.common.hash.PrimitiveSink sink)
```
    Specified by:
    
    putTo in interface PrimitiveSinkable

Class OFPort

Field Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

MAX

IN_PORT

TABLE

NORMAL

FLOOD

ALL

CONTROLLER

LOCAL

ANY

ZERO

NO_MASK

FULL_MASK

Method Detail

ofInt

of

ofShort

getPortNumber

getShortPortNumber

toString

getLength

equals

hashCode

write2Bytes

read2Bytes

write4Bytes

read4Bytes

applyMask

compareTo

putTo