io.r2dbc.mssql.message.token

Class RowToken

java.lang.Object

io.netty.util.AbstractReferenceCounted

io.r2dbc.mssql.message.token.RowToken

All Implemented Interfaces:

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

Direct Known Subclasses:

NbcRowToken

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

Row token message containing row bytes. Extends AbstractReferenceCounted to release associated ByteBufs once the row is de-allocated.

Note: PLP values are aggregated in a single ByteBuf and not yet streamed. This is to be fixed.

Author:

Mark Paluch

Field Summary

Fields

Modifier and Type	Field and Description
static byte	TYPE

Method Summary

Modifier and Type	Method and Description
static boolean	canDecode(io.netty.buffer.ByteBuf buffer, Column[] columns) Check whether the ByteBuf can be decoded into an entire RowToken.
protected void	deallocate()
static RowToken	decode(io.netty.buffer.ByteBuf buffer, Column[] columns) Decode a RowToken.
io.netty.buffer.ByteBuf	getColumnData(int index) Returns the data for the column at index.
String	getName()
byte	getType()
RowToken	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, toString, wait, wait, wait

Field Detail

TYPE

public static final byte TYPE

See Also:

Constant Field Values

Method Detail

decode

public static RowToken decode(io.netty.buffer.ByteBuf buffer,
                              Column[] columns)

Decode a RowToken.

Parameters:

buffer - the data buffer.

columns - column descriptors.

Returns:

the RowToken.

canDecode

public static boolean canDecode(io.netty.buffer.ByteBuf buffer,
                                Column[] columns)

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

Parameters:

buffer - the data buffer.

columns - column descriptors.

Returns:

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

getColumnData

@Nullable
public io.netty.buffer.ByteBuf getColumnData(int index)

Returns the data for the column at index.

Parameters:

index - the column index.

Returns:

the data buffer. Can be null if indicated by null-bit compression.

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 RowToken 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