diff --git a/doc/zmq_getsockopt.txt b/doc/zmq_getsockopt.txt index 91b95f51..e418d124 100644 --- a/doc/zmq_getsockopt.txt +++ b/doc/zmq_getsockopt.txt @@ -404,66 +404,48 @@ Option value unit:: N/A Default value:: NULL Applicable socket types:: all, when binding TCP or IPC transports -ZMQ_TCP_KEEPALIVE: Retrieve override TCP keepalives flag -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -Retrieve override OS TCP keepalives on/off flag (maps to SO_KEEPALIVE socket option). -When equal to `1`(or `0`) TCP keepalives will be turned on(or off) for each new TCP connection -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. +ZMQ_TCP_KEEPALIVE: Override SO_KEEPALIVE socket option +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +Override 'SO_KEEPALIVE' socket option(where supported by OS). +The default value of `-1` means to skip any overrides and leave it to OS default. [horizontal] Option value type:: int 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. -ZMQ_TCP_KEEPALIVE_IDLE: -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -Retrieve option value to override the interval between the last data packet sent over -the TCP socket and the first keepalive probe (maps to TCP_KEEPCNT or TCP_KEEPALIVE 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`. +ZMQ_TCP_KEEPALIVE_IDLE: Override TCP_KEEPCNT(or TCP_KEEPALIVE on some OS) +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +Override 'TCP_KEEPCNT'(or 'TCP_KEEPALIVE' on some OS) socket option(where supported by OS). +The default value of `-1` means to skip any overrides and leave it to OS default. [horizontal] Option value type:: int 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. -ZMQ_TCP_KEEPALIVE_CNT: -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -Retrieve option value to override the number of unacknowledged keepalive probes -to send over the TCP socket before considering the connection dead and notifying -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`. +ZMQ_TCP_KEEPALIVE_CNT: Override TCP_KEEPCNT socket option +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +Override 'TCP_KEEPCNT' socket option(where supported by OS). +The default value of `-1` means to skip any overrides and leave it to OS default. [horizontal] Option value type:: int 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. -ZMQ_TCP_KEEPALIVE_INTVL: -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -Retrieve option value to override the interval between subsequential keepalive probes, -regardless of what the TCP connection has exchanged in the meantime -(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`. +ZMQ_TCP_KEEPALIVE_INTVL: Override TCP_KEEPINTVL socket option +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +Override 'TCP_KEEPINTVL' socket option(where supported by OS). +The default value of `-1` means to skip any overrides and leave it to OS default. [horizontal] Option value type:: int 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. diff --git a/doc/zmq_setsockopt.txt b/doc/zmq_setsockopt.txt index e0217fc6..9cc0a6d0 100644 --- a/doc/zmq_setsockopt.txt +++ b/doc/zmq_setsockopt.txt @@ -367,69 +367,51 @@ Default value:: 0 (false) Applicable socket types:: ZMQ_ROUTER -ZMQ_TCP_KEEPALIVE: Set TCP keepalives flag -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -Sets the option to override TCP keepalives on/off flag (maps to SO_KEEPALIVE socket option). -When set to `1`(or `0`) TCP keepalives will be turned on(or off) for each new TCP connection -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. +ZMQ_TCP_KEEPALIVE: Override SO_KEEPALIVE socket option +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +Override 'SO_KEEPALIVE' socket option(where supported by OS). +The default value of `-1` means to skip any overrides and leave it to OS default. [horizontal] Option value type:: int 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. -ZMQ_TCP_KEEPALIVE_IDLE: -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -Sets option value to override the interval between the last data packet sent over -the TCP socket and the first keepalive probe (maps to TCP_KEEPCNT or TCP_KEEPALIVE 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`. +ZMQ_TCP_KEEPALIVE_IDLE: Override TCP_KEEPCNT(or TCP_KEEPALIVE on some OS) +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +Override 'TCP_KEEPCNT'(or 'TCP_KEEPALIVE' on some OS) socket option(where supported by OS). +The default value of `-1` means to skip any overrides and leave it to OS default. [horizontal] Option value type:: int 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. -ZMQ_TCP_KEEPALIVE_CNT: -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -Sets option value to override the number of unacknowledged keepalive probes -to send over the TCP socket before considering the connection dead and notifying -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`. +ZMQ_TCP_KEEPALIVE_CNT: Override TCP_KEEPCNT socket option +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +Override 'TCP_KEEPCNT' socket option(where supported by OS). +The default value of `-1` means to skip any overrides and leave it to OS default. [horizontal] Option value type:: int 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. -ZMQ_TCP_KEEPALIVE_INTVL: -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -Sets option value to override the interval between subsequential keepalive probes, -regardless of what the TCP connection has exchanged in the meantime -(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`. +ZMQ_TCP_KEEPALIVE_INTVL: Override TCP_KEEPINTVL socket option +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +Override 'TCP_KEEPINTVL' socket option(where supported by OS). +The default value of `-1` means to skip any overrides and leave it to OS default. [horizontal] Option value type:: int 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.