org.openflow.protocol

Class OFStatisticsMessageBase

java.lang.Object

org.openflow.protocol.OFMessage

org.openflow.protocol.OFStatisticsMessageBase

All Implemented Interfaces:

OFStatisticsFactoryAware

Direct Known Subclasses:

OFStatisticsReply, OFStatisticsRequest

public abstract class OFStatisticsMessageBase
extends OFMessage
implements OFStatisticsFactoryAware

Base class for statistics requests/replies

Author:

David Erickson (daviderickson@cs.stanford.edu) - Mar 27, 2010

Field Summary

Fields

Modifier and Type	Field and Description
protected short	flags
static int	MINIMUM_LENGTH
protected List<? extends OFStatistics>	statistics
protected OFStatisticsFactory	statisticsFactory
protected OFStatisticsType	statisticType

Fields inherited from class org.openflow.protocol.OFMessage

length, OFP_VERSION, type, version, xid

Constructor Summary

Constructors

Constructor and Description
OFStatisticsMessageBase()

Method Summary

Methods

Modifier and Type	Method and Description
boolean	equals(Object obj)
OFStatistics	getFirstStatistics() return the first statistics request in the list of statistics, for statistics messages that expect exactly one message in their body (e.g., flow stats request, port statsrequest)
short	getFlags()
List<? extends OFStatistics>	getStatistics()
OFStatisticsType	getStatisticType()
int	hashCode()
void	readFrom(org.jboss.netty.buffer.ChannelBuffer data) Read this message off the wire from the specified ByteBuffer
void	setFlags(short flags)
void	setStatistics(List<? extends OFStatistics> statistics)
void	setStatisticsFactory(OFStatisticsFactory statisticsFactory) Sets the OFStatisticsFactory
void	setStatisticType(OFStatisticsType statisticType)
void	writeTo(org.jboss.netty.buffer.ChannelBuffer data) Write this message's binary format to the specified ByteBuffer

Methods inherited from class org.openflow.protocol.OFMessage

getData, getDataAsString, getLength, getLengthU, getMessageStore, getType, getVersion, getXid, setLength, setLengthU, setType, setVersion, setXid, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

MINIMUM_LENGTH

public static int MINIMUM_LENGTH

statisticsFactory

protected OFStatisticsFactory statisticsFactory

statisticType

protected OFStatisticsType statisticType

flags

protected short flags

statistics

protected List<? extends OFStatistics> statistics

Constructor Detail

OFStatisticsMessageBase

public OFStatisticsMessageBase()

Method Detail

getStatisticType

public OFStatisticsType getStatisticType()

Returns:

the statisticType

setStatisticType

public void setStatisticType(OFStatisticsType statisticType)

Parameters:

statisticType - the statisticType to set

getFlags

public short getFlags()

Returns:

the flags

setFlags

public void setFlags(short flags)

Parameters:

flags - the flags to set

getStatistics

public List<? extends OFStatistics> getStatistics()

Returns:

the statistics

getFirstStatistics

public OFStatistics getFirstStatistics()

return the first statistics request in the list of statistics, for statistics messages that expect exactly one message in their body (e.g., flow stats request, port statsrequest)

Returns:

the first and only element in the list of statistics

setStatistics

public void setStatistics(List<? extends OFStatistics> statistics)

Parameters:

statistics - the statistics to set

setStatisticsFactory

public void setStatisticsFactory(OFStatisticsFactory statisticsFactory)

Description copied from interface: OFStatisticsFactoryAware

Sets the OFStatisticsFactory

Specified by:

setStatisticsFactory in interface OFStatisticsFactoryAware

readFrom

public void readFrom(org.jboss.netty.buffer.ChannelBuffer data)

Description copied from class: OFMessage

Read this message off the wire from the specified ByteBuffer

Overrides:

readFrom in class OFMessage

writeTo

public void writeTo(org.jboss.netty.buffer.ChannelBuffer data)

Description copied from class: OFMessage

Write this message's binary format to the specified ByteBuffer

Overrides:

writeTo in class OFMessage

hashCode

public int hashCode()

Overrides:

hashCode in class OFMessage

equals

public boolean equals(Object obj)

Overrides:

equals in class OFMessage