io.r2dbc.mssql.message.header

Interface HeaderOptions

All Known Implementing Classes:

Header

public interface HeaderOptions

Base header options defining Type and Status. Typically used to provide a TDS packet context so lower-level components can form a Header packet from this options and TDS payload.

Method Summary

Modifier and Type	Method and Description
default HeaderOptions	and(Status.StatusBit bit) Create a HeaderOptions object with Status.StatusBit set.
static HeaderOptions	create(Type type, Status status) Create HeaderOptions given Type and Status.
Status	getStatus() Status is a bit field used to indicate the message state.
Type	getType() Defines the type of message.
boolean	is(Status.StatusBit bit) Check if the header status has set the Status.StatusBit.
default HeaderOptions	not(Status.StatusBit bit) Create a HeaderOptions object with Status.StatusBit removed.

Method Detail

and

default HeaderOptions and(Status.StatusBit bit)

Create a HeaderOptions object with Status.StatusBit set.

Parameters:

bit - status bit to set.

Returns:

the HeaderOptions.

not

default HeaderOptions not(Status.StatusBit bit)

Create a HeaderOptions object with Status.StatusBit removed.

Parameters:

bit - status bit to remove.

Returns:

the HeaderOptions.

getType

Type getType()

Defines the type of message. 1-byte.

Returns:

the message type.

getStatus

Status getStatus()

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

Returns:

the Status.StatusBit.

is

boolean is(Status.StatusBit bit)

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

Parameters:

bit - the status bit.

Returns:

true of the bit is set; false otherwise.

create

static HeaderOptions create(Type type,
                            Status status)

Create HeaderOptions given Type and Status.

Parameters:

type - the header Type.

status - the Status.

Returns:

the HeaderOptions.