org.mobicents.protocols.api

Class PayloadData

java.lang.Object

org.mobicents.protocols.api.PayloadData

public class PayloadData
extends Object

The actual pay load data received or to be sent from/to underlying socket

Author:

amit bhayani

Constructor Summary

Constructors

Constructor and Description
PayloadData(int dataLength, byte[] data, boolean complete, boolean unordered, int payloadProtocolId, int streamNumber)
PayloadData(int dataLength, io.netty.buffer.ByteBuf byteBuf, boolean complete, boolean unordered, int payloadProtocolId, int streamNumber)

Method Summary

Methods

Modifier and Type	Method and Description
io.netty.buffer.ByteBuf	getByteBuf()
byte[]	getData()
int	getDataLength()
int	getPayloadProtocolId()
int	getStreamNumber() This is SCTP Stream sequence identifier.
boolean	isComplete()
boolean	isUnordered()
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

PayloadData

public PayloadData(int dataLength,
           io.netty.buffer.ByteBuf byteBuf,
           boolean complete,
           boolean unordered,
           int payloadProtocolId,
           int streamNumber)

Parameters:

dataLength - Length of byte[] data

byteBuf - the payload data

complete - if this data represents complete protocol data

unordered - set to true if we don't care for oder

payloadProtocolId - protocol ID of the data carried

streamNumber - the SCTP stream number

PayloadData

public PayloadData(int dataLength,
           byte[] data,
           boolean complete,
           boolean unordered,
           int payloadProtocolId,
           int streamNumber)

Parameters:

dataLength - Length of byte[] data

data - the payload data

complete - if this data represents complete protocol data

unordered - set to true if we don't care for oder

payloadProtocolId - protocol ID of the data carried

streamNumber - the SCTP stream number

Method Detail

getDataLength

public int getDataLength()

Returns:

the dataLength

getByteBuf

public io.netty.buffer.ByteBuf getByteBuf()

Returns:

the byteBuf

getData

public byte[] getData()

Returns:

the data

isComplete

public boolean isComplete()

Returns:

the complete

isUnordered

public boolean isUnordered()

Returns:

the unordered

getPayloadProtocolId

public int getPayloadProtocolId()

Returns:

the payloadProtocolId

getStreamNumber

public int getStreamNumber()

This is SCTP Stream sequence identifier.

While sending PayloadData to SCTP Association, this value should be set by SCTP user. If value greater than or equal to maxOutboundStreams or lesser than 0 is used, packet will be dropped and error message will be logged

While PayloadData is received from underlying SCTP socket, this value indicates stream identifier on which data was received. Its guaranteed that this value will be greater than 0 and less than maxInboundStreams

Returns:

the streamNumber

toString

public String toString()

Overrides:

toString in class Object