io.rsocket.framing

Class ErrorFrame

java.lang.Object

io.rsocket.framing.ErrorFrame

All Implemented Interfaces:

DataFrame, Frame, Disposable

public final class ErrorFrame
extends Object

An RSocket ERROR frame.

See Also:

Error 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 ErrorFrame	createErrorFrame(ByteBuf byteBuf) Creates the ERROR frame.
static ErrorFrame	createErrorFrame(ByteBufAllocator byteBufAllocator, int errorCode, ByteBuf data) Creates the ERROR frame.
static ErrorFrame	createErrorFrame(ByteBufAllocator byteBufAllocator, int errorCode, String data) Creates the ERROR frame.
void	dispose()
boolean	equals(Object o)
int	getErrorCode() Returns the error code.
FrameType	getFrameType() Returns the FrameType.
ByteBuf	getUnsafeData() Returns the data directly.
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.DataFrame

getDataAsUtf8, getDataLength, mapData

Methods inherited from interface io.rsocket.framing.Frame

consumeFrame, getFrameType, getUnsafeFrame, mapFrame

Methods inherited from interface reactor.core.Disposable

dispose, isDisposed

Method Detail

createErrorFrame

public static ErrorFrame createErrorFrame(ByteBuf byteBuf)

Creates the ERROR frame.

Parameters:

byteBuf - the ByteBuf representing the frame

Returns:

the ERROR frame.

Throws:

NullPointerException - if byteBuf is null

createErrorFrame

public static ErrorFrame createErrorFrame(ByteBufAllocator byteBufAllocator,
                                          int errorCode,
                                          @Nullable
                                          String data)

Creates the ERROR frame.

Parameters:

byteBufAllocator - the ByteBufAllocator to use

errorCode - the error code

data - the error data

Returns:

the ERROR frame

Throws:

NullPointerException - if byteBufAllocator is null

createErrorFrame

public static ErrorFrame createErrorFrame(ByteBufAllocator byteBufAllocator,
                                          int errorCode,
                                          @Nullable
                                          ByteBuf data)

Creates the ERROR frame.

Parameters:

byteBufAllocator - the ByteBufAllocator to use

errorCode - the error code

data - the error data

Returns:

the ERROR frame

Throws:

NullPointerException - if byteBufAllocator is null

getErrorCode

public int getErrorCode()

Returns the error code.

Returns:

the error code

getUnsafeData

public ByteBuf getUnsafeData()

Description copied from interface: DataFrame

Returns the data directly.

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

Returns:

the data directly

See Also:

DataFrame.getDataAsUtf8(), DataFrame.mapData(Function)

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