Mercurial > hg > freeDiameter
annotate doc/rt_busypeers.conf.sample @ 1020:8110a781116a
New extension rt_busypeers. See doc/rt_busypeers.conf.sample for more information. This code is not tested yet
author | Sebastien Decugis <sdecugis@freediameter.net> |
---|---|
date | Mon, 01 Apr 2013 16:17:13 +0800 |
parents | |
children | 7ee7b95701c9 |
rev | line source |
---|---|
1020
8110a781116a
New extension rt_busypeers. See doc/rt_busypeers.conf.sample for more information. This code is not tested yet
Sebastien Decugis <sdecugis@freediameter.net>
parents:
diff
changeset
|
1 # This file contains information for configuring the rt_busypeers extension. |
8110a781116a
New extension rt_busypeers. See doc/rt_busypeers.conf.sample for more information. This code is not tested yet
Sebastien Decugis <sdecugis@freediameter.net>
parents:
diff
changeset
|
2 # To find how to have freeDiameter load this extension, please refer to the freeDiameter documentation. |
8110a781116a
New extension rt_busypeers. See doc/rt_busypeers.conf.sample for more information. This code is not tested yet
Sebastien Decugis <sdecugis@freediameter.net>
parents:
diff
changeset
|
3 # |
8110a781116a
New extension rt_busypeers. See doc/rt_busypeers.conf.sample for more information. This code is not tested yet
Sebastien Decugis <sdecugis@freediameter.net>
parents:
diff
changeset
|
4 # The rt_busypeers extension has two purposes. |
8110a781116a
New extension rt_busypeers. See doc/rt_busypeers.conf.sample for more information. This code is not tested yet
Sebastien Decugis <sdecugis@freediameter.net>
parents:
diff
changeset
|
5 # - when the local peer receives an error DIAMETER_TOO_BUSY from a peer, |
8110a781116a
New extension rt_busypeers. See doc/rt_busypeers.conf.sample for more information. This code is not tested yet
Sebastien Decugis <sdecugis@freediameter.net>
parents:
diff
changeset
|
6 # this extension catchs this error and attempts to retransmit the query to another peer if it makes sense, i.e.: |
8110a781116a
New extension rt_busypeers. See doc/rt_busypeers.conf.sample for more information. This code is not tested yet
Sebastien Decugis <sdecugis@freediameter.net>
parents:
diff
changeset
|
7 # * the peer issuing the error is not the peer referenced in the Destination-Host AVP of the message, |
8110a781116a
New extension rt_busypeers. See doc/rt_busypeers.conf.sample for more information. This code is not tested yet
Sebastien Decugis <sdecugis@freediameter.net>
parents:
diff
changeset
|
8 # * we have a direct link with the peer that issued the error (see parameter RetryDistantPeers below) |
8110a781116a
New extension rt_busypeers. See doc/rt_busypeers.conf.sample for more information. This code is not tested yet
Sebastien Decugis <sdecugis@freediameter.net>
parents:
diff
changeset
|
9 # |
8110a781116a
New extension rt_busypeers. See doc/rt_busypeers.conf.sample for more information. This code is not tested yet
Sebastien Decugis <sdecugis@freediameter.net>
parents:
diff
changeset
|
10 # - When a request is forwarded by the local peer, start a timer and if the corresponding answer/error has |
8110a781116a
New extension rt_busypeers. See doc/rt_busypeers.conf.sample for more information. This code is not tested yet
Sebastien Decugis <sdecugis@freediameter.net>
parents:
diff
changeset
|
11 # not been received within RelayTimeout seconds, either send to another peer or return a DIAMETER_TOO_BUSY |
8110a781116a
New extension rt_busypeers. See doc/rt_busypeers.conf.sample for more information. This code is not tested yet
Sebastien Decugis <sdecugis@freediameter.net>
parents:
diff
changeset
|
12 # error, depending on the RetryMaxPeers parameter. |
8110a781116a
New extension rt_busypeers. See doc/rt_busypeers.conf.sample for more information. This code is not tested yet
Sebastien Decugis <sdecugis@freediameter.net>
parents:
diff
changeset
|
13 # |
8110a781116a
New extension rt_busypeers. See doc/rt_busypeers.conf.sample for more information. This code is not tested yet
Sebastien Decugis <sdecugis@freediameter.net>
parents:
diff
changeset
|
14 # This extension is mainly useful for Diameter agents, for Diameter clients it is recommended to |
8110a781116a
New extension rt_busypeers. See doc/rt_busypeers.conf.sample for more information. This code is not tested yet
Sebastien Decugis <sdecugis@freediameter.net>
parents:
diff
changeset
|
15 # implement this logic directly in the client application. |
8110a781116a
New extension rt_busypeers. See doc/rt_busypeers.conf.sample for more information. This code is not tested yet
Sebastien Decugis <sdecugis@freediameter.net>
parents:
diff
changeset
|
16 |
8110a781116a
New extension rt_busypeers. See doc/rt_busypeers.conf.sample for more information. This code is not tested yet
Sebastien Decugis <sdecugis@freediameter.net>
parents:
diff
changeset
|
17 |
8110a781116a
New extension rt_busypeers. See doc/rt_busypeers.conf.sample for more information. This code is not tested yet
Sebastien Decugis <sdecugis@freediameter.net>
parents:
diff
changeset
|
18 # Parameter: SkipTooBusyErrors |
8110a781116a
New extension rt_busypeers. See doc/rt_busypeers.conf.sample for more information. This code is not tested yet
Sebastien Decugis <sdecugis@freediameter.net>
parents:
diff
changeset
|
19 # If defined, this parameter disables the handling of Diameter Errors message with a Result-Code set to DIAMETER_TOO_BUSY in this extension. |
8110a781116a
New extension rt_busypeers. See doc/rt_busypeers.conf.sample for more information. This code is not tested yet
Sebastien Decugis <sdecugis@freediameter.net>
parents:
diff
changeset
|
20 # When this parameter is defined, the parameter RetryDistantPeer has no effect. |
8110a781116a
New extension rt_busypeers. See doc/rt_busypeers.conf.sample for more information. This code is not tested yet
Sebastien Decugis <sdecugis@freediameter.net>
parents:
diff
changeset
|
21 # Default: parameter is not defined. |
8110a781116a
New extension rt_busypeers. See doc/rt_busypeers.conf.sample for more information. This code is not tested yet
Sebastien Decugis <sdecugis@freediameter.net>
parents:
diff
changeset
|
22 #SkipTooBusyErrors; |
8110a781116a
New extension rt_busypeers. See doc/rt_busypeers.conf.sample for more information. This code is not tested yet
Sebastien Decugis <sdecugis@freediameter.net>
parents:
diff
changeset
|
23 |
8110a781116a
New extension rt_busypeers. See doc/rt_busypeers.conf.sample for more information. This code is not tested yet
Sebastien Decugis <sdecugis@freediameter.net>
parents:
diff
changeset
|
24 |
8110a781116a
New extension rt_busypeers. See doc/rt_busypeers.conf.sample for more information. This code is not tested yet
Sebastien Decugis <sdecugis@freediameter.net>
parents:
diff
changeset
|
25 # Parameter: RetryDistantPeers |
8110a781116a
New extension rt_busypeers. See doc/rt_busypeers.conf.sample for more information. This code is not tested yet
Sebastien Decugis <sdecugis@freediameter.net>
parents:
diff
changeset
|
26 # By default, the extension only retries to send messages if the peer that issued the DIAMETER_TOO_BUSY error is directly connected to |
8110a781116a
New extension rt_busypeers. See doc/rt_busypeers.conf.sample for more information. This code is not tested yet
Sebastien Decugis <sdecugis@freediameter.net>
parents:
diff
changeset
|
27 # the local peer (not through a Diameter agent). This avoids the situation where the message is sent to a different relay that will deliver |
8110a781116a
New extension rt_busypeers. See doc/rt_busypeers.conf.sample for more information. This code is not tested yet
Sebastien Decugis <sdecugis@freediameter.net>
parents:
diff
changeset
|
28 # to the same busy peer afterwards. If the parameter is defined, then the extension will also retry sending messages for errors generated in |
8110a781116a
New extension rt_busypeers. See doc/rt_busypeers.conf.sample for more information. This code is not tested yet
Sebastien Decugis <sdecugis@freediameter.net>
parents:
diff
changeset
|
29 # distant peers. This should increase the chance that the message is delivered, but also can increase the load of the network unnecessarily. |
8110a781116a
New extension rt_busypeers. See doc/rt_busypeers.conf.sample for more information. This code is not tested yet
Sebastien Decugis <sdecugis@freediameter.net>
parents:
diff
changeset
|
30 # Default: parameter is not defined. |
8110a781116a
New extension rt_busypeers. See doc/rt_busypeers.conf.sample for more information. This code is not tested yet
Sebastien Decugis <sdecugis@freediameter.net>
parents:
diff
changeset
|
31 #RetryDistantPeers; |
8110a781116a
New extension rt_busypeers. See doc/rt_busypeers.conf.sample for more information. This code is not tested yet
Sebastien Decugis <sdecugis@freediameter.net>
parents:
diff
changeset
|
32 |
8110a781116a
New extension rt_busypeers. See doc/rt_busypeers.conf.sample for more information. This code is not tested yet
Sebastien Decugis <sdecugis@freediameter.net>
parents:
diff
changeset
|
33 |
8110a781116a
New extension rt_busypeers. See doc/rt_busypeers.conf.sample for more information. This code is not tested yet
Sebastien Decugis <sdecugis@freediameter.net>
parents:
diff
changeset
|
34 # Parameter: RetryMaxPeers |
8110a781116a
New extension rt_busypeers. See doc/rt_busypeers.conf.sample for more information. This code is not tested yet
Sebastien Decugis <sdecugis@freediameter.net>
parents:
diff
changeset
|
35 # This parameter specifies the limit on the number of times a request can be re-sent to a different peer, before the local relay gives up and |
8110a781116a
New extension rt_busypeers. See doc/rt_busypeers.conf.sample for more information. This code is not tested yet
Sebastien Decugis <sdecugis@freediameter.net>
parents:
diff
changeset
|
36 # forwards the error to upstream. |
8110a781116a
New extension rt_busypeers. See doc/rt_busypeers.conf.sample for more information. This code is not tested yet
Sebastien Decugis <sdecugis@freediameter.net>
parents:
diff
changeset
|
37 # Default: 0, meaning all possible candidates are attempted before give up. |
8110a781116a
New extension rt_busypeers. See doc/rt_busypeers.conf.sample for more information. This code is not tested yet
Sebastien Decugis <sdecugis@freediameter.net>
parents:
diff
changeset
|
38 #RetryMaxPeers=0; |
8110a781116a
New extension rt_busypeers. See doc/rt_busypeers.conf.sample for more information. This code is not tested yet
Sebastien Decugis <sdecugis@freediameter.net>
parents:
diff
changeset
|
39 |
8110a781116a
New extension rt_busypeers. See doc/rt_busypeers.conf.sample for more information. This code is not tested yet
Sebastien Decugis <sdecugis@freediameter.net>
parents:
diff
changeset
|
40 |
8110a781116a
New extension rt_busypeers. See doc/rt_busypeers.conf.sample for more information. This code is not tested yet
Sebastien Decugis <sdecugis@freediameter.net>
parents:
diff
changeset
|
41 # Parameter: RelayTimeout |
8110a781116a
New extension rt_busypeers. See doc/rt_busypeers.conf.sample for more information. This code is not tested yet
Sebastien Decugis <sdecugis@freediameter.net>
parents:
diff
changeset
|
42 # If the value of this parameter is not 0, it specifies the number of seconds that the local relay waits for an answer to a |
8110a781116a
New extension rt_busypeers. See doc/rt_busypeers.conf.sample for more information. This code is not tested yet
Sebastien Decugis <sdecugis@freediameter.net>
parents:
diff
changeset
|
43 # forwarded request before considering the remote peer is busy and taking corrective action (similar as if that relay had returned TOO_BUSY status). |
8110a781116a
New extension rt_busypeers. See doc/rt_busypeers.conf.sample for more information. This code is not tested yet
Sebastien Decugis <sdecugis@freediameter.net>
parents:
diff
changeset
|
44 # Note: this parameter does not apply for requests issued locally. In that case, the extension issuing the request should directly specify the timeout. |
8110a781116a
New extension rt_busypeers. See doc/rt_busypeers.conf.sample for more information. This code is not tested yet
Sebastien Decugis <sdecugis@freediameter.net>
parents:
diff
changeset
|
45 # Default: 0, meaning that there is no timeout parameter. |
8110a781116a
New extension rt_busypeers. See doc/rt_busypeers.conf.sample for more information. This code is not tested yet
Sebastien Decugis <sdecugis@freediameter.net>
parents:
diff
changeset
|
46 #RelayTimeout=0; |
8110a781116a
New extension rt_busypeers. See doc/rt_busypeers.conf.sample for more information. This code is not tested yet
Sebastien Decugis <sdecugis@freediameter.net>
parents:
diff
changeset
|
47 |