Module ranch_proxy

accept(ProxySocket::proxy_socket(), Timeout::timeout()) -> {ok, proxy_socket()} | {error, closed | timeout | not_proxy_protocol | {timeout, proxy_handshake} | atom()}

accept_ack(ProxySocket::proxy_socket(), Timeout::timeout()) -> ok

bearer_port(ProxySocket::proxy_socket()) -> port()

close(ProxySocket::proxy_socket()) -> ok

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

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

connection_info(ProxySocket::proxy_socket()) -> {ok, list()}

connection_info(ProxySocket::proxy_socket(), Items::[protocol | cipher_suite | sni_hostname]) -> {ok, list()}

controlling_process(ProxySocket::proxy_socket(), Pid::pid()) -> ok | {error, closed | not_owner | atom()}

getopts(ProxySocket::proxy_socket(), Opts::[atom()]) -> {ok, list()} | {error, atom()}

getstat(ProxySocket::proxy_socket()) -> {ok, list()} | {error, atom()}

getstat(ProxySocket::proxy_socket(), OptionNames::[atom()]) -> {ok, list()} | {error, atom()}

handshake(ProxySocket::proxy_socket(), Opts::list(), Timeout::timeout()) -> {ok, proxy_socket()} | {error, any()}

listen(Opts::ranch_tcp:opts()) -> {ok, proxy_socket()} | {error, atom()}

listen_port(ProxySocket::proxy_socket()) -> port()

match_port(ProxySocket::proxy_socket()) -> port()

messages() -> tuple()

name() -> atom()

opts_from_socket(Transport::atom(), Socket::proxy_socket()) -> ranch_proxy_protocol:proxy_opts()

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

proxyname(ProxySocket::proxy_socket()) -> {ok, proxy_protocol_info()}

recv(ProxySocket::proxy_socket(), Length::non_neg_integer(), Timeout::timeout()) -> {ok, any()} | {error, closed | atom()}

secure() -> boolean()

send(ProxySocket::proxy_socket(), Packet::iodata()) -> ok | {error, atom()}

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

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

sendfile(ProxySocket::proxy_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(ProxySocket::proxy_socket(), Opts::list()) -> ok | {error, atom()}

shutdown(ProxySocket::proxy_socket(), How::read | write | read_write) -> ok | {error, atom()}

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