Mercurial > hg > freeDiameter
annotate doc/test_app.conf.sample @ 1228:e5010975da35
Fix typo in comment.
author | Thomas Klausner <tk@giga.or.at> |
---|---|
date | Thu, 18 Jul 2013 14:45:37 +0200 |
parents | c2fbaf2985f4 |
children |
rev | line source |
---|---|
94
e00bc54ebbb6
Added app_test configuration sample
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
diff
changeset
|
1 ####################### |
e00bc54ebbb6
Added app_test configuration sample
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
diff
changeset
|
2 # This file contains the description of configuration and general information about the |
1197
823829bf1037
Couple of typos in the comments
Sebastien Decugis <sdecugis@freediameter.net>
parents:
575
diff
changeset
|
3 # "test_app" extension. |
94
e00bc54ebbb6
Added app_test configuration sample
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
diff
changeset
|
4 |
e00bc54ebbb6
Added app_test configuration sample
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
diff
changeset
|
5 # This extension provides a simple way to send a predefined message over the Diameter Network. |
e00bc54ebbb6
Added app_test configuration sample
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
diff
changeset
|
6 # It may be used to test the Routing or other base mechanisms from the Diameter network. |
e00bc54ebbb6
Added app_test configuration sample
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
diff
changeset
|
7 |
e00bc54ebbb6
Added app_test configuration sample
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
diff
changeset
|
8 # In order to enable this extension, the main freeDiameter configuration file |
e00bc54ebbb6
Added app_test configuration sample
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
diff
changeset
|
9 # must contain the following declaration: |
e00bc54ebbb6
Added app_test configuration sample
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
diff
changeset
|
10 # LoadExtension = "extensions/app_test.fdx" : "/path/to/app_test.conf" ; |
e00bc54ebbb6
Added app_test configuration sample
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
diff
changeset
|
11 # Note that the conffile may be omitted, in which case default parameters will be assumed. |
e00bc54ebbb6
Added app_test configuration sample
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
diff
changeset
|
12 ####################### |
e00bc54ebbb6
Added app_test configuration sample
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
diff
changeset
|
13 |
e00bc54ebbb6
Added app_test configuration sample
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
diff
changeset
|
14 |
e00bc54ebbb6
Added app_test configuration sample
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
diff
changeset
|
15 ####################### |
e00bc54ebbb6
Added app_test configuration sample
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
diff
changeset
|
16 # Configuration of the test message |
e00bc54ebbb6
Added app_test configuration sample
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
diff
changeset
|
17 |
e00bc54ebbb6
Added app_test configuration sample
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
diff
changeset
|
18 # This application is defined as a Vendor-Specific application. |
336
5d1a22bb1cfe
Removed some references to waaad
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
127
diff
changeset
|
19 # Since freeDiameter does not have a IANA-assigned Vendor ID, we let a configurable value here: |
94
e00bc54ebbb6
Added app_test configuration sample
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
diff
changeset
|
20 # vendor-id = 999999; |
e00bc54ebbb6
Added app_test configuration sample
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
diff
changeset
|
21 |
e00bc54ebbb6
Added app_test configuration sample
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
diff
changeset
|
22 # The application id. Same remark as previously. |
e00bc54ebbb6
Added app_test configuration sample
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
diff
changeset
|
23 # appli-id = 999999; |
e00bc54ebbb6
Added app_test configuration sample
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
diff
changeset
|
24 |
e00bc54ebbb6
Added app_test configuration sample
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
diff
changeset
|
25 # The command code for Test-Request and Test-Answer. The range 0xfffffe-ffffff (dec: 16777215) is reserved for experimental use. |
e00bc54ebbb6
Added app_test configuration sample
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
diff
changeset
|
26 # cmd-id = 16777214; |
e00bc54ebbb6
Added app_test configuration sample
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
diff
changeset
|
27 |
e00bc54ebbb6
Added app_test configuration sample
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
diff
changeset
|
28 # The AVP id for the test. |
e00bc54ebbb6
Added app_test configuration sample
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
diff
changeset
|
29 # avp-id = 345678; |
e00bc54ebbb6
Added app_test configuration sample
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
diff
changeset
|
30 |
1214
c2fbaf2985f4
New options to test_app extension to generate long Diameter messages
Sebastien Decugis <sdecugis@freediameter.net>
parents:
1197
diff
changeset
|
31 # Another AVP id for long payload test. default to value 0, meaning this is not used. |
c2fbaf2985f4
New options to test_app extension to generate long Diameter messages
Sebastien Decugis <sdecugis@freediameter.net>
parents:
1197
diff
changeset
|
32 # long-avp-id = 0; |
c2fbaf2985f4
New options to test_app extension to generate long Diameter messages
Sebastien Decugis <sdecugis@freediameter.net>
parents:
1197
diff
changeset
|
33 |
c2fbaf2985f4
New options to test_app extension to generate long Diameter messages
Sebastien Decugis <sdecugis@freediameter.net>
parents:
1197
diff
changeset
|
34 # Define the payload length of the long-avp. Default 5000 bytes. |
c2fbaf2985f4
New options to test_app extension to generate long Diameter messages
Sebastien Decugis <sdecugis@freediameter.net>
parents:
1197
diff
changeset
|
35 # long-avp-len = 5000; |
c2fbaf2985f4
New options to test_app extension to generate long Diameter messages
Sebastien Decugis <sdecugis@freediameter.net>
parents:
1197
diff
changeset
|
36 |
c2fbaf2985f4
New options to test_app extension to generate long Diameter messages
Sebastien Decugis <sdecugis@freediameter.net>
parents:
1197
diff
changeset
|
37 |
94
e00bc54ebbb6
Added app_test configuration sample
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
diff
changeset
|
38 ####################### |
e00bc54ebbb6
Added app_test configuration sample
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
diff
changeset
|
39 # Configuration of the extension behavior |
e00bc54ebbb6
Added app_test configuration sample
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
diff
changeset
|
40 |
e00bc54ebbb6
Added app_test configuration sample
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
diff
changeset
|
41 # The mode for the extension. |
e00bc54ebbb6
Added app_test configuration sample
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
diff
changeset
|
42 # - server: Answer incoming requests. The signal is ignored. |
e00bc54ebbb6
Added app_test configuration sample
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
diff
changeset
|
43 # - client: Send a request when the signal is received, and measure the time to receiving answer. |
e00bc54ebbb6
Added app_test configuration sample
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
diff
changeset
|
44 # - both: acts as client and server |
e00bc54ebbb6
Added app_test configuration sample
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
diff
changeset
|
45 # mode = both; |
e00bc54ebbb6
Added app_test configuration sample
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
diff
changeset
|
46 |
572
b1b56d4682d0
Added benchmark mode in test_app
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
336
diff
changeset
|
47 # The behavior can be changed by specifying additional "benchmark;" keyword. |
b1b56d4682d0
Added benchmark mode in test_app
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
336
diff
changeset
|
48 # When this keyword appears, it changes the behavior as follow: |
b1b56d4682d0
Added benchmark mode in test_app
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
336
diff
changeset
|
49 # - server is silent on message reception, only the activity summary is displayed every 30 seconds |
b1b56d4682d0
Added benchmark mode in test_app
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
336
diff
changeset
|
50 # - client attempts to send as many messages as possible during 10 seconds and counts them. |
1228 | 51 # The benchmark keyword can be followed optionally by two integers: |
575
66f188b3ca84
Configurable parameters for the benchmark mode
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
572
diff
changeset
|
52 # duration is the time for the measurement, in seconds (default 10). |
66f188b3ca84
Configurable parameters for the benchmark mode
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
572
diff
changeset
|
53 # concurrency is the number of messages that can be on the wire before waiting for an answer (default 100). |
66f188b3ca84
Configurable parameters for the benchmark mode
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
572
diff
changeset
|
54 # benchmark [duration concurrency]; |
66f188b3ca84
Configurable parameters for the benchmark mode
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
572
diff
changeset
|
55 |
572
b1b56d4682d0
Added benchmark mode in test_app
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
336
diff
changeset
|
56 |
94
e00bc54ebbb6
Added app_test configuration sample
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
diff
changeset
|
57 ####################### |
e00bc54ebbb6
Added app_test configuration sample
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
diff
changeset
|
58 # Client-specific configuration |
e00bc54ebbb6
Added app_test configuration sample
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
diff
changeset
|
59 |
e00bc54ebbb6
Added app_test configuration sample
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
diff
changeset
|
60 # The Destination-Realm for the message |
e00bc54ebbb6
Added app_test configuration sample
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
diff
changeset
|
61 # (default is sending to same realm as local peer). |
e00bc54ebbb6
Added app_test configuration sample
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
diff
changeset
|
62 # dest-realm = "foreign.net"; |
e00bc54ebbb6
Added app_test configuration sample
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
diff
changeset
|
63 |
e00bc54ebbb6
Added app_test configuration sample
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
diff
changeset
|
64 # The Destination-Host for the message. |
e00bc54ebbb6
Added app_test configuration sample
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
diff
changeset
|
65 # (default is not providing this AVP). |
e00bc54ebbb6
Added app_test configuration sample
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
diff
changeset
|
66 # dest-host = "server.foreign.net"; |
e00bc54ebbb6
Added app_test configuration sample
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
diff
changeset
|
67 |
127
8ee43cf85a5f
Added User-Name AVP in test_app extension
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
120
diff
changeset
|
68 # The User-Name for the message (may be useful for some routing tests). |
8ee43cf85a5f
Added User-Name AVP in test_app extension
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
120
diff
changeset
|
69 # (default is not providing this AVP). |
8ee43cf85a5f
Added User-Name AVP in test_app extension
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
120
diff
changeset
|
70 # user-name = "user@server.foreign.net"; |
8ee43cf85a5f
Added User-Name AVP in test_app extension
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
120
diff
changeset
|
71 |
94
e00bc54ebbb6
Added app_test configuration sample
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
diff
changeset
|
72 # The signal that triggers sending the test message |
1197
823829bf1037
Couple of typos in the comments
Sebastien Decugis <sdecugis@freediameter.net>
parents:
575
diff
changeset
|
73 # Note: Symbolic names are not recognized, you must use integers |
94
e00bc54ebbb6
Added app_test configuration sample
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
diff
changeset
|
74 # signal = 10; |