Package io.netty.channel.sctp

Class SctpMessage

java.lang.Object

io.netty.buffer.DefaultByteBufHolder

io.netty.channel.sctp.SctpMessage

All Implemented Interfaces:

ByteBufHolder, ReferenceCounted

public final class SctpMessage
extends DefaultByteBufHolder

Representation of SCTP Data Chunk

Constructor Summary

Constructors

Constructor	Description
SctpMessage(int protocolIdentifier, int streamIdentifier, boolean unordered, ByteBuf payloadBuffer)	Essential data that is being carried within SCTP Data Chunk
SctpMessage(int protocolIdentifier, int streamIdentifier, ByteBuf payloadBuffer)	Essential data that is being carried within SCTP Data Chunk
SctpMessage(com.sun.nio.sctp.MessageInfo msgInfo, ByteBuf payloadBuffer)	Essential data that is being carried within SCTP Data Chunk

Method Summary

Modifier and Type	Method	Description
SctpMessage	copy()	Creates a deep copy of this ByteBufHolder.
SctpMessage	duplicate()	Duplicates this ByteBufHolder.
boolean	equals(java.lang.Object o)	This implementation of the equals operation is restricted to work only with instances of the same class.
int	hashCode()
boolean	isComplete()	Return true if this message is complete.
boolean	isUnordered()	return the unordered flag
com.sun.nio.sctp.MessageInfo	messageInfo()	Return the MessageInfo for inbound messages or null for outbound messages.
int	protocolIdentifier()	Return the protocol-identifier
SctpMessage	replace(ByteBuf content)	Returns a new ByteBufHolder which contains the specified content.
SctpMessage	retain()	Increases the reference count by 1.
SctpMessage	retain(int increment)	Increases the reference count by the specified increment.
SctpMessage	retainedDuplicate()	Duplicates this ByteBufHolder.
int	streamIdentifier()	Return the stream-identifier
java.lang.String	toString()
SctpMessage	touch()	Records the current access location of this object for debugging purposes.
SctpMessage	touch(java.lang.Object hint)	Records the current access location of this object with an additional arbitrary information for debugging purposes.

Methods inherited from class io.netty.buffer.DefaultByteBufHolder

content, contentToString, refCnt, release, release

Methods inherited from class java.lang.Object

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

Constructor Detail

SctpMessage

public SctpMessage(int protocolIdentifier,
                   int streamIdentifier,
                   ByteBuf payloadBuffer)

Essential data that is being carried within SCTP Data Chunk

Parameters:

protocolIdentifier - of payload

streamIdentifier - that you want to send the payload

payloadBuffer - channel buffer

SctpMessage

public SctpMessage(int protocolIdentifier,
                   int streamIdentifier,
                   boolean unordered,
                   ByteBuf payloadBuffer)

Essential data that is being carried within SCTP Data Chunk

Parameters:

protocolIdentifier - of payload

streamIdentifier - that you want to send the payload

unordered - if true, the SCTP Data Chunk will be sent with the U (unordered) flag set.

payloadBuffer - channel buffer

SctpMessage

public SctpMessage(com.sun.nio.sctp.MessageInfo msgInfo,
                   ByteBuf payloadBuffer)

Essential data that is being carried within SCTP Data Chunk

Parameters:

msgInfo - the MessageInfo

payloadBuffer - channel buffer

Method Detail

streamIdentifier

public int streamIdentifier()

Return the stream-identifier

protocolIdentifier

public int protocolIdentifier()

Return the protocol-identifier

isUnordered

public boolean isUnordered()

return the unordered flag

messageInfo

public com.sun.nio.sctp.MessageInfo messageInfo()

Return the MessageInfo for inbound messages or null for outbound messages.

isComplete

public boolean isComplete()

Return true if this message is complete.

equals

public boolean equals(java.lang.Object o)

Description copied from class: DefaultByteBufHolder

This implementation of the equals operation is restricted to work only with instances of the same class. The reason for that is that Netty library already has a number of classes that extend DefaultByteBufHolder and override equals method with an additional comparison logic and we need the symmetric property of the equals operation to be preserved.

Overrides:

equals in class DefaultByteBufHolder

Parameters:

o - the reference object with which to compare.

Returns:

true if this object is the same as the obj argument; false otherwise.

hashCode

public int hashCode()

Overrides:

hashCode in class DefaultByteBufHolder

copy

public SctpMessage copy()

Description copied from class: DefaultByteBufHolder

Creates a deep copy of this ByteBufHolder.

This method calls replace(content().copy()) by default.

Specified by:

copy in interface ByteBufHolder

Overrides:

copy in class DefaultByteBufHolder

duplicate

public SctpMessage duplicate()

Description copied from class: DefaultByteBufHolder

Duplicates this ByteBufHolder. Be aware that this will not automatically call ByteBufHolder.retain().

This method calls replace(content().duplicate()) by default.

Specified by:

duplicate in interface ByteBufHolder

Overrides:

duplicate in class DefaultByteBufHolder

retainedDuplicate

public SctpMessage retainedDuplicate()

Description copied from class: DefaultByteBufHolder

Duplicates this ByteBufHolder. This method returns a retained duplicate unlike ByteBufHolder.duplicate().

This method calls replace(content().retainedDuplicate()) by default.

Specified by:

retainedDuplicate in interface ByteBufHolder

Overrides:

retainedDuplicate in class DefaultByteBufHolder

See Also:

ByteBuf.retainedDuplicate()

replace

public SctpMessage replace(ByteBuf content)

Description copied from class: DefaultByteBufHolder

Returns a new ByteBufHolder which contains the specified content.

Override this method to return a new instance of this object whose content is set to the specified content. The default implementation of DefaultByteBufHolder.copy(), DefaultByteBufHolder.duplicate() and DefaultByteBufHolder.retainedDuplicate() invokes this method to create a copy.

Specified by:

replace in interface ByteBufHolder

Overrides:

replace in class DefaultByteBufHolder

retain

public SctpMessage retain()

Description copied from interface: ReferenceCounted

Increases the reference count by 1.

Specified by:

retain in interface ByteBufHolder

Specified by:

retain in interface ReferenceCounted

Overrides:

retain in class DefaultByteBufHolder

retain

public SctpMessage retain(int increment)

Description copied from interface: ReferenceCounted

Increases the reference count by the specified increment.

Specified by:

retain in interface ByteBufHolder

Specified by:

retain in interface ReferenceCounted

Overrides:

retain in class DefaultByteBufHolder

touch

public SctpMessage touch()

Description copied from interface: ReferenceCounted

Records the current access location of this object for debugging purposes. If this object is determined to be leaked, the information recorded by this operation will be provided to you via ResourceLeakDetector. This method is a shortcut to touch(null).

Specified by:

touch in interface ByteBufHolder

Specified by:

touch in interface ReferenceCounted

Overrides:

touch in class DefaultByteBufHolder

touch

public SctpMessage touch(java.lang.Object hint)

Description copied from interface: ReferenceCounted

Records the current access location of this object with an additional arbitrary information for debugging purposes. If this object is determined to be leaked, the information recorded by this operation will be provided to you via ResourceLeakDetector.

Specified by:

touch in interface ByteBufHolder

Specified by:

touch in interface ReferenceCounted

Overrides:

touch in class DefaultByteBufHolder

toString

public java.lang.String toString()

Overrides:

toString in class DefaultByteBufHolder