generic-library/libzmq
1
0
Fork 0
mirror of https://github.com/zeromq/libzmq.git synced 2024-12-13 18:55:10 +01:00
Code Issues Projects Releases Wiki Activity

Problem: docs for ZMQ_RECONNECT_IVL_MAX are stubs

Browse Source 
Solution: write them now that the option is back
This commit is contained in:
Luca Boccassi 2023-06-06 18:02:05 +01:00
parent 346907065f
commit 5bf04ee2ff
2 changed files with 34 additions and 10 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

22
doc/zmq_getsockopt.txt
View File

@ -619,11 +619,23 @@ Default value:: 100
Applicable socket types:: all, only for connection-oriented transports Applicable socket types:: all, only for connection-oriented transports
ZMQ_RECONNECT_IVL_MAX: DEPRECATED ZMQ_RECONNECT_IVL_MAX: Retrieve max reconnection interval
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
The 'ZMQ_RECONNECT_IVL_MAX option is an empty stub that only returns an The 'ZMQ_RECONNECT_IVL_MAX' option shall retrieve the max reconnection interval
*EOPNOTSUPP* error, as the author did not provide a relicense agreement for for the specified 'socket'. 0MQ shall wait at most the configured interval between
the Mozilla Public License v2 relicense of libzmq. reconnection attempts. The interval grows exponentionally (i.e.: it is doubled)
with each attempt until it reaches ZMQ_RECONNECT_IVL_MAX. Default value means
that the reconnect interval is based exclusively on ZMQ_RECONNECT_IVL and no
exponential backoff is performed.
NOTE: Value has to be greater or equal than ZMQ_RECONNECT_IVL, or else it will
be ignored.
[horizontal]
Option value type:: int
Option value unit:: milliseconds
Default value:: 0 (ZMQ_RECONNECT_IVL will be used)
Applicable socket types:: all, only for connection-oriented transport
ZMQ_RECONNECT_STOP: Retrieve condition where reconnection will stop ZMQ_RECONNECT_STOP: Retrieve condition where reconnection will stop

22
doc/zmq_setsockopt.txt
View File

@ -750,11 +750,23 @@ Default value:: 100
Applicable socket types:: all, only for connection-oriented transports Applicable socket types:: all, only for connection-oriented transports
ZMQ_RECONNECT_IVL_MAX: DEPRECATED ZMQ_RECONNECT_IVL_MAX: Set max reconnection interval
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
The 'ZMQ_RECONNECT_IVL_MAX option is an empty stub that only returns an The 'ZMQ_RECONNECT_IVL_MAX' option shall set the max reconnection interval for
*EOPNOTSUPP* error, as the author did not provide a relicense agreement for the specified 'socket'. 0MQ shall wait at most the configured interval between
the Mozilla Public License v2 relicense of libzmq. reconnection attempts. The interval grows exponentionally (i.e.: it is doubled)
with each attempt until it reaches ZMQ_RECONNECT_IVL_MAX. Default value means
that the reconnect interval is based exclusively on ZMQ_RECONNECT_IVL and no
exponential backoff is performed.
NOTE: Value has to be greater or equal than ZMQ_RECONNECT_IVL, or else it will
be ignored.
[horizontal]
Option value type:: int
Option value unit:: milliseconds
Default value:: 0 (ZMQ_RECONNECT_IVL will be used)
Applicable socket types:: all, only for connection-oriented transports
ZMQ_RECONNECT_STOP: Set condition where reconnection will stop ZMQ_RECONNECT_STOP: Set condition where reconnection will stop