View Source hackney_ssl (hackney v1.23.0)

Summary

Functions

check_hostname_opts(Host0)
cipher_opts()
close(Socket)
Close a TCP socket.

See also: ssl:close/1.

connect(Host, Port, Opts)
connect(Host, Port, Opts0, Timeout)
controlling_process(Socket, Pid)
Assign a new controlling process Pid to Socket.

See also: ssl:controlling_process/2.

messages(_)
Atoms used to identify messages in {active, once | true} mode.
peername(Socket)
Return the address and port for the other end of a connection.

See also: ssl:peername/1.

recv(Socket, Length)
recv(Socket, Length, Timeout)
Receive a packet from a socket in passive mode.

See also: ssl:recv/3.

send(Socket, Packet)
Send a packet on a socket.

See also: ssl:send/2.

setopts(Socket, Opts)
Set one or more options for a socket.

See also: ssl:setopts/2.

shutdown(Socket, How)
Immediately close a socket in one or two directions.

See also: ssl:shutdown/2.

sockname(Socket)
Get the local address and port of a socket

See also: ssl:sockname/1.

Functions

check_hostname_opts(Host0)

cipher_opts()

close(Socket)

-spec close(ssl:sslsocket()) -> ok.
Close a TCP socket.

See also: ssl:close/1.

connect(Host, Port, Opts)

connect(Host, Port, Opts0, Timeout)

controlling_process(Socket, Pid)

-spec controlling_process(ssl:sslsocket(), pid()) -> ok | {error, closed | not_owner | atom()}.
Assign a new controlling process Pid to Socket.

See also: ssl:controlling_process/2.

messages(_)

Atoms used to identify messages in {active, once | true} mode.

peername(Socket)

-spec peername(ssl:sslsocket()) -> {ok, {inet:ip_address(), inet:port_number()}} | {error, atom()}.
Return the address and port for the other end of a connection.

See also: ssl:peername/1.

recv(Socket, Length)

recv(Socket, Length, Timeout)

-spec recv(ssl:sslsocket(), non_neg_integer(), timeout()) -> {ok, any()} | {error, closed | atom()}.
Receive a packet from a socket in passive mode.

See also: ssl:recv/3.

send(Socket, Packet)

-spec send(ssl:sslsocket(), iolist()) -> ok | {error, atom()}.
Send a packet on a socket.

See also: ssl:send/2.

setopts(Socket, Opts)

-spec setopts(ssl:sslsocket(), list()) -> ok | {error, atom()}.
Set one or more options for a socket.

See also: ssl:setopts/2.

shutdown(Socket, How)

-spec shutdown(ssl:sslsocket(), read | write | read_write) -> ok | {error, any()}.
Immediately close a socket in one or two directions.

See also: ssl:shutdown/2.

sockname(Socket)

-spec sockname(ssl:sslsocket()) -> {ok, {inet:ip_address(), inet:port_number()}} | {error, atom()}.
Get the local address and port of a socket

See also: ssl:sockname/1.