diff options
Diffstat (limited to 'doc/zmq_getsockopt.txt')
| -rw-r--r-- | doc/zmq_getsockopt.txt | 17 |
1 files changed, 10 insertions, 7 deletions
diff --git a/doc/zmq_getsockopt.txt b/doc/zmq_getsockopt.txt index 7886eaf..1e36a2a 100644 --- a/doc/zmq_getsockopt.txt +++ b/doc/zmq_getsockopt.txt @@ -20,7 +20,7 @@ specified by the 'option_name' argument for the 0MQ socket pointed to by the 'socket' argument, and store it in the buffer pointed to by the 'option_value' argument. The 'option_len' argument is the size in bytes of the buffer pointed to by 'option_value'; upon successful completion _zmq_getsockopt()_ shall -modify the 'option_value' argument to indicate the actual size of the option +modify the 'option_len' argument to indicate the actual size of the option value stored in the buffer. The following options can be retrieved with the _zmq_getsockopt()_ function: @@ -60,7 +60,7 @@ type. The default 'ZMQ_HWM' value of zero means "no limit". [horizontal] -Option value type:: int64_t +Option value type:: uint64_t Option value unit:: messages Default value:: 0 Applicable socket types:: all @@ -99,7 +99,7 @@ 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 type:: uint64_t Option value unit:: N/A (bitmap) Default value:: 0 Applicable socket types:: N/A @@ -134,7 +134,7 @@ 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 type:: int64_t Option value unit:: kilobits per second Default value:: 100 Applicable socket types:: all, when using multicast transports @@ -148,7 +148,7 @@ 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 type:: int64_t Option value unit:: seconds Default value:: 10 Applicable socket types:: all, when using multicast transports @@ -165,7 +165,7 @@ on performance. Where possible, disable 'ZMQ_MCAST_LOOP' in production environments. [horizontal] -Option value type:: uint64_t +Option value type:: int64_t Option value unit:: boolean Default value:: 1 Applicable socket types:: all, when using multicast transports @@ -214,6 +214,8 @@ _option_value_, as specified by _option_len_, is insufficient for storing the option value. *ETERM*:: The 0MQ 'context' associated with the specified 'socket' was terminated. +*EFAULT*:: +The provided 'socket' was not valid (NULL). EXAMPLE @@ -222,7 +224,8 @@ EXAMPLE ---- /* Retrieve high water mark into hwm */ int64_t hwm; -rc = zmq_getsockopt (socket, ZMQ_HWM, &hwm, sizeof hwm); +size_t hwm_size = sizeof (hwm); +rc = zmq_getsockopt (socket, ZMQ_HWM, &hwm, &hwm_size); assert (rc == 0); ---- |