antikythera v0.4.0 AntikytheraCore.Handler.WebsocketState View Source
Link to this section Summary
Functions
Type-aware getter for conn.
Type-aware setter for conn.
Type-aware getter for error_reason.
Type-aware setter for error_reason.
Type-aware getter for frames_received.
Type-aware setter for frames_received.
Type-aware getter for frames_sent.
Type-aware setter for frames_sent.
Type-aware getter for gear_impl_state.
Type-aware setter for gear_impl_state.
Type-aware getter for helper_modules.
Type-aware setter for helper_modules.
Creates a new instance of AntikytheraCore.Handler.WebsocketState by using the given dict
.
A variant of new/1
which returns t
or raise if validation fails.
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}
.
A variant of update/2
which returns t
or raise if validation fails.
In other words, update/2
followed by Croma.Result.get!/1
.
Checks if the given value belongs to t/0
or not.
Type-aware getter for ws_module.
Type-aware setter for ws_module.
Link to this section Types
Specs
callback_result() :: {:ok, t()} | {:reply, Antikythera.Websocket.FrameList.t(), t()}
Specs
Specs
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
Specs
conn(t()) :: Antikythera.Conn.t()
Type-aware getter for conn.
Specs
conn(t(), Antikythera.Conn.t()) :: t()
Type-aware setter for conn.
Specs
error_reason(t()) :: Croma.TypeGen.Nilable.Antikythera.ErrorReason.t()
Type-aware getter for error_reason.
Specs
Type-aware setter for error_reason.
Specs
frames_received(t()) :: Croma.NonNegInteger.t()
Type-aware getter for frames_received.
Specs
frames_received(t(), Croma.NonNegInteger.t()) :: t()
Type-aware setter for frames_received.
Specs
frames_sent(t()) :: Croma.NonNegInteger.t()
Type-aware getter for frames_sent.
Specs
frames_sent(t(), Croma.NonNegInteger.t()) :: t()
Type-aware setter for frames_sent.
Specs
gear_impl_state(t()) :: Croma.Any.t()
Type-aware getter for gear_impl_state.
Specs
gear_impl_state(t(), Croma.Any.t()) :: t()
Type-aware setter for gear_impl_state.
Specs
handle_client_message( AntikytheraCore.Handler.WebsocketState.t(), Antikythera.Websocket.Frame.t() ) :: callback_result()
Specs
handle_server_message(AntikytheraCore.Handler.WebsocketState.t(), any()) :: callback_result()
Specs
helper_modules(t()) :: AntikytheraCore.Handler.HelperModules.t()
Type-aware getter for helper_modules.
Specs
helper_modules(t(), AntikytheraCore.Handler.HelperModules.t()) :: t()
Type-aware setter for helper_modules.
Specs
init(AntikytheraCore.Handler.WebsocketState.t()) :: callback_result()
Specs
make( Antikythera.Conn.t(), Antikythera.Context.GearEntryPoint.t(), AntikytheraCore.Handler.HelperModules.t() ) :: t()
Specs
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 typenew/1
of each field type, with empty map as input
Specs
A variant of new/1
which returns t
or raise if validation fails.
In other words, new/1
followed by Croma.Result.get!/1
.
Specs
terminate( AntikytheraCore.Handler.WebsocketState.t(), cowboy_ws_terminate_reason() ) :: any()
Specs
update(t(), Dict.t()) :: Croma.Result.t(t())
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}
.
Specs
A variant of update/2
which returns t
or raise if validation fails.
In other words, update/2
followed by Croma.Result.get!/1
.
Specs
Checks if the given value belongs to t/0
or not.
Specs
ws_module(t()) :: Croma.Atom.t()
Type-aware getter for ws_module.
Specs
ws_module(t(), Croma.Atom.t()) :: t()
Type-aware setter for ws_module.