io.r2dbc.mssql.message.header

Class Header

java.lang.Object

io.r2dbc.mssql.message.header.Header

All Implemented Interfaces:

HeaderOptions

public class Header
extends Object
implements HeaderOptions

A header exchanged between client and server.

Field Summary

Fields

Modifier and Type	Field and Description
static int	LENGTH Number of bytes required to represent the header.

Constructor Summary

Constructors

Constructor and Description
Header(Type type, Status status, int length, int spid)
Header(Type type, Status status, int length, int spid, int packetId, int window)
Header(Type type, Status status, short length, short spid, byte packetId, byte window)

Method Summary

Modifier and Type	Method and Description
static boolean	canDecode(io.netty.buffer.ByteBuf buffer)
static Header	create(HeaderOptions options, int length, PacketIdProvider packetIdProvider) Create a Header given HeaderOptions, packet length, and PacketIdProvider.
static Header	decode(io.netty.buffer.ByteBuf buffer)
void	encode(io.netty.buffer.ByteBuf buffer) Encode a header into a ByteBuf.
static void	encode(io.netty.buffer.ByteBuf buffer, HeaderOptions options, int length, PacketIdProvider packetIdProvider) Encode a header into a ByteBuf.
void	encode(io.netty.buffer.ByteBuf buffer, PacketIdProvider packetIdProvider) Encode a header into a ByteBuf.
static void	encode(io.netty.buffer.ByteBuf buffer, Type type, Status status, int length, short spid, byte packetId, byte window) Encode the Header.
boolean	equals(Object o)
short	getLength()
byte	getPacketId()
short	getSpid()
Status	getStatus() Status is a bit field used to indicate the message state.
Type	getType() Defines the type of message.
byte	getWindow()
int	hashCode()
boolean	is(Status.StatusBit bit) Check if the header status has set the Status.StatusBit.
String	toString()

Methods inherited from class java.lang.Object

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

Methods inherited from interface io.r2dbc.mssql.message.header.HeaderOptions

and, create, not

Field Detail

LENGTH

public static final int LENGTH

Number of bytes required to represent the header.

See Also:

Constant Field Values

Constructor Detail

Header

public Header(Type type,
              Status status,
              int length,
              int spid)

Header

public Header(Type type,
              Status status,
              int length,
              int spid,
              int packetId,
              int window)

Header

public Header(Type type,
              Status status,
              short length,
              short spid,
              byte packetId,
              byte window)

Method Detail

create

public static Header create(HeaderOptions options,
                            int length,
                            PacketIdProvider packetIdProvider)

Create a Header given HeaderOptions, packet length, and PacketIdProvider.

Parameters:

options - the HeaderOptions.

length - packet length.

packetIdProvider - the PacketIdProvider.

Returns:

the Header.

Throws:

IllegalArgumentException - when HeaderOptions or PacketIdProvider is null.

getType

public Type getType()

Description copied from interface: HeaderOptions

Defines the type of message. 1-byte.

Specified by:

getType in interface HeaderOptions

Returns:

the message type.

getStatus

public Status getStatus()

Description copied from interface: HeaderOptions

Status is a bit field used to indicate the message state. 1-byte.

Specified by:

getStatus in interface HeaderOptions

Returns:

the Status.StatusBit.

is

public boolean is(Status.StatusBit bit)

Description copied from interface: HeaderOptions

Check if the header status has set the Status.StatusBit.

Specified by:

is in interface HeaderOptions

Parameters:

bit - the status bit.

Returns:

true of the bit is set; false otherwise.

getSpid

public short getSpid()

getPacketId

public byte getPacketId()

getWindow

public byte getWindow()

getLength

public short getLength()

encode

public void encode(io.netty.buffer.ByteBuf buffer)

Encode a header into a ByteBuf.

Parameters:

buffer - the target ByteBuf.

encode

public void encode(io.netty.buffer.ByteBuf buffer,
                   PacketIdProvider packetIdProvider)

Encode a header into a ByteBuf.

Parameters:

buffer - the target ByteBuf.

packetIdProvider - must not be null.

Throws:

IllegalArgumentException - when HeaderOptions or PacketIdProvider is null.

encode

public static void encode(io.netty.buffer.ByteBuf buffer,
                          HeaderOptions options,
                          int length,
                          PacketIdProvider packetIdProvider)

Encode a header into a ByteBuf.

Parameters:

buffer - the target ByteBuf.

options - header options.

length - packet length.

packetIdProvider - must not be null.

Throws:

IllegalArgumentException - when HeaderOptions or PacketIdProvider is null.

encode

public static void encode(io.netty.buffer.ByteBuf buffer,
                          Type type,
                          Status status,
                          int length,
                          short spid,
                          byte packetId,
                          byte window)

Encode the Header.

Parameters:

buffer - the target ByteBuf.

type - packet type.

status - fragmentation/message status.

length - packet length.

spid - the spid (unused).

packetId - the packet Id.

window - the window (unused).

canDecode

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

Parameters:

buffer - the data buffer to inspect.

Returns:

true if the header can be decoded.

decode

public static Header decode(io.netty.buffer.ByteBuf buffer)

Parameters:

buffer - the data buffer.

Returns:

the decoded Header.

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