diff options
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/zmq_bind.txt | 2 | ||||
| -rw-r--r-- | doc/zmq_close.txt | 3 | ||||
| -rw-r--r-- | doc/zmq_connect.txt | 2 | ||||
| -rw-r--r-- | doc/zmq_device.txt | 13 | ||||
| -rw-r--r-- | doc/zmq_getsockopt.txt | 2 | ||||
| -rw-r--r-- | doc/zmq_poll.txt | 2 | ||||
| -rw-r--r-- | doc/zmq_recv.txt | 2 | ||||
| -rw-r--r-- | doc/zmq_send.txt | 2 | ||||
| -rw-r--r-- | doc/zmq_setsockopt.txt | 2 | ||||
| -rw-r--r-- | doc/zmq_socket.txt | 3 | ||||
| -rw-r--r-- | doc/zmq_term.txt | 3 |
11 files changed, 31 insertions, 5 deletions
diff --git a/doc/zmq_bind.txt b/doc/zmq_bind.txt index 2678ca6..5eb1bcf 100644 --- a/doc/zmq_bind.txt +++ b/doc/zmq_bind.txt @@ -61,6 +61,8 @@ The requested 'address' was not local. The requested 'address' specifies a nonexistent interface. *ETERM*:: The 0MQ 'context' associated with the specified 'socket' was terminated. +*EFAULT*:: +The provided 'socket' was not valid (NULL). EXAMPLE diff --git a/doc/zmq_close.txt b/doc/zmq_close.txt index a1f835e..7936fca 100644 --- a/doc/zmq_close.txt +++ b/doc/zmq_close.txt @@ -31,7 +31,8 @@ return `-1` and set 'errno' to one of the values defined below. ERRORS ------ -No errors are defined. +*EFAULT*:: +The provided 'socket' was not valid (NULL). SEE ALSO diff --git a/doc/zmq_connect.txt b/doc/zmq_connect.txt index 6121493..5634bbf 100644 --- a/doc/zmq_connect.txt +++ b/doc/zmq_connect.txt @@ -59,6 +59,8 @@ The requested 'transport' protocol is not supported. The requested 'transport' protocol is not compatible with the socket type. *ETERM*:: The 0MQ 'context' associated with the specified 'socket' was terminated. +*EFAULT*:: +The provided 'socket' was not valid (NULL). EXAMPLE diff --git a/doc/zmq_device.txt b/doc/zmq_device.txt index 45d4052..d5d7a18 100644 --- a/doc/zmq_device.txt +++ b/doc/zmq_device.txt @@ -89,8 +89,17 @@ Refer to linkzmq:zmq_socket[3] for a description of these socket types. RETURN VALUE ------------ -The _zmq_device()_ function always returns `-1` and 'errno' set to *ETERM* (the -0MQ 'context' associated with either of the specified sockets was terminated). +The _zmq_device()_ function shall not return if successful. Otherwise it shall +return `-1` and set 'errno' to one of the values defined below. + + +ERRORS +------ +*ETERM*:: +The 0MQ 'context' associated with the specified 'frontend' or 'backend' was +terminated. +*EFAULT*:: +The provided 'frontend' or 'backend' was not valid (NULL). EXAMPLE diff --git a/doc/zmq_getsockopt.txt b/doc/zmq_getsockopt.txt index 3f131ba..0a2d51e 100644 --- a/doc/zmq_getsockopt.txt +++ b/doc/zmq_getsockopt.txt @@ -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 diff --git a/doc/zmq_poll.txt b/doc/zmq_poll.txt index 9761881..2648ad7 100644 --- a/doc/zmq_poll.txt +++ b/doc/zmq_poll.txt @@ -96,6 +96,8 @@ to a different application thread. *ETERM*:: At least one of the members of the 'items' array refers to a 'socket' whose associated 0MQ 'context' was terminated. +*EFAULT*:: +The provided 'items' was not valid (NULL). EXAMPLE diff --git a/doc/zmq_recv.txt b/doc/zmq_recv.txt index 8aba42a..5a7ec1b 100644 --- a/doc/zmq_recv.txt +++ b/doc/zmq_recv.txt @@ -63,6 +63,8 @@ socket types that switch between several states, such as ZMQ_REP. See the _messaging patterns_ section of linkzmq:zmq_socket[3] for more information. *ETERM*:: The 0MQ 'context' associated with the specified 'socket' was terminated. +*EFAULT*:: +The provided 'socket' was not valid (NULL). EXAMPLE diff --git a/doc/zmq_send.txt b/doc/zmq_send.txt index 37524c8..ace4a66 100644 --- a/doc/zmq_send.txt +++ b/doc/zmq_send.txt @@ -69,6 +69,8 @@ socket types that switch between several states, such as ZMQ_REP. See the _messaging patterns_ section of linkzmq:zmq_socket[3] for more information. *ETERM*:: The 0MQ 'context' associated with the specified 'socket' was terminated. +*EFAULT*:: +The provided 'context' was not valid (NULL). EXAMPLE diff --git a/doc/zmq_setsockopt.txt b/doc/zmq_setsockopt.txt index c612247..0106f8f 100644 --- a/doc/zmq_setsockopt.txt +++ b/doc/zmq_setsockopt.txt @@ -229,6 +229,8 @@ The requested option _option_name_ is unknown, or the requested _option_len_ or _option_value_ is invalid. *ETERM*:: The 0MQ 'context' associated with the specified 'socket' was terminated. +*EFAULT*:: +The provided 'socket' was not valid (NULL). EXAMPLE diff --git a/doc/zmq_socket.txt b/doc/zmq_socket.txt index 7f0ac4e..7d78366 100644 --- a/doc/zmq_socket.txt +++ b/doc/zmq_socket.txt @@ -242,9 +242,10 @@ ERRORS ------ *EINVAL*:: The requested socket 'type' is invalid. - *EMTHREAD*:: The maximum number of sockets within this 'context' has been exceeded. +*EFAULT*:: +The provided 'context' was not valid (NULL). SEE ALSO diff --git a/doc/zmq_term.txt b/doc/zmq_term.txt index 546c7a6..10455dd 100644 --- a/doc/zmq_term.txt +++ b/doc/zmq_term.txt @@ -43,7 +43,8 @@ return `-1` and set 'errno' to one of the values defined below. ERRORS ------ -No errors are defined. +*EFAULT*:: +The provided 'context' was not valid (NULL). SEE ALSO |