quicer_lib (quicer v0.4.3)

View Source

Summary

Types

action/0
cb_ret/0
cb_ret_noreply/0
cb_ret_reply/0
cb_ret_stop_noreply/0
cb_ret_stop_reply/0
cb_state/0
conf_handle/0
connection_handle/0
global_handle/0
handle/0
listener_handle/0
lost_suspect_callback/0
probe_res/0
reg_handle/0
stream_handle/0

Functions

default_cb_ret(_, State)
handle_dgram_send_states(Conn)
handle_dgram_send_states(Conn, CB, Timeout)
probe(Conn, Timeout)

Types

action/0

-type action() :: hibernate | timeout() | {continue, Continue :: term()}.

cb_ret/0

-type cb_ret() :: cb_ret_noreply() | cb_ret_reply().

cb_ret_noreply/0

-type cb_ret_noreply() ::
          {ok, cb_state()} |
          {error, Reason :: term(), cb_state()} |
          {action(), cb_state()} |
          cb_ret_stop_noreply().

cb_ret_reply/0

-type cb_ret_reply() ::
          {reply, Reply :: term(), cb_state()} |
          {reply, Reply :: term(), cb_state(), action()} |
          cb_ret_stop_reply().

cb_ret_stop_noreply/0

-type cb_ret_stop_noreply() :: {stop, Reason :: term(), cb_state()}.

cb_ret_stop_reply/0

-type cb_ret_stop_reply() :: {stop, Reason :: term(), Reply :: term(), cb_state()}.

cb_state/0

-type cb_state() :: term().

conf_handle/0

-type conf_handle() :: reference().

connection_handle/0

-type connection_handle() :: reference().

global_handle/0

-type global_handle() :: quic_global.

handle/0

-type handle() ::
          global_handle() |
          listener_handle() |
          connection_handle() |
          stream_handle() |
          conf_handle() |
          reg_handle().

listener_handle/0

-type listener_handle() :: reference().

lost_suspect_callback/0

-type lost_suspect_callback() ::
          {fun((connection_handle(), term(), term()) -> term()), term()} | {atom(), term()}.

probe_res/0

-type probe_res() ::
          #probe_state{final :: term() | undefined,
                       sent_at :: integer() | undefined,
                       suspect_lost_at :: integer() | undefined,
                       final_at :: integer() | undefined} |
          {error, dgram_send_error, atom()} |
          {error, atom()}.

reg_handle/0

-type reg_handle() :: reference().

stream_handle/0

-type stream_handle() :: reference().

Functions

default_cb_ret(_, State)

-spec default_cb_ret(cb_ret(), State :: term()) ->
                        {reply, NewState :: term()} |
                        {reply, NewState :: term(), action()} |
                        {noreply, NewState :: term()} |
                        {noreply, NewState :: term(), action()} |
                        {stop, Reason :: term(), Reply :: term(), NewState :: term()} |
                        {stop, Reason :: term(), NewState :: term()}.

handle_dgram_send_states(Conn)

-spec handle_dgram_send_states(connection_handle()) ->
                                  ok |
                                  {error,
                                   dgram_send_canceled | dgram_send_unknown | dgram_send_lost_discarded}.

handle_dgram_send_states(Conn, CB, Timeout)

-spec handle_dgram_send_states(connection_handle(), lost_suspect_callback(), timeout()) -> any().

probe(Conn, Timeout)

-spec probe(connection_handle(), timeout()) -> probe_res().