Tds.Protocol.Prelogin (Tds v2.3.6)

Prelogin message definition

See: https://docs.microsoft.com/en-us/openspecs/windows_protocols/ms-tds/60f56408-0188-4cd5-8b90-25c6f2423868

Summary

Types

packet_data()

response()

state()

t()

Functions

decode(packet_data, s)

encode(opts)

Types

packet_data()

@type packet_data() :: iodata()

response()

@type response() :: {:ok, state()} | {:error, Exception.t() | atom(), state()}

state()

@type state() :: Tds.Protocol.t()

t()

@type t() :: %Tds.Protocol.Prelogin{
  encryption: <<_::8>>,
  fed_auth_required: term(),
  instance: boolean(),
  mars: boolean(),
  nonce_opt: term(),
  thread_id: term(),
  trace_id: term(),
  version: tuple()
}

Functions

decode(packet_data, s)

@spec decode(iodata(), state()) ::
  {:encrypt, state()}
  | {:login, state()}
  | {:disconnect, Tds.Error.t(), state()}

encode(opts)

@spec encode(maybe_improper_list()) :: [binary(), ...]