diff options
Diffstat (limited to 'man')
36 files changed, 0 insertions, 1889 deletions
diff --git a/man/Makefile.am b/man/Makefile.am deleted file mode 100644 index 6a39af2..0000000 --- a/man/Makefile.am +++ /dev/null @@ -1,22 +0,0 @@ -dist_man_MANS = man1/zmq_forwarder.1 man1/zmq_streamer.1 man1/zmq_queue.1 \ - man3/zmq_init.3 man3/zmq_term.3 \ - man3/zmq_socket.3 man3/zmq_close.3 man3/zmq_setsockopt.3 man3/zmq_bind.3 \ - man3/zmq_connect.3 man3/zmq_send.3 man3/zmq_flush.3 man3/zmq_recv.3 \ - man3/zmq_poll.3 man3/zmq_msg_init.3 man3/zmq_msg_init_size.3 \ - man3/zmq_msg_close.3 man3/zmq_msg_move.3 man3/zmq_msg_copy.3 \ - man3/zmq_msg_data.3 man3/zmq_msg_size.3 man3/zmq_strerror.3 \ - man7/zmq.7 man7/zmq_cpp.7 man7/zmq_python.7 \ - man7/zmq_cl.7 man7/zmq_tcp.7 man7/zmq_udp.7 man7/zmq_pgm.7 \ - man7/zmq_inproc.7 man7/zmq_ipc.7 man7/zmq_java.7 - -distclean-local: - -rm *.pdf - -rm man1/*.ps - -rm man3/*.ps - -rm man7/*.ps - -dist-hook: - ./convert2pdf.sh - $(mkdir_p) $(top_distdir)/doc - cp $(top_srcdir)/man/*.pdf $(top_distdir)/doc - diff --git a/man/convert2html.sh b/man/convert2html.sh deleted file mode 100644 index 40617da..0000000 --- a/man/convert2html.sh +++ /dev/null @@ -1,55 +0,0 @@ -#!/bin/sh -# -# Copyright (c) 2007-2010 iMatix Corporation -# -# This file is part of 0MQ. -# -# 0MQ is free software; you can redistribute it and/or modify it under -# the terms of the Lesser GNU General Public License as published by -# the Free Software Foundation; either version 3 of the License, or -# (at your option) any later version. -# -# 0MQ is distributed in the hope that it will be useful, -# but WITHOUT ANY WARRANTY; without even the implied warranty of -# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the -# Lesser GNU General Public License for more details. -# -# You should have received a copy of the Lesser GNU General Public License -# along with this program. If not, see <http://www.gnu.org/licenses/>. - -groff -man -Thtml man1/zmq_forwarder.1 > man1/zmq_forwarder.1.html -groff -man -Thtml man1/zmq_streamer.1 > man1/zmq_streamer.1.html -groff -man -Thtml man1/zmq_queue.1 > man1/zmq_queue.1.html - -groff -man -Thtml man3/zmq_init.3 > man3/zmq_init.3.html -groff -man -Thtml man3/zmq_term.3 > man3/zmq_term.3.html -groff -man -Thtml man3/zmq_socket.3 > man3/zmq_socket.3.html -groff -man -Thtml man3/zmq_close.3 > man3/zmq_close.3.html -groff -man -Thtml man3/zmq_setsockopt.3 > man3/zmq_setsockopt.3.html -groff -man -Thtml man3/zmq_bind.3 > man3/zmq_bind.3.html -groff -man -Thtml man3/zmq_connect.3 > man3/zmq_connect.3.html -groff -man -Thtml man3/zmq_send.3 > man3/zmq_send.3.html -groff -man -Thtml man3/zmq_flush.3 > man3/zmq_flush.3.html -groff -man -Thtml man3/zmq_recv.3 > man3/zmq_recv.3.html -groff -man -Thtml man3/zmq_poll.3 > man3/zmq_poll.3.html -groff -man -Thtml man3/zmq_msg_init.3 > man3/zmq_msg_init.3.html -groff -man -Thtml man3/zmq_msg_init_size.3 > man3/zmq_msg_init_size.3.html -groff -man -Thtml man3/zmq_msg_init_data.3 > man3/zmq_msg_init_data.3.html -groff -man -Thtml man3/zmq_msg_close.3 > man3/zmq_msg_close.3.html -groff -man -Thtml man3/zmq_msg_move.3 > man3/zmq_msg_move.3.html -groff -man -Thtml man3/zmq_msg_copy.3 > man3/zmq_msg_copy.3.html -groff -man -Thtml man3/zmq_msg_data.3 > man3/zmq_msg_data.3.html -groff -man -Thtml man3/zmq_msg_size.3 > man3/zmq_msg_size.3.html -groff -man -Thtml man3/zmq_strerror.3 > man3/zmq_strerror.3.html - -groff -man -Thtml man7/zmq.7 > man7/zmq.7.html -groff -man -Thtml man7/zmq_cpp.7 > man7/zmq_cpp.7.html -groff -man -Thtml man7/zmq_java.7 > man7/zmq_java.7.html -groff -man -Thtml man7/zmq_python.7 > man7/zmq_python.7.html -groff -man -Thtml man7/zmq_cl.7 > man7/zmq_cl.7.html -groff -man -Thtml man7/zmq_tcp.7 > man7/zmq_tcp.7.html -groff -man -Thtml man7/zmq_udp.7 > man7/zmq_udp.7.html -groff -man -Thtml man7/zmq_pgm.7 > man7/zmq_pgm.7.html -groff -man -Thtml man7/zmq_inproc.7 > man7/zmq_inproc.7.html -groff -man -Thtml man7/zmq_ipc.7 > man7/zmq_ipc.7.html - diff --git a/man/convert2pdf.sh b/man/convert2pdf.sh deleted file mode 100755 index 574571b..0000000 --- a/man/convert2pdf.sh +++ /dev/null @@ -1,88 +0,0 @@ -#!/bin/sh -# -# Copyright (c) 2007-2010 iMatix Corporation -# -# This file is part of 0MQ. -# -# 0MQ is free software; you can redistribute it and/or modify it under -# the terms of the Lesser GNU General Public License as published by -# the Free Software Foundation; either version 3 of the License, or -# (at your option) any later version. -# -# 0MQ is distributed in the hope that it will be useful, -# but WITHOUT ANY WARRANTY; without even the implied warranty of -# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the -# Lesser GNU General Public License for more details. -# -# You should have received a copy of the Lesser GNU General Public License -# along with this program. If not, see <http://www.gnu.org/licenses/>. - -groff -man -Tps man1/zmq_forwarder.1 > man1/zmq_forwarder.1.ps -ps2pdf man1/zmq_forwarder.1.ps zmq_forwarder.pdf -groff -man -Tps man1/zmq_streamer.1 > man1/zmq_streamer.1.ps -ps2pdf man1/zmq_streamer.1.ps zmq_streamer.pdf -groff -man -Tps man1/zmq_queue.1 > man1/zmq_queue.1.ps -ps2pdf man1/zmq_queue.1.ps zmq_queue.pdf - -groff -man -Tps man3/zmq_init.3 > man3/zmq_init.3.ps -ps2pdf man3/zmq_init.3.ps zmq_init.pdf -groff -man -Tps man3/zmq_term.3 > man3/zmq_term.3.ps -ps2pdf man3/zmq_term.3.ps zmq_term.pdf -groff -man -Tps man3/zmq_socket.3 > man3/zmq_socket.3.ps -ps2pdf man3/zmq_socket.3.ps zmq_socket.pdf -groff -man -Tps man3/zmq_close.3 > man3/zmq_close.3.ps -ps2pdf man3/zmq_close.3.ps zmq_close.pdf -groff -man -Tps man3/zmq_setsockopt.3 > man3/zmq_setsockopt.3.ps -ps2pdf man3/zmq_setsockopt.3.ps zmq_setsockopt.pdf -groff -man -Tps man3/zmq_bind.3 > man3/zmq_bind.3.ps -ps2pdf man3/zmq_bind.3.ps zmq_bind.pdf -groff -man -Tps man3/zmq_connect.3 > man3/zmq_connect.3.ps -ps2pdf man3/zmq_connect.3.ps zmq_connect.pdf -groff -man -Tps man3/zmq_send.3 > man3/zmq_send.3.ps -ps2pdf man3/zmq_send.3.ps zmq_send.pdf -groff -man -Tps man3/zmq_flush.3 > man3/zmq_flush.3.ps -ps2pdf man3/zmq_flush.3.ps zmq_flush.pdf -groff -man -Tps man3/zmq_recv.3 > man3/zmq_recv.3.ps -ps2pdf man3/zmq_recv.3.ps zmq_recv.pdf -groff -man -Tps man3/zmq_poll.3 > man3/zmq_poll.3.ps -ps2pdf man3/zmq_poll.3.ps zmq_poll.pdf -groff -man -Tps man3/zmq_msg_init.3 > man3/zmq_msg_init.3.ps -ps2pdf man3/zmq_msg_init.3.ps zmq_msg_init.pdf -groff -man -Tps man3/zmq_msg_init_size.3 > man3/zmq_msg_init_size.3.ps -ps2pdf man3/zmq_msg_init_size.3.ps zmq_msg_init_size.pdf -groff -man -Tps man3/zmq_msg_init_data.3 > man3/zmq_msg_init_data.3.ps -ps2pdf man3/zmq_msg_init_data.3.ps zmq_msg_init_data.pdf -groff -man -Tps man3/zmq_msg_close.3 > man3/zmq_msg_close.3.ps -ps2pdf man3/zmq_msg_close.3.ps zmq_msg_close.pdf -groff -man -Tps man3/zmq_msg_move.3 > man3/zmq_msg_move.3.ps -ps2pdf man3/zmq_msg_move.3.ps zmq_msg_move.pdf -groff -man -Tps man3/zmq_msg_copy.3 > man3/zmq_msg_copy.3.ps -ps2pdf man3/zmq_msg_copy.3.ps zmq_msg_copy.pdf -groff -man -Tps man3/zmq_msg_data.3 > man3/zmq_msg_data.3.ps -ps2pdf man3/zmq_msg_data.3.ps zmq_msg_data.pdf -groff -man -Tps man3/zmq_msg_size.3 > man3/zmq_msg_size.3.ps -ps2pdf man3/zmq_msg_size.3.ps zmq_msg_size.pdf -groff -man -Tps man3/zmq_strerror.3 > man3/zmq_strerror.3.ps -ps2pdf man3/zmq_strerror.3.ps zmq_strerror.pdf - -groff -man -Tps man7/zmq.7 > man7/zmq.7.ps -ps2pdf man7/zmq.7.ps zmq.pdf -groff -man -Tps man7/zmq_cpp.7 > man7/zmq_cpp.7.ps -ps2pdf man7/zmq_cpp.7.ps zmq_cpp.pdf -groff -man -Tps man7/zmq_java.7 > man7/zmq_java.7.ps -ps2pdf man7/zmq_java.7.ps zmq_java.pdf -groff -man -Tps man7/zmq_python.7 > man7/zmq_python.7.ps -ps2pdf man7/zmq_python.7.ps zmq_python.pdf -groff -man -Tps man7/zmq_cl.7 > man7/zmq_cl.7.ps -ps2pdf man7/zmq_cl.7.ps zmq_cl.pdf -groff -man -Tps man7/zmq_tcp.7 > man7/zmq_tcp.7.ps -ps2pdf man7/zmq_tcp.7.ps zmq_tcp.pdf -groff -man -Tps man7/zmq_udp.7 > man7/zmq_udp.7.ps -ps2pdf man7/zmq_udp.7.ps zmq_udp.pdf -groff -man -Tps man7/zmq_pgm.7 > man7/zmq_pgm.7.ps -ps2pdf man7/zmq_pgm.7.ps zmq_pgm.pdf -groff -man -Tps man7/zmq_inproc.7 > man7/zmq_inproc.7.ps -ps2pdf man7/zmq_inproc.7.ps zmq_inproc.pdf -groff -man -Tps man7/zmq_ipc.7 > man7/zmq_ipc.7.ps -ps2pdf man7/zmq_ipc.7.ps zmq_ipc.pdf - diff --git a/man/man1/zmq_forwarder.1 b/man/man1/zmq_forwarder.1 deleted file mode 100644 index b45d9c8..0000000 --- a/man/man1/zmq_forwarder.1 +++ /dev/null @@ -1,11 +0,0 @@ -.TH zmq_forwarder 1 "" "(c)2007-2010 iMatix Corporation" "0MQ User Manuals" -.SH NAME -zmq_forwarder \- forwards the stream of PUB/SUB messages -.SH SYNOPSIS -.SH DESCRIPTION -.SH OPTIONS -.SH "SEE ALSO" -.SH AUTHOR -Martin Sustrik <sustrik at 250bpm dot com> - - diff --git a/man/man1/zmq_queue.1 b/man/man1/zmq_queue.1 deleted file mode 100644 index da29d86..0000000 --- a/man/man1/zmq_queue.1 +++ /dev/null @@ -1,11 +0,0 @@ -.TH zmq_queue 1 "" "(c)2007-2010 iMatix Corporation" "0MQ User Manuals" -.SH NAME -zmq_queue \- forwards REQ/REP messages -.SH SYNOPSIS -.SH DESCRIPTION -.SH OPTIONS -.SH "SEE ALSO" -.SH AUTHOR -Martin Sustrik <sustrik at 250bpm dot com> - - diff --git a/man/man1/zmq_streamer.1 b/man/man1/zmq_streamer.1 deleted file mode 100644 index deadc65..0000000 --- a/man/man1/zmq_streamer.1 +++ /dev/null @@ -1,11 +0,0 @@ -.TH zmq_streamer 1 "" "(c)2007-2010 iMatix Corporation" "0MQ User Manuals" -.SH NAME -zmq_streamer \- forwards the stream of UPSTREAM/DOWNSTREAM messages -.SH SYNOPSIS -.SH DESCRIPTION -.SH OPTIONS -.SH "SEE ALSO" -.SH AUTHOR -Martin Sustrik <sustrik at 250bpm dot com> - - diff --git a/man/man3/zmq_bind.3 b/man/man3/zmq_bind.3 deleted file mode 100644 index 61d97fa..0000000 --- a/man/man3/zmq_bind.3 +++ /dev/null @@ -1,52 +0,0 @@ -.TH zmq_bind 3 "" "(c)2007-2010 iMatix Corporation" "0MQ User Manuals" -.SH NAME -zmq_bind \- binds the socket to the specified address -.SH SYNOPSIS -.B int zmq_bind (void *s, const char *addr); -.SH DESCRIPTION -The function binds socket -.IR s -to a particular transport. Actual semantics of the -command depend on the underlying transport mechanism, however, in cases where -peers connect in an asymmetric manner, -.IR zmq_bind -should be called first, -.IR zmq_connect -afterwards. Actual formats of -.IR addr -parameter are defined by individual transports. For a list of supported -transports have a look at -.IR zmq(7) -manual page. - -Note that single socket can be bound (and connected) to -arbitrary number of peers using different transport mechanisms. -.SH RETURN VALUE -In case of success the function returns zero. Otherwise it returns -1 and -sets -.IR errno -to the appropriate value. -.SH ERRORS -.IP "\fBEPROTONOSUPPORT\fP" -unsupported protocol. -.IP "\fBENOCOMPATPROTO\fP" -protocol is not compatible with the socket type. -.IP "\fBEADDRINUSE\fP" -the given address is already in use. -.IP "\fBEADDRNOTAVAIL\fP" -a nonexistent interface was requested or the requested address was not local. -.SH EXAMPLE -.nf -void *s = zmq_socket (context, ZMQ_PUB); -assert (s); -int rc = zmq_bind (s, "inproc://my_publisher"); -assert (rc == 0); -rc = zmq_bind (s, "tcp://eth0:5555"); -assert (rc == 0); -.fi -.SH SEE ALSO -.BR zmq_connect (3) -.BR zmq_socket (3) -.BR zmq (7) -.SH AUTHOR -Martin Sustrik <sustrik at 250bpm dot com> diff --git a/man/man3/zmq_close.3 b/man/man3/zmq_close.3 deleted file mode 100644 index ad731d3..0000000 --- a/man/man3/zmq_close.3 +++ /dev/null @@ -1,30 +0,0 @@ -.TH zmq_close 3 "" "(c)2007-2010 iMatix Corporation" "0MQ User Manuals" -.SH NAME -zmq_close \- destroys 0MQ socket -.SH SYNOPSIS -.B int zmq_close (void *s); -.SH DESCRIPTION -Destroys 0MQ socket (one created using -.IR zmq_socket -function). All sockets have to be properly closed before the application -terminates, otherwise memory leaks will occur. Note that any outbound messages -that haven't been psuhed to the network yet and any inbound messages that -haven't been received by the application yet will be dropped on the socket -shutdown. -.SH RETURN VALUE -In case of success the function returns zero. Otherwise it returns -1 and -sets -.IR errno -to the appropriate value. -.SH ERRORS -No errors are defined. -.SH EXAMPLE -.nf -int rc = zmq_close (s); -assert (rc == 0); -.fi -.SH SEE ALSO -.BR zmq_socket (3) -.BR zmq_term (3) -.SH AUTHOR -Martin Sustrik <sustrik at 250bpm dot com> diff --git a/man/man3/zmq_connect.3 b/man/man3/zmq_connect.3 deleted file mode 100644 index 925b66e..0000000 --- a/man/man3/zmq_connect.3 +++ /dev/null @@ -1,49 +0,0 @@ -.TH zmq_connect 3 "" "(c)2007-2010 iMatix Corporation" "0MQ User Manuals" -.SH NAME -zmq_connect \- connect the socket to the specified peer -.SH SYNOPSIS -.B int zmq_connect (void *s, const char *addr); -.SH DESCRIPTION -The function connect socket -.IR s -to the peer identified by -.IR addr . -Actual semantics of the command depend on the underlying transport mechanism, -however, in cases where peers connect in an asymmetric manner, -.IR zmq_bind -should be called first, -.IR zmq_connect -afterwards. Formats of the -.IR addr -parameter are defined by individual transports. For a list of supported -transports have a look at -.IR zmq(7) -manual page. - -Note that single socket can be connected (and bound) to -arbitrary number of peers using different transport mechanisms. -.SH RETURN VALUE -In case of success the function returns zero. Otherwise it returns -1 and -sets -.IR errno -to the appropriate value. -.SH ERRORS -.IP "\fBEPROTONOSUPPORT\fP" -unsupported protocol. -.IP "\fBENOCOMPATPROTO\fP" -protocol is not compatible with the socket type. -.SH EXAMPLE -.nf -void *s = zmq_socket (context, ZMQ_SUB); -assert (s); -int rc = zmq_connect (s, "inproc://my_publisher"); -assert (rc == 0); -rc = zmq_connect (s, "tcp://server001:5555"); -assert (rc == 0); -.fi -.SH SEE ALSO -.BR zmq_bind (3) -.BR zmq_socket (3) -.BR zmq (7) -.SH AUTHOR -Martin Sustrik <sustrik at 250bpm dot com> diff --git a/man/man3/zmq_flush.3 b/man/man3/zmq_flush.3 deleted file mode 100644 index eb2a719..0000000 --- a/man/man3/zmq_flush.3 +++ /dev/null @@ -1,37 +0,0 @@ -.TH zmq_flush 3 "" "(c)2007-2010 iMatix Corporation" "0MQ User Manuals" -.SH NAME -zmq_flush \- flushes pre-sent messages to the socket -.SH SYNOPSIS -.B int zmq_flush (void *s); -.SH DESCRIPTION -Flushes all the pre-sent messages - i.e. those that have been sent with -ZMQ_NOFLUSH flag - to the socket. This functionality improves performance in -cases where several messages are sent during a single business operation. -It should not be used as a transaction - ACID properties are not guaranteed. -Note that calling -.IR zmq_send -without ZMQ_NOFLUSH flag automatically flushes all previously pre-sent messages. -.SH RETURN VALUE -In case of success the function returns zero. Otherwise it returns -1 and -sets -.IR errno -to the appropriate value. -.SH ERRORS -.IP "\fBENOTSUP\fP" -function isn't supported by particular socket type. -.IP "\fBEFSM\fP" -function cannot be called at the moment, because socket is not in the -approprite state. -.SH EXAMPLE -.nf -rc = zmq_send (s, &msg1, ZMQ_NOFLUSH); -assert (rc == 0); -rc = zmq_send (s, &msg2, ZMQ_NOFLUSH); -assert (rc == 0); -rc = zmq_flush (s); -assert (rc == 0); -.fi -.SH SEE ALSO -.BR zmq_send (3) -.SH AUTHOR -Martin Sustrik <sustrik at 250bpm dot com> diff --git a/man/man3/zmq_init.3 b/man/man3/zmq_init.3 deleted file mode 100644 index 6b5e75f..0000000 --- a/man/man3/zmq_init.3 +++ /dev/null @@ -1,40 +0,0 @@ -.TH zmq_init 3 "" "(c)2007-2010 iMatix Corporation" "0MQ User Manuals" -.SH NAME -zmq_init \- initialises 0MQ context -.SH SYNOPSIS -.B void *zmq_init (int app_threads, int io_threads, int flags); -.SH DESCRIPTION -Initialises 0MQ context. -.IR app_threads -specifies maximal number of application threads that can own open sockets -at the same time. At least one application thread should be defined. -.IR io_threads -specifies the size of thread pool to handle I/O operations. The value shouldn't -be negative. Zero can be used in case only in-process messaging is going to be -used, i.e. there will be no I/O traffic. - -.IR flags -argument is a combination of the flags defined below: -.IP "\fBZMQ_POLL\fP" -flag specifying that the sockets within this context should be pollable (see -.IR zmq_poll -). Pollable sockets may add a little latency to the message transfer when -compared to non-pollable sockets. - -.SH RETURN VALUE -Function returns context handle is successful. Otherwise it returns NULL and -sets errno to one of the values below. -.SH ERRORS -.IP "\fBEINVAL\fP" -there's less than one application thread allocated, or number of I/O threads -is negative. -.SH EXAMPLE -.nf -void *ctx = zmq_init (1, 1, ZMQ_POLL); -assert (ctx); -.fi -.SH SEE ALSO -.BR zmq_term (3) -.BR zmq_socket (3) -.SH AUTHOR -Martin Sustrik <sustrik at 250bpm dot com> diff --git a/man/man3/zmq_msg_close.3 b/man/man3/zmq_msg_close.3 deleted file mode 100644 index e601ea2..0000000 --- a/man/man3/zmq_msg_close.3 +++ /dev/null @@ -1,32 +0,0 @@ -.TH zmq_msg_close 3 "" "(c)2007-2010 iMatix Corporation" "0MQ User Manuals" -.SH NAME -zmq_msg_close \- destroys 0MQ message -.SH SYNOPSIS -.B int zmq_msg_close (zmq_msg_t *msg); -.SH DESCRIPTION -Deallocates message -.IR msg -including any associated buffers (unless the buffer is -shared with another message). Not calling this function can result in -memory leaks. -.SH RETURN VALUE -In case of success the function returns zero. Otherwise it returns -1 and -sets -.IR errno -to the appropriate value. -.SH ERRORS -No errors are defined. -.SH EXAMPLE -.nf -zmq_msg_t msg; -rc = zmq_msg_init_size (&msg, 1000000); -assert (rc = 0); -rc = zmq_msg_close (&msg); -assert (rc = 0); -.fi -.SH SEE ALSO -.BR zmq_msg_init (3) -.BR zmq_msg_init_size (3) -.BR zmq_msg_init_data (3) -.SH AUTHOR -Martin Sustrik <sustrik at 250bpm dot com> diff --git a/man/man3/zmq_msg_copy.3 b/man/man3/zmq_msg_copy.3 deleted file mode 100644 index acb8389..0000000 --- a/man/man3/zmq_msg_copy.3 +++ /dev/null @@ -1,43 +0,0 @@ -.TH zmq_msg_copy 3 "" "(c)2007-2010 iMatix Corporation" "0MQ User Manuals" -.SH NAME -zmq_msg_copy \- copies content of a message to another message -.SH SYNOPSIS -.B int zmq_msg_copy (zmq_msg_t *dest, zmq_msg_t *src); -.SH DESCRIPTION -Copy the -.IR src -message to -.IR dest . -The original content of -.IR dest -is orderly deallocated. -Caution: The implementation may choose not to physically copy the data, rather -to share the buffer between two messages. Thus avoid modifying message data -after the message was copied. Doing so can modify multiple message instances. -If what you need is actual hard copy, allocate new message using -.IR zmq_msg_size -and copy the data using -.IR memcpy . -.SH RETURN VALUE -In case of success the function returns zero. Otherwise it returns -1 and -sets -.IR errno -to the appropriate value. -.SH ERRORS -No errors are defined. -.SH EXAMPLE -.nf -zmq_msg_t dest; -rc = zmq_msg_init (&dest); -assert (rc == 0); -rc = zmq_msg_copy (&dest, &src); -assert (rc == 0); -.fi -.SH SEE ALSO -.BR zmq_msg_move (3) -.BR zmq_msg_init (3) -.BR zmq_msg_init_size (3) -.BR zmq_msg_init_data (3) -.BR zmq_msg_close (3) -.SH AUTHOR -Martin Sustrik <sustrik at 250bpm dot com> diff --git a/man/man3/zmq_msg_data.3 b/man/man3/zmq_msg_data.3 deleted file mode 100644 index ef3cba8..0000000 --- a/man/man3/zmq_msg_data.3 +++ /dev/null @@ -1,27 +0,0 @@ -.TH zmq_msg_data 3 "" "(c)2007-2010 iMatix Corporation" "0MQ User Manuals" -.SH NAME -zmq_msg_data \- retrieves pointer to the message content -.SH SYNOPSIS -.B void *zmq_msg_data (zmq_msg_t *msg); -.SH DESCRIPTION -Returns pointer to message data. Always use this function to access the data, -never use -.IR zmq_msg_t -members directly. -.SH RETURN VALUE -Pointer to the message data. -.SH ERRORS -No errors are defined. -.SH EXAMPLE -.nf -zmq_msg_t msg; -rc = zmq_msg_init_size (&msg, 100); -memset (zmq_msg_data (&msg), 0, 100); -.fi -.SH SEE ALSO -.BR zmq_msg_init (3) -.BR zmq_msg_init_size (3) -.BR zmq_msg_init_data (3) -.BR zmq_msg_close (3) -.SH AUTHOR -Martin Sustrik <sustrik at 250bpm dot com> diff --git a/man/man3/zmq_msg_init.3 b/man/man3/zmq_msg_init.3 deleted file mode 100644 index 80d51d2..0000000 --- a/man/man3/zmq_msg_init.3 +++ /dev/null @@ -1,33 +0,0 @@ -.TH zmq_msg_init 3 "" "(c)2007-2010 iMatix Corporation" "0MQ User Manuals" -.SH NAME -zmq_msg_init \- initialises empty 0MQ message -.SH SYNOPSIS -.B int zmq_msg_init (zmq_msg_t *msg); -.SH DESCRIPTION -Initialises 0MQ message zero bytes long. The function is most useful -to initialise a -.IR zmq_msg_t -structure before receiving a message. -.SH RETURN VALUE -In case of success the function returns zero. Otherwise it returns -1 and -sets -.IR errno -to the appropriate value. -.SH ERRORS -No errors are defined. -.SH EXAMPLE -.nf -zmq_msg_t msg; -rc = zmq_msg_init (&msg); -assert (rc == 0); -rc = zmq_recv (s, &msg, 0); -assert (rc == 0); -.fi -.SH SEE ALSO -.BR zmq_msg_close (3) -.BR zmq_msg_init_size (3) -.BR zmq_msg_init_data (3) -.BR zmq_msg_data (3) -.BR zmq_msg_size (3) -.SH AUTHOR -Martin Sustrik <sustrik at 250bpm dot com> diff --git a/man/man3/zmq_msg_init_data.3 b/man/man3/zmq_msg_init_data.3 deleted file mode 100644 index 0af95be..0000000 --- a/man/man3/zmq_msg_init_data.3 +++ /dev/null @@ -1,55 +0,0 @@ -.TH zmq_msg_init_data 3 "" "(c)2007-2010 iMatix Corporation" "0MQ User Manuals" -.SH NAME -zmq_msg_init \- initialises 0MQ message from the given data -.SH SYNOPSIS -.nf -.B typedef void (zmq_free_fn) (void *data, void *hint); -.B int zmq_msg_init_data (zmq_msg_t *msg, void *data, size_t size, zmq_free_fn *ffn, void *hint); -.fi -.SH DESCRIPTION -Initialise a message from a supplied buffer. Message isn't copied, -instead 0MQ infrastructure takes ownership of the buffer located at address -.IR data , -.IR size -bytes long. -Deallocation function ( -.IR ffn -) will be called once the data are not needed anymore. When using a static -constant buffer, -.IR ffn -may be NULL to prevent subsequent deallocation. If needed, additional -.IR hint -can be passed to the initialisation function. It's an opaque pointer that will -be later on passed to -.IR ffn -as a second argument. -.SH RETURN VALUE -In case of success the function returns zero. Otherwise it returns -1 and -sets -.IR errno -to the appropriate value. -.SH ERRORS -No errors are defined. -.SH EXAMPLE -.nf -void my_free (void *data, void *hint) {free (data);} - - ... - -void *data = malloc (6); -assert (data); -memcpy (data, "ABCDEF", 6); -zmq_msg_t msg; -rc = zmq_msg_init_data (&msg, data, 6, my_free, NULL); -assert (rc == 0); -rc = zmq_send (s, &msg, 0); -assert (rc == 0); -.fi -.SH SEE ALSO -.BR zmq_msg_close (3) -.BR zmq_msg_init (3) -.BR zmq_msg_init_size (3) -.BR zmq_msg_data (3) -.BR zmq_msg_size (3) -.SH AUTHOR -Martin Sustrik <sustrik at 250bpm dot com> diff --git a/man/man3/zmq_msg_init_size.3 b/man/man3/zmq_msg_init_size.3 deleted file mode 100644 index cc7a71e..0000000 --- a/man/man3/zmq_msg_init_size.3 +++ /dev/null @@ -1,44 +0,0 @@ -.TH zmq_msg_init_size 3 "" "(c)2007-2010 iMatix Corporation" "0MQ User Manuals" -.SH NAME -zmq_msg_init \- initialises 0MQ message of a specified size -.SH SYNOPSIS -.B int zmq_msg_init_size (zmq_msg_t *msg, size_t size); -.SH DESCRIPTION -Initialises 0MQ message -.IR size -bytes long. The implementation chooses whether it is more efficient to store -message content on the stack (small messages) or on the heap (large messages). -Therefore, never access message data directly via -.IR zmq_msg_t -members, rather use -.IR zmq_msg_data -and -.IR zmq_msg_size -functions to get message data and size. Note that the message data are not -nullified to avoid the associated performance impact. Thus you -should expect your message to contain bogus data after this call. -.SH RETURN VALUE -In case of success the function returns zero. Otherwise it returns -1 and -sets -.IR errno -to the appropriate value. -.SH ERRORS -.IP "\fBENOMEM\fP" -memory to hold the message cannot be allocated. -.SH EXAMPLE -.nf -zmq_msg_t msg; -rc = zmq_msg_init_size (&msg, 6); -assert (rc == 0); -memcpy (zmq_msg_data (&msg), "ABCDEF", 6); -rc = zmq_send (s, &msg, 0); -assert (rc == 0); -.fi -.SH SEE ALSO -.BR zmq_msg_close (3) -.BR zmq_msg_init (3) -.BR zmq_msg_init_data (3) -.BR zmq_msg_data (3) -.BR zmq_msg_size (3) -.SH AUTHOR -Martin Sustrik <sustrik at 250bpm dot com> diff --git a/man/man3/zmq_msg_move.3 b/man/man3/zmq_msg_move.3 deleted file mode 100644 index 8663585..0000000 --- a/man/man3/zmq_msg_move.3 +++ /dev/null @@ -1,38 +0,0 @@ -.TH zmq_msg_move 3 "" "(c)2007-2010 iMatix Corporation" "0MQ User Manuals" -.SH NAME -zmq_msg_move \- moves content of a message to another message -.SH SYNOPSIS -.B int zmq_msg_move (zmq_msg_t *dest, zmq_msg_t *src); -.SH DESCRIPTION -Move the content of the message from -.IR src -to -.IR dest . -The content isn't copied, just moved. -.IR src -becomes an empty message after the call. Original content of -.IR dest -message is deallocated. -.SH RETURN VALUE -In case of success the function returns zero. Otherwise it returns -1 and -sets -.IR errno -to the appropriate value. -.SH ERRORS -No errors are defined. -.SH EXAMPLE -.nf -zmq_msg_t dest; -rc = zmq_msg_init (&dest); -assert (rc == 0); -rc = zmq_msg_move (&dest, &src); -assert (rc == 0); -.fi -.SH SEE ALSO -.BR zmq_msg_copy (3) -.BR zmq_msg_init (3) -.BR zmq_msg_init_size (3) -.BR zmq_msg_init_data (3) -.BR zmq_msg_close (3) -.SH AUTHOR -Martin Sustrik <sustrik at 250bpm dot com> diff --git a/man/man3/zmq_msg_size.3 b/man/man3/zmq_msg_size.3 deleted file mode 100644 index aa1f8b0..0000000 - |