The
Record definitions for the
-include_lib("kernel/include/inet_sctp.hrl").
These record definitions use the "new" spelling 'adaptation', not the deprecated 'adaption', regardless of which spelling the underlying C API uses.
An opaque term returned in for example #sctp_paddr_change{}
that identifies an association for an SCTP socket. The term
is opaque except for the special value
Represents an address of an SCTP socket.
It is a tuple as explained in
See
One of the
Socket identifier returned from
Timeout used in SCTP connect and receive calls.
Abnormally terminates the association given by
Completely closes the socket and all associations on it. The unsent
data is flushed as in
Same as
Establishes a new association for the socket
A socket can be associated with multiple peers.
#sctp_assoc_change{ state = atom(), error = atom(), outbound_streams = int(), inbound_streams = int(), assoc_id = assoc_id() }
The number of outbound and inbound streams can be set by
giving an
connect(Socket, Ip, Port, [{sctp_initmsg,#sctp_initmsg{num_ostreams=OutStreams, max_instreams=MaxInStreams}}])
All options
The returned
The following values of
All other states do not normally occur in the output from
Assigns a new controlling process Pid to Socket. Same implementation
as
Gracefully terminates the association given by
Sets up a socket to listen on the IP address and port number it is bound to. IsServer must be 'true' or 'false'. In the contrast to TCP, in SCTP there is no listening queue length. If IsServer is 'true' the socket accepts new associations, i.e. it will become an SCTP server socket.
Creates an SCTP socket and binds it to the local addresses
specified by all
A default set of socket
Receives the
The actual
#sctp_paddr_change{ addr = {ip_address(),port()}, state = atom(), error = int(), assoc_id = assoc_id() }
Indicates change of the status of the peer's IP address given by
In case of an error (e.g.
#sctp_send_failed{ flags = true | false, error = int(), info = #sctp_sndrcvinfo{}, assoc_id = assoc_id() data = binary() }
The sender may receive this event if a send operation fails.
The
In the current implementation of the Erlang/SCTP binding,
this Event is internally converted into an
#sctp_adaptation_event{ adaptation_ind = int(), assoc_id = assoc_id() }
Delivered when a peer sends an Adaptation Layer Indication
parameter (configured through the option
#sctp_pdapi_event{ indication = sctp_partial_delivery_aborted, assoc_id = assoc_id() }
A partial delivery failure. In the current implementation of
the Erlang/SCTP binding, this Event is internally converted
into an
Sends the
Sends
Translates an SCTP error number from for example
The set of admissible SCTP socket options is by construction
orthogonal to the sets of TCP, UDP and generic INET options:
only those options which are explicitly listed below are allowed
for SCTP sockets. Options can be set on the socket using
Determines the type of data returned from
If
If
NB: This can cause the message queue to overflow, as there is no way to throttle the sender in this case (no flow control!).
If
Determines the size of the user-level software buffer used by
the SCTP driver. Not to be confused with
Sets the Type-Of-Service field on the IP datagrams being sent, to the given value, which effectively determines a prioritization policy for the outbound packets. The acceptable values are system-dependent. TODO: we do not provide symbolic names for these values yet.
A protocol-independent equivalent of
By default
By default
Determines the timeout in seconds for flushing unsent data in the
The size, in bytes, of the *kernel* send buffer for this socket.
Sending errors would occur for datagrams larger than
The size, in bytes, of the *kernel* recv buffer for this socket.
Sending errors would occur for datagrams larger than
#sctp_rtoinfo{ assoc_id = assoc_id(), initial = int(), max = int(), min = int() }
Determines re-transmission time-out parameters, in milliseconds,
for the association(s) given by
#sctp_assocparams{ assoc_id = assoc_id(), asocmaxrxt = int(), number_peer_destinations = int(), peer_rwnd = int(), local_rwnd = int(), cookie_life = int() }
Determines association parameters for the association(s) given by
#sctp_initmsg{ num_ostreams = int(), max_instreams = int(), max_attempts = int(), max_init_timeo = int() }
Determines the default parameters which this socket attempts
to negotiate with its peer while establishing an association with it.
Should be set after
Determines the time (in seconds) after which an idle association is automatically closed.
Turns on|off the Nagle algorithm for merging small packets into larger ones (which improves throughput at the expense of latency).
If
Turns on|off automatic mapping of IPv4 addresses into IPv6 ones (if the socket address family is AF_INET6).
Determines the maximum chunk size if message fragmentation is used.
If
#sctp_prim{ assoc_id = assoc_id(), addr = {IP, Port} } IP = ip_address() Port = port_number()
For the association given by
#sctp_setpeerprim{ assoc_id = assoc_id(), addr = {IP, Port} } IP = ip_address() Port = port_number()
When set, informs the peer that it should use
#sctp_setadaptation{ adaptation_ind = int() }
When set, requests that the local endpoint uses the value given by
#sctp_paddrparams{ assoc_id = assoc_id(), address = {IP, Port}, hbinterval = int(), pathmaxrxt = int(), pathmtu = int(), sackdelay = int(), flags = list() } IP = ip_address() Port = port_number()
This option determines various per-address parameters for
the association given by
#sctp_sndrcvinfo{ stream = int(), ssn = int(), flags = list(), ppid = int(), context = int(), timetolive = int(), tsn = int(), cumtsn = int(), assoc_id = assoc_id() }
Other fields are rarely used. See
#sctp_event_subscribe{ data_io_event = true | false, association_event = true | false, address_event = true | false, send_failure_event = true | false, peer_error_event = true | false, shutdown_event = true | false, partial_delivery_event = true | false, adaptation_layer_event = true | false }
This option determines which
#sctp_assoc_value{ assoc_id = assoc_id(), assoc_value = int() }
Rarely used. Determines the ACK time
(given by
#sctp_status{ assoc_id = assoc_id(), state = atom(), rwnd = int(), unackdata = int(), penddata = int(), instrms = int(), outstrms = int(), fragmentation_point = int(), primary = #sctp_paddrinfo{} }
This option is read-only. It determines the status of
the SCTP association given by
The semantics of other fields is the following:
#sctp_paddrinfo{ assoc_id = assoc_id(), address = {IP, Port}, state = inactive | active, cwnd = int(), srtt = int(), rto = int(), mtu = int() } IP = ip_address() Port = port_number()
This option is read-only. It determines the parameters specific to
the peer's address given by
Example of an Erlang SCTP Server which receives SCTP messages and prints them on the standard output:
-module(sctp_server). -export([server/0,server/1,server/2]). -include_lib("kernel/include/inet.hrl"). -include_lib("kernel/include/inet_sctp.hrl"). server() -> server(any, 2006). server([Host,Port]) when is_list(Host), is_list(Port) -> {ok, #hostent{h_addr_list = [IP|_]}} = inet:gethostbyname(Host), io:format("~w -> ~w~n", [Host, IP]), server([IP, list_to_integer(Port)]). server(IP, Port) when is_tuple(IP) orelse IP == any orelse IP == loopback, is_integer(Port) -> {ok,S} = gen_sctp:open([{ip,IP},{port,Port}],[{recbuf,65536}]), io:format("Listening on ~w:~w. ~w~n", [IP,Port,S]), ok = gen_sctp:listen(S, true), server_loop(S). server_loop(S) -> case gen_sctp:recv(S) of {error, Error} -> io:format("SCTP RECV ERROR: ~p~n", [Error]); Data -> io:format("Received: ~p~n", [Data]) end, server_loop(S).
Example of an Erlang SCTP Client which interacts with the above Server.
Note that in this example, the Client creates an association with
the Server with 5 outbound streams. For this reason, sending of
"Test 0" over Stream 0 succeeds, but sending of "Test 5"
over Stream 5 fails. The client then
-module(sctp_client). -export([client/0, client/1, client/2]). -include_lib("kernel/include/inet.hrl"). -include_lib("kernel/include/inet_sctp.hrl"). client() -> client([localhost]). client([Host]) -> client(Host, 2006); client([Host, Port]) when is_list(Host), is_list(Port) -> client(Host,list_to_integer(Port)), init:stop(). client(Host, Port) when is_integer(Port) -> {ok,S} = gen_sctp:open(), {ok,Assoc} = gen_sctp:connect (S, Host, Port, [{sctp_initmsg,#sctp_initmsg{num_ostreams=5}}]), io:format("Connection Successful, Assoc=~p~n", [Assoc]), io:write(gen_sctp:send(S, Assoc, 0, <<"Test 0">>)), io:nl(), timer:sleep(10000), io:write(gen_sctp:send(S, Assoc, 5, <<"Test 5">>)), io:nl(), timer:sleep(10000), io:write(gen_sctp:abort(S, Assoc)), io:nl(), timer:sleep(1000), gen_sctp:close(S).