io.rsocket

Interface Payload

All Superinterfaces:

ReferenceCounted

All Known Implementing Classes:

ByteBufPayload, ConnectionSetupPayload, DefaultPayload, EmptyPayload, Frame

public interface Payload
extends ReferenceCounted

Payload of a Frame.

Method Summary

Modifier and Type	Method and Description
default ByteBuffer	getData()
default String	getDataUtf8()
default ByteBuffer	getMetadata()
default String	getMetadataUtf8()
boolean	hasMetadata() Returns whether the payload has metadata, useful for tell if metadata is empty or not present.
Payload	retain() Increases the reference count by 1.
Payload	retain(int increment) Increases the reference count by the specified increment.
ByteBuf	sliceData() Returns the Payload data.
ByteBuf	sliceMetadata() Returns the Payload metadata.
Payload	touch() Records the current access location of this object for debugging purposes.
Payload	touch(Object hint) Records the current access location of this object with an additional arbitrary information for debugging purposes.

Methods inherited from interface io.netty.util.ReferenceCounted

refCnt, release, release

Method Detail

hasMetadata

boolean hasMetadata()

Returns whether the payload has metadata, useful for tell if metadata is empty or not present.

Returns:

whether payload has non-null (possibly empty) metadata

sliceMetadata

ByteBuf sliceMetadata()

Returns the Payload metadata. Always non-null, check hasMetadata() to differentiate null from "".

Returns:

payload metadata.

sliceData

ByteBuf sliceData()

Returns the Payload data. Always non-null.

Returns:

payload data.

retain

Payload retain()

Increases the reference count by 1.

Specified by:

retain in interface ReferenceCounted

retain

Payload retain(int increment)

Increases the reference count by the specified increment.

Specified by:

retain in interface ReferenceCounted

touch

Payload touch()

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 ReferenceCounted

touch

Payload touch(Object hint)

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 ReferenceCounted

getMetadata

default ByteBuffer getMetadata()

getData

default ByteBuffer getData()

getMetadataUtf8

default String getMetadataUtf8()

getDataUtf8

default String getDataUtf8()