Module rabbit_net

Data Types

hostname()

hostname() = inet:hostname()

ip_port()

ip_port() = inet:port_number()

-type host_or_ip() :: binary() | inet:ip_address().

ok_or_any_error()

ok_or_any_error() = rabbit_types:ok_or_error(any())

ok_val_or_error()

ok_val_or_error(A) = rabbit_types:ok_or_error2(A, any())

opts()

opts() = [{atom(), any()} | {raw, non_neg_integer(), non_neg_integer(), binary()}]

socket()

socket() = port() | ssl:sslsocket()

stat_option()

stat_option() = recv_cnt | recv_max | recv_avg | recv_oct | recv_dvi | send_cnt | send_max | send_avg | send_oct | send_pend

Function Index

async_recv/3
close/1
connection_string/2
controlling_process/2
fast_close/1
getifaddrs/0
getopts/2
getstat/2
hostname/0
is_loopback/1
is_ssl/1
maybe_get_proxy_socket/1
peercert/1
peername/1
port_command/2
proxy_ssl_info/2
recv/1
send/2
setopts/2
socket_ends/2
sockname/1
ssl_info/1
sync_recv/2
tcp_host/1
unwrap_socket/1

Function Details

async_recv/3

async_recv(Sock::socket(), Length::integer(), Timeout::timeout()) -> rabbit_types:ok(any())

close/1

close(Sock::socket()) -> ok_or_any_error()

connection_string/2

connection_string(Sock::socket(), Direction::inbound | outbound) -> ok_val_or_error(string())

controlling_process/2

controlling_process(Sock::socket(), Pid::pid()) -> ok_or_any_error()

fast_close/1

fast_close(Sock::socket()) -> ok_or_any_error()

getifaddrs/0

getifaddrs() -> any()

getopts/2

getopts(Sock::socket(), Options::[atom() | {raw, non_neg_integer(), non_neg_integer(), non_neg_integer() | binary()}]) -> ok_val_or_error(opts())

getstat/2

getstat(Sock::socket(), Stats::[stat_option()]) -> ok_val_or_error([{stat_option(), integer()}])

hostname/0

hostname() -> any()

is_loopback/1

is_loopback(Sock::socket() | inet:ip_address()) -> boolean()

is_ssl/1

is_ssl(Sock::socket()) -> boolean()

maybe_get_proxy_socket/1

maybe_get_proxy_socket(Sock) -> any()

peercert/1

peercert(Sock::socket()) -> nossl | ok_val_or_error(rabbit_ssl:certificate())

peername/1

peername(Sock::socket()) -> ok_val_or_error({inet:ip_address(), ip_port()})

port_command/2

port_command(Sock::socket(), Data::iolist()) -> true

proxy_ssl_info/2

proxy_ssl_info(Sock::socket(), X2::ranch_proxy:proxy_socket()) -> nossl | ok_val_or_error([{atom(), any()}])

recv/1

recv(Sock::socket()) -> {data, [char()] | binary()} | closed | rabbit_types:error(any()) | {other, any()}

send/2

send(Sock::socket(), Data::binary() | iolist()) -> ok_or_any_error()

setopts/2

setopts(Sock::socket(), Options::opts()) -> ok_or_any_error()

socket_ends/2

socket_ends(Sock, Direction) -> any()

sockname/1

sockname(Sock::socket()) -> ok_val_or_error({inet:ip_address(), ip_port()})

ssl_info/1

ssl_info(Sock::socket()) -> nossl | ok_val_or_error([{atom(), any()}])

sync_recv/2

sync_recv(Sock::socket(), Length::integer()) -> rabbit_types:ok(binary()) | rabbit_types:error(any())

tcp_host/1

tcp_host(IPAddress) -> any()

unwrap_socket/1

unwrap_socket(Sock) -> any()


Generated by EDoc