SafeRPC.Transport behaviour (safe_rpc v0.1.0)

Copy Markdown View Source

Transport behaviour for SafeRPC framed binaries.

Summary

Callbacks

accept(term, timeout)
close(term)
connect(keyword)
listen(keyword)
recv(term, timeout)
send(term, binary, timeout)

Callbacks

accept(term, timeout)

@callback accept(term(), timeout()) :: {:ok, term()} | {:error, term()}

close(term)

@callback close(term()) :: :ok

connect(keyword)

@callback connect(keyword()) :: {:ok, term()} | {:error, term()}

listen(keyword)

@callback listen(keyword()) :: {:ok, term()} | {:error, term()}

recv(term, timeout)

@callback recv(term(), timeout()) :: {:ok, binary()} | {:error, term()}

send(term, binary, timeout)

@callback send(term(), binary(), timeout()) :: :ok | {:error, term()}