Ircxd.Server.Adapter behaviour (ircxd v1.1.0)

Application-owned server integration contract.

Adapters may authenticate accounts, consume committed domain events, answer application state queries, and observe outbound IRC messages. All callbacks are serialized by the server's adapter worker except authentication, which runs in a bounded task.

Summary

Types

action()

A protocol action that needs an authorization decision.

context()

Server and actor data for one callback.

operation()

An application-owned state operation.

query()

A query supported by the built-in ETS adapter.

state()

Application state for one server adapter.

Callbacks

authenticate(t, t, map, state)

Verifies SASL credentials and returns an application account.

authentication_enabled?(state)

Returns true when the initialized adapter can authenticate accounts.

authorize(action, context, state)

Allows or rejects a protocol action before the server changes state.

handle_command(t, context, state)

Handles an IRC command that the protocol engine does not recognize.

handle_event(t, context, state)

Consumes one committed server event and returns the next adapter state.

handle_operation(operation, context, state)

Handles an application operation from Ircxd.Server.execute/2.

handle_publish(t, map, state)

Observes one outbound IRC message, including numerics.

handle_query(query, context, state)

Handles an application query from Ircxd.Server.query/2.

init(term)

Initializes the adapter state from the configured argument.

Types

action()

@type action() :: term()

A protocol action that needs an authorization decision.

context()

@type context() :: map()

Server and actor data for one callback.

operation()

@type operation() :: term()

An application-owned state operation.

query()

@type query() ::
  :users
  | :channels
  | {:channel, String.t()}
  | {:channels_for, String.t()}
  | {:channel_roles, String.t(), String.t()}
  | {:messages, String.t(), keyword()}

A query supported by the built-in ETS adapter.

state()

@type state() :: term()

Application state for one server adapter.

Callbacks

authenticate(t, t, map, state)

(optional)

@callback authenticate(String.t(), String.t(), map(), state()) ::
  {:ok, term(), state()} | {:error, term(), state()}

Verifies SASL credentials and returns an application account.

authentication_enabled?(state)

(optional)

@callback authentication_enabled?(state()) :: boolean()

Returns true when the initialized adapter can authenticate accounts.

authorize(action, context, state)

(optional)

@callback authorize(action(), context(), state()) ::
  {:ok, state()} | {:error, term(), state()}

Allows or rejects a protocol action before the server changes state.

handle_command(t, context, state)

(optional)

@callback handle_command(Ircxd.Message.t(), context(), state()) ::
  {:unhandled, state()}
  | {:reply, [Ircxd.Message.t()], state()}
  | {:error, term(), state()}

Handles an IRC command that the protocol engine does not recognize.

handle_event(t, context, state)

(optional)

@callback handle_event(Ircxd.Server.Event.t(), context(), state()) :: {:ok, state()}

Consumes one committed server event and returns the next adapter state.

handle_operation(operation, context, state)

(optional)

@callback handle_operation(operation(), context(), state()) ::
  {:ok, term(), state()} | {:error, term(), state()}

Handles an application operation from Ircxd.Server.execute/2.

handle_publish(t, map, state)

(optional)

@callback handle_publish(Ircxd.Message.t(), map(), state()) :: {:ok, state()}

Observes one outbound IRC message, including numerics.

handle_query(query, context, state)

(optional)

@callback handle_query(query(), context(), state()) ::
  {:ok, term(), state()} | {:error, term(), state()}

Handles an application query from Ircxd.Server.query/2.

init(term)

@callback init(term()) :: {:ok, state()} | {:error, term()}

Initializes the adapter state from the configured argument.