Module ranch_etls

An implementation of ranch_transport behavior on top of etls.

Copyright © (C) 2015 ACK CYFRONET AGH This software is released under the MIT license cited in 'LICENSE.md'.

Authors: Konrad Zemek.

Description

An implementation of ranch_transport behavior on top of etls. For function documentation check Ranch's ranch_transport docs.

Function Index

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

Function Details

accept/2

accept(Socket::etls:acceptor(), Timeout::timeout()) -> {ok, etls:socket()} | {error, closed | timeout | atom()}

ranch_transport callback accept/2.

accept_ack/2

accept_ack(Socket::etls:socket(), Timeout::timeout()) -> ok

ranch_transport callback accept_ack/2.

close/1

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

ranch_transport callback close/1.

connect/3

connect(Host::string(), Port::inet:port_number(), Opts::[etls:option() | etls:ssl_option()]) -> {ok, etls:socket()} | {error, atom()}

ranch_transport callback connect/3.

connect/4

connect(Host::string(), Port::inet:port_number(), Opts::[etls:option() | etls:ssl_option()], Timeout::timeout()) -> {ok, etls:socket()} | {error, atom()}

ranch_transport callback connect/4.

controlling_process/2

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

ranch_transport callback controlling_process/2.

listen/1

listen(Opts::[etls:option() | etls:ssl_option()]) -> {ok, etls:socket()} | {error, atom()}

ranch_transport callback listen/1.

messages/0

messages() -> {OK::atom(), Closed::atom(), Error::atom()}

ranch_transport callback messages/0.

name/0

name() -> atom()

ranch_transport callback name/0.

peername/1

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

ranch_transport callback peername/1.

recv/3

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

ranch_transport callback recv/3.

secure/0

secure() -> boolean()

ranch_transport callback secure/0.

send/2

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

ranch_transport callback send/2.

sendfile/2

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

ranch_transport callback sendfile/2.

sendfile/4

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

ranch_transport callback sendfile/4.

sendfile/5

sendfile(Socket::etls:socket(), File::file:name() | file:fd(), Offset::non_neg_integer(), Bytes::non_neg_integer(), Opts::ranch_transport:sendfile_opts()) -> {ok, non_neg_integer()} | {error, atom()}

ranch_transport callback sendfile/5.

setopts/2

setopts(Socket::etls:socket(), Opts::[etls:option() | etls:ssl_option()]) -> ok | {error, atom()}

ranch_transport callback setopts/2.

shutdown/2

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

ranch_transport callback shutdown/2.

sockname/1

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

ranch_transport callback sockname/1.


Generated by EDoc, Jan 17 2017, 02:25:41.