From 67ffc483c80d29334c6c7739bcf1be756f374dfb Mon Sep 17 00:00:00 2001
From: Anders Svensson
Date: Tue, 20 Nov 2012 13:11:19 +0100
Subject: Add content to diameter_codec(3) and diameter_make(3)
---
lib/diameter/doc/src/diameter_sctp.xml | 27 +++++++++++++--------------
1 file changed, 13 insertions(+), 14 deletions(-)
(limited to 'lib/diameter/doc/src/diameter_sctp.xml')
diff --git a/lib/diameter/doc/src/diameter_sctp.xml b/lib/diameter/doc/src/diameter_sctp.xml
index a023a9bc08..5e3fd5eaf1 100644
--- a/lib/diameter/doc/src/diameter_sctp.xml
+++ b/lib/diameter/doc/src/diameter_sctp.xml
@@ -1,5 +1,11 @@
gen_sctp(3)'>
+ gen_sctp:open/1'>
+ inet:ip_address()'>
+ inet(3)'>
%also;
@@ -43,8 +49,7 @@ under the License.
-This module implements diameter transport over SCTP using gen_sctp.
+This module implements diameter transport over SCTP using &gen_sctp;.
It can be specified as the value of a transport_module option to
&mod_add_transport;
and implements the behaviour documented in
@@ -65,9 +70,9 @@ and implements the behaviour documented in
Type = connect | accept
Ref = &mod_transport_ref;
Svc = #diameter_service{}
-Opt = {raddr, inet:ip_address()} | {rport, integer()} | term()
+Opt = {raddr, &ip_address;} | {rport, integer()} | term()
Pid = pid()
-LAddr = inet:ip_address()
+LAddr = &ip_address;
Reason = term()
@@ -84,8 +89,7 @@ unspecified.
More than one raddr option can be specified, in which case the
connecting transport in question attempts each in sequence until
an association is established.
-Remaining options are any accepted by gen_sctp:open/1, with the exception
+Remaining options are any accepted by &gen_sctp_open1;, with the exception
of options mode, binary, list, active
and sctp_events.
Note that options ip and port specify the local address
@@ -102,14 +106,12 @@ connecting transport.
An insufficiently large receive buffer may result in a peer having to
-resend incoming messages: set the inet(3) option recbuf to increase
+resend incoming messages: set the &inet; option recbuf to increase
the buffer size.
An insufficiently large send buffer may result in outgoing messages
-being discarded: set the inet(3) option sndbuf to increase
+being discarded: set the &inet; option sndbuf to increase
the buffer size.
@@ -145,10 +147,7 @@ outbound streams.
SEE ALSO
-&man_main;,
-&man_transport;,
-gen_sctp(3),
-inet(3)
+&man_main;, &man_transport;, &gen_sctp;, &inet;
--
cgit v1.2.3