Module ranch_ssl

Behaviours: ranch_transport.

Data Types

opt()

opt() = ranch_tcp:opt() | ssl_opt()

opts()

opts() = [opt()]

ssl_opt()

ssl_opt() = {alpn_preferred_protocols, [binary()]} | {cacertfile, string()} | {cacerts, [public_key:der_encoded()]} | {cert, public_key:der_encoded()} | {certfile, string()} | {ciphers, [ssl:erl_cipher_suite()] | string()} | {client_renegotiation, boolean()} | {crl_cache, {module(), {internal | any(), list()}}} | {crl_check, boolean() | peer | best_effort} | {depth, 0..255} | {dh, public_key:der_encoded()} | {dhfile, string()} | {fail_if_no_peer_cert, boolean()} | {hibernate_after, integer() | undefined} | {honor_cipher_order, boolean()} | {key, {'RSAPrivateKey' | 'DSAPrivateKey' | 'PrivateKeyInfo', public_key:der_encoded()}} | {keyfile, string()} | {log_alert, boolean()} | {next_protocols_advertised, [binary()]} | {partial_chain, fun(([public_key:der_encoded()]) -> {trusted_ca, public_key:der_encoded()} | unknown_ca)} | {password, string()} | {psk_identity, string()} | {reuse_session, function()} | {reuse_sessions, boolean()} | {secure_renegotiate, boolean()} | {sni_fun, function()} | {sni_hosts, [{string(), ssl_opt()}]} | {user_lookup_fun, {function(), any()}} | {verify, ssl:verify_type()} | {verify_fun, {function(), any()}} | {versions, [atom()]}

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::ssl:sslsocket(), Timeout::timeout()) -> {ok, ssl:sslsocket()} | {error, closed | timeout | atom()}

accept_ack/2

accept_ack(CSocket::ssl:sslsocket(), Timeout::timeout()) -> ok

close/1

close(Socket::ssl:sslsocket()) -> 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::ssl:sslsocket(), Pid::pid()) -> ok | {error, closed | not_owner | atom()}

listen/1

listen(Opts::opts()) -> {ok, ssl:sslsocket()} | {error, atom()}

listen_options/0

listen_options() -> any()

messages/0

messages() -> any()

name/0

name() -> any()

peername/1

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

recv/3

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

secure/0

secure() -> boolean()

send/2

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

sendfile/2

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

sendfile/4

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

sendfile/5

sendfile(Socket::ssl:sslsocket(), File::file:name_all() | file:fd(), Offset::non_neg_integer(), Bytes::non_neg_integer(), Opts::ranch_transport:sendfile_opts()) -> {ok, non_neg_integer()} | {error, atom()}

setopts/2

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

shutdown/2

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

sockname/1

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


Generated by EDoc, May 1 2016, 01:44:51.