From 439dd4b95017a9966dd0cf1f090a9b00da831fe4 Mon Sep 17 00:00:00 2001 From: Anders Svensson Date: Fri, 16 Nov 2012 00:41:34 +0100 Subject: Use entities for cross references --- lib/diameter/doc/src/diameter_transport.xml | 30 +++++++++++++---------------- 1 file changed, 13 insertions(+), 17 deletions(-) (limited to 'lib/diameter/doc/src/diameter_transport.xml') diff --git a/lib/diameter/doc/src/diameter_transport.xml b/lib/diameter/doc/src/diameter_transport.xml index 0c8b41397a..a06d8a348b 100644 --- a/lib/diameter/doc/src/diameter_transport.xml +++ b/lib/diameter/doc/src/diameter_transport.xml @@ -1,5 +1,8 @@ - + + %ents; +]>
@@ -38,8 +41,7 @@ under the License.

-A module specified as a transport_module to diameter:add_transport/2 +A module specified as a transport_module to &mod_add_transport; must implement the interface documented here. The interface consists of a function with which diameter starts a transport process and a message interface with which @@ -59,7 +61,7 @@ parent).

Start a transport process. Type = connect | accept -Ref = diameter:transport_ref() +Ref = &mod_transport_ref; Svc = #diameter_service{} Config = term() Pid = pid() @@ -69,8 +71,7 @@ parent).

Start a transport process. -Called by diameter as a consequence of a call to diameter:add_transport/2 in +Called by diameter as a consequence of a call to &mod_add_transport; in order to establish or accept a transport connection respectively. A transport process maintains a connection with a single remote peer.

@@ -82,22 +83,18 @@ In the latter case, transport processes are started as required to accept connections from multiple peers.

-Ref is the value that was returned from the call to diameter:add_transport/2 +Ref is the value that was returned from the call to &mod_add_transport; that has lead to starting of a transport process.

-Svc contains the capabilities passed to diameter:start_service/2 and -diameter:add_transport/2, +Svc contains the capabilities passed to &mod_start_service; and +&mod_add_transport;, values passed to the latter overriding those passed to the former.

Config is as passed in transport_config tuple in the -diameter:transport_opt() -list passed to diameter:add_transport/2.

+&mod_transport_opt; +list passed to &mod_add_transport;.

The start function should use the Host-IP-Address list and/or @@ -245,8 +242,7 @@ A transport must exit if a handshake is not successful.

SEE ALSO

-diameter_tcp(3), -diameter_sctp(3)

+&man_tcp;, &man_sctp;

-- cgit v1.2.3