Tds v2.1.1 Tds.Protocol.Header View Source

Link to this section Summary

Types

(Client to SQL server only) Reset the connection before processing event but do not modify the transaction state (the state will remain the same before and after the reset).

msg_sned_status()

Header flag that should tell if pakcage data that header preceding is end of TDS message or not.

pkg_header_status()

Tuple that holds decoded package header status flags.

pkg_header_type()

(Client to SQL server only) Reset this connection before processing event. Only set for event types Batch, RPC, or Transaction Manager request

t()

Decoded TDS package header

Functions

Link to this section Types

conn_reset()

conn_reset() :: :no_reset | :conn_reset | :conn_reset_skip_tran

(Client to SQL server only) Reset the connection before processing event but do not modify the transaction state (the state will remain the same before and after the reset).

msg_sned_status()

msg_sned_status() :: :normal | :eom

Header flag that should tell if pakcage data that header preceding is end of TDS message or not.

:eom - End of message (EOM). The packet is the last packet in the whole request/response.
normal - Normal message, means that there is more packages comming after the one that header is preceding.

pkg_header_status()

pkg_header_status() :: {msg_sned_status(), pkg_process(), conn_reset()}

Tuple that holds decoded package header status flags.

pkg_header_type()

pkg_header_type() ::
  :sql_batch
  | :login
  | :rpc
  | :result
  | :attention
  | :bulk_data
  | :federation_token
  | :tm_request
  | :login7
  | :sspi
  | :pre_login

pkg_process()

pkg_process() :: :process | :ignore

(Client to SQL server only) Reset this connection before processing event. Only set for event types Batch, RPC, or Transaction Manager request

t()

t() :: %Tds.Protocol.Header{
  has_data?: any(),
  length: any(),
  package: any(),
  spid: any(),
  status: pkg_header_status(),
  type: pkg_header_type(),
  window: any()
}

Decoded TDS package header

Link to this section Functions

decode(arg)

decode(<<_::64>>) :: t() | {:error, any()}