com.hp.of.lib.msg

Class OfmMultipartRequest

java.lang.Object

com.hp.nbio.AbstractMessage

com.hp.of.lib.msg.OpenflowMessage

com.hp.of.lib.msg.OfmMultipartRequest

All Implemented Interfaces:

Message, Structure

Direct Known Subclasses:

OfmMutableMultipartRequest

public class OfmMultipartRequest
extends OpenflowMessage

Represents an OpenFlow MULTIPART_REQUEST message; Since 1.3 (but see note).

Important Note: Although MULTIPART_REQUEST messages were only added to the protocol at 1.3, they are semantically equivalent to the (now deprecated) STATS_REQUEST messages in 1.0, 1.1 and 1.2.

For example, to create a "switch description request" message (Stats-Request/DESC) to send to a switch running OpenFlow 1.0, one would do the following:

 OfmMutableMultipartRequest req = (OfmMutableMultipartRequest)
     MessageFactory.create(ProtocolVersion.V_1_0, MULTIPART_REQUEST);
 req.type(MultipartType.DESC);
 OpenflowMessage msgToSend = req.toImmutable();
 

When the message is encoded, the MessageFactory will use the version of the message to decide whether to encode it as a MULTIPART_REQUEST or a STATS_REQUEST.

Author:

Simon Hunt

See Also:

OfmMultipartReply

Field Summary

Fields inherited from class com.hp.nbio.AbstractMessage

length

Method Summary

Methods

Modifier and Type	Method and Description
MultipartBody	getBody() Returns the body of the message; Since 1.3.
Set<MultipartRequestFlag>	getFlags() Returns the set of multipart message request flags; Since 1.3.
MultipartType	getMultipartType() Returns the multipart message type; Since 1.3.
boolean	hasMore() Returns true if the MultipartRequestFlag.REQUEST_MORE flag is present.
String	toDebugString() Returns a string representation useful for debugging.
String	toString()
void	validate() Validates this message for completeness and throws an exception if the message is considered "not complete".

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

Method Detail

toString

public String toString()

Overrides:

toString in class OpenflowMessage

toDebugString

public String toDebugString()

Description copied from class: OpenflowMessage

Returns a string representation useful for debugging. This default implementation delegates to OpenflowMessage.toString(), but subclasses are free to override this behavior.

Specified by:

toDebugString in interface Structure

Overrides:

toDebugString in class OpenflowMessage

Returns:

a (possibly multi-line) string representation of this message

validate

public void validate()
              throws IncompleteMessageException

Description copied from class: OpenflowMessage

Validates this message for completeness and throws an exception if the message is considered "not complete".

This default implementation does nothing, i.e. default behavior is that messages are considered complete.

Subclasses should override this method to check that mandatory fields or other internal state is present, throwing an exception if it is not.

Overrides:

validate in class OpenflowMessage

Throws:

IncompleteMessageException - if the message is not complete

getMultipartType

public MultipartType getMultipartType()

Returns the multipart message type; Since 1.3.

Returns:

the multipart message type.

getFlags

public Set<MultipartRequestFlag> getFlags()

Returns the set of multipart message request flags; Since 1.3.

Returns:

the set of flags

hasMore

public boolean hasMore()

Returns true if the MultipartRequestFlag.REQUEST_MORE flag is present.

The presence of this flag indicates to the receiver that more (related) multipart-requests are on their way; Only the last request in such a sequence will have this flag false (cleared).

Returns:

true

getBody

public MultipartBody getBody()

Returns the body of the message; Since 1.3.

Returns:

the body of the message