org.projectfloodlight.openflow.protocol

Interface OFMessage

All Superinterfaces:

OFObject, PrimitiveSinkable, Writeable

All Known Subinterfaces:

OFAggregateStatsReply, OFAggregateStatsRequest, OFAsyncConfigFailedErrorMsg, OFAsyncGetReply, OFAsyncGetRequest, OFAsyncSet, OFBadActionErrorMsg, OFBadInstructionErrorMsg, OFBadMatchErrorMsg, OFBadPropertyErrorMsg, OFBadRequestErrorMsg, OFBarrierReply, OFBarrierRequest, OFBsnArpIdle, OFBsnBaseError, OFBsnBwClearDataReply, OFBsnBwClearDataRequest, OFBsnBwEnableGetReply, OFBsnBwEnableGetRequest, OFBsnBwEnableSetReply, OFBsnBwEnableSetRequest, OFBsnControllerConnectionsReply, OFBsnControllerConnectionsRequest, OFBsnDebugCounterDescStatsReply, OFBsnDebugCounterDescStatsRequest, OFBsnDebugCounterStatsReply, OFBsnDebugCounterStatsRequest, OFBsnError, OFBsnFlowChecksumBucketStatsReply, OFBsnFlowChecksumBucketStatsRequest, OFBsnFlowIdle, OFBsnFlowIdleEnableGetReply, OFBsnFlowIdleEnableGetRequest, OFBsnFlowIdleEnableSetReply, OFBsnFlowIdleEnableSetRequest, OFBsnGenericAsync, OFBsnGenericCommand, OFBsnGenericStatsReply, OFBsnGenericStatsRequest, OFBsnGentableBucketStatsReply, OFBsnGentableBucketStatsRequest, OFBsnGentableClearReply, OFBsnGentableClearRequest, OFBsnGentableDescStatsReply, OFBsnGentableDescStatsRequest, OFBsnGentableEntryAdd, OFBsnGentableEntryDelete, OFBsnGentableEntryDescStatsReply, OFBsnGentableEntryDescStatsRequest, OFBsnGentableEntryStatsReply, OFBsnGentableEntryStatsRequest, OFBsnGentableError, OFBsnGentableSetBucketsSize, OFBsnGentableStatsReply, OFBsnGentableStatsRequest, OFBsnGetInterfacesReply, OFBsnGetInterfacesRequest, OFBsnGetIpMaskReply, OFBsnGetIpMaskRequest, OFBsnGetL2TableReply, OFBsnGetL2TableRequest, OFBsnGetMirroringReply, OFBsnGetMirroringRequest, OFBsnGetSwitchPipelineReply, OFBsnGetSwitchPipelineRequest, OFBsnHeader, OFBsnHybridGetReply, OFBsnHybridGetRequest, OFBsnImageDescStatsReply, OFBsnImageDescStatsRequest, OFBsnLacpConvergenceNotif, OFBsnLacpStatsReply, OFBsnLacpStatsRequest, OFBsnLog, OFBsnLuaCommandReply, OFBsnLuaCommandRequest, OFBsnLuaNotification, OFBsnLuaUpload, OFBsnPduRxReply, OFBsnPduRxRequest, OFBsnPduRxTimeout, OFBsnPduTxReply, OFBsnPduTxRequest, OFBsnPortCounterStatsReply, OFBsnPortCounterStatsRequest, OFBsnRoleStatus, OFBsnSetAuxCxnsReply, OFBsnSetAuxCxnsRequest, OFBsnSetIpMask, OFBsnSetL2TableReply, OFBsnSetL2TableRequest, OFBsnSetLacpReply, OFBsnSetLacpRequest, OFBsnSetMirroring, OFBsnSetPktinSuppressionReply, OFBsnSetPktinSuppressionRequest, OFBsnSetSwitchPipelineReply, OFBsnSetSwitchPipelineRequest, OFBsnShellCommand, OFBsnShellOutput, OFBsnShellStatus, OFBsnStatsReply, OFBsnStatsRequest<T>, OFBsnSwitchPipelineStatsReply, OFBsnSwitchPipelineStatsRequest, OFBsnTableChecksumStatsReply, OFBsnTableChecksumStatsRequest, OFBsnTableSetBucketsSize, OFBsnTakeover, OFBsnTimeReply, OFBsnTimeRequest, OFBsnVirtualPortCreateReply, OFBsnVirtualPortCreateRequest, OFBsnVirtualPortRemoveReply, OFBsnVirtualPortRemoveRequest, OFBsnVlanCounterClear, OFBsnVlanCounterStatsReply, OFBsnVlanCounterStatsRequest, OFBsnVrfCounterStatsReply, OFBsnVrfCounterStatsRequest, OFBundleAddMsg, OFBundleCtrlMsg, OFBundleFailedErrorMsg, OFBundleFeaturesStatsReply, OFBundleFeaturesStatsRequest, OFControllerStatus, OFControllerStatusStatsReply, OFControllerStatusStatsRequest, OFDescStatsReply, OFDescStatsRequest, OFEchoReply, OFEchoRequest, OFErrorMsg, OFExperimenter, OFExperimenterErrorMsg, OFExperimenterStatsReply, OFExperimenterStatsRequest<T>, OFFeaturesReply, OFFeaturesRequest, OFFlowAdd, OFFlowDelete, OFFlowDeleteStrict, OFFlowLightweightStatsReply, OFFlowLightweightStatsRequest, OFFlowMod, OFFlowModFailedErrorMsg, OFFlowModify, OFFlowModifyStrict, OFFlowMonitorFailedErrorMsg, OFFlowMonitorReply, OFFlowMonitorRequest, OFFlowRemoved, OFFlowStatsReply, OFFlowStatsRequest, OFGetConfigReply, OFGetConfigRequest, OFGroupAdd, OFGroupDelete, OFGroupDescStatsReply, OFGroupDescStatsRequest, OFGroupFeaturesStatsReply, OFGroupFeaturesStatsRequest, OFGroupInsertBucket, OFGroupMod, OFGroupModFailedErrorMsg, OFGroupModify, OFGroupRemoveBucket, OFGroupStatsReply, OFGroupStatsRequest, OFHello, OFHelloFailedErrorMsg, OFMeterConfigStatsReply, OFMeterConfigStatsRequest, OFMeterFeaturesStatsReply, OFMeterFeaturesStatsRequest, OFMeterMod, OFMeterModFailedErrorMsg, OFMeterStatsReply, OFMeterStatsRequest, OFNiciraControllerRoleReply, OFNiciraControllerRoleRequest, OFNiciraHeader, OFPacketIn, OFPacketOut, OFPortDescStatsReply, OFPortDescStatsRequest, OFPortMod, OFPortModFailedErrorMsg, OFPortStatsReply, OFPortStatsRequest, OFPortStatus, OFQueueDescStatsReply, OFQueueDescStatsRequest, OFQueueGetConfigReply, OFQueueGetConfigRequest, OFQueueOpFailedErrorMsg, OFQueueStatsReply, OFQueueStatsRequest, OFRequest<REPLY>, OFRequestforward, OFRoleReply, OFRoleRequest, OFRoleRequestFailedErrorMsg, OFRoleStatus, OFSetConfig, OFStatsReply, OFStatsRequest<T>, OFSwitchConfigFailedErrorMsg, OFTableDescStatsReply, OFTableDescStatsRequest, OFTableFeaturesFailedErrorMsg, OFTableFeaturesStatsReply, OFTableFeaturesStatsRequest, OFTableMod, OFTableModFailedErrorMsg, OFTableStatsReply, OFTableStatsRequest, OFTableStatus

public interface OFMessage
extends OFObject

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	OFMessage.Builder

Method Summary

Methods

Modifier and Type	Method and Description
OFMessage.Builder	createBuilder()
boolean	equalsIgnoreXid(Object obj) Compares the two messages for equality, ignoring the XID field.
OFType	getType()
OFVersion	getVersion()
long	getXid()
int	hashCodeIgnoreXid() Computes the hashcode of the message, ignoring the XID field.
void	writeTo(io.netty.buffer.ByteBuf channelBuffer)

Methods inherited from interface org.projectfloodlight.openflow.types.PrimitiveSinkable

putTo

Method Detail

getVersion

OFVersion getVersion()

Specified by:

getVersion in interface OFObject

getType

OFType getType()

getXid

long getXid()

equalsIgnoreXid

boolean equalsIgnoreXid(Object obj)

Compares the two messages for equality, ignoring the XID field.

Parameters:

obj - the other message to compare

Returns:

true if the messages are equal, ignoring the XID; false otherwise

hashCodeIgnoreXid

int hashCodeIgnoreXid()

Computes the hashcode of the message, ignoring the XID field. This can be useful in hashing OFMessages where an OFMessage is "the same as" another OFMessage if all fields are equal except for possibly the XIDs, which may or may not be equal. The obvious problem is that existing hash data structure implementations will use OFMessage's hashCode() function instead. In order to use the functionality of hashCodeIgnoreXid(), one must wrap the OFMessage within a user-defined class, where this user-defined class is used as the key within a hash data structure, e.g. HashMap. The user-defined class' overrideen hashCode() function must explicitly invoke hashCodeIgnoreXid() when computing the hash of the OFMessage member instead of computing it using OFMessage's hashCode().

Returns:

the hashcode of the message, ignoring the XID

writeTo

void writeTo(io.netty.buffer.ByteBuf channelBuffer)

Specified by:

writeTo in interface Writeable

createBuilder

OFMessage.Builder createBuilder()