generic-library/libzmq
1
0
Fork 0
mirror of https://github.com/zeromq/libzmq.git synced 2025-01-06 00:31:13 +01:00
Code Issues Projects Releases Wiki Activity

Merge pull request #1475 from jimenezrick/fix-doc-setsockopt

Browse Source 
Fix doc formatting issues in zmq_setsockopt page
This commit is contained in:
Pieter Hintjens 2015-07-19 14:19:57 +02:00
commit 15e35c52e7
1 changed files with 10 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

14
doc/zmq_setsockopt.txt
View File

@ -246,6 +246,7 @@ Option value unit:: milliseconds
Default value:: 30000 Default value:: 30000
Applicable socket types:: all but ZMQ_STREAM, only for connection-oriented transports Applicable socket types:: all but ZMQ_STREAM, only for connection-oriented transports
ZMQ_HEARTBEAT_IVL: Set interval between sending ZMTP heartbeats ZMQ_HEARTBEAT_IVL: Set interval between sending ZMTP heartbeats
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
The 'ZMQ_HEARTBEAT_IVL' option shall set the interval between sending ZMTP heartbeats The 'ZMQ_HEARTBEAT_IVL' option shall set the interval between sending ZMTP heartbeats
@ -258,6 +259,7 @@ Option value unit:: milliseconds
Default value:: 0 Default value:: 0
Applicable socket types:: all, when using connection-oriented transports Applicable socket types:: all, when using connection-oriented transports
ZMQ_HEARTBEAT_TIMEOUT: Set timeout for ZMTP heartbeats ZMQ_HEARTBEAT_TIMEOUT: Set timeout for ZMTP heartbeats
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
The 'ZMQ_HEARTBEAT_TIMEOUT' option shall set how long to wait before timing-out a The 'ZMQ_HEARTBEAT_TIMEOUT' option shall set how long to wait before timing-out a
@ -273,6 +275,7 @@ Option value unit:: milliseconds
Default value:: 0 Default value:: 0
Applicable socket types:: all, when using connection-oriented transports Applicable socket types:: all, when using connection-oriented transports
ZMQ_HEARTBEAT_TTL: Set the TTL value for ZMTP heartbeats ZMQ_HEARTBEAT_TTL: Set the TTL value for ZMTP heartbeats
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
The 'ZMQ_HEARTBEAT_TTL' option shall set the timeout on the remote peer for ZMTP The 'ZMQ_HEARTBEAT_TTL' option shall set the timeout on the remote peer for ZMTP
@ -288,6 +291,7 @@ Option value unit:: milliseconds
Default value:: 0 Default value:: 0
Applicable socket types:: all, when using connection-oriented transports Applicable socket types:: all, when using connection-oriented transports
ZMQ_IDENTITY: Set socket identity ZMQ_IDENTITY: Set socket identity
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
The 'ZMQ_IDENTITY' option shall set the identity of the specified 'socket' The 'ZMQ_IDENTITY' option shall set the identity of the specified 'socket'
@ -834,9 +838,9 @@ Option value unit:: 0, 1
Default value:: 0 Default value:: 0
Applicable socket types:: ZMQ_XPUB Applicable socket types:: ZMQ_XPUB
ZMQ_XPUB_MANUAL: change the subscription handling to manual
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
ZMQ_XPUB_MANUAL: change the subscription handling to manual
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Sets the 'XPUB' socket subscription handling mode manual/automatic. Sets the 'XPUB' socket subscription handling mode manual/automatic.
A value of '0' is the default and subscription requests will be handled automatically. A value of '0' is the default and subscription requests will be handled automatically.
A value of '1' will change the subscription requests handling to manual, A value of '1' will change the subscription requests handling to manual,
@ -849,6 +853,7 @@ Option value unit:: 0, 1
Default value:: 0 Default value:: 0
Applicable socket types:: ZMQ_XPUB Applicable socket types:: ZMQ_XPUB
ZMQ_XPUB_NODROP: do not silently drop messages if SENDHWM is reached ZMQ_XPUB_NODROP: do not silently drop messages if SENDHWM is reached
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Sets the 'XPUB' socket behaviour to return error EAGAIN if SENDHWM is Sets the 'XPUB' socket behaviour to return error EAGAIN if SENDHWM is
@ -864,9 +869,9 @@ Option value unit:: 0, 1
Default value:: 0 Default value:: 0
Applicable socket types:: ZMQ_XPUB, ZMQ_PUB Applicable socket types:: ZMQ_XPUB, ZMQ_PUB
ZMQ_WELCOME_MSG: set welcome message that will be received by subscriber when connecting
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
ZMQ_WELCOME_MSG: set welcome message that will be received by subscriber when connecting
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Sets a welcome message the will be recieved by subscriber when connecting. Sets a welcome message the will be recieved by subscriber when connecting.
Subscriber must subscribe to the Welcome message before connecting. Subscriber must subscribe to the Welcome message before connecting.
Welcome message will also be sent on reconnecting. Welcome message will also be sent on reconnecting.
@ -880,6 +885,7 @@ Option value unit:: N/A
Default value:: NULL Default value:: NULL
Applicable socket types:: ZMQ_XPUB Applicable socket types:: ZMQ_XPUB
ZMQ_ZAP_DOMAIN: Set RFC 27 authentication domain ZMQ_ZAP_DOMAIN: Set RFC 27 authentication domain
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Sets the domain for ZAP (ZMQ RFC 27) authentication. For NULL security (the Sets the domain for ZAP (ZMQ RFC 27) authentication. For NULL security (the