org.opendaylight.usc.protocol

Class UscHeader

java.lang.Object

org.opendaylight.usc.protocol.UscHeader

public class UscHeader
extends Object

The USC packet header.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	UscHeader.OperationType Types of USC packets.

Field Summary

Fields

Modifier and Type	Field and Description
static int	HEADER_LENGTH Length of the header by bytes.
static int	PAYLOAD_LENGTH_OFFSET Offset to the payload length field in bytes.
static int	PAYLOAD_LENGTH_SIZE The length of the payload length field in bytes.
static int	USC_VERSION USC protocol version number.

Constructor Summary

Constructors

Constructor and Description
UscHeader(int uscVersion, UscHeader.OperationType operationType, int applicationPort, int sessionId, int payloadLength) Initializes the USC header.

Method Summary

Modifier and Type	Method and Description
static UscHeader	fromByteBuffer(ByteBuffer buf) Constructs an USC header from a byte stream
int	getApplicationPort() Returns the port number of the service on the device
static int	getBitsAsInteger(byte value, int offset, int size) Returns a range of bits in a byte value as an integer
static UscHeader	getFromBytes(byte[] bytes) Constructs an USC header from a byte stream
UscHeader.OperationType	getOperationType() Returns the USC packet type
int	getPayloadLength() Returns the the payload length in bytes
int	getSessionId() Returns the session ID
int	getUscVersion() Returns the USC version
static boolean	isBitSet(byte value, int offset) Checks whether a bit is set in a byte value
int	length() Returns the length of the USC header in bytes
static byte	setBit(byte value, int offset, boolean target) Set or unset a specific bit in a byte value
static byte	setBitsAsInteger(byte value, int offset, int size, int target) Set or unset a range of bits in a byte value
ByteBuffer	toByteBuffer() Constructs a byte stream representation of this USC header

Methods inherited from class java.lang.Object

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

Field Detail

HEADER_LENGTH

public static final int HEADER_LENGTH

Length of the header by bytes.

See Also:

Constant Field Values

PAYLOAD_LENGTH_OFFSET

public static final int PAYLOAD_LENGTH_OFFSET

Offset to the payload length field in bytes.

See Also:

Constant Field Values

PAYLOAD_LENGTH_SIZE

public static final int PAYLOAD_LENGTH_SIZE

The length of the payload length field in bytes.

See Also:

Constant Field Values

USC_VERSION

public static final int USC_VERSION

USC protocol version number.

See Also:

Constant Field Values

Constructor Detail

UscHeader

public UscHeader(int uscVersion,
                 UscHeader.OperationType operationType,
                 int applicationPort,
                 int sessionId,
                 int payloadLength)

Initializes the USC header.

Parameters:

uscVersion - USC version number

operationType - USC packet type

applicationPort - the port number of the service on the device

sessionId - the session ID

payloadLength - the length of the payload in bytes

Method Detail

setBit

public static byte setBit(byte value,
                          int offset,
                          boolean target)

Set or unset a specific bit in a byte value

Parameters:

value -

offset -

target -

Returns:

the resulting byte value

setBitsAsInteger

public static byte setBitsAsInteger(byte value,
                                    int offset,
                                    int size,
                                    int target)

Set or unset a range of bits in a byte value

Parameters:

value -

offset -

size -

target -

Returns:

the resulting byte value

isBitSet

public static boolean isBitSet(byte value,
                               int offset)

Checks whether a bit is set in a byte value

Parameters:

value -

offset -

Returns:

getBitsAsInteger

public static int getBitsAsInteger(byte value,
                                   int offset,
                                   int size)

Returns a range of bits in a byte value as an integer

Parameters:

value -

offset -

size -

Returns:

the value of the bits

fromByteBuffer

public static UscHeader fromByteBuffer(ByteBuffer buf)

Constructs an USC header from a byte stream

Parameters:

buf -

Returns:

the USC header

getFromBytes

public static UscHeader getFromBytes(byte[] bytes)

Constructs an USC header from a byte stream

Parameters:

bytes - buffer

Returns:

the USC header

getUscVersion

public int getUscVersion()

Returns the USC version

Returns:

the USC version

getOperationType

public UscHeader.OperationType getOperationType()

Returns the USC packet type

Returns:

the USC packet type

getApplicationPort

public int getApplicationPort()

Returns the port number of the service on the device

Returns:

the port number of the service on the device

getSessionId

public int getSessionId()

Returns the session ID

Returns:

the session ID

getPayloadLength

public int getPayloadLength()

Returns the the payload length in bytes

Returns:

the payload length in bytes

length

public int length()

Returns the length of the USC header in bytes

Returns:

the length of the USC header in bytes

toByteBuffer

public ByteBuffer toByteBuffer()

Constructs a byte stream representation of this USC header

Returns:

the resulting byte stream