From e70a331569b2d161d976950d209989a5dc06a2bc Mon Sep 17 00:00:00 2001 From: Anders Svensson Date: Wed, 29 Aug 2012 02:23:28 +0200 Subject: Assorted doc improvements --- lib/diameter/doc/src/diameter_transport.xml | 62 +++++++++++++++-------------- 1 file changed, 33 insertions(+), 29 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 4ed02e3881..4890333669 100644 --- a/lib/diameter/doc/src/diameter_transport.xml +++ b/lib/diameter/doc/src/diameter_transport.xml @@ -93,16 +93,19 @@ It should not link to the parent. It should exit if its transport connection with its peer is lost.

-Transport processes for a given service are started sequentially.

- -

-The start function should use the 'Host-IP-Address' list on the service, -namely Svc#diameter_service.host_ip_address, and/or +The capabilities in the #diameter_service{} record are as +passed to diameter:start_service/2 and +diameter:add_transport/2, +values passed to the latter overriding those passed to the former. +The start function should use the Host-IP-Address list and/or Opts to select an appropriate list of local IP addresses, -and should return this list if different from the service addresses. -The returned list is used to populate 'Host-IP-Address' AVPs in outgoing -capabilities exchange messages, the service addresses being used -otherwise.

+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.

@@ -129,9 +132,10 @@ diameter.

An outbound Diameter message. -Packet can be either binary() (the message to be sent) -or a #diameter_packet{} whose transport_data field -containes a value other than undefined.

+Packet can be either binary() (the message to be sent) +or a #diameter_packet{} record whose transport_data +field contains a value other than undefined and whose bin field +contains the binary to send.

 {diameter, {close, Pid}} @@ -140,7 +144,7 @@ containes a value other than undefined.

A request to close the transport connection. The transport process should terminate after closing the connection. -Pid is the pid() of the parent process.

+Pid is the pid() of the parent process.

{diameter, {tls, Ref, Type, Bool}} @@ -148,17 +152,17 @@ Pid is the pid() of the parent process.

Indication of whether or not capabilities exchange has selected inband security using TLS. -Ref is a reference() that must be included in the +Ref is a reference() that must be included in the {diameter, {tls, Ref}} reply message to the transport's parent process (see below). -Type is either connect or accept depending on +Type is either connect or accept depending on whether the process has been started for a connecting or listening transport respectively. -Bool is a boolean() indicating whether or not the transport connection -should be upgraded to TLS.

+Bool is a boolean() indicating whether or not the transport +connection should be upgraded to TLS.

-If TLS is requested (Bool = true) then a connecting process should +If TLS is requested (Bool = true) then a connecting process should initiate a TLS handshake with the peer and an accepting process should prepare to accept a handshake. A successful handshake should be followed by a {diameter, {tls, Ref}} @@ -182,18 +186,18 @@ to its parent.

{diameter, {self(), connected}}

-Inform the parent that the transport process with Type = accept has +Inform the parent that the transport process with Type=accept has established a connection with the peer. -Not sent if the transport process has Type = connect.

+Not sent if the transport process has Type=connect.

 {diameter, {self(), connected, Remote}}

-Inform the parent that the transport process with Type = connect +Inform the parent that the transport process with Type=connect has established a connection with a peer. -Not sent if the transport process has Type = accept. -Remote is an arbitrary term that uniquely identifies the remote +Not sent if the transport process has Type=accept. +Remote is an arbitrary term that uniquely identifies the remote endpoint to which the transport has connected.

 @@ -201,14 +205,14 @@ endpoint to which the transport has connected.

An inbound Diameter message. -Packet can be either binary() (the message to be sent) -or #diameter_packet{} -whose packet field contains a binary(). -Any value (other than undefined) set in +Packet can be either binary() (the received message) +or a #diameter_packet{} record +whose bin field contains the received binary(). +Any value (other than undefined) set in the transport_data field will be passed back with a corresponding answer message in the case that the inbound message is a request unless the sender sets another value. -How the transport_data is used/interpreted is up to the +How transport_data is used/interpreted is up to the transport module.

 @@ -216,7 +220,7 @@ transport module.

Acknowledgment of a successful TLS handshake. -Ref is the reference() received in the +Ref is the reference() received in the {diameter, {tls, Ref, Type, Bool}} message in response to which the reply is sent. A transport must exit if a handshake is not successful.

-- cgit v1.2.3