diff options
author | Martin Lucina <mato@kotelna.sk> | 2010-03-09 18:47:31 +0100 |
---|---|---|
committer | Martin Lucina <mato@kotelna.sk> | 2010-03-09 18:47:31 +0100 |
commit | 1aee86408d575d6572b071d7564da7f006d1757e (patch) | |
tree | 98d54989b5961db8c458017034bfb8f981e98c8f /doc/zmq_term.txt | |
parent | d790940fd06060c8a2c624b0e41e470ad31ae0d8 (diff) |
Documentation rewrite
Diffstat (limited to 'doc/zmq_term.txt')
-rw-r--r-- | doc/zmq_term.txt | 33 |
1 files changed, 14 insertions, 19 deletions
diff --git a/doc/zmq_term.txt b/doc/zmq_term.txt index 451c1ac..eea9f48 100644 --- a/doc/zmq_term.txt +++ b/doc/zmq_term.txt @@ -4,25 +4,27 @@ zmq_term(3) NAME ---- -zmq_term - terminates 0MQ context +zmq_term - terminate 0MQ context SYNOPSIS -------- -'int zmq_term (void *context);' +*int zmq_term (void '*context');* DESCRIPTION ----------- -Destroys 0MQ context. However, if there are still any sockets open within -the context, 'zmq_term' succeeds but shutdown of the context is delayed till -the last socket is closed. +The _zmq_term()_ function terminates the 0MQ context 'context'. + +If there are still sockets open within 'context' at the time _zmq_term()_ is +called the call will succeed but the actual shutdown of 'context' will be +delayed until the last socket within it is closed. RETURN VALUE ------------ -Function returns zero is successful. Otherwise it returns -1 and sets errno to -one of the values below. +The _zmq_term()_ function shall return zero if successful. Otherwise it shall +return -1 and set 'errno' to one of the values defined below. ERRORS @@ -30,20 +32,13 @@ ERRORS No errors are defined. -EXAMPLE -------- ----- -int rc = zmq_term (context); -assert (rc == 0); ----- - - SEE ALSO -------- +linkzmq:zmq[7] linkzmq:zmq_init[3] -linkzmq:zmq_close[3] -AUTHOR ------- -Martin Sustrik <sustrik at 250bpm dot com> +AUTHORS +------- +The 0MQ documentation was written by Martin Sustrik <sustrik@250bpm.com> and +Martin Lucina <mato@kotelna.sk>. |