7478214944dc2296a0c902b5e96b6b1bea7a9bf0
[sip-router] / doc / cfg_list / cfg_tm.txt
1 Configuration Variables for tm
2 ==============================
3
4                   [ this file is autogenerated, do not edit ]
5
6
7  1. tm.ruri_matching
8         perform Request URI check in transaction matching.
9         Default: 1.
10         Range: 0 - 1.
11         Type: integer.
12
13  2. tm.via1_matching
14         perform first Via header check in transaction matching.
15         Default: 1.
16         Range: 0 - 1.
17         Type: integer.
18
19  3. tm.fr_timer
20         timer which hits if no final reply for a request or ACK for a
21         negative INVITE reply arrives (in milliseconds).
22         Default: 30000.
23         Type: integer.
24
25  4. tm.fr_inv_timer
26         timer which hits if no final reply for an INVITE arrives after
27         a provisional message was received (in milliseconds).
28         Default: 120000.
29         Type: integer.
30
31  5. tm.fr_inv_timer_next
32         The value [ms] of fr_inv_timer for subsequent branches during
33         serial forking..
34         Default: 30000.
35         Type: integer.
36
37  6. tm.wt_timer
38         time for which a transaction stays in memory to absorb delayed
39         messages after it completed.
40         Default: 5000.
41         Type: integer.
42
43  7. tm.delete_timer
44         time after which a to-be-deleted transaction currently ref-ed
45         by a process will be tried to be deleted again..
46         Default: 200.
47         Type: integer.
48
49  8. tm.retr_timer1
50         initial retransmission period (in milliseconds).
51         Default: 500.
52         Type: integer.
53
54  9. tm.retr_timer2
55         maximum retransmission period (in milliseconds).
56         Default: 4000.
57         Type: integer.
58
59 10. tm.max_inv_lifetime
60         maximum time an invite transaction can live from the moment of
61         creation.
62         Default: 180000.
63         Type: integer.
64
65 11. tm.max_noninv_lifetime
66         maximum time a non-invite transaction can live from the moment
67         of creation.
68         Default: 32000.
69         Type: integer.
70
71 12. tm.noisy_ctimer
72         if set, INVITE transactions that time-out (FR INV timer) will
73         be always replied.
74         Default: 1.
75         Range: 0 - 1.
76         Type: integer.
77
78 13. tm.auto_inv_100
79         automatically send 100 to an INVITE.
80         Default: 1.
81         Range: 0 - 1.
82         Type: integer.
83
84 14. tm.auto_inv_100_reason
85         reason text of the automatically send 100 to an INVITE.
86         Default: trying -- your call is important to us.
87         Type: string.
88
89 15. tm.unix_tx_timeout
90         Unix socket transmission timeout, in milliseconds.
91         Default: 500.
92         Type: integer.
93
94 16. tm.restart_fr_on_each_reply
95         restart final response timer on each provisional reply.
96         Default: 1.
97         Range: 0 - 1.
98         Type: integer.
99
100 17. tm.pass_provisional_replies
101         enable/disable passing of provisional replies to
102         TMCB_LOCAL_RESPONSE_OUT callbacks.
103         Default: 0.
104         Range: 0 - 1.
105         Type: integer.
106
107 18. tm.aggregate_challenges
108         if the final response is a 401 or a 407, aggregate all the
109         authorization headers (challenges) (rfc3261 requires this to be
110         on).
111         Default: 1.
112         Range: 0 - 1.
113         Type: integer.
114
115 19. tm.unmatched_cancel
116         determines how CANCELs with no matching transaction are handled
117         (0: statefull forwarding, 1: stateless forwarding, 2: drop).
118         Default: 0.
119         Range: 0 - 2.
120         Type: integer.
121
122 20. tm.default_code
123         default SIP response code sent by t_reply(), if the function
124         cannot retrieve its parameters.
125         Default: 500.
126         Range: 400 - 699.
127         Type: integer.
128
129 21. tm.default_reason
130         default SIP reason phrase sent by t_reply(), if the function
131         cannot retrieve its parameters.
132         Default: Server Internal Error.
133         Type: string.
134
135 22. tm.reparse_invite
136         if set to 1, the CANCEL and negative ACK requests are
137         constructed from the INVITE message which was sent out instead
138         of building them from the received request.
139         Default: 1.
140         Range: 0 - 1.
141         Type: integer.
142
143 23. tm.ac_extra_hdrs
144         header fields prefixed by this parameter value are included in
145         the CANCEL and negative ACK messages if they were present in
146         the outgoing INVITE (depends on reparse_invite).
147         Default: <unknown:str>.
148         Type: string.
149
150 24. tm.blst_503
151         if set to 1, blacklist 503 SIP response sources.
152         Default: 0.
153         Range: 0 - 1.
154         Type: integer.
155
156 25. tm.blst_503_def_timeout
157         default 503 blacklist time (in s), when no Retry-After header
158         is present.
159         Default: 0.
160         Type: integer.
161
162 26. tm.blst_503_min_timeout
163         minimum 503 blacklist time (in s).
164         Default: 0.
165         Type: integer.
166
167 27. tm.blst_503_max_timeout
168         maximum 503 blacklist time (in s).
169         Default: 3600.
170         Type: integer.
171
172 28. tm.blst_methods_add
173         bitmap of method types that trigger blacklisting on transaction
174         timeouts.
175         Default: 1.
176         Type: integer.
177
178 29. tm.blst_methods_lookup
179         Bitmap of method types that are looked-up in the blacklist
180         before statefull forwarding.
181         Default: -9.
182         Type: integer.
183
184 30. tm.cancel_b_method
185         How to cancel branches on which no replies were received: 0 -
186         fake reply, 1 - retransmitting the request, 2 - send cancel.
187         Default: 1.
188         Range: 0 - 2.
189         Type: integer.
190
191 31. tm.reparse_on_dns_failover
192         if set to 1, the SIP message after a DNS failover is
193         constructed from the outgoing message buffer of the failed
194         branch instead of from the received request.
195         Default: 1.
196         Range: 0 - 1.
197         Type: integer.
198
199 32. tm.disable_6xx_block
200         if set to 1, 6xx is treated like a normal reply (breaks rfc).
201         Default: 0.
202         Range: 0 - 1.
203         Type: integer.
204
205 33. tm.local_ack_mode
206         if set to 1 or 2, local 200 ACKs are sent to the same address
207         as the corresponding INVITE (1) or the source of the 200 reply
208         (2) instead of using the contact and the route set (it breaks
209         the rfc, if  it is not set to 0 but allows dealing with NATed
210         contacts in some simple cases).
211         Default: 0.
212         Range: 0 - 2.
213         Type: integer.
214
215 34. tm.local_cancel_reason
216         if set to 1, a Reason header is added to locally generated
217         CANCELs (see RFC3326).
218         Default: 1.
219         Range: 0 - 1.
220         Type: integer.
221
222 35. tm.e2e_cancel_reason
223         if set to 1, Reason headers from received CANCELs are copied
224         into the corresponding generated hop-by-hop CANCELs.
225         Default: 1.
226         Range: 0 - 1.
227         Type: integer.
228