com.hp.of.lib.msg

Class OfmMutablePacketOut

java.lang.Object

com.hp.nbio.AbstractMessage

com.hp.of.lib.msg.OpenflowMessage

com.hp.of.lib.msg.OfmPacketOut

com.hp.of.lib.msg.OfmMutablePacketOut

All Implemented Interfaces:

Message, MutableMessage, MutableObject, Structure

public class OfmMutablePacketOut
extends OfmPacketOut
implements MutableMessage

Mutable subclass of OfmPacketOut.

Author:

Simon Hunt

Field Summary

Fields inherited from class com.hp.nbio.AbstractMessage

length

Method Summary

Methods

Modifier and Type	Method and Description
OfmMutablePacketOut	addAction(Action act) Adds an action to the action list; Since 1.0; Removed at 1.1.
OfmMutablePacketOut	bufferId(BufferId bufferId) Sets the buffer id; Since 1.0.
OfmMutablePacketOut	clearActions() Clears any previously added actions.
void	clearXid() Clears the transaction ID field of this message (sets it to 0).
OfmMutablePacketOut	data(byte[] data) Sets the packet frame data; Since 1.0.
OfmMutablePacketOut	inPort(BigPortNumber inPort) Sets the ingress port that must be associated with the packet; Since 1.0.
OfmMutablePacketOut	inPort(OfmPacketIn pktIn) Deprecated.
OpenflowMessage	toImmutable() Returns an immutable instance of this message.
String	toString()
boolean	writable() Returns true if this mutable object is still writable.

Methods inherited from class com.hp.of.lib.msg.OfmPacketOut

getActions, getBufferId, getData, getDataLength, getInPort, toDebugString, toDebugString, validate

Methods inherited from class com.hp.of.lib.msg.OpenflowMessage

decodeHeader, getType, getVersion, getXid, hex, hex, length

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.hp.of.lib.msg.Message

getType, getXid

Methods inherited from interface com.hp.of.lib.Structure

getVersion, toDebugString

Method Detail

clearXid

public void clearXid()

Description copied from interface: MutableMessage

Clears the transaction ID field of this message (sets it to 0). This is provided for unit testing purposes, only.

Specified by:

clearXid in interface MutableMessage

toImmutable

public OpenflowMessage toImmutable()

Description copied from interface: MutableMessage

Returns an immutable instance of this message. In essence, converts this message to be read-only.

It is expected that the reference to this mutable message will be dropped. Note that all method calls invoked on a MutableMessage after toImmutable() has been invoked will result in an InvalidMutableException being thrown.

Specified by:

toImmutable in interface MutableMessage

Returns:

an immutable instance of this message.

writable

public boolean writable()

Description copied from interface: MutableObject

Returns true if this mutable object is still writable. That is, the #toImmutable() method (defined on a sub-interface) has not yet been invoked.

Specified by:

writable in interface MutableObject

Returns:

true if this mutable object is still writable

toString

public String toString()

Overrides:

toString in class OfmPacketOut

bufferId

public OfmMutablePacketOut bufferId(BufferId bufferId)

Sets the buffer id; Since 1.0.

Parameters:

bufferId - the buffer id

Returns:

self, for chaining

Throws:

InvalidMutableException - if this instance is no longer writable

NullPointerException - if bufferId is null

inPort

public OfmMutablePacketOut inPort(BigPortNumber inPort)

Sets the ingress port that must be associated with the packet; Since 1.0. This must be either a valid standard switch port (from 1 to MAX) or CONTROLLER. (For 1.0, NONE can also be used.)

Note that in 1.0, port numbers are u16.

Parameters:

inPort - the ingress port

Returns:

self, for chaining

Throws:

InvalidMutableException - if this instance is no longer writable

NullPointerException - if inPort is null

IllegalArgumentException - if the port number is invalid

See Also:

Port

inPort

@Deprecated
public OfmMutablePacketOut inPort(OfmPacketIn pktIn)

Deprecated.

Sets the ingress port that must be associated with the packet; Since 1.0. This must be either a valid standard switch port (from 1 to MAX) or CONTROLLER.

Note that in 1.0, port numbers are u16.

Parameters:

pktIn - the ingress port

Returns:

self, for chaining

Throws:

InvalidMutableException - if this instance is no longer writable

NullPointerException - if inPort is null

IllegalArgumentException - if the port number is invalid

See Also:

Port

addAction

public OfmMutablePacketOut addAction(Action act)

Adds an action to the action list; Since 1.0; Removed at 1.1.

Parameters:

act - the action to add

Returns:

self, for chaining

Throws:

InvalidMutableException - if this instance is no longer writable

VersionMismatchException - if action version does not match

NullPointerException - if act is null

clearActions

public OfmMutablePacketOut clearActions()

Clears any previously added actions.

Throws:

InvalidMutableException - if this instance is no longer writable

data

public OfmMutablePacketOut data(byte[] data)

Sets the packet frame data; Since 1.0.

Parameters:

data - the frame data

Returns:

self, for chaining

Throws:

InvalidMutableException - if this instance is no longer writable

NullPointerException - if data is null