Module ranch

Data Types

max_conns()

max_conns() = non_neg_integer() | infinity

opt()

opt() = {ack_timeout, timeout()} | {connection_type, worker | supervisor} | {max_connections, max_conns()} | {shutdown, timeout() | brutal_kill} | {socket, any()}

ref()

ref() = any()

Function Index

accept_ack/1
child_spec/6
filter_options/3
get_addr/1
get_max_connections/1
get_port/1
get_protocol_options/1
remove_connection/1
require/1
set_max_connections/2
set_option_default/3
set_protocol_options/2
start_listener/6
stop_listener/1

Function Details

accept_ack/1

accept_ack(Ref::ref()) -> ok

child_spec/6

child_spec(Ref::ref(), NbAcceptors::non_neg_integer(), Transport::module(), TransOpts::any(), Protocol::module(), ProtoOpts::any()) -> supervisor:child_spec()

filter_options/3

filter_options(UserOptions::[inet | inet6 | {atom(), any()} | {raw, any(), any(), any()}], AllowedKeys::[atom()], Acc) -> Acc

get_addr/1

get_addr(Ref::ref()) -> {inet:ip_address(), inet:port_number()}

get_max_connections/1

get_max_connections(Ref::ref()) -> max_conns()

get_port/1

get_port(Ref::ref()) -> inet:port_number()

get_protocol_options/1

get_protocol_options(Ref::ref()) -> any()

remove_connection/1

remove_connection(Ref::ref()) -> ok

require/1

require(Tail::[atom()]) -> ok

set_max_connections/2

set_max_connections(Ref::ref(), MaxConnections::max_conns()) -> ok

set_option_default/3

set_option_default(Opts, Key::atom(), Value::any()) -> Opts

set_protocol_options/2

set_protocol_options(Ref::ref(), Opts::any()) -> ok

start_listener/6

start_listener(Ref::ref(), NbAcceptors::non_neg_integer(), Transport::module(), TransOpts::any(), Protocol::module(), ProtoOpts::any()) -> supervisor:startchild_ret()

stop_listener/1

stop_listener(Ref::ref()) -> ok | {error, not_found}


Generated by EDoc, Mar 4 2016, 15:44:12.