io.rsocket.util

Class ByteBufPayload

java.lang.Object

io.netty.util.AbstractReferenceCounted

io.rsocket.util.ByteBufPayload

All Implemented Interfaces:

ReferenceCounted, Payload

public final class ByteBufPayload
extends AbstractReferenceCounted
implements Payload

Method Summary

Modifier and Type	Method and Description
static Payload	create(byte[] data)
static Payload	create(byte[] data, byte[] metadata)
static Payload	create(ByteBuf data)
static Payload	create(ByteBuf data, ByteBuf metadata)
static Payload	create(ByteBuffer data)
static Payload	create(ByteBuffer data, ByteBuffer metadata)
static Payload	create(CharSequence data, Charset dataCharset)
static Payload	create(CharSequence data, Charset dataCharset, CharSequence metadata, Charset metadataCharset)
static Payload	create(Payload payload)
static Payload	create(String data) Static factory method for a text payload.
static Payload	create(String data, String metadata) Static factory method for a text payload.
ByteBuf	data() Returns the Payloads' data without slicing if possible.
protected void	deallocate()
boolean	hasMetadata() Returns whether the payload has metadata, useful for tell if metadata is empty or not present.
ByteBuf	metadata() Returns the Payloads' metadata without slicing if possible.
ByteBufPayload	retain() Increases the reference count by 1.
ByteBufPayload	retain(int increment) Increases the reference count by the specified increment.
ByteBuf	sliceData() Returns the Payload data.
ByteBuf	sliceMetadata() Returns a slice Payload metadata.
ByteBufPayload	touch() Records the current access location of this object for debugging purposes.
ByteBufPayload	touch(Object hint) Records the current access location of this object with an additional arbitrary information for debugging purposes.

Methods inherited from class io.netty.util.AbstractReferenceCounted

refCnt, release, release, setRefCnt

Methods inherited from class java.lang.Object

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

Methods inherited from interface io.rsocket.Payload

getData, getDataUtf8, getMetadata, getMetadataUtf8

Methods inherited from interface io.netty.util.ReferenceCounted

refCnt, release, release

Method Detail

create

public static Payload create(String data)

Static factory method for a text payload. Mainly looks better than "new ByteBufPayload(data)"

Parameters:

data - the data of the payload.

Returns:

a payload.

create

public static Payload create(String data,
                             @Nullable
                             String metadata)

Static factory method for a text payload. Mainly looks better than "new ByteBufPayload(data, metadata)"

Parameters:

data - the data of the payload.

metadata - the metadata for the payload.

Returns:

a payload.

create

public static Payload create(CharSequence data,
                             Charset dataCharset)

create

public static Payload create(CharSequence data,
                             Charset dataCharset,
                             @Nullable
                             CharSequence metadata,
                             Charset metadataCharset)

create

public static Payload create(byte[] data)

create

public static Payload create(byte[] data,
                             @Nullable
                             byte[] metadata)

create

public static Payload create(ByteBuffer data)

create

public static Payload create(ByteBuffer data,
                             @Nullable
                             ByteBuffer metadata)

create

public static Payload create(ByteBuf data)

create

public static Payload create(ByteBuf data,
                             @Nullable
                             ByteBuf metadata)

create

public static Payload create(Payload payload)

hasMetadata

public boolean hasMetadata()

Description copied from interface: Payload

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

Specified by:

hasMetadata in interface Payload

Returns:

whether payload has non-null (possibly empty) metadata

sliceMetadata

public ByteBuf sliceMetadata()

Description copied from interface: Payload

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

Specified by:

sliceMetadata in interface Payload

Returns:

payload metadata.

data

public ByteBuf data()

Description copied from interface: Payload

Returns the Payloads' data without slicing if possible. This is not safe and editing this could effect the payload. It is recommended to call sliceData().

Specified by:

data in interface Payload

Returns:

data as a bytebuf or slice of the data

metadata

public ByteBuf metadata()

Description copied from interface: Payload

Returns the Payloads' metadata without slicing if possible. This is not safe and editing this could effect the payload. It is recommended to call sliceMetadata().

Specified by:

metadata in interface Payload

Returns:

metadata as a bytebuf or slice of the metadata

sliceData

public ByteBuf sliceData()

Description copied from interface: Payload

Returns the Payload data. Always non-null.

Specified by:

sliceData in interface Payload

Returns:

payload data.

retain

public ByteBufPayload retain()

Description copied from interface: Payload

Increases the reference count by 1.

Specified by:

retain in interface ReferenceCounted

Specified by:

retain in interface Payload

Overrides:

retain in class AbstractReferenceCounted

retain

public ByteBufPayload retain(int increment)

Description copied from interface: Payload

Increases the reference count by the specified increment.

Specified by:

retain in interface ReferenceCounted

Specified by:

retain in interface Payload

Overrides:

retain in class AbstractReferenceCounted

touch

public ByteBufPayload touch()

Description copied from interface: Payload

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

Specified by:

touch in interface Payload

Overrides:

touch in class AbstractReferenceCounted

touch

public ByteBufPayload touch(Object hint)

Description copied from interface: Payload

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

Specified by:

touch in interface Payload

deallocate

protected void deallocate()

Specified by:

deallocate in class AbstractReferenceCounted