io.rsocket.framing

Class CancelFrame

java.lang.Object

io.rsocket.framing.CancelFrame

All Implemented Interfaces:

Frame, Disposable

public final class CancelFrame
extends Object

An RSocket CANCEL frame.

See Also:

Cancel Frame

Nested Class Summary

Nested classes/interfaces inherited from interface reactor.core.Disposable

Disposable.Composite, Disposable.Swap

Field Summary

Fields inherited from interface io.rsocket.framing.Frame

FRAME_TYPE_SHIFT

Method Summary

Modifier and Type	Method and Description
static CancelFrame	createCancelFrame(ByteBuf byteBuf) Creates the CANCEL frame.
static CancelFrame	createCancelFrame(ByteBufAllocator byteBufAllocator) Creates the CANCEL frame.
void	dispose()
boolean	equals(Object o)
FrameType	getFrameType() Returns the FrameType.
ByteBuf	getUnsafeFrame() Returns the frame directly.
int	hashCode()
String	toString()

Methods inherited from class java.lang.Object

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

Methods inherited from interface io.rsocket.framing.Frame

consumeFrame, mapFrame

Methods inherited from interface reactor.core.Disposable

isDisposed

Method Detail

createCancelFrame

public static CancelFrame createCancelFrame(ByteBuf byteBuf)

Creates the CANCEL frame.

Parameters:

byteBuf - the ByteBuf representing the frame

Returns:

the CANCEL frame

Throws:

NullPointerException - if byteBuf is null

createCancelFrame

public static CancelFrame createCancelFrame(ByteBufAllocator byteBufAllocator)

Creates the CANCEL frame.

Parameters:

byteBufAllocator - the ByteBufAllocator to use

Returns:

the CANCEL frame

Throws:

NullPointerException - if byteBufAllocator is null

toString

public String toString()

Overrides:

toString in class Object

dispose

public final void dispose()

Specified by:

dispose in interface Disposable

equals

public boolean equals(Object o)

Overrides:

equals in class Object

getFrameType

public FrameType getFrameType()

Description copied from interface: Frame

Returns the FrameType.

Specified by:

getFrameType in interface Frame

Returns:

the FrameType

getUnsafeFrame

public final ByteBuf getUnsafeFrame()

Description copied from interface: Frame

Returns the frame directly.

Note: this frame will be outside of the Frame's lifecycle and may be released at any time. It is highly recommended that you ByteBuf.retain() the frame if you store it.

Specified by:

getUnsafeFrame in interface Frame

Returns:

the frame directly

See Also:

Frame.consumeFrame(Consumer), Frame.mapFrame(Function)

hashCode

public int hashCode()

Overrides:

hashCode in class Object