@callback authenticate?(map()) :: boolean()

Use the fedecks information supplied at login authenticate the user.

Only called if there is no fedecks-token supplied, so is likely to be an initial registration, a re-registration (perhaps to associate the device with a new user), or a re-registration due to an expired token which can occur if a device has not connected for a few days.

Will be a map with string keys. The key "fedecks-device-id" will present which you can use to associate the device with a user (should you wish).

@callback connection_established(device_id :: String.t()) :: any()

Called when a new connection is established, with the Fedecks box device_id.

@callback handle_in(device_id :: String.t(), message :: term()) ::
  :ok | {:reply, message :: term()} | {:stop, term()}

Optional. Handles incoming message, which has been encoded by the Fedecks client as an Erlang binary term that is safe to decode. Binary messages which are not safe Erlang terms can be handled by handle_raw_in/2. Text messages are ignored.

• For no reply, return ':ok'
• To reply, return {:reply, "some message"}. The message will be conded as an Erlang binary term. As the Fedecks client will used safe decoding avoid atoms (or structs) that are not present on the client. It is safer to stick to maps, rather than structs, and strings rather than atoms (eg for map keys).
• To terminate the connection, return {:stop, reason}

@callback handle_info(device_id :: String.t(), message :: term()) ::
  :ok | {:push, message :: term()} | {:stop, reason :: term()}

Called when the connection process has received a message (to its process mailbox). Internal Fedecks messages, ie :refresh_token have been filtered out. The info message and a map of user data is sent. Return

• :ok for now action
• {:push, message} to send a message down the socket, as an erlang binary term
• {:stop, reason} to

@callback handle_raw_in(device_id :: String.t(), message :: binary()) ::
  :ok | {:reply, message :: term()} | {:stop, term()}

Optional. Handles incoming messages raw binary messages.

• For no reply, return :ok
• To reply, return {:reply, message}. The message will be sent to the client as a binary.
• To terminate the connection, return {:stop, reason}

@callback otp_app() :: atom()

The name of the OTP app used to get the configuration details.

@callback socket_error(device_id :: String.t(), error_type(), info :: term()) :: any()

Optionally called when an error occurs, such as receiving an invalid message, authentication failure, or other