org.opendaylight.usc.protocol

Class UscError

java.lang.Object

org.opendaylight.usc.protocol.UscFrame

org.opendaylight.usc.protocol.UscError

public class UscError
extends UscFrame

An USC Error packet.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	UscError.ErrorCode The possible error codes that can be encountered in an USC session.

Constructor Summary

Constructors

Constructor and Description
UscError(int port, int sessionId, int errorCode) Constructs a new UscError

Method Summary

Modifier and Type	Method and Description
UscError.ErrorCode	getErrorCode() Returns the error code
io.netty.buffer.ByteBuf	getPayload() To be implemented by subclasses to return the payload as a ByteBuf.

Methods inherited from class org.opendaylight.usc.protocol.UscFrame

getFromByteBuf, getHeader, length

Methods inherited from class java.lang.Object

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

Constructor Detail

UscError

public UscError(int port,
                int sessionId,
                int errorCode)

Constructs a new UscError

Parameters:

port -

sessionId -

errorCode -

Method Detail

getPayload

public io.netty.buffer.ByteBuf getPayload()

Description copied from class: UscFrame

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

Specified by:

getPayload in class UscFrame

Returns:

payload as a buffer

getErrorCode

public UscError.ErrorCode getErrorCode()

Returns the error code

Returns:

the error code