Mercurial > hg > nginx-site

comparison xml/en/docs/stream/ngx_stream_core_module.xml @ 1742:c511b73da3a9

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Documented variables in ngx_stream_core_module.
author Yaroslav Zhuravlev <yar@nginx.com>
date Tue, 05 Jul 2016 17:58:34 +0300
parents a99ebc3af3e4
children 256774f145ac
comparison
equal deleted inserted replaced
1741:a99ebc3af3e4 1742:c511b73da3a9
7 <!DOCTYPE module SYSTEM "../../../../dtd/module.dtd"> 7 <!DOCTYPE module SYSTEM "../../../../dtd/module.dtd">
8 8
9 <module name="Module ngx_stream_core_module" 9 <module name="Module ngx_stream_core_module"
10 link="/en/docs/stream/ngx_stream_core_module.html" 10 link="/en/docs/stream/ngx_stream_core_module.html"
11 lang="en" 11 lang="en"
12 rev="13"> 12 rev="14">
13 13
14 <section id="summary"> 14 <section id="summary">
15 15
16 <para> 16 <para>
17 The <literal>ngx_stream_core_module</literal> module 17 The <literal>ngx_stream_core_module</literal> module
358 358
359 </directive> 359 </directive>
360 360
361 </section> 361 </section>
362 362
363
364 <section id="variables" name="Embedded Variables">
365
366 <para>
367 The <literal>ngx_stream_core_module</literal> module supports variables
368 since 1.11.2.
369 <list type="tag">
370
371 <tag-name id="var_binary_remote_addr"><var>$binary_remote_addr</var></tag-name>
372 <tag-desc>
373 client address in a binary form, value’s length is always 4 bytes
374 for IPv4 addresses or 16 bytes for IPv6 addresses
375 </tag-desc>
376
377 <tag-name id="var_bytes_sent"><var>$bytes_sent</var></tag-name>
378 <tag-desc>
379 number of bytes sent to a client
380 </tag-desc>
381
382 <tag-name id="var_connection"><var>$connection</var></tag-name>
383 <tag-desc>
384 connection serial number
385 </tag-desc>
386
387 <tag-name id="var_hostname"><var>$hostname</var></tag-name>
388 <tag-desc>
389 host name
390 </tag-desc>
391
392 <tag-name id="var_msec"><var>$msec</var></tag-name>
393 <tag-desc>
394 current time in seconds with the milliseconds resolution
395 </tag-desc>
396
397 <tag-name id="var_nginx_version"><var>$nginx_version</var></tag-name>
398 <tag-desc>
399 nginx version
400 </tag-desc>
401
402 <tag-name id="var_pid"><var>$pid</var></tag-name>
403 <tag-desc>
404 PID of the worker process
405 </tag-desc>
406
407 <tag-name id="var_remote_addr"><var>$remote_addr</var></tag-name>
408 <tag-desc>
409 client address
410 </tag-desc>
411
412 <tag-name id="var_remote_port"><var>$remote_port</var></tag-name>
413 <tag-desc>
414 client port
415 </tag-desc>
416
417 <tag-name id="var_server_addr"><var>$server_addr</var></tag-name>
418 <tag-desc>
419 an address of the server which accepted a connection
420 <para>
421 Computing a value of this variable usually requires one system call.
422 To avoid a system call, the <link id="listen"/> directives
423 must specify addresses and use the <literal>bind</literal> parameter.
424 </para>
425 </tag-desc>
426
427 <tag-name id="var_server_port"><var>$server_port</var></tag-name>
428 <tag-desc>
429 port of the server which accepted a connection
430 </tag-desc>
431
432 <tag-name id="var_time_iso8601"><var>$time_iso8601</var></tag-name>
433 <tag-desc>
434 local time in the ISO 8601 standard format
435 </tag-desc>
436
437 <tag-name id="var_time_local"><var>$time_local</var></tag-name>
438 <tag-desc>
439 local time in the Common Log Format
440 </tag-desc>
441
442 </list>
443 </para>
444
445 </section>
446
363 </module> 447 </module>