diff options
| -rw-r--r-- | doc/zmq_getsockopt.txt | 10 | ||||
| -rw-r--r-- | doc/zmq_setsockopt.txt | 11 |
2 files changed, 21 insertions, 0 deletions
diff --git a/doc/zmq_getsockopt.txt b/doc/zmq_getsockopt.txt index f08748b..7886eaf 100644 --- a/doc/zmq_getsockopt.txt +++ b/doc/zmq_getsockopt.txt @@ -37,6 +37,7 @@ be returned. Otherwise, a value of 1 shall be returned. Refer to linkzmq:zmq_send[3] and linkzmq:zmq_recv[3] for a detailed description of sending/receiving multi-part messages. +[horizontal] Option value type:: int64_t Option value unit:: boolean Default value:: N/A @@ -58,6 +59,7 @@ type. The default 'ZMQ_HWM' value of zero means "no limit". +[horizontal] Option value type:: int64_t Option value unit:: messages Default value:: 0 @@ -73,6 +75,7 @@ offloaded to storage on disk rather than held in memory. The value of 'ZMQ_SWAP' defines the maximum size of the swap space in bytes. +[horizontal] Option value type:: int64_t Option value unit:: bytes Default value:: 0 @@ -95,6 +98,7 @@ exclusively by I/O threads 1 and 2. See also linkzmq:zmq_init[3] for details on allocating the number of I/O threads for a specific _context_. +[horizontal] Option value type:: int64_t Option value unit:: N/A (bitmap) Default value:: 0 @@ -117,6 +121,7 @@ queue_ limits shall be shared with previous run(s) and so on. Identity can be at least one byte and at most 255 bytes long. Identities starting with binary zero are reserved for use by 0MQ infrastructure. +[horizontal] Option value type:: binary data Option value unit:: N/A Default value:: NULL @@ -128,6 +133,7 @@ ZMQ_RATE: Retrieve multicast data rate The 'ZMQ_RATE' option shall retrieve the maximum send or receive data rate for multicast transports using the specified 'socket'. +[horizontal] Option value type:: uint64_t Option value unit:: kilobits per second Default value:: 100 @@ -141,6 +147,7 @@ multicast transports using the specified 'socket'. The recovery interval determines the maximum time in seconds that a receiver can be absent from a multicast group before unrecoverable data loss will occur. +[horizontal] Option value type:: uint64_t Option value unit:: seconds Default value:: 10 @@ -157,6 +164,7 @@ multicast loopback enabled when it is not required can have a negative impact on performance. Where possible, disable 'ZMQ_MCAST_LOOP' in production environments. +[horizontal] Option value type:: uint64_t Option value unit:: boolean Default value:: 1 @@ -170,6 +178,7 @@ size for the specified 'socket'. A value of zero means that the OS default is in effect. For details refer to your operating system documentation for the 'SO_SNDBUF' socket option. +[horizontal] Option value type:: uint64_t Option value unit:: bytes Default value:: 0 @@ -183,6 +192,7 @@ size for the specified 'socket'. A value of zero means that the OS default is in effect. For details refer to your operating system documentation for the 'SO_RCVBUF' socket option. +[horizontal] Option value type:: uint64_t Option value unit:: bytes Default value:: 0 diff --git a/doc/zmq_setsockopt.txt b/doc/zmq_setsockopt.txt index 93c5889..a5a2601 100644 --- a/doc/zmq_setsockopt.txt +++ b/doc/zmq_setsockopt.txt @@ -38,6 +38,7 @@ type. The default 'ZMQ_HWM' value of zero means "no limit". +[horizontal] Option value type:: int64_t Option value unit:: messages Default value:: 0 @@ -53,6 +54,7 @@ storage on disk rather than held in memory. The value of 'ZMQ_SWAP' defines the maximum size of the swap space in bytes. +[horizontal] Option value type:: int64_t Option value unit:: bytes Default value:: 0 @@ -75,6 +77,7 @@ exclusively by I/O threads 1 and 2. See also linkzmq:zmq_init[3] for details on allocating the number of I/O threads for a specific _context_. +[horizontal] Option value type:: int64_t Option value unit:: N/A (bitmap) Default value:: 0 @@ -97,6 +100,7 @@ queue_ limits shall be shared with previous run(s) and so on. Identity should be at least one byte and at most 255 bytes long. Identities starting with binary zero are reserved for use by 0MQ infrastructure. +[horizontal] Option value type:: binary data Option value unit:: N/A Default value:: NULL @@ -115,6 +119,7 @@ with the specified prefix. Mutiple filters may be attached to a single 'ZMQ_SUB' socket, in which case a message shall be accepted if it matches at least one filter. +[horizontal] Option value type:: binary data Option value unit:: N/A Default value:: N/A @@ -129,6 +134,7 @@ established with the 'ZMQ_SUBSCRIBE' option. If the socket has several instances of the same filter attached the 'ZMQ_UNSUBSCRIBE' option shall remove only one instance, leaving the rest in place and functional. +[horizontal] Option value type:: binary data Option value unit:: N/A Default value:: N/A @@ -140,6 +146,7 @@ ZMQ_RATE: Set multicast data rate The 'ZMQ_RATE' option shall set the maximum send or receive data rate for multicast transports such as linkzmq:zmq_pgm[7] using the specified 'socket'. +[horizontal] Option value type:: uint64_t Option value unit:: kilobits per second Default value:: 100 @@ -157,6 +164,7 @@ CAUTION: Excersize care when setting large recovery intervals as the data needed for recovery will be held in memory. For example, a 1 minute recovery interval at a data rate of 1Gbps requires a 7GB in-memory buffer. +[horizontal] Option value type:: uint64_t Option value unit:: seconds Default value:: 10 @@ -173,6 +181,7 @@ loopback enabled when it is not required can have a negative impact on performance. Where possible, disable 'ZMQ_MCAST_LOOP' in production environments. +[horizontal] Option value type:: uint64_t Option value unit:: boolean Default value:: 1 @@ -186,6 +195,7 @@ for the 'socket' to the specified size in bytes. A value of zero means leave the OS default unchanged. For details please refer to your operating system documentation for the 'SO_SNDBUF' socket option. +[horizontal] Option value type:: uint64_t Option value unit:: bytes Default value:: 0 @@ -199,6 +209,7 @@ the 'socket' to the specified size in bytes. A value of zero means leave the OS default unchanged. For details refer to your operating system documentation for the 'SO_RCVBUF' socket option. +[horizontal] Option value type:: uint64_t Option value unit:: bytes Default value:: 0 |