Module ranch_tcp

Behaviours: ranch_transport.

Data Types

opt()

opt() = {backlog, non_neg_integer()} | {buffer, non_neg_integer()} | {delay_send, boolean()} | {dontroute, boolean()} | {exit_on_close, boolean()} | {fd, non_neg_integer()} | {high_msgq_watermark, non_neg_integer()} | {high_watermark, non_neg_integer()} | inet | inet6 | {ip, inet:ip_address()} | {keepalive, boolean()} | {linger, {boolean(), non_neg_integer()}} | {low_msgq_watermark, non_neg_integer()} | {low_watermark, non_neg_integer()} | {nodelay, boolean()} | {port, inet:port_number()} | {priority, integer()} | {raw, non_neg_integer(), non_neg_integer(), binary()} | {recbuf, non_neg_integer()} | {send_timeout, timeout()} | {send_timeout_close, boolean()} | {sndbuf, non_neg_integer()} | {tos, integer()}

opts()

opts() = [opt()]

Function Index

accept/2
accept_ack/2
close/1
connect/3
connect/4
controlling_process/2
listen/1
listen_options/0
messages/0
name/0
peername/1
recv/3
secure/0
send/2
sendfile/2
sendfile/4
sendfile/5
setopts/2
shutdown/2
sockname/1

Function Details

accept/2

accept(LSocket::inet:socket(), Timeout::timeout()) -> {ok, inet:socket()} | {error, closed | timeout | atom()}

accept_ack/2

accept_ack(X1::inet:socket(), X2::timeout()) -> ok

close/1

close(Socket::inet:socket()) -> ok

connect/3

connect(Host::inet:ip_address() | inet:hostname(), Port::inet:port_number(), Opts::any()) -> {ok, inet:socket()} | {error, atom()}

connect/4

connect(Host::inet:ip_address() | inet:hostname(), Port::inet:port_number(), Opts::any(), Timeout::timeout()) -> {ok, inet:socket()} | {error, atom()}

controlling_process/2

controlling_process(Socket::inet:socket(), Pid::pid()) -> ok | {error, closed | not_owner | atom()}

listen/1

listen(Opts::opts()) -> {ok, inet:socket()} | {error, atom()}

listen_options/0

listen_options() -> any()

messages/0

messages() -> any()

name/0

name() -> any()

peername/1

peername(Socket::inet:socket()) -> {ok, {inet:ip_address(), inet:port_number()}} | {error, atom()}

recv/3

recv(Socket::inet:socket(), Length::non_neg_integer(), Timeout::timeout()) -> {ok, any()} | {error, closed | atom()}

secure/0

secure() -> boolean()

send/2

send(Socket::inet:socket(), Packet::iodata()) -> ok | {error, atom()}

sendfile/2

sendfile(Socket::inet:socket(), Filename::file:name_all() | file:fd()) -> {ok, non_neg_integer()} | {error, atom()}

sendfile/4

sendfile(Socket::inet:socket(), File::file:name_all() | file:fd(), Offset::non_neg_integer(), Bytes::non_neg_integer()) -> {ok, non_neg_integer()} | {error, atom()}

sendfile/5

sendfile(Socket::inet:socket(), Filename::file:name_all() | file:fd(), Offset::non_neg_integer(), Bytes::non_neg_integer(), Opts::[{chunk_size, non_neg_integer()}]) -> {ok, non_neg_integer()} | {error, atom()}

setopts/2

setopts(Socket::inet:socket(), Opts::list()) -> ok | {error, atom()}

shutdown/2

shutdown(Socket::inet:socket(), How::read | write | read_write) -> ok | {error, atom()}

sockname/1

sockname(Socket::inet:socket()) -> {ok, {inet:ip_address(), inet:port_number()}} | {error, atom()}


Generated by EDoc, Mar 3 2016, 14:32:06.