Type = connect | accept
Ref = diameter:transport_ref()
Svc = #diameter_service{}
-Opts = term()
+Config = term()
Pid = pid()
LAddrs = [inet:ip_address()]
Reason = term()
@@ -75,38 +75,46 @@ order to establish or accept a transport connection respectively.
A transport process maintains a connection with a single remote peer.
-The first argument indicates whether the transport process in question
+Type indicates whether the transport process in question
is being started for a connecting (connect) or listening
(accept) transport.
In the latter case, transport processes are started as required to
-accept connections from multiple peers.
-Ref is in each case the same value that was returned from the
-call to diameter:add_transport/2
-that has lead to starting of a transport process.
+accept connections from multiple peers.
-A transport process must implement the message interface documented below.
-It should retain the pid of its parent, monitor the parent and terminate if
-it dies.
-It should not link to the parent.
-It should exit if its transport connection with its peer is lost.
+Ref is the value that was returned from the call to diameter:add_transport/2
+that has lead to starting of a transport process.
-The capabilities in the #diameter_service{} record are as
-passed to Svc contains the capabilities passed to diameter:start_service/2 and
diameter:add_transport/2,
-values passed to the latter overriding those passed to the former.
+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.
+
+
The start function should use the Host-IP-Address list and/or
-Opts to select an appropriate list of local IP addresses,
+Config to select an appropriate list of local IP addresses,
and should return this list if different from the
#diameter_service{} addresses.
The returned list is used to populate Host-IP-Address AVPs in
outgoing capabilities exchange messages, the
#diameter_service{} addresses being used otherwise.
+
+A transport process must implement the message interface documented below.
+It should retain the pid of its parent, monitor the parent and terminate if
+it dies.
+It should not link to the parent.
+It should exit if its transport connection with its peer is lost.
+