Module fusco_sock

Description
Function Index
Function Details

This module implements wrappers for socket operations.

Authors: Oscar Hellström (oscar@hellstrom.st), Diana Parra Corbacho (diana.corbacho@erlang-solutions.com).

Description

This module implements wrappers for socket operations.

Makes it possible to have the same interface to ssl and tcp sockets.

Function Index

close/2	Closes a socket.
connect/5	Connects to `Host` and `Port`.
recv/2	Reads available bytes from `Socket`.
recv/3
send/3	Sends data on a socket.
setopts/3	Sets options for a socket.

Function Details

close/2

close(Socket, X2::SslFlag) -> ok | {error, Reason}

Socket = socket()
SslFlag = boolean()
Reason = atom()

Closes a socket.

connect/5

connect(Host, Port, Options, Timeout, X5::SslFlag) -> {ok, Socket} | {error, Reason}

Host = string() | ip_address()
Port = integer()
Options = [{atom(), term()} | atom()]
Timeout = infinity | integer()
SslFlag = boolean()
Socket = socket()
Reason = atom()

Connects to Host and Port. Will use the ssl module if SslFlag is true and gen_tcp otherwise. Options are the normal gen_tcp or ssl Options.

recv/2

recv(Socket, X2::SslFlag) -> {ok, Data} | {error, Reason}

Socket = socket()
Length = integer()
SslFlag = boolean()
Data = term()
Reason = atom()

Reads available bytes from Socket. Will block untill data is available on the socket and return the first packet.

recv/3

recv(Socket::socket(), X2::boolean(), Timeout::timeout()) -> {ok, any()} | {error, atom()} | {error, {http_error, string()}}

send/3

send(Socket, Request::Data, X3::SslFlag) -> ok | {error, Reason}

Socket = socket()
Data = iolist()
SslFlag = boolean()
Reason = atom()

Sends data on a socket. Will use the ssl module if SslFlag is set to true, otherwise the gen_tcp module.

setopts/3

setopts(Socket, Opts, X3::SslFlag) -> ok | {error, Reason}

Socket = socket()
Opts = list()
SslFlag = boolean()
Reason = atom()

Sets options for a socket. Will use the ssl module if SslFlag is set to true, otherwise the inets module.

Generated by EDoc, May 17 2017, 09:28:02.