org.opendaylight.usc.protocol

Class UscFrame

java.lang.Object

org.opendaylight.usc.protocol.UscFrame

Direct Known Subclasses:

UscControl, UscData, UscError

public abstract class UscFrame
extends Object

Base class of a UscFrame packet.

Constructor Summary

Constructors

Constructor and Description
UscFrame(UscHeader.OperationType operationType, int port, int sessionId, int payloadLength) Constructs a new UscFrame

Method Summary

Modifier and Type	Method and Description
static UscFrame	getFromByteBuf(io.netty.buffer.ByteBuf buf) Decodes a ByteBuf into a UscFrame
UscHeader	getHeader() Returns the USC header
abstract io.netty.buffer.ByteBuf	getPayload() To be implemented by subclasses to return the payload as a ByteBuf.
int	length() Length of the frame in bytes, inclusive of both the header and the.

Methods inherited from class java.lang.Object

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

Constructor Detail

UscFrame

public UscFrame(UscHeader.OperationType operationType,
                int port,
                int sessionId,
                int payloadLength)

Constructs a new UscFrame

Parameters:

operationType -

port -

sessionId -

payloadLength -

Method Detail

getHeader

public UscHeader getHeader()

Returns the USC header

Returns:

the USC header

length

public int length()

Length of the frame in bytes, inclusive of both the header and the. payload

Returns:

Length of the frame in bytes.

getPayload

public abstract io.netty.buffer.ByteBuf getPayload()

To be implemented by subclasses to return the payload as a ByteBuf.

Returns:

payload as a buffer

getFromByteBuf

public static UscFrame getFromByteBuf(io.netty.buffer.ByteBuf buf)
                               throws IOException

Decodes a ByteBuf into a UscFrame

Parameters:

buf -

Returns:

Throws:

IOException