io.rsocket

Class Frame

java.lang.Object

io.netty.util.AbstractReferenceCounted

io.rsocket.Frame

All Implemented Interfaces:

ByteBufHolder, ReferenceCounted, Payload

public class Frame
extends AbstractReferenceCounted
implements Payload, ByteBufHolder

Represents a Frame sent over a DuplexConnection.

This provides encoding, decoding and field accessors.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Frame.Cancel
static class	Frame.Error
static class	Frame.Keepalive
static class	Frame.Lease
static class	Frame.PayloadFrame
static class	Frame.Request
static class	Frame.RequestN
static class	Frame.Setup

Method Summary

Modifier and Type	Method and Description
ByteBuf	content() Return the content which is held by this Frame.
Frame	copy() Creates a deep copy of this Frame.
protected void	deallocate() Called once AbstractReferenceCounted.refCnt() is equals 0.
Frame	duplicate() Duplicates this Frame.
static void	ensureFrameType(FrameType frameType, Frame frame)
boolean	equals(Object o)
int	flags() Return the flags field for the frame
static Frame	from(ByteBuf content) Acquire a free Frame backed by given ByteBuf
int	getStreamId() Return frame stream identifier
FrameType	getType() Return frame FrameType
int	hashCode()
boolean	hasMetadata() Returns whether the payload has metadata, useful for tell if metadata is empty or not present.
static boolean	isFlagSet(int flags, int checkedFlag)
Frame	replace(ByteBuf content) Returns a new Frame which contains the specified content.
Frame	retain() Increases the reference count by 1.
Frame	retain(int increment) Increases the reference count by the specified increment.
Frame	retainedDuplicate() Duplicates this Frame.
static int	setFlag(int current, int toSet)
ByteBuf	sliceData() Return ByteBuf that is a ByteBuf.slice() for the frame data
ByteBuf	sliceMetadata() Return ByteBuf that is a ByteBuf.slice() for the frame metadata
String	toString()
Frame	touch() Records the current access location of this object for debugging purposes.
Frame	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, finalize, getClass, notify, notifyAll, 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

content

public ByteBuf content()

Return the content which is held by this Frame.

Specified by:

content in interface ByteBufHolder

copy

public Frame copy()

Creates a deep copy of this Frame.

Specified by:

copy in interface ByteBufHolder

duplicate

public Frame duplicate()

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

Specified by:

duplicate in interface ByteBufHolder

retainedDuplicate

public Frame retainedDuplicate()

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

Specified by:

retainedDuplicate in interface ByteBufHolder

See Also:

ByteBuf.retainedDuplicate()

replace

public Frame replace(ByteBuf content)

Returns a new Frame which contains the specified content.

Specified by:

replace in interface ByteBufHolder

retain

public Frame retain()

Increases the reference count by 1.

Specified by:

retain in interface ByteBufHolder

Specified by:

retain in interface ReferenceCounted

Specified by:

retain in interface Payload

Overrides:

retain in class AbstractReferenceCounted

retain

public Frame retain(int increment)

Increases the reference count by the specified increment.

Specified by:

retain in interface ByteBufHolder

Specified by:

retain in interface ReferenceCounted

Specified by:

retain in interface Payload

Overrides:

retain in class AbstractReferenceCounted

touch

public Frame 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 ByteBufHolder

Specified by:

touch in interface ReferenceCounted

Specified by:

touch in interface Payload

Overrides:

touch in class AbstractReferenceCounted

touch

public Frame touch(@Nullable
                   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 ByteBufHolder

Specified by:

touch in interface ReferenceCounted

Specified by:

touch in interface Payload

deallocate

protected void deallocate()

Called once AbstractReferenceCounted.refCnt() is equals 0.

Specified by:

deallocate in class AbstractReferenceCounted

sliceMetadata

public ByteBuf sliceMetadata()

Return ByteBuf that is a ByteBuf.slice() for the frame metadata

If no metadata is present, the ByteBuf will have 0 capacity.

Specified by:

sliceMetadata in interface Payload

Returns:

ByteBuf containing the content

sliceData

public ByteBuf sliceData()

Return ByteBuf that is a ByteBuf.slice() for the frame data

If no data is present, the ByteBuf will have 0 capacity.

Specified by:

sliceData in interface Payload

Returns:

ByteBuf containing the data

getStreamId

public int getStreamId()

Return frame stream identifier

Returns:

frame stream identifier

getType

public FrameType getType()

Return frame FrameType

Returns:

frame type

flags

public int flags()

Return the flags field for the frame

Returns:

frame flags field value

from

public static Frame from(ByteBuf content)

Acquire a free Frame backed by given ByteBuf

Parameters:

content - to use as backing buffer

Returns:

frame

isFlagSet

public static boolean isFlagSet(int flags,
                                int checkedFlag)

setFlag

public static int setFlag(int current,
                          int toSet)

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

ensureFrameType

public static void ensureFrameType(FrameType frameType,
                                   Frame frame)

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object