cfg_tcp.xml 7.1 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321
  1. <?xml version="1.0" encoding="UTF-8"?>
  2. <!-- this file is autogenerated, do not edit! -->
  3. <!DOCTYPE section PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
  4. "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd">
  5. <chapter id="config_vars.tcp">
  6. <title> Configuration Variables for tcp</title>
  7. <section id="tcp.connect_timeout">
  8. <title>tcp.connect_timeout</title>
  9. <para>
  10. used only in non-async mode, in seconds.
  11. </para>
  12. <para>Range: -1 - 134217727.</para>
  13. <para>Type: integer.</para>
  14. <para>
  15. </para>
  16. </section>
  17. <section id="tcp.send_timeout">
  18. <title>tcp.send_timeout</title>
  19. <para>
  20. in seconds.
  21. </para>
  22. <para>Range: -1 - 2147483647.</para>
  23. <para>Type: integer.</para>
  24. <para>
  25. </para>
  26. </section>
  27. <section id="tcp.connection_lifetime">
  28. <title>tcp.connection_lifetime</title>
  29. <para>
  30. connection lifetime (in seconds).
  31. </para>
  32. <para>Range: -1 - 2147483647.</para>
  33. <para>Type: integer.</para>
  34. <para>
  35. </para>
  36. </section>
  37. <section id="tcp.max_connections">
  38. <title>tcp.max_connections</title>
  39. <para>
  40. maximum tcp connections number, soft limit.
  41. </para>
  42. <para>Range: 0 - 2147483647.</para>
  43. <para>Type: integer.</para>
  44. <para>
  45. </para>
  46. </section>
  47. <section id="tcp.max_tls_connections">
  48. <title>tcp.max_tls_connections</title>
  49. <para>
  50. maximum tls connections number, soft limit.
  51. </para>
  52. <para>Range: 0 - 2147483647.</para>
  53. <para>Type: integer.</para>
  54. <para>
  55. </para>
  56. </section>
  57. <section id="tcp.no_connect">
  58. <title>tcp.no_connect</title>
  59. <para>
  60. if set only accept new connections, never actively open new
  61. ones.
  62. </para>
  63. <para>Range: 0 - 1.</para>
  64. <para>Type: integer.</para>
  65. <para>
  66. </para>
  67. </section>
  68. <section id="tcp.fd_cache">
  69. <title>tcp.fd_cache</title>
  70. <para>
  71. file descriptor cache for tcp_send.
  72. </para>
  73. <para>Range: 0 - 1.</para>
  74. <para>Type: integer.</para>
  75. <para>
  76. Read-only.
  77. </para>
  78. </section>
  79. <section id="tcp.async">
  80. <title>tcp.async</title>
  81. <para>
  82. async mode for writes and connects.
  83. </para>
  84. <para>Range: 0 - 1.</para>
  85. <para>Type: integer.</para>
  86. <para>
  87. Read-only.
  88. </para>
  89. </section>
  90. <section id="tcp.connect_wait">
  91. <title>tcp.connect_wait</title>
  92. <para>
  93. parallel simultaneous connects to the same dst. (0) or one
  94. connect.
  95. </para>
  96. <para>Range: 0 - 1.</para>
  97. <para>Type: integer.</para>
  98. <para>
  99. Read-only.
  100. </para>
  101. </section>
  102. <section id="tcp.conn_wq_max">
  103. <title>tcp.conn_wq_max</title>
  104. <para>
  105. maximum bytes queued for write per connection (depends on
  106. async).
  107. </para>
  108. <para>Range: 0 - 1048576.</para>
  109. <para>Type: integer.</para>
  110. <para>
  111. </para>
  112. </section>
  113. <section id="tcp.wq_max">
  114. <title>tcp.wq_max</title>
  115. <para>
  116. maximum bytes queued for write allowed globally (depends on
  117. async).
  118. </para>
  119. <para>Range: 0 - 1073741824.</para>
  120. <para>Type: integer.</para>
  121. <para>
  122. </para>
  123. </section>
  124. <section id="tcp.defer_accept">
  125. <title>tcp.defer_accept</title>
  126. <para>
  127. 0/1 on linux, seconds on freebsd (see docs).
  128. </para>
  129. <para>Range: 0 - 3600.</para>
  130. <para>Type: integer.</para>
  131. <para>
  132. Read-only.
  133. </para>
  134. </section>
  135. <section id="tcp.delayed_ack">
  136. <title>tcp.delayed_ack</title>
  137. <para>
  138. initial ack will be delayed and sent with the first data
  139. segment.
  140. </para>
  141. <para>Range: 0 - 1.</para>
  142. <para>Type: integer.</para>
  143. <para>
  144. </para>
  145. </section>
  146. <section id="tcp.syncnt">
  147. <title>tcp.syncnt</title>
  148. <para>
  149. number of syn retransmissions before aborting a connect (0=not
  150. set).
  151. </para>
  152. <para>Range: 0 - 1024.</para>
  153. <para>Type: integer.</para>
  154. <para>
  155. </para>
  156. </section>
  157. <section id="tcp.linger2">
  158. <title>tcp.linger2</title>
  159. <para>
  160. lifetime of orphaned sockets in FIN_WAIT2 state in s (0=not
  161. set).
  162. </para>
  163. <para>Range: 0 - 3600.</para>
  164. <para>Type: integer.</para>
  165. <para>
  166. </para>
  167. </section>
  168. <section id="tcp.keepalive">
  169. <title>tcp.keepalive</title>
  170. <para>
  171. enables/disables keepalives for tcp.
  172. </para>
  173. <para>Range: 0 - 1.</para>
  174. <para>Type: integer.</para>
  175. <para>
  176. </para>
  177. </section>
  178. <section id="tcp.keepidle">
  179. <title>tcp.keepidle</title>
  180. <para>
  181. time before sending a keepalive if the connection is idle
  182. (linux).
  183. </para>
  184. <para>Range: 0 - 86400.</para>
  185. <para>Type: integer.</para>
  186. <para>
  187. </para>
  188. </section>
  189. <section id="tcp.keepintvl">
  190. <title>tcp.keepintvl</title>
  191. <para>
  192. time interval between keepalive probes on failure (linux).
  193. </para>
  194. <para>Range: 0 - 86400.</para>
  195. <para>Type: integer.</para>
  196. <para>
  197. </para>
  198. </section>
  199. <section id="tcp.keepcnt">
  200. <title>tcp.keepcnt</title>
  201. <para>
  202. number of failed keepalives before dropping the connection
  203. (linux).
  204. </para>
  205. <para>Range: 0 - 1024.</para>
  206. <para>Type: integer.</para>
  207. <para>
  208. </para>
  209. </section>
  210. <section id="tcp.crlf_ping">
  211. <title>tcp.crlf_ping</title>
  212. <para>
  213. enable responding to CRLF SIP-level keepalives .
  214. </para>
  215. <para>Range: 0 - 1.</para>
  216. <para>Type: integer.</para>
  217. <para>
  218. </para>
  219. </section>
  220. <section id="tcp.accept_aliases">
  221. <title>tcp.accept_aliases</title>
  222. <para>
  223. turn on/off tcp aliases (see tcp_accept_aliases) .
  224. </para>
  225. <para>Range: 0 - 1.</para>
  226. <para>Type: integer.</para>
  227. <para>
  228. </para>
  229. </section>
  230. <section id="tcp.alias_flags">
  231. <title>tcp.alias_flags</title>
  232. <para>
  233. flags used for adding new aliases (FORCE_ADD:1 , REPLACE:2) .
  234. </para>
  235. <para>Range: 0 - 2.</para>
  236. <para>Type: integer.</para>
  237. <para>
  238. </para>
  239. </section>
  240. <section id="tcp.new_conn_alias_flags">
  241. <title>tcp.new_conn_alias_flags</title>
  242. <para>
  243. flags for the def. aliases for a new conn. (FORCE_ADD:1,
  244. REPLACE:2 .
  245. </para>
  246. <para>Range: 0 - 2.</para>
  247. <para>Type: integer.</para>
  248. <para>
  249. </para>
  250. </section>
  251. <section id="tcp.accept_no_cl">
  252. <title>tcp.accept_no_cl</title>
  253. <para>
  254. accept TCP messages without Content-Length .
  255. </para>
  256. <para>Range: 0 - 1.</para>
  257. <para>Type: integer.</para>
  258. <para>
  259. </para>
  260. </section>
  261. <section id="tcp.reuse_port">
  262. <title>tcp.reuse_port</title>
  263. <para>
  264. reuse TCP ports .
  265. </para>
  266. <para>Range: 0 - 1.</para>
  267. <para>Type: integer.</para>
  268. <para>
  269. </para>
  270. </section>
  271. <section id="tcp.rd_buf_size">
  272. <title>tcp.rd_buf_size</title>
  273. <para>
  274. internal read buffer size (should be &gt; max. expected
  275. datagram).
  276. </para>
  277. <para>Range: 512 - 16777216.</para>
  278. <para>Type: integer.</para>
  279. <para>
  280. </para>
  281. </section>
  282. <section id="tcp.wq_blk_size">
  283. <title>tcp.wq_blk_size</title>
  284. <para>
  285. internal async write block size (debugging use only for now).
  286. </para>
  287. <para>Range: 1 - 65535.</para>
  288. <para>Type: integer.</para>
  289. <para>
  290. </para>
  291. </section>
  292. </chapter>