io.r2dbc.mssql.message.token

Class ReturnValue

java.lang.Object

io.netty.util.AbstractReferenceCounted

io.r2dbc.mssql.message.token.ReturnValue

All Implemented Interfaces:

io.netty.util.ReferenceCounted, io.r2dbc.mssql.message.Message, DataToken

public class ReturnValue
extends io.netty.util.AbstractReferenceCounted
implements DataToken

A returned value from a RPC call.

Author:

Mark Paluch

See Also:

RpcDirection.OUT

Field Summary

Fields

Modifier and Type	Field and Description
static byte	TYPE

Constructor Summary

Constructors

Constructor and Description
ReturnValue(int ordinal, String parameterName, byte status, TypeInformation type, io.netty.buffer.ByteBuf value) Creates a new ReturnValue.
ReturnValue(int ordinal, String parameterName, int status, TypeInformation type, io.netty.buffer.ByteBuf value) Creates a new ReturnValue.

Method Summary

Modifier and Type	Method and Description
io.r2dbc.mssql.codec.Decodable	asDecodable() Create a Decodable from this ReturnValue to allow decoding.
static boolean	canDecode(io.netty.buffer.ByteBuf buffer, boolean encryptionSupported) Check whether the ByteBuf can be decoded into an entire ReturnValue.
protected void	deallocate()
static ReturnValue	decode(io.netty.buffer.ByteBuf buffer, boolean encryptionSupported) Decode a RowToken.
String	getName()
int	getOrdinal()
String	getParameterName()
byte	getStatus()
byte	getType()
io.netty.buffer.ByteBuf	getValue()
TypeInformation	getValueType()
static boolean	matches(io.r2dbc.mssql.message.Message message, int ordinal) Check whether the Message is a ReturnValue that matches the parameter ordinal.
static boolean	matches(io.r2dbc.mssql.message.Message message, String name) Check whether the Message is a ReturnValue that matches the parameter name.
String	toString()
io.netty.util.ReferenceCounted	touch(Object hint)

Methods inherited from class io.netty.util.AbstractReferenceCounted

refCnt, release, release, retain, retain, setRefCnt, touch

Methods inherited from class java.lang.Object

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

Field Detail

TYPE

public static final byte TYPE

See Also:

Constant Field Values

Constructor Detail

ReturnValue

public ReturnValue(int ordinal,
                   @Nullable
                   String parameterName,
                   int status,
                   TypeInformation type,
                   io.netty.buffer.ByteBuf value)

Creates a new ReturnValue.

Parameters:

ordinal - the ordinal position of the output parameter in the original RPC call.

parameterName - the parameter name.

status - indicator whether the value is a OUT value or a UDF.

type - type descriptor of this value.

value - the actual value.

ReturnValue

public ReturnValue(int ordinal,
                   @Nullable
                   String parameterName,
                   byte status,
                   TypeInformation type,
                   io.netty.buffer.ByteBuf value)

Creates a new ReturnValue.

Parameters:

ordinal - the ordinal position of the output parameter in the original RPC call.

parameterName - the parameter name.

status - indicator whether the value is a OUT value or a UDF.

type - type descriptor of this value.

value - the actual value.

Method Detail

decode

public static ReturnValue decode(io.netty.buffer.ByteBuf buffer,
                                 boolean encryptionSupported)

Decode a RowToken.

Parameters:

buffer - the data buffer.

encryptionSupported - whether encryption is supported.

Returns:

the ReturnValue.

canDecode

public static boolean canDecode(io.netty.buffer.ByteBuf buffer,
                                boolean encryptionSupported)

Check whether the ByteBuf can be decoded into an entire ReturnValue.

Parameters:

buffer - the data buffer.

encryptionSupported - whether encryption is supported.

Returns:

true if the buffer contains sufficient data to entirely decode a ReturnValue.

matches

public static boolean matches(io.r2dbc.mssql.message.Message message,
                              String name)

Check whether the Message is a ReturnValue that matches the parameter name.

Parameters:

message - the message.

name - the parameter name.

Returns:

true if the Message is a ReturnValue that matches the parameter name.

matches

public static boolean matches(io.r2dbc.mssql.message.Message message,
                              int ordinal)

Check whether the Message is a ReturnValue that matches the parameter ordinal.

Parameters:

message - the message.

ordinal - the parameter ordinal.

Returns:

true if the Message is a ReturnValue that matches the parameter ordinal.

getOrdinal

public int getOrdinal()

getParameterName

@Nullable
public String getParameterName()

getValueType

public TypeInformation getValueType()

getStatus

public byte getStatus()

getValue

public io.netty.buffer.ByteBuf getValue()

asDecodable

public io.r2dbc.mssql.codec.Decodable asDecodable()

Create a Decodable from this ReturnValue to allow decoding.

Returns:

the Decodable.

See Also:

Codecs.decode(ByteBuf, Decodable, Class)

getType

public byte getType()

Specified by:

getType in interface DataToken

Returns:

the token type.

getName

public String getName()

Specified by:

getName in interface DataToken

Returns:

symbolic name of the DataToken.

touch

public io.netty.util.ReferenceCounted touch(Object hint)

Specified by:

touch in interface io.netty.util.ReferenceCounted

deallocate

protected void deallocate()

Specified by:

deallocate in class io.netty.util.AbstractReferenceCounted

toString

public String toString()

Overrides:

toString in class Object