aboutsummaryrefslogtreecommitdiffstats
path: root/lib/diameter/doc
diff options
context:
space:
mode:
authorAnders Svensson <[email protected]>2013-02-27 10:30:54 +0100
committerAnders Svensson <[email protected]>2013-03-04 01:18:06 +0100
commit899120dd73724793c787db3227ecb1ba42c00381 (patch)
tree7abea4f2d0563658e74bc5f86fe5a403c0ef5965 /lib/diameter/doc
parent05f11890bdfec4bfc3a78e191a87e70a937ffc54 (diff)
downloadotp-899120dd73724793c787db3227ecb1ba42c00381.tar.gz
otp-899120dd73724793c787db3227ecb1ba42c00381.tar.bz2
otp-899120dd73724793c787db3227ecb1ba42c00381.zip
Add transport_opt() watchdog_config
To make the number of watchdogs sent before the transitions REOPEN -> OKAY and OKAY -> SUSPECT configurable. Using anything other then the default config is non-standard and should only be used for test.
Diffstat (limited to 'lib/diameter/doc')
-rw-r--r--lib/diameter/doc/src/diameter.xml24
1 files changed, 24 insertions, 0 deletions
diff --git a/lib/diameter/doc/src/diameter.xml b/lib/diameter/doc/src/diameter.xml
index 379e9f0738..75e95a9a3d 100644
--- a/lib/diameter/doc/src/diameter.xml
+++ b/lib/diameter/doc/src/diameter.xml
@@ -1125,6 +1125,30 @@ modules in order until one establishes a connection within the
corresponding timeout (see below) or all fail.</p>
</item>
+<marker id="watchdog_config"/>
+<tag><c>{watchdog_config, [{okay|suspect, non_neg_integer()}]}</c></tag>
+<item>
+<p>
+Specifies configuration that alters the behaviour of the watchdog
+state machine.
+On key <c>okay</c>, the non-negative number of answered DWR
+messages required before transitioning from REOPEN to OKAY.
+On key <c>suspect</c>, the positive number of unanswered DWR messages
+before transitioning from OKAY to SUSPECT, or 0 to never make this
+transition.</p>
+
+<p>
+Defaults to <c>[{okay, 3}, {suspect, 1}]</c>.
+Not specifying a key is equivalent to specifying
+the default value for that key.</p>
+<warning>
+<p>
+The default value is as required by RFC 3539: changing it results
+in non-standard behaviour that should only be used to simulate
+misbehaving nodes during test.</p>
+</warning>
+</item>
+
<marker id="watchdog_timer"/>
<tag><c>{watchdog_timer, TwInit}</c></tag>
<item>