From 3b1b9e110e9db2ee0fcfad2b5d558c4d6a82700d Mon Sep 17 00:00:00 2001 From: Anders Svensson Date: Thu, 15 Nov 2012 16:52:16 +0100 Subject: Document transport_opt() capx_timeout --- lib/diameter/doc/src/diameter.xml | 62 ++++++++++++++++++++++++++++++--------- 1 file changed, 48 insertions(+), 14 deletions(-) (limited to 'lib') diff --git a/lib/diameter/doc/src/diameter.xml b/lib/diameter/doc/src/diameter.xml index 64c983d4a6..f545b2c9ad 100644 --- a/lib/diameter/doc/src/diameter.xml +++ b/lib/diameter/doc/src/diameter.xml @@ -606,6 +606,14 @@ indicated result code. Pkt contains the CER in question.

+{'CER', timeout} + +

+An expected CER was not received within capx_timeout of +connection establishment.

+
+ {'CEA', Result, Caps, Pkt} @@ -639,6 +647,14 @@ An incoming CEA contained errors and has been rejected. Pkt contains the CEA in question.

+{'CEA', timeout} + +

+An expected CEA was not received within capx_timeout +of connection establishment.

+
+ @@ -850,13 +866,30 @@ case the corresponding callbacks are applied until either all return ok or one does not.

+ +{capx_timeout, + Unsigned32()} + +

+The number of milliseconds after which a transport process having an +established transport connection will be terminated if the expected +capabilities exchange message (CER or CEA) is not received from the peer. +For a connecting transport, the timing reconnection attempts is +governed by watchdog_timer or +reconnect_timer expiry. +For a listening transport, the peer determines the timing.

+ +

+Defaults to 10000.

+
+ {disconnect_cb, evaluable()}

-A callback invoked prior to requesting shutdown of a transport process -for a transport connection having watchdog state OKAY. +A callback invoked prior to terminating the transport process of a +transport connection having watchdog state OKAY. Applied to Reason=transport|service|application and the transport_ref() and diameter_app:peer() @@ -875,20 +908,12 @@ The return value can have one of the following types.

{dpr, [option()]}

-Causes Disconnect-Peer-Request to be sent to the peer, transport -process shutdown being requested after reception of +Causes Disconnect-Peer-Request to be sent to the peer, the transport +process being terminated following reception of Disconnect-Peer-Answer or timeout. An option() can be one of the following.

-{timeout, integer()} - -

-Transport process shutdown will be requested after this number of -milliseconds if DPA is not received. -Defaults to 1000.

-
- {cause, 0|rebooting|1|busy|2|goaway}

@@ -897,6 +922,15 @@ The Disconnect-Cause to send, REBOOTING, BUSY and Defaults to rebooting for Reason=service|application and goaway for Reason=transport.

+ +{timeout, + Unsigned32()} + +

+The number of milliseconds after which the transport process is +terminated if DPA has not been received. +Defaults to 1000.

+
@@ -909,7 +943,7 @@ Equivalent to {dpr, []}.

close

-Causes transport process shutdown to be requested without +Causes the transport process to be terminated without Disconnect-Peer-Request being sent to the peer.

@@ -1301,7 +1335,7 @@ Pred = {M,F,A}: fun(Ref, Type, Opts) -> apply(M, F, [Ref, Type, Opts | A]) end

Removing a transport causes the corresponding transport processes to -be asked to terminate. +be terminated. Whether or not a DPR message is sent to a peer is controlled by value of disconnect_cb -- cgit v1.2.3