48 lines
1.6 KiB
Markdown
48 lines
1.6 KiB
Markdown
|
Connection
|
||
|
|
==========
|
||
|
|
|
||
|
|
`Connection` behaviour for connection processes. The API is superset of the
|
||
|
|
GenServer API. There are 2 additional callbacks `connect/2` and `disconnect/2`:
|
||
|
|
|
||
|
|
```elixir
|
||
|
|
@callback init(any) ::
|
||
|
|
{:ok, any} | {:ok, any, timeout | :hibernate} |
|
||
|
|
{:connect, any, any} |
|
||
|
|
{:backoff, timeout, any} | {:backoff, timeout, any, timeout | :hibernate} |
|
||
|
|
:ignore | {:stop, any}
|
||
|
|
|
||
|
|
@callback connect(any, any) ::
|
||
|
|
{:ok, any} | {:ok, any, timeout | :hibernate} |
|
||
|
|
{:backoff, timeout, any} | {:backoff, timeout, any, timeout | :hibernate} |
|
||
|
|
{:stop, any, any}
|
||
|
|
|
||
|
|
@callback disconnect(any, any) ::
|
||
|
|
{:connect, any, any} |
|
||
|
|
{:backoff, timeout, any} | {:backoff, timeout, any, timeout | :hibernate} |
|
||
|
|
{:noconnect, any} | {:noconnect, any, timeout | :hibernate}
|
||
|
|
{:stop, any, any}
|
||
|
|
|
||
|
|
@callback handle_call(any, {pid, any}, any) ::
|
||
|
|
{:reply, any, any} | {:reply, any, any, timeout | :hibernate} |
|
||
|
|
{:noreply, any} | {:noreply, any, timeout | :hibernate} |
|
||
|
|
{:disconnect | :connect, any, any} |
|
||
|
|
{:disconnect | :connect, any, any, any} |
|
||
|
|
{:stop, any, any} | {:stop, any, any, any}
|
||
|
|
|
||
|
|
@callback handle_cast(any, any) ::
|
||
|
|
{:noreply, any} | {:noreply, any, timeout | :hibernate} |
|
||
|
|
{:disconnect | :connect, any, any} |
|
||
|
|
{:stop, any, any}
|
||
|
|
|
||
|
|
@callback handle_info(any, any) ::
|
||
|
|
{:noreply, any} | {:noreply, any, timeout | :hibernate} |
|
||
|
|
{:disconnect | :connect, any, any} |
|
||
|
|
{:stop, any, any}
|
||
|
|
|
||
|
|
@callback code_change(any, any, any) :: {:ok, any}
|
||
|
|
|
||
|
|
@callback terminate(any, any) :: any
|
||
|
|
```
|
||
|
|
There is an example of a simple TCP connection process in
|
||
|
|
`examples/tcp_connection/`.
|