From e645fc2693acc796304498909786b7b47005b429 Mon Sep 17 00:00:00 2001 From: Martin Lucina Date: Mon, 23 Jan 2012 08:53:35 +0100 Subject: Imported Upstream version 2.1.3 --- doc/Makefile.am | 20 +- doc/Makefile.in | 106 ++-- doc/zmq.7 | 34 +- doc/zmq.html | 866 --------------------------- doc/zmq.txt | 32 +- doc/zmq_bind.3 | 13 +- doc/zmq_bind.html | 738 ----------------------- doc/zmq_bind.txt | 4 +- doc/zmq_close.3 | 28 +- doc/zmq_close.html | 635 -------------------- doc/zmq_close.txt | 18 +- doc/zmq_connect.3 | 13 +- doc/zmq_connect.html | 724 ----------------------- doc/zmq_connect.txt | 4 +- doc/zmq_cpp.7 | 12 +- doc/zmq_cpp.html | 763 ------------------------ doc/zmq_cpp.txt | 4 +- doc/zmq_device.3 | 140 +++++ doc/zmq_device.txt | 138 +++++ doc/zmq_epgm.7 | 14 +- doc/zmq_epgm.html | 745 ----------------------- doc/zmq_epgm.txt | 8 +- doc/zmq_errno.3 | 10 +- doc/zmq_errno.html | 634 -------------------- doc/zmq_errno.txt | 4 +- doc/zmq_forwarder.1 | 57 -- doc/zmq_forwarder.html | 613 ------------------- doc/zmq_forwarder.txt | 33 -- doc/zmq_getsockopt.3 | 445 +++++++++++++- doc/zmq_getsockopt.html | 1202 ------------------------------------- doc/zmq_getsockopt.txt | 180 +++++- doc/zmq_init.3 | 12 +- doc/zmq_init.html | 632 -------------------- doc/zmq_init.txt | 7 +- doc/zmq_inproc.7 | 8 +- doc/zmq_inproc.html | 669 --------------------- doc/zmq_inproc.txt | 2 +- doc/zmq_ipc.7 | 8 +- doc/zmq_ipc.html | 662 --------------------- doc/zmq_ipc.txt | 2 +- doc/zmq_msg_close.3 | 8 +- doc/zmq_msg_close.html | 638 -------------------- doc/zmq_msg_close.txt | 2 +- doc/zmq_msg_copy.3 | 8 +- doc/zmq_msg_copy.html | 647 -------------------- doc/zmq_msg_copy.txt | 2 +- doc/zmq_msg_data.3 | 8 +- doc/zmq_msg_data.html | 633 -------------------- doc/zmq_msg_data.txt | 2 +- doc/zmq_msg_init.3 | 8 +- doc/zmq_msg_init.html | 656 --------------------- doc/zmq_msg_init.txt | 2 +- doc/zmq_msg_init_data.3 | 8 +- doc/zmq_msg_init_data.html | 669 --------------------- doc/zmq_msg_init_data.txt | 2 +- doc/zmq_msg_init_size.3 | 8 +- doc/zmq_msg_init_size.html | 656 --------------------- doc/zmq_msg_init_size.txt | 2 +- doc/zmq_msg_move.3 | 8 +- doc/zmq_msg_move.html | 636 -------------------- doc/zmq_msg_move.txt | 2 +- doc/zmq_msg_size.3 | 8 +- doc/zmq_msg_size.html | 633 -------------------- doc/zmq_msg_size.txt | 2 +- doc/zmq_pgm.7 | 14 +- doc/zmq_pgm.html | 745 ----------------------- doc/zmq_pgm.txt | 8 +- doc/zmq_poll.3 | 44 +- doc/zmq_poll.html | 764 ------------------------ doc/zmq_poll.txt | 21 +- doc/zmq_queue.1 | 57 -- doc/zmq_queue.html | 613 ------------------- doc/zmq_queue.txt | 33 -- doc/zmq_recv.3 | 13 +- doc/zmq_recv.html | 729 ----------------------- doc/zmq_recv.txt | 5 +- doc/zmq_send.3 | 15 +- doc/zmq_send.html | 735 ----------------------- doc/zmq_send.txt | 7 +- doc/zmq_setsockopt.3 | 306 +++++++++- doc/zmq_setsockopt.html | 1277 ---------------------------------------- doc/zmq_setsockopt.txt | 125 +++- doc/zmq_socket.3 | 76 +-- doc/zmq_socket.html | 1403 -------------------------------------------- doc/zmq_socket.txt | 82 +-- doc/zmq_streamer.1 | 57 -- doc/zmq_streamer.html | 613 ------------------- doc/zmq_streamer.txt | 33 -- doc/zmq_strerror.3 | 8 +- doc/zmq_strerror.html | 634 -------------------- doc/zmq_strerror.txt | 2 +- doc/zmq_tcp.7 | 14 +- doc/zmq_tcp.html | 755 ------------------------ doc/zmq_tcp.txt | 8 +- doc/zmq_term.3 | 67 ++- doc/zmq_term.html | 658 --------------------- doc/zmq_term.txt | 36 +- doc/zmq_version.3 | 10 +- doc/zmq_version.html | 632 -------------------- doc/zmq_version.txt | 4 +- 100 files changed, 1748 insertions(+), 24342 deletions(-) delete mode 100644 doc/zmq.html delete mode 100644 doc/zmq_bind.html delete mode 100644 doc/zmq_close.html delete mode 100644 doc/zmq_connect.html delete mode 100644 doc/zmq_cpp.html create mode 100644 doc/zmq_device.3 create mode 100644 doc/zmq_device.txt delete mode 100644 doc/zmq_epgm.html delete mode 100644 doc/zmq_errno.html delete mode 100644 doc/zmq_forwarder.1 delete mode 100644 doc/zmq_forwarder.html delete mode 100644 doc/zmq_forwarder.txt delete mode 100644 doc/zmq_getsockopt.html delete mode 100644 doc/zmq_init.html delete mode 100644 doc/zmq_inproc.html delete mode 100644 doc/zmq_ipc.html delete mode 100644 doc/zmq_msg_close.html delete mode 100644 doc/zmq_msg_copy.html delete mode 100644 doc/zmq_msg_data.html delete mode 100644 doc/zmq_msg_init.html delete mode 100644 doc/zmq_msg_init_data.html delete mode 100644 doc/zmq_msg_init_size.html delete mode 100644 doc/zmq_msg_move.html delete mode 100644 doc/zmq_msg_size.html delete mode 100644 doc/zmq_pgm.html delete mode 100644 doc/zmq_poll.html delete mode 100644 doc/zmq_queue.1 delete mode 100644 doc/zmq_queue.html delete mode 100644 doc/zmq_queue.txt delete mode 100644 doc/zmq_recv.html delete mode 100644 doc/zmq_send.html delete mode 100644 doc/zmq_setsockopt.html delete mode 100644 doc/zmq_socket.html delete mode 100644 doc/zmq_streamer.1 delete mode 100644 doc/zmq_streamer.html delete mode 100644 doc/zmq_streamer.txt delete mode 100644 doc/zmq_strerror.html delete mode 100644 doc/zmq_tcp.html delete mode 100644 doc/zmq_term.html delete mode 100644 doc/zmq_version.html (limited to 'doc') diff --git a/doc/Makefile.am b/doc/Makefile.am index ba2b64a..d00014d 100644 --- a/doc/Makefile.am +++ b/doc/Makefile.am @@ -1,5 +1,5 @@ -MAN1 = zmq_forwarder.1 zmq_streamer.1 zmq_queue.1 -MAN3 = zmq_bind.3 zmq_close.3 zmq_connect.3 zmq_init.3 \ +MAN1 = +MAN3 = zmq_bind.3 zmq_close.3 zmq_connect.3 zmq_device.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 \ @@ -11,7 +11,6 @@ MAN_DOC = $(MAN1) $(MAN3) $(MAN7) MAN_TXT = $(MAN1:%.1=%.txt) MAN_TXT += $(MAN3:%.3=%.txt) MAN_TXT += $(MAN7:%.7=%.txt) -MAN_HTML = $(MAN_TXT:%.txt=%.html) if INSTALL_MAN dist_man_MANS = $(MAN_DOC) @@ -27,20 +26,17 @@ MAINTAINERCLEANFILES = $(MAN_DOC) $(MAN_HTML) dist-hook : $(MAN_DOC) $(MAN_HTML) if BUILD_DOC -SUFFIXES=.html .txt .xml .1 .3 .7 +SUFFIXES=.txt .xml .1 .3 .7 -.txt.html: - asciidoc -d manpage -b xhtml11 -f asciidoc.conf \ - -azmq_version=@PACKAGE_VERSION@ $< .txt.xml: - asciidoc -d manpage -b docbook -f asciidoc.conf \ + $(AM_V_GEN)$(ASCIIDOC) -d manpage -b docbook -f asciidoc.conf \ -azmq_version=@PACKAGE_VERSION@ $< .xml.1: - xmlto man $< + $(AM_V_GEN)$(XMLTO) man $< .xml.3: - xmlto man $< + $(AM_V_GEN)$(XMLTO) man $< .xml.7: - xmlto man $< + $(AM_V_GEN)$(XMLTO) man $< zmq_epgm.7: zmq_pgm.7 - cp zmq_pgm.7 $@ + $(AM_V_GEN)cp zmq_pgm.7 $@ endif diff --git a/doc/Makefile.in b/doc/Makefile.in index 4a1c0c2..0d71c0e 100644 --- a/doc/Makefile.in +++ b/doc/Makefile.in @@ -42,13 +42,20 @@ am__aclocal_m4_deps = $(top_srcdir)/config/libtool.m4 \ $(top_srcdir)/config/ltoptions.m4 \ $(top_srcdir)/config/ltsugar.m4 \ $(top_srcdir)/config/ltversion.m4 \ - $(top_srcdir)/config/lt~obsolete.m4 $(top_srcdir)/configure.in + $(top_srcdir)/config/lt~obsolete.m4 $(top_srcdir)/acinclude.m4 \ + $(top_srcdir)/configure.in am__configure_deps = $(am__aclocal_m4_deps) $(CONFIGURE_DEPENDENCIES) \ $(ACLOCAL_M4) mkinstalldirs = $(install_sh) -d CONFIG_HEADER = $(top_builddir)/src/platform.hpp CONFIG_CLEAN_FILES = CONFIG_CLEAN_VPATH_FILES = +AM_V_GEN = $(am__v_GEN_$(V)) +am__v_GEN_ = $(am__v_GEN_$(AM_DEFAULT_VERBOSITY)) +am__v_GEN_0 = @echo " GEN " $@; +AM_V_at = $(am__v_at_$(V)) +am__v_at_ = $(am__v_at_$(AM_DEFAULT_VERBOSITY)) +am__v_at_0 = @ SOURCES = DIST_SOURCES = am__vpath_adj_setup = srcdirstrip=`echo "$(srcdir)" | sed 's|.|.|g'`; @@ -72,18 +79,18 @@ am__nobase_list = $(am__nobase_strip_setup); \ am__base_list = \ sed '$$!N;$$!N;$$!N;$$!N;$$!N;$$!N;$$!N;s/\n/ /g' | \ sed '$$!N;$$!N;$$!N;$$!N;s/\n/ /g' -man1dir = $(mandir)/man1 -am__installdirs = "$(DESTDIR)$(man1dir)" "$(DESTDIR)$(man3dir)" \ - "$(DESTDIR)$(man7dir)" man3dir = $(mandir)/man3 +am__installdirs = "$(DESTDIR)$(man3dir)" "$(DESTDIR)$(man7dir)" man7dir = $(mandir)/man7 NROFF = nroff MANS = $(dist_man_MANS) DISTFILES = $(DIST_COMMON) $(DIST_SOURCES) $(TEXINFOS) $(EXTRA_DIST) ACLOCAL = @ACLOCAL@ AMTAR = @AMTAR@ +AM_DEFAULT_VERBOSITY = @AM_DEFAULT_VERBOSITY@ AR = @AR@ AS = @AS@ +ASCIIDOC = @ASCIIDOC@ AUTOCONF = @AUTOCONF@ AUTOHEADER = @AUTOHEADER@ AUTOMAKE = @AUTOMAKE@ @@ -109,8 +116,6 @@ ECHO_T = @ECHO_T@ EGREP = @EGREP@ EXEEXT = @EXEEXT@ FGREP = @FGREP@ -GLIB_CFLAGS = @GLIB_CFLAGS@ -GLIB_LIBS = @GLIB_LIBS@ GREP = @GREP@ INSTALL = @INSTALL@ INSTALL_DATA = @INSTALL_DATA@ @@ -122,6 +127,7 @@ LDFLAGS = @LDFLAGS@ LIBOBJS = @LIBOBJS@ LIBS = @LIBS@ LIBTOOL = @LIBTOOL@ +LIBZMQ_EXTRA_CFLAGS = @LIBZMQ_EXTRA_CFLAGS@ LIBZMQ_EXTRA_CXXFLAGS = @LIBZMQ_EXTRA_CXXFLAGS@ LIBZMQ_EXTRA_LDFLAGS = @LIBZMQ_EXTRA_LDFLAGS@ LIPO = @LIPO@ @@ -144,13 +150,13 @@ PACKAGE_TARNAME = @PACKAGE_TARNAME@ PACKAGE_URL = @PACKAGE_URL@ PACKAGE_VERSION = @PACKAGE_VERSION@ PATH_SEPARATOR = @PATH_SEPARATOR@ -PKG_CONFIG = @PKG_CONFIG@ RANLIB = @RANLIB@ SED = @SED@ SET_MAKE = @SET_MAKE@ SHELL = @SHELL@ STRIP = @STRIP@ VERSION = @VERSION@ +XMLTO = @XMLTO@ abs_builddir = @abs_builddir@ abs_srcdir = @abs_srcdir@ abs_top_builddir = @abs_top_builddir@ @@ -158,6 +164,8 @@ abs_top_srcdir = @abs_top_srcdir@ ac_ct_CC = @ac_ct_CC@ ac_ct_CXX = @ac_ct_CXX@ ac_ct_DUMPBIN = @ac_ct_DUMPBIN@ +ac_zmq_have_asciidoc = @ac_zmq_have_asciidoc@ +ac_zmq_have_xmlto = @ac_zmq_have_xmlto@ am__include = @am__include@ am__leading_dot = @am__leading_dot@ am__quote = @am__quote@ @@ -175,12 +183,6 @@ datarootdir = @datarootdir@ docdir = @docdir@ dvidir = @dvidir@ exec_prefix = @exec_prefix@ -have_asciidoc = @have_asciidoc@ -have_gzip = @have_gzip@ -have_perl = @have_perl@ -have_pkg_config = @have_pkg_config@ -have_python = @have_python@ -have_xmlto = @have_xmlto@ host = @host@ host_alias = @host_alias@ host_cpu = @host_cpu@ @@ -190,7 +192,6 @@ htmldir = @htmldir@ includedir = @includedir@ infodir = @infodir@ install_sh = @install_sh@ -inttypes = @inttypes@ libdir = @libdir@ libexecdir = @libexecdir@ localedir = @localedir@ @@ -201,20 +202,21 @@ mkdir_p = @mkdir_p@ oldincludedir = @oldincludedir@ pdfdir = @pdfdir@ pgm_basename = @pgm_basename@ +pgm_srcdir = @pgm_srcdir@ prefix = @prefix@ program_transform_name = @program_transform_name@ psdir = @psdir@ sbindir = @sbindir@ sharedstatedir = @sharedstatedir@ srcdir = @srcdir@ -stdint = @stdint@ +subdirs = @subdirs@ sysconfdir = @sysconfdir@ target_alias = @target_alias@ top_build_prefix = @top_build_prefix@ top_builddir = @top_builddir@ top_srcdir = @top_srcdir@ -MAN1 = zmq_forwarder.1 zmq_streamer.1 zmq_queue.1 -MAN3 = zmq_bind.3 zmq_close.3 zmq_connect.3 zmq_init.3 \ +MAN1 = +MAN3 = zmq_bind.3 zmq_close.3 zmq_connect.3 zmq_device.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 \ @@ -225,15 +227,14 @@ MAN7 = zmq.7 zmq_tcp.7 zmq_pgm.7 zmq_epgm.7 zmq_inproc.7 zmq_ipc.7 \ MAN_DOC = $(MAN1) $(MAN3) $(MAN7) MAN_TXT = $(MAN1:%.1=%.txt) $(MAN3:%.3=%.txt) $(MAN7:%.7=%.txt) -MAN_HTML = $(MAN_TXT:%.txt=%.html) @INSTALL_MAN_TRUE@dist_man_MANS = $(MAN_DOC) EXTRA_DIST = asciidoc.conf $(MAN_TXT) $(am__append_1) MAINTAINERCLEANFILES = $(MAN_DOC) $(MAN_HTML) -@BUILD_DOC_TRUE@SUFFIXES = .html .txt .xml .1 .3 .7 +@BUILD_DOC_TRUE@SUFFIXES = .txt .xml .1 .3 .7 all: all-am .SUFFIXES: -.SUFFIXES: .html .txt .xml .1 .3 .7 +.SUFFIXES: .txt .xml .1 .3 .7 $(srcdir)/Makefile.in: $(srcdir)/Makefile.am $(am__configure_deps) @for dep in $?; do \ case '$(am__configure_deps)' in \ @@ -270,44 +271,6 @@ mostlyclean-libtool: clean-libtool: -rm -rf .libs _libs -install-man1: $(dist_man_MANS) - @$(NORMAL_INSTALL) - test -z "$(man1dir)" || $(MKDIR_P) "$(DESTDIR)$(man1dir)" - @list=''; test -n "$(man1dir)" || exit 0; \ - { for i in $$list; do echo "$$i"; done; \ - l2='$(dist_man_MANS)'; for i in $$l2; do echo "$$i"; done | \ - sed -n '/\.1[a-z]*$$/p'; \ - } | while read p; do \ - if test -f $$p; then d=; else d="$(srcdir)/"; fi; \ - echo "$$d$$p"; echo "$$p"; \ - done | \ - sed -e 'n;s,.*/,,;p;h;s,.*\.,,;s,^[^1][0-9a-z]*$$,1,;x' \ - -e 's,\.[0-9a-z]*$$,,;$(transform);G;s,\n,.,' | \ - sed 'N;N;s,\n, ,g' | { \ - list=; while read file base inst; do \ - if test "$$base" = "$$inst"; then list="$$list $$file"; else \ - echo " $(INSTALL_DATA) '$$file' '$(DESTDIR)$(man1dir)/$$inst'"; \ - $(INSTALL_DATA) "$$file" "$(DESTDIR)$(man1dir)/$$inst" || exit $$?; \ - fi; \ - done; \ - for i in $$list; do echo "$$i"; done | $(am__base_list) | \ - while read files; do \ - test -z "$$files" || { \ - echo " $(INSTALL_DATA) $$files '$(DESTDIR)$(man1dir)'"; \ - $(INSTALL_DATA) $$files "$(DESTDIR)$(man1dir)" || exit $$?; }; \ - done; } - -uninstall-man1: - @$(NORMAL_UNINSTALL) - @list=''; test -n "$(man1dir)" || exit 0; \ - files=`{ for i in $$list; do echo "$$i"; done; \ - l2='$(dist_man_MANS)'; for i in $$l2; do echo "$$i"; done | \ - sed -n '/\.1[a-z]*$$/p'; \ - } | sed -e 's,.*/,,;h;s,.*\.,,;s,^[^1][0-9a-z]*$$,1,;x' \ - -e 's,\.[0-9a-z]*$$,,;$(transform);G;s,\n,.,'`; \ - test -z "$$files" || { \ - echo " ( cd '$(DESTDIR)$(man1dir)' && rm -f" $$files ")"; \ - cd "$(DESTDIR)$(man1dir)" && rm -f $$files; } install-man3: $(dist_man_MANS) @$(NORMAL_INSTALL) test -z "$(man3dir)" || $(MKDIR_P) "$(DESTDIR)$(man3dir)" @@ -441,7 +404,7 @@ check-am: all-am check: check-am all-am: Makefile $(MANS) installdirs: - for dir in "$(DESTDIR)$(man1dir)" "$(DESTDIR)$(man3dir)" "$(DESTDIR)$(man7dir)"; do \ + for dir in "$(DESTDIR)$(man3dir)" "$(DESTDIR)$(man7dir)"; do \ test -z "$$dir" || $(MKDIR_P) "$$dir"; \ done install: install-am @@ -506,7 +469,7 @@ install-info: install-info-am install-info-am: -install-man: install-man1 install-man3 install-man7 +install-man: install-man3 install-man7 install-pdf: install-pdf-am @@ -536,7 +499,7 @@ ps-am: uninstall-am: uninstall-man -uninstall-man: uninstall-man1 uninstall-man3 uninstall-man7 +uninstall-man: uninstall-man3 uninstall-man7 .MAKE: install-am install-strip @@ -546,30 +509,27 @@ uninstall-man: uninstall-man1 uninstall-man3 uninstall-man7 install-am install-data install-data-am install-dvi \ install-dvi-am install-exec install-exec-am install-html \ install-html-am install-info install-info-am install-man \ - install-man1 install-man3 install-man7 install-pdf \ - install-pdf-am install-ps install-ps-am install-strip \ - installcheck installcheck-am installdirs maintainer-clean \ + install-man3 install-man7 install-pdf install-pdf-am \ + install-ps install-ps-am install-strip installcheck \ + installcheck-am installdirs maintainer-clean \ maintainer-clean-generic mostlyclean mostlyclean-generic \ mostlyclean-libtool pdf pdf-am ps ps-am uninstall uninstall-am \ - uninstall-man uninstall-man1 uninstall-man3 uninstall-man7 + uninstall-man uninstall-man3 uninstall-man7 dist-hook : $(MAN_DOC) $(MAN_HTML) -@BUILD_DOC_TRUE@.txt.html: -@BUILD_DOC_TRUE@ asciidoc -d manpage -b xhtml11 -f asciidoc.conf \ -@BUILD_DOC_TRUE@ -azmq_version=@PACKAGE_VERSION@ $< @BUILD_DOC_TRUE@.txt.xml: -@BUILD_DOC_TRUE@ asciidoc -d manpage -b docbook -f asciidoc.conf \ +@BUILD_DOC_TRUE@ $(AM_V_GEN)$(ASCIIDOC) -d manpage -b docbook -f asciidoc.conf \ @BUILD_DOC_TRUE@ -azmq_version=@PACKAGE_VERSION@ $< @BUILD_DOC_TRUE@.xml.1: -@BUILD_DOC_TRUE@ xmlto man $< +@BUILD_DOC_TRUE@ $(AM_V_GEN)$(XMLTO) man $< @BUILD_DOC_TRUE@.xml.3: -@BUILD_DOC_TRUE@ xmlto man $< +@BUILD_DOC_TRUE@ $(AM_V_GEN)$(XMLTO) man $< @BUILD_DOC_TRUE@.xml.7: -@BUILD_DOC_TRUE@ xmlto man $< +@BUILD_DOC_TRUE@ $(AM_V_GEN)$(XMLTO) man $< @BUILD_DOC_TRUE@zmq_epgm.7: zmq_pgm.7 -@BUILD_DOC_TRUE@ cp zmq_pgm.7 $@ +@BUILD_DOC_TRUE@ $(AM_V_GEN)cp zmq_pgm.7 $@ # Tell versions [3.59,3.63) of GNU make to not export all variables. # Otherwise a system limit (for SysV at least) may be exceeded. diff --git a/doc/zmq.7 b/doc/zmq.7 index 9b1e430..61345fb 100644 --- a/doc/zmq.7 +++ b/doc/zmq.7 @@ -2,12 +2,12 @@ .\" Title: zmq .\" Author: [see the "AUTHORS" section] .\" Generator: DocBook XSL Stylesheets v1.75.2 -.\" Date: 10/15/2010 +.\" Date: 03/15/2011 .\" Manual: 0MQ Manual -.\" Source: 0MQ 2.0.10 +.\" Source: 0MQ 2.1.3 .\" Language: English .\" -.TH "ZMQ" "7" "10/15/2010" "0MQ 2\&.0\&.10" "0MQ Manual" +.TH "ZMQ" "7" "03/15/2011" "0MQ 2\&.1\&.3" "0MQ Manual" .\" ----------------------------------------------------------------- .\" * Define some portability stuff .\" ----------------------------------------------------------------- @@ -63,7 +63,9 @@ Terminate 0MQ context \fBThread safety\fR .RS 4 .sp -A 0MQ \fIcontext\fR is thread safe and may be shared among as many application threads as necessary, without any additional locking required on the part of the caller\&. Each 0MQ socket belonging to a particular \fIcontext\fR may only be used by \fBthe thread that created it\fR using \fIzmq_socket()\fR\&. +A 0MQ \fIcontext\fR is thread safe and may be shared among as many application threads as necessary, without any additional locking required on the part of the caller\&. +.sp +Individual 0MQ \fIsockets\fR are \fInot\fR thread safe except in the case where full memory barriers are issued when migrating a socket from one thread to another\&. In practice this means applications can create a socket in one thread with \fIzmq_socket()\fR and then pass it to a \fInewly created\fR thread as part of thread initialization, for example via a structure passed as an argument to \fIpthread_create()\fR\&. .RE .sp .it 1 an-trap @@ -183,27 +185,9 @@ Local in\-process (inter\-thread) communication transport .RE .SS "Devices" .sp -Apart from the 0MQ library the 0MQ distribution includes \fIdevices\fR which are building blocks intended to serve as intermediate nodes in complex messaging topologies\&. +0MQ provides \fIdevices\fR, which are building blocks that act as intermediate nodes in complex messaging topologies\&. Devices can act as brokers that other nodes connect to, proxies that connect through to other nodes, or any mix of these two models\&. .sp -The following devices are provided: -.PP -Forwarder device for request\-response messaging -.RS 4 - -\fBzmq_queue\fR(1) -.RE -.PP -Forwarder device for publish\-subscribe messaging -.RS 4 - -\fBzmq_forwarder\fR(1) -.RE -.PP -Streamer device for parallelized pipeline messaging -.RS 4 - -\fBzmq_streamer\fR(1) -.RE +You can start a device in an application thread, see \fBzmq_device\fR(3)\&. .SH "ERROR HANDLING" .sp The 0MQ library functions handle errors using the standard conventions found on POSIX systems\&. Generally, this means that upon failure a 0MQ library function 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 \fIerrno\fR variable\&. @@ -231,7 +215,7 @@ The 0MQ distribution includes a C++ language binding, which is documented separa Other language bindings (Python, Ruby, Java and more) are provided by members of the 0MQ community and pointers can be found on the 0MQ website\&. .SH "AUTHORS" .sp -The 0MQ documentation was written by Martin Sustrik <\m[blue]\fBsustrik@250bpm\&.com\fR\m[]\&\s-2\u[1]\d\s+2> and Martin Lucina <\m[blue]\fBmato@kotelna\&.sk\fR\m[]\&\s-2\u[2]\d\s+2>\&. +This 0MQ manual page was written by Martin Sustrik <\m[blue]\fBsustrik@250bpm\&.com\fR\m[]\&\s-2\u[1]\d\s+2> and Martin Lucina <\m[blue]\fBmato@kotelna\&.sk\fR\m[]\&\s-2\u[2]\d\s+2>\&. .SH "RESOURCES" .sp Main web site: \m[blue]\fBhttp://www\&.zeromq\&.org/\fR\m[] diff --git a/doc/zmq.html b/doc/zmq.html deleted file mode 100644 index bbb90ec..0000000 --- a/doc/zmq.html +++ /dev/null @@ -1,866 +0,0 @@ - - - - - -zmq(7) - - - - - -
-

SYNOPSIS

-
-

#include <zmq.h>

-

cc [flags] files -lzmq [libraries]

-
-

DESCRIPTION

-
-

The ØMQ lightweight messaging kernel is a library which extends the standard -socket interfaces with features traditionally provided by specialised -messaging middleware products. ØMQ sockets provide an abstraction of -asynchronous message queues, multiple messaging patterns, message -filtering (subscriptions), seamless access to multiple transport protocols -and more.

-

This documentation presents an overview of ØMQ concepts, describes how ØMQ -abstracts standard sockets and provides a reference manual for the functions -provided by the ØMQ library.

-

Context

-

Before using any ØMQ library functions the caller must initialise a ØMQ -context using zmq_init(). The following functions are provided to handle -initialisation and termination of a context:

-
-
-Initialise ØMQ context -
-
-

- zmq_init(3) -

-
-
-Terminate ØMQ context -
-
-

- zmq_term(3) -

-
-
-

Thread safety

-

A ØMQ context is thread safe and may be shared among as many application -threads as necessary, without any additional locking required on the part of the -caller. Each ØMQ socket belonging to a particular context may only be used -by the thread that created it using zmq_socket().

-

Multiple contexts

-

Multiple contexts may coexist within a single application. Thus, an -application can use ØMQ directly and at the same time make use of any number of -additional libraries or components which themselves make use of ØMQ as long as -the above guidelines regarding thread safety are adhered to.

-

Messages

-

A ØMQ message is a discrete unit of data passed between applications or -components of the same application. ØMQ messages have no internal structure and -from the point of view of ØMQ itself they are considered to be opaque binary -data.

-

The following functions are provided to work with messages:

-
-
-Initialise a message -
-
-

- zmq_msg_init(3) - zmq_msg_init_size(3) - zmq_msg_init_data(3) -

-
-
-Release a message -
-
-

- zmq_msg_close(3) -

-
-
-Access message content -
-
-

- zmq_msg_data(3) - zmq_msg_size(3) -

-
-
-Message manipulation -
-
-

- zmq_msg_copy(3) - zmq_msg_move(3) -

-
-
-

Sockets

-

ØMQ sockets present an abstraction of a asynchronous message queue, with the -exact queueing semantics depending on the socket type in use. See -zmq_socket(3) for the socket types provided.

-

The following functions are provided to work with sockets:

-
-
-Creating a socket -
-
-

- zmq_socket(3) -

-
-
-Closing a socket -
-
-

- zmq_close(3) -

-
-
-Manipulating socket options -
-
-

- zmq_getsockopt(3) - zmq_setsockopt(3) -

-
-
-Establishing a message flow -
-
-

- zmq_bind(3) - zmq_connect(3) -

-
-
-Sending and receiving messages -
-
-

- zmq_send(3) - zmq_recv(3) -

-
-
-
Input/output multiplexing

ØMQ provides a mechanism for applications to multiplex input/output events over -a set containing both ØMQ sockets and standard sockets. This mechanism mirrors -the standard poll() system call, and is described in detail in -zmq_poll(3).

-

Transports

-

A ØMQ socket can use multiple different underlying transport mechanisms. -Each transport mechanism is suited to a particular purpose and has its own -advantages and drawbacks.

-

The following transport mechanisms are provided:

-
-
-Unicast transport using TCP -
-
-

- zmq_tcp(7) -

-
-
-Reliable multicast transport using PGM -
-
-

- zmq_pgm(7) -

-
-
-Local inter-process communication transport -
-
-

- zmq_ipc(7) -

-
-
-Local in-process (inter-thread) communication transport -
-
-

- zmq_inproc(7) -

-
-
-

Devices

-

Apart from the ØMQ library the ØMQ distribution includes devices which are -building blocks intended to serve as intermediate nodes in complex messaging -topologies.

-

The following devices are provided:

-
-
-Forwarder device for request-response messaging -
-
-

- zmq_queue(1) -

-
-
-Forwarder device for publish-subscribe messaging -
-
-

- zmq_forwarder(1) -

-
-
-Streamer device for parallelized pipeline messaging -
-
-

- zmq_streamer(1) -

-
-
-
-

ERROR HANDLING

-
-

The ØMQ library functions handle errors using the standard conventions found on -POSIX systems. Generally, this means that upon failure a ØMQ library function -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.

-

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 zmq_errno(3).

-

The zmq_strerror() function is provided to translate ØMQ-specific error codes -into error message strings; for details refer to zmq_strerror(3).

-
-

MISCELLANEOUS

-
-

The following miscellaneous functions are provided:

-
-
-Report ØMQ library version -
-
-

- zmq_version(3) -

-
-
-
-

LANGUAGE BINDINGS

-
-

The ØMQ library provides interfaces suitable for calling from programs in any -language; this documentation documents those interfaces as they would be used -by C programmers. The intent is that programmers using ØMQ from other languages -shall refer to this documentation alongside any documentation provided by the -vendor of their language binding.

-

C++ language binding

-

The ØMQ distribution includes a C++ language binding, which is documented -separately in zmq_cpp(7).

-

Other language bindings

-

Other language bindings (Python, Ruby, Java and more) are provided by members -of the ØMQ community and pointers can be found on the ØMQ website.

-
-

AUTHORS

-
-

The ØMQ documentation was written by Martin Sustrik <sustrik@250bpm.com> and -Martin Lucina <mato@kotelna.sk>.

-
-

RESOURCES

-
-

Main web site: http://www.zeromq.org/

-

Report bugs to the ØMQ development mailing list: <zeromq-dev@lists.zeromq.org>

-
-

COPYING

-
-

Free use of this software is granted under the terms of the GNU Lesser General -Public License (LGPL). For details see the files COPYING and COPYING.LESSER -included with the ØMQ distribution.

-
-
-
- - - diff --git a/doc/zmq.txt b/doc/zmq.txt index 06658c9..16a5d30 100644 --- a/doc/zmq.txt +++ b/doc/zmq.txt @@ -44,9 +44,15 @@ Terminate 0MQ context:: Thread safety ^^^^^^^^^^^^^ A 0MQ 'context' is thread safe and may be shared among as many application -threads as necessary, without any additional locking required on the part of the -caller. Each 0MQ socket belonging to a particular 'context' may only be used -by *the thread that created it* using _zmq_socket()_. +threads as necessary, without any additional locking required on the part of +the caller. + +Individual 0MQ 'sockets' are _not_ thread safe except in the case where full +memory barriers are issued when migrating a socket from one thread to another. +In practice this means applications can create a socket in one thread with +_zmq_socket()_ and then pass it to a _newly created_ thread as part of thread +initialization, for example via a structure passed as an argument to +_pthread_create()_. Multiple contexts @@ -139,20 +145,12 @@ Local in-process (inter-thread) communication transport:: Devices ~~~~~~~ -Apart from the 0MQ library the 0MQ distribution includes 'devices' which are -building blocks intended to serve as intermediate nodes in complex messaging -topologies. - -The following devices are provided: - -Forwarder device for request-response messaging:: - linkzmq:zmq_queue[1] - -Forwarder device for publish-subscribe messaging:: - linkzmq:zmq_forwarder[1] +0MQ provides 'devices', which are building blocks that act as intermediate +nodes in complex messaging topologies. Devices can act as brokers that other +nodes connect to, proxies that connect through to other nodes, or any mix of +these two models. -Streamer device for parallelized pipeline messaging:: - linkzmq:zmq_streamer[1] +You can start a device in an application thread, see linkzmq:zmq_device[3]. ERROR HANDLING @@ -202,7 +200,7 @@ of the 0MQ community and pointers can be found on the 0MQ website. AUTHORS ------- -The 0MQ documentation was written by Martin Sustrik and +This 0MQ manual page was written by Martin Sustrik and Martin Lucina . diff --git a/doc/zmq_bind.3 b/doc/zmq_bind.3 index c9e1e53..f4a637a 100644 --- a/doc/zmq_bind.3 +++ b/doc/zmq_bind.3 @@ -2,12 +2,12 @@ .\" Title: zmq_bind .\" Author: [see the "AUTHORS" section] .\" Generator: DocBook XSL Stylesheets v1.75.2 -.\" Date: 10/15/2010 +.\" Date: 03/15/2011 .\" Manual: 0MQ Manual -.\" Source: 0MQ 2.0.10 +.\" Source: 0MQ 2.1.3 .\" Language: English .\" -.TH "ZMQ_BIND" "3" "10/15/2010" "0MQ 2\&.0\&.10" "0MQ Manual" +.TH "ZMQ_BIND" "3" "03/15/2011" "0MQ 2\&.1\&.3" "0MQ Manual" .\" ----------------------------------------------------------------- .\" * Define some portability stuff .\" ----------------------------------------------------------------- @@ -120,6 +120,11 @@ The provided \fIsocket\fR was not valid (NULL)\&. .RE +.PP +\fBEMTHREAD\fR +.RS 4 +No I/O thread is available to accomplish the task\&. +.RE .SH "EXAMPLE" .PP \fBBinding a publisher socket to an in-process and a TCP transport\fR. @@ -147,7 +152,7 @@ assert (rc == 0); \fBzmq_connect\fR(3) \fBzmq_socket\fR(3) \fBzmq\fR(7) .SH "AUTHORS" .sp -The 0MQ documentation was written by Martin Sustrik <\m[blue]\fBsustrik@250bpm\&.com\fR\m[]\&\s-2\u[1]\d\s+2> and Martin Lucina <\m[blue]\fBmato@kotelna\&.sk\fR\m[]\&\s-2\u[2]\d\s+2>\&. +This 0MQ manual page was written by Martin Sustrik <\m[blue]\fBsustrik@250bpm\&.com\fR\m[]\&\s-2\u[1]\d\s+2> and Martin Lucina <\m[blue]\fBmato@kotelna\&.sk\fR\m[]\&\s-2\u[2]\d\s+2>\&. .SH "NOTES" .IP " 1." 4 sustrik@250bpm.com diff --git a/doc/zmq_bind.html b/doc/zmq_bind.html deleted file mode 100644 index 72d37dc..0000000 --- a/doc/zmq_bind.html +++ /dev/null @@ -1,738 +0,0 @@ - - - - - -zmq_bind(3) - - - - - -
-

SYNOPSIS

-
-

int zmq_bind (void *socket, const char *endpoint);

-
-

DESCRIPTION

-
-

The zmq_bind() function shall create an endpoint for accepting connections -and bind it to the socket referenced by the socket argument.

-

The endpoint argument is a string consisting of two parts as follows: -transport://address. The transport part specifies the underlying -transport protocol to use. The meaning of the address part is specific to -the underlying transport protocol selected.

-

The following transports are defined:

-
-
-inproc -
-
-

-local in-process (inter-thread) communication transport, see zmq_inproc(7) -

-
-
-ipc -
-
-

-local inter-process communication transport, see zmq_ipc(7) -

-
-
-tcp -
-
-

-unicast transport using TCP, see zmq_tcp(7) -

-
-
-pgm, epgm -
-
-

-reliable multicast transport using PGM, see zmq_pgm(7) -

-
-
-

With the exception of ZMQ_PAIR sockets, a single socket may be connected to -multiple endpoints using zmq_connect(), while simultaneously accepting -incoming connections from multiple endpoints bound to the socket using -zmq_bind(). Refer to zmq_socket(3) for a description of the exact -semantics involved when connecting or binding a socket to multiple endpoints.

-
-

RETURN VALUE

-
-

The zmq_bind() function shall return zero if successful. Otherwise it shall -return -1 and set errno to one of the values defined below.

-
-

ERRORS

-
-
-
-EPROTONOSUPPORT -
-
-

-The requested transport protocol is not supported. -

-
-
-ENOCOMPATPROTO -
-
-

-The requested transport protocol is not compatible with the socket type. -

-
-
-EADDRINUSE -
-
-

-The requested address is already in use. -

-
-
-EADDRNOTAVAIL -
-
-

-The requested address was not local. -

-
-
-ENODEV -
-
-

-The requested address specifies a nonexistent interface. -

-
-
-ETERM -
-
-

-The ØMQ context associated with the specified socket was terminated. -

-
-
-EFAULT -
-
-

-The provided socket was not valid (NULL). -

-
-
-
-

EXAMPLE

-
-
-
Binding a publisher socket to an in-process and a TCP transport