diff options
author | Martin Lucina <mato@kotelna.sk> | 2010-06-03 14:08:36 +0200 |
---|---|---|
committer | Martin Lucina <mato@kotelna.sk> | 2010-06-03 14:08:36 +0200 |
commit | 8076fd1a3abece7dc91c2b2309dd0ecba57e882f (patch) | |
tree | 8000d6fede387260fc0759682d5e3ed32a875e6c /doc | |
parent | 7c9b09bc511236c8cc5f6cea7623a8b98fedf302 (diff) |
Documentation: zmq_errno(3)
Diffstat (limited to 'doc')
-rw-r--r-- | doc/Makefile.am | 2 | ||||
-rw-r--r-- | doc/zmq.txt | 9 | ||||
-rw-r--r-- | doc/zmq_errno.txt | 50 |
3 files changed, 57 insertions, 4 deletions
diff --git a/doc/Makefile.am b/doc/Makefile.am index 0a76e3b..3c7b20b 100644 --- a/doc/Makefile.am +++ b/doc/Makefile.am @@ -3,7 +3,7 @@ MAN3 = zmq_bind.3 zmq_close.3 zmq_connect.3 zmq_init.3 \ zmq_msg_close.3 zmq_msg_copy.3 zmq_msg_data.3 zmq_msg_init.3 \ zmq_msg_init_data.3 zmq_msg_init_size.3 zmq_msg_move.3 zmq_msg_size.3 \ zmq_poll.3 zmq_recv.3 zmq_send.3 zmq_setsockopt.3 zmq_socket.3 \ - zmq_strerror.3 zmq_term.3 zmq_version.3 zmq_getsockopt.3 + zmq_strerror.3 zmq_term.3 zmq_version.3 zmq_getsockopt.3 zmq_errno.3 MAN7 = zmq.7 zmq_tcp.7 zmq_pgm.7 zmq_epgm.7 zmq_inproc.7 zmq_ipc.7 \ zmq_cpp.7 MAN_DOC = $(MAN1) $(MAN3) $(MAN7) diff --git a/doc/zmq.txt b/doc/zmq.txt index 2d7f1c8..d13f572 100644 --- a/doc/zmq.txt +++ b/doc/zmq.txt @@ -164,9 +164,12 @@ shall return either a NULL value (if returning a pointer) or a negative value (if returning an integer), and the actual error code shall be stored in the 'errno' variable. -A _zmq_strerror()_ function is provided to translate 0MQ-specific error codes -into error message strings. For further details refer to -linkzmq:zmq_strerror[3]. +On non-POSIX systems some users may experience issues with retrieving the +correct value of the 'errno' variable. The _zmq_errno()_ function is provided +to assist in these cases; for details refer to linkzmq:zmq_errno[3]. + +The _zmq_strerror()_ function is provided to translate 0MQ-specific error codes +into error message strings; for details refer to linkzmq:zmq_strerror[3]. MISCELLANEOUS diff --git a/doc/zmq_errno.txt b/doc/zmq_errno.txt new file mode 100644 index 0000000..61939a5 --- /dev/null +++ b/doc/zmq_errno.txt @@ -0,0 +1,50 @@ +zmq_errno(3) +============ + + +NAME +---- +zmq_errno - retrieve value of errno for the calling thread + + +SYNOPSIS +-------- +*int zmq_errno (void);* + + +DESCRIPTION +----------- +The _zmq_errno()_ function shall retrieve the value of the 'errno' variable for +the calling thread. + +The _zmq_errno()_ function is provided to assist users on non-POSIX systems who +are experiencing issues with retrieving the correct value of 'errno' directly. +Specifically, users on Win32 systems whose application is using a different C +runtime library from the C runtime library in use by 0MQ will need to use +_zmq_errno()_ for correct operation. + +IMPORTANT: Users not experiencing issues with retrieving the correct value of +'errno' should not use this function and should instead access the 'errno' +variable directly. + + +RETURN VALUE +------------ +The _zmq_errno()_ function shall return the value of the 'errno' variable for +the calling thread. + + +ERRORS +------ +No errors are defined. + + +SEE ALSO +-------- +linkzmq:zmq[7] + + +AUTHORS +------- +The 0MQ documentation was written by Martin Sustrik <sustrik@250bpm.com> and +Martin Lucina <mato@kotelna.sk>. |