quicer_listener (quicer v0.4.3)
View SourceSummary
Functions
count accepted but not yet closed connections
get the listener configuration
Reload the listener with new *listener* opts.
Reload the listener with new *listener* opts and new listen_on.
Starts the server
Types
-type alpn() :: string().
-type conf_handle() :: reference().
-type conn_opts() :: #{alpn := [string()], conn_callback => module(), custom_verify => boolean(), handle => connection_handle(), nst => binary(), handshake_idle_timeout_ms => non_neg_integer(), quic_event_mask => uint32(), disable_1rtt_encryption => boolean(), local_address => string(), local_bidi_stream_count => uint16(), local_peer_unidi_stream_count => uint16(), cert => file:filename(), certfile => file:filename(), key => file:filename(), keyfile => file:filename(), password => string(), verify => none | peer | verify_peer | verify_none, cacertfile => file:filename(), sslkeylogfile => file:filename(), max_bytes_per_key => uint64(), handshake_idle_timeout_ms => uint64(), idle_timeout_ms => uint64(), tls_client_max_send_buffer => uint32(), tls_server_max_send_buffer => uint32(), stream_recv_window_default => uint32(), stream_recv_buffer_default => uint32(), conn_flow_control_window => uint32(), max_stateless_operations => uint32(), initial_window_packets => uint32(), send_idle_timeout_ms => uint32(), initial_rtt_ms => uint32(), max_ack_delay_ms => uint32(), disconnect_timeout_ms => uint32(), keep_alive_interval_ms => uint32(), congestion_control_algorithm => uint16(), peer_bidi_stream_count => uint16(), peer_unidi_stream_count => uint16(), retry_memory_limit => uint16(), load_balancing_mode => uint16(), max_operations_per_drain => uint8(), send_buffering_enabled => uint8(), pacing_enabled => uint8(), migration_enabled => uint8(), datagram_receive_enabled => uint8(), server_resumption_level => uint8(), minimum_mtu => uint16(), maximum_mtu => uint16(), mtu_discovery_search_complete_timeout_us => uint64(), mtu_discovery_missing_probe_count => uint8(), max_binding_stateless_operations => uint16(), stateless_operation_expiration_ms => uint16(), dynamic() => dynamic()}.
-type connection_handle() :: reference().
-type global_handle() :: quic_global.
-type handle() :: global_handle() | listener_handle() | connection_handle() | stream_handle() | conf_handle() | reg_handle().
-type listen_opts() :: #{alpn := [alpn()], allow_insecure => boolean(), quic_registration => reg_handle(), conn_acceptors => non_neg_integer(), cert => file:filename(), certfile => file:filename(), key => file:filename(), keyfile => file:filename(), password => string(), verify => none | peer | verify_peer | verify_none, cacertfile => file:filename(), sslkeylogfile => file:filename(), max_bytes_per_key => uint64(), handshake_idle_timeout_ms => uint64(), idle_timeout_ms => uint64(), tls_client_max_send_buffer => uint32(), tls_server_max_send_buffer => uint32(), stream_recv_window_default => uint32(), stream_recv_buffer_default => uint32(), conn_flow_control_window => uint32(), max_stateless_operations => uint32(), initial_window_packets => uint32(), send_idle_timeout_ms => uint32(), initial_rtt_ms => uint32(), max_ack_delay_ms => uint32(), disconnect_timeout_ms => uint32(), keep_alive_interval_ms => uint32(), congestion_control_algorithm => uint16(), peer_bidi_stream_count => uint16(), peer_unidi_stream_count => uint16(), retry_memory_limit => uint16(), load_balancing_mode => uint16(), max_operations_per_drain => uint8(), send_buffering_enabled => uint8(), pacing_enabled => uint8(), migration_enabled => uint8(), datagram_receive_enabled => uint8(), server_resumption_level => uint8(), minimum_mtu => uint16(), maximum_mtu => uint16(), mtu_discovery_search_complete_timeout_us => uint64(), mtu_discovery_missing_probe_count => uint8(), max_binding_stateless_operations => uint16(), stateless_operation_expiration_ms => uint16()}.
-type listener_handle() :: reference().
-type listener_name() :: atom().
-type listener_opts() :: {listen_opts() | proplists:proplist(), conn_opts() | proplists:proplist(), stream_opts() | proplists:proplist()}.
-type reg_handle() :: reference().
-type stream_handle() :: reference().
-type stream_open_flags() :: 0 | 1 | 2.
-type stream_opts() :: #{active := active_n(), open_flag => stream_open_flags(), start_flag => stream_start_flags(), event_mask => uint32(), disable_fpbuffer => boolean(), stream_id => uint62(), priority => uint16(), ideal_send_buffer_size => uint64(), '0rtt_length' => uint64(), dynamic() => dynamic()}.
-type stream_start_flags() :: 0 | 1 | 2 | 4 | 8.
-type uint8() :: 0..1 bsl 8 - 1.
-type uint16() :: 0..1 bsl 16 - 1.
-type uint32() :: 0..1 bsl 32 - 1.
-type uint62() :: 0..1 bsl 62 - 1.
-type uint64() :: 0..1 bsl 64 - 1.
Functions
-spec count_conns(pid()) -> non_neg_integer().
count accepted but not yet closed connections
-spec get_conf(pid(), timeout()) -> listener_opts().
get the listener configuration
-spec get_handle(pid(), timeout()) -> quicer:listener_handle().
Reload the listener with new *listener* opts.
-spec reload(pid(), quicer:listen_on(), NewConf :: listener_opts()) -> ok | {error, _}.
Reload the listener with new *listener* opts and new listen_on.
-spec start_link(Name :: listener_name(), ListenOn :: quicer:listen_on(), Options :: quicer:listener_opts()) -> {ok, Pid :: pid()} | {error, Error :: {already_started, pid()}} | {error, Error :: term()} | ignore.
Starts the server