Skip to content

L
libzmq
Commit 4315467d authored by Sergey KHripchenko's avatar Sergey KHripchenko
Browse files
Options

documentation trimmed down to be just placeholders for who knows english better than me

parent 4b303402
Hide whitespace changes
Inline Side-by-side
Showing with 40 additions and 76 deletions
doc/zmq_getsockopt.txt
View file @ 4315467d
...@@ -404,66 +404,48 @@ Option value unit:: N/A ...@@ -404,66 +404,48 @@ Option value unit:: N/A
Default value:: NULL Default value:: NULL
Applicable socket types:: all, when binding TCP or IPC transports Applicable socket types:: all, when binding TCP or IPC transports
ZMQ_TCP_KEEPALIVE: Retrieve override TCP keepalives flag ZMQ_TCP_KEEPALIVE: Override SO_KEEPALIVE socket option
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Retrieve override OS TCP keepalives on/off flag (maps to SO_KEEPALIVE socket option). Override 'SO_KEEPALIVE' socket option(where supported by OS).
When equal to `1`(or `0`) TCP keepalives will be turned on(or off) for each new TCP connection The default value of `-1` means to skip any overrides and leave it to OS default.
of ZeroMQ socket, `-1` value disables TCP keepalives adjustments.
If the host OS does not support it then setsockopt() call will return `0` but leave this option equal to `-1`.
TCP keepalives are zero-length TCP packets automatically generated by OS
and transparrent to application socket, used to update state of TCP connection.
This also can be used to prevent the infrastructure (VPNs, NATs and similar) to terminate
connections with no activity.
[horizontal] [horizontal]
Option value type:: int Option value type:: int
Option value unit:: -1,0,1 Option value unit:: -1,0,1
Default value:: -1 (leave for OS default) Default value:: -1 (leave to OS default)
Applicable socket types:: all, when using TCP transports. Applicable socket types:: all, when using TCP transports.
ZMQ_TCP_KEEPALIVE_IDLE: <dont know how to summarize it> ZMQ_TCP_KEEPALIVE_IDLE: Override TCP_KEEPCNT(or TCP_KEEPALIVE on some OS)
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Retrieve option value to override the interval between the last data packet sent over Override 'TCP_KEEPCNT'(or 'TCP_KEEPALIVE' on some OS) socket option(where supported by OS).
the TCP socket and the first keepalive probe (maps to TCP_KEEPCNT or TCP_KEEPALIVE socket option). The default value of `-1` means to skip any overrides and leave it to OS default.
Default value `-1` disables adjustment.
If the host OS does not support it then setsockopt() call will return `0` but leave this option equal to `-1`.
[horizontal] [horizontal]
Option value type:: int Option value type:: int
Option value unit:: -1,>0 Option value unit:: -1,>0
Default value:: -1 (leave for OS default) Default value:: -1 (leave to OS default)
Applicable socket types:: all, when using TCP transports. Applicable socket types:: all, when using TCP transports.
ZMQ_TCP_KEEPALIVE_CNT: <dont know how to summarize it> ZMQ_TCP_KEEPALIVE_CNT: Override TCP_KEEPCNT socket option
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Retrieve option value to override the number of unacknowledged keepalive probes Override 'TCP_KEEPCNT' socket option(where supported by OS).
to send over the TCP socket before considering the connection dead and notifying The default value of `-1` means to skip any overrides and leave it to OS default.
the application ZeroMQ layer (maps to TCP_KEEPCNT socket option).
Default value `-1` disables adjustment.
If the host OS does not support it then setsockopt() call will return `0` but leave this option equal to `-1`.
[horizontal] [horizontal]
Option value type:: int Option value type:: int
Option value unit:: -1,>0 Option value unit:: -1,>0
Default value:: -1 (leave for OS default) Default value:: -1 (leave to OS default)
Applicable socket types:: all, when using TCP transports. Applicable socket types:: all, when using TCP transports.
ZMQ_TCP_KEEPALIVE_INTVL: <dont know how to summarize it> ZMQ_TCP_KEEPALIVE_INTVL: Override TCP_KEEPINTVL socket option
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Retrieve option value to override the interval between subsequential keepalive probes, Override 'TCP_KEEPINTVL' socket option(where supported by OS).
regardless of what the TCP connection has exchanged in the meantime The default value of `-1` means to skip any overrides and leave it to OS default.
(maps to TCP_KEEPINTVL socket option).
Default value `-1` disables adjustment.
If the host OS does not support it then setsockopt() call will return `0` but leave this option equal to `-1`.
[horizontal] [horizontal]
Option value type:: int Option value type:: int
Option value unit:: -1,>0 Option value unit:: -1,>0
Default value:: -1 (leave for OS default) Default value:: -1 (leave to OS default)
Applicable socket types:: all, when using TCP transports. Applicable socket types:: all, when using TCP transports.
......
doc/zmq_setsockopt.txt
View file @ 4315467d
...@@ -367,69 +367,51 @@ Default value:: 0 (false) ...@@ -367,69 +367,51 @@ Default value:: 0 (false)
Applicable socket types:: ZMQ_ROUTER Applicable socket types:: ZMQ_ROUTER
ZMQ_TCP_KEEPALIVE: Set TCP keepalives flag ZMQ_TCP_KEEPALIVE: Override SO_KEEPALIVE socket option
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Sets the option to override TCP keepalives on/off flag (maps to SO_KEEPALIVE socket option). Override 'SO_KEEPALIVE' socket option(where supported by OS).
When set to `1`(or `0`) TCP keepalives will be turned on(or off) for each new TCP connection The default value of `-1` means to skip any overrides and leave it to OS default.
of ZeroMQ socket, `-1` value disables TCP keepalives adjustments.
If the host OS does not support it then setsockopt() call will return `0` but leave this option equal to `-1`.
TCP keepalives are zero-length TCP packets automatically generated by OS
and transparrent to application socket, used to update state of TCP connection.
This also can be used to prevent the infrastructure (VPNs, NATs and similar) to terminate
connections with no activity.
[horizontal] [horizontal]
Option value type:: int Option value type:: int
Option value unit:: -1,0,1 Option value unit:: -1,0,1
Default value:: -1 (leave for OS default) Default value:: -1 (leave to OS default)
Applicable socket types:: all, when using TCP transports. Applicable socket types:: all, when using TCP transports.
ZMQ_TCP_KEEPALIVE_IDLE: <dont know how to summarize it> ZMQ_TCP_KEEPALIVE_IDLE: Override TCP_KEEPCNT(or TCP_KEEPALIVE on some OS)
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Sets option value to override the interval between the last data packet sent over Override 'TCP_KEEPCNT'(or 'TCP_KEEPALIVE' on some OS) socket option(where supported by OS).
the TCP socket and the first keepalive probe (maps to TCP_KEEPCNT or TCP_KEEPALIVE socket option). The default value of `-1` means to skip any overrides and leave it to OS default.
Default value `-1` disables adjustment.
If the host OS does not support it then setsockopt() call will return `0` but leave this option equal to `-1`.
[horizontal] [horizontal]
Option value type:: int Option value type:: int
Option value unit:: -1,>0 Option value unit:: -1,>0
Default value:: -1 (leave for OS default) Default value:: -1 (leave to OS default)
Applicable socket types:: all, when using TCP transports. Applicable socket types:: all, when using TCP transports.
ZMQ_TCP_KEEPALIVE_CNT: <dont know how to summarize it> ZMQ_TCP_KEEPALIVE_CNT: Override TCP_KEEPCNT socket option
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Sets option value to override the number of unacknowledged keepalive probes Override 'TCP_KEEPCNT' socket option(where supported by OS).
to send over the TCP socket before considering the connection dead and notifying The default value of `-1` means to skip any overrides and leave it to OS default.
the application ZeroMQ layer (maps to TCP_KEEPCNT socket option).
Default value `-1` disables adjustment.
If the host OS does not support it then setsockopt() call will return `0` but leave this option equal to `-1`.
[horizontal] [horizontal]
Option value type:: int Option value type:: int
Option value unit:: -1,>0 Option value unit:: -1,>0
Default value:: -1 (leave for OS default) Default value:: -1 (leave to OS default)
Applicable socket types:: all, when using TCP transports. Applicable socket types:: all, when using TCP transports.
ZMQ_TCP_KEEPALIVE_INTVL: <dont know how to summarize it> ZMQ_TCP_KEEPALIVE_INTVL: Override TCP_KEEPINTVL socket option
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Sets option value to override the interval between subsequential keepalive probes, Override 'TCP_KEEPINTVL' socket option(where supported by OS).
regardless of what the TCP connection has exchanged in the meantime The default value of `-1` means to skip any overrides and leave it to OS default.
(maps to TCP_KEEPINTVL socket option).
Default value `-1` disables adjustment.
If the host OS does not support it then setsockopt() call will return `0` but leave this option equal to `-1`.
[horizontal] [horizontal]
Option value type:: int Option value type:: int
Option value unit:: -1,>0 Option value unit:: -1,>0
Default value:: -1 (leave for OS default) Default value:: -1 (leave to OS default)
Applicable socket types:: all, when using TCP transports. Applicable socket types:: all, when using TCP transports.
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment