TigerBeetlex.Types (tigerbeetlex v0.16.50)

View Source

Common typespecs.

This module provides common types that can be used in any part of the TigerBeetlex library.

Summary

Types

client()

@type client() :: reference()

event_type()

@type event_type() ::
  :single_phase
  | :two_phase_pending
  | :two_phase_posted
  | :two_phase_voided
  | :two_phase_expired

id_128()

@type id_128() :: <<_::128>>

init_client_error()

@type init_client_error() ::
  :unexpected
  | :out_of_memory
  | :invalid_address
  | :address_limit_exceeded
  | :system_resources
  | :network_subsystem

partition_supervisor_start_option()

@type partition_supervisor_start_option() :: {atom(), any()}

request_error()

@type request_error() :: :client_closed | :out_of_memory

start_option()

start_options()

@type start_options() :: [start_option()]

tigerbeetlex_connection_start_option()

@type tigerbeetlex_connection_start_option() ::
  {:cluster_id, non_neg_integer()} | {:addresses, [String.t()]}