blob: f9c4d12135a4477cac5c61a237b553947a298420 [file] [log] [blame]
Brian Waters13d96012017-12-08 16:53:31 -06001# This file contains information for configuring the test_netemul extension.
2# To find how to have freeDiameter load this extension, please refer to the freeDiameter documentation.
3#
4# The test_netemul extension implements a Diameter proxy that behaves like simple forwarding agent,
5# with the exception that it can introduce delay in the forwarding of the messages and generate duplicates
6# of messages, as can be expected from a real Diameter network. It can also generate routing errors when
7# connected to more than 2 peers.
8
9
10# LATENCY:
11# Two parameters are used to control the delay introduced in the messages.
12# - latency_average:
13# This is the average delay introduced in the packets.
14# Set to 0 to not add any latency (beyond the normal processing time).
15# The value is expressed as an integer followed by a unit which can
16# be 's' (seconds) or 'ms' (milliseconds). Example:
17# latency_average = 700 ms;
18#
19# - latency_deviation:
20# This parameter controls the variance in the latency. It is expressed
21# as a value between 0 % and 100 %. When set to 0 %, all messages will be delayed
22# by exactly latency_average. Otherwise, it represents the width of the interval
23# "around" the average where "most" of the latency will be chosen (the distribution
24# has a Gaussian shape). Example:
25# latency_deviation = 25 %;
26#
27# The default values give an added latency "mostly" between 0.4 and 0.6 seconds:
28# latency_average = 500 ms;
29# latency_deviation = 20 % ;
30
31
32# REORDERING:
33# There is no special control over the reordering of messages. It may simply happen
34# as a result of the latency. If you want to get a lot of reordering, set the
35# latency_variance to a high value.
36
37
38# DUPLICATES:
39# Duplicate messages are expected in the Diameter protocol by design, as a consequence
40# of the failover mechanism that provides the protocol's reliability.
41# - dupl_proba:
42# This value gives the probability of producing a duplicate of a forwarded message.
43# The value is comprized between 0 (no duplicates) and 1 (duplicate all messages).
44# Duplicates are created for requests, but may result in duplicate answers
45# received by your Diameter client(s), depending on your server(s)'s behavior.
46# In the case of freeDiameter client, the duplicate answer is automatically filtered out
47# because the hop-by-hop id has already been used.
48# Note that each duplicate copy is an independent message,
49# which receives a different latency, and might be routed to a different server if you
50# use for example load-balancing.
51# The parameter can take several forms:
52# dupl_proba = 0 ;
53# Disables the generation of duplicate messages completely.
54# dupl_proba = 1 / 10000 ;
55# dupl_proba = 0.0001 ;
56# Around 1 messages over ten thousands will be duplicated.
57#
58# Default value:
59# dupl_proba = 1 / 100 ;