antikythera v0.3.0 AntikytheraCore.Handler.WebsocketState View Source

Updates an existing instance of AntikytheraCore.Handler.WebsocketState with the given dict. The values in the dict are validated by each field's valid?/1 function. Returns {:ok, valid_struct} or {:error, reason}.

update!(s, dict)

A variant of update/2 which returns t or raise if validation fails. In other words, update/2 followed by Croma.Result.get!/1.

valid?(value)

Checks if the given value belongs to t/0 or not.

ws_module(websocket_state)

Type-aware getter for ws_module.

ws_module(s, field)

Type-aware setter for ws_module.

Link to this section Types

callback_result()

callback_result() ::
  {:ok, t()} | {:reply, Antikythera.Websocket.FrameList.t(), t()}

cowboy_ws_terminate_reason()

cowboy_ws_terminate_reason() ::
  :normal
  | :stop
  | :timeout
  | :remote
  | {:remote, :cow_ws.close_code(), binary()}
  | {:error, :badencoding | :badframe | :closed | atom()}
  | {:crash, :error | :exit | :throw, any()}

t()

t() :: %AntikytheraCore.Handler.WebsocketState{
  conn: Antikythera.Conn.t(),
  error_reason: Croma.TypeGen.Nilable.Antikythera.ErrorReason.t(),
  frames_received: Croma.NonNegInteger.t(),
  frames_sent: Croma.NonNegInteger.t(),
  gear_impl_state: Croma.Any.t(),
  helper_modules: AntikytheraCore.Handler.HelperModules.t(),
  ws_module: Croma.Atom.t()
}

Link to this section Functions

conn(websocket_state)

conn(t()) :: Antikythera.Conn.t()

Type-aware getter for conn.

conn(s, field)

conn(t(), Antikythera.Conn.t()) :: t()

Type-aware setter for conn.

error_reason(websocket_state)

error_reason(t()) :: Croma.TypeGen.Nilable.Antikythera.ErrorReason.t()

Type-aware getter for error_reason.

error_reason(s, field)

error_reason(t(), Croma.TypeGen.Nilable.Antikythera.ErrorReason.t()) ::
  t()

Type-aware setter for error_reason.

frames_received(websocket_state)

frames_received(t()) :: Croma.NonNegInteger.t()

Type-aware getter for frames_received.

frames_received(s, field)

frames_received(t(), Croma.NonNegInteger.t()) :: t()

Type-aware setter for frames_received.

frames_sent(websocket_state)

frames_sent(t()) :: Croma.NonNegInteger.t()

Type-aware getter for frames_sent.

frames_sent(s, field)

frames_sent(t(), Croma.NonNegInteger.t()) :: t()

Type-aware setter for frames_sent.

gear_impl_state(websocket_state)

gear_impl_state(t()) :: Croma.Any.t()

Type-aware getter for gear_impl_state.

gear_impl_state(s, field)

gear_impl_state(t(), Croma.Any.t()) :: t()

Type-aware setter for gear_impl_state.

handle_client_message(state, frame)

handle_client_message(
  AntikytheraCore.Handler.WebsocketState.t(),
  Antikythera.Websocket.Frame.t()
) :: callback_result()

handle_server_message(state, message)

handle_server_message(AntikytheraCore.Handler.WebsocketState.t(), any()) ::
  callback_result()

helper_modules(websocket_state)

helper_modules(t()) :: AntikytheraCore.Handler.HelperModules.t()

Type-aware getter for helper_modules.

helper_modules(s, field)

helper_modules(t(), AntikytheraCore.Handler.HelperModules.t()) :: t()

Type-aware setter for helper_modules.

init(state)

init(AntikytheraCore.Handler.WebsocketState.t()) :: callback_result()

make(conn, arg1, helper_modules)

make(
  Antikythera.Conn.t(),
  Antikythera.Context.GearEntryPoint.t(),
  AntikytheraCore.Handler.HelperModules.t()
) :: t()

new(dict)

new(term()) :: Croma.Result.t(t())

Creates a new instance of AntikytheraCore.Handler.WebsocketState by using the given dict.

Returns {:ok, valid_struct} or {:error, reason}.

The values in the dict are validated by each field's valid?/1 function. If the value was invalid, it will be passed to new/1 of the field

For missing fields, followings will be tried:

default/0 of each field type
new/1 of each field type, with empty map as input

new!(dict)

new!(term()) :: t()

A variant of new/1 which returns t or raise if validation fails.

In other words, new/1 followed by Croma.Result.get!/1.

terminate(state, cowboy_terminate_reason)

terminate(
  AntikytheraCore.Handler.WebsocketState.t(),
  cowboy_ws_terminate_reason()
) :: any()

update(s, dict)

update(t(), Dict.t()) :: Croma.Result.t(t())