bookish_spork_transport.md

Module bookish_spork_transport

• Data Types
• Function Index
• Function Details

This module defines the bookish_spork_transport behaviour.
Required callback functions: listen/2, accept/1, recv/2, send/2, close/1, shutdown/2, setopts/2, connection_information/1.

Data Types

callback_module()

callback_module() = bookish_spork_tcp | bookish_spork_ssl

listen()

abstract datatype: listen()

socket()

socket() = gen_tcp:socket() | ssl:sslsocket()

t()

abstract datatype: t()

Function Index

accept/1
close/1
connection_id/1
listen/2
read_raw/2
recv/1
send/2
shutdown/1
socket/1
ssl_ext/1
ssl_info/1

Function Details

accept/1

accept(Listen::listen()) -> t()

close/1

close(Listen::listen() | t()) -> ok

connection_id/1

connection_id(Transport::t()) -> binary()

listen/2

listen(Module::callback_module(), Port::inet:port_number()) -> listen()

read_raw/2

read_raw(Transport::t(), ContentLength::integer()) -> binary()

recv/1

recv(Transport::t()) -> {ok, term()} | {error, term()}

send/2

send(Transport::t(), String::iodata()) -> ok

shutdown/1

shutdown(Transport::t()) -> ok

socket/1

socket(Transport::t()) -> socket()

ssl_ext/1

ssl_ext(Transport::t()) -> ssl:protocol_extensions()

ssl_info/1

ssl_info(Transport::t()) -> proplists:proplist()