summaryrefslogtreecommitdiff
path: root/doc/zmq.html
diff options
context:
space:
mode:
Diffstat (limited to 'doc/zmq.html')
-rw-r--r--doc/zmq.html197
1 files changed, 123 insertions, 74 deletions
diff --git a/doc/zmq.html b/doc/zmq.html
index e44f8a1..2c3ceee 100644
--- a/doc/zmq.html
+++ b/doc/zmq.html
@@ -2,15 +2,28 @@
"http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en">
<head>
-<meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />
-<meta name="generator" content="AsciiDoc 8.5.2" />
+<meta http-equiv="Content-Type" content="application/xhtml+xml; charset=UTF-8" />
+<meta name="generator" content="AsciiDoc 8.6.4" />
<title>zmq(7)</title>
<style type="text/css">
-/* Debug borders */
-p, li, dt, dd, div, pre, h1, h2, h3, h4, h5, h6 {
-/*
- border: 1px solid red;
-*/
+/* Sans-serif font. */
+h1, h2, h3, h4, h5, h6,
+div.title, caption.title,
+thead, p.table.header,
+div#toctitle,
+span#author, span#revnumber, span#revdate, span#revremark,
+div#footer {
+ font-family: Arial,Helvetica,sans-serif;
+}
+
+/* Serif font. */
+div.sectionbody {
+ font-family: Georgia,"Times New Roman",Times,serif;
+}
+
+/* Monospace font. */
+tt {
+ font-size: inherit;
}
body {
@@ -36,12 +49,12 @@ strong {
}
tt {
+ font-size: inherit;
color: navy;
}
h1, h2, h3, h4, h5, h6 {
color: #527bbd;
- font-family: sans-serif;
margin-top: 1.2em;
margin-bottom: 0.5em;
line-height: 1.3;
@@ -61,7 +74,6 @@ h3 + * {
}
div.sectionbody {
- font-family: serif;
margin-left: 0;
}
@@ -77,6 +89,8 @@ p {
ul, ol, li > p {
margin-top: 0;
}
+ul > li { color: #aaa; }
+ul > li > * { color: black; }
pre {
padding: 0;
@@ -85,18 +99,15 @@ pre {
span#author {
color: #527bbd;
- font-family: sans-serif;
font-weight: bold;
font-size: 1.1em;
}
span#email {
}
span#revnumber, span#revdate, span#revremark {
- font-family: sans-serif;
}
div#footer {
- font-family: sans-serif;
font-size: small;
border-top: 2px solid silver;
padding-top: 0.5em;
@@ -135,7 +146,6 @@ div.content { /* Block element content. */
/* Block element titles. */
div.title, caption.title {
color: #527bbd;
- font-family: sans-serif;
font-weight: bold;
text-align: left;
margin-top: 1.0em;
@@ -157,13 +167,15 @@ div.content + div.title {
div.sidebarblock > div.content {
background: #ffffee;
- border: 1px solid silver;
+ border: 1px solid #dddddd;
+ border-left: 4px solid #f0f0f0;
padding: 0.5em;
}
div.listingblock > div.content {
- border: 1px solid silver;
- background: #f4f4f4;
+ border: 1px solid #dddddd;
+ border-left: 5px solid #f0f0f0;
+ background: #f8f8f8;
padding: 0.5em;
}
@@ -171,7 +183,7 @@ div.quoteblock, div.verseblock {
padding-left: 1.0em;
margin-left: 1.0em;
margin-right: 10%;
- border-left: 5px solid #dddddd;
+ border-left: 5px solid #f0f0f0;
color: #777777;
}
@@ -180,8 +192,9 @@ div.quoteblock > div.attribution {
text-align: right;
}
-div.verseblock > div.content {
- white-space: pre;
+div.verseblock > pre.content {
+ font-family: inherit;
+ font-size: inherit;
}
div.verseblock > div.attribution {
padding-top: 0.75em;
@@ -258,8 +271,8 @@ div.tableblock > table {
border: 3px solid #527bbd;
}
thead, p.table.header {
- font-family: sans-serif;
font-weight: bold;
+ color: #527bbd;
}
tfoot {
font-weight: bold;
@@ -339,6 +352,14 @@ span.footnote, span.footnoteref {
min-width: 100px;
}
+div.colist td {
+ padding-right: 0.5em;
+ padding-bottom: 0.3em;
+ vertical-align: top;
+}
+div.colist td img {
+ margin-top: 0.3em;
+}
@media print {
div#footer-badges { display: none; }
@@ -350,7 +371,6 @@ div#toc {
div#toctitle {
color: #527bbd;
- font-family: sans-serif;
font-size: 1.1em;
font-weight: bold;
margin-top: 1.0em;
@@ -373,6 +393,43 @@ div.toclevel4 {
margin-left: 6em;
font-size: 0.9em;
}
+
+span.aqua { color: aqua; }
+span.black { color: black; }
+span.blue { color: blue; }
+span.fuchsia { color: fuchsia; }
+span.gray { color: gray; }
+span.green { color: green; }
+span.lime { color: lime; }
+span.maroon { color: maroon; }
+span.navy { color: navy; }
+span.olive { color: olive; }
+span.purple { color: purple; }
+span.red { color: red; }
+span.silver { color: silver; }
+span.teal { color: teal; }
+span.white { color: white; }
+span.yellow { color: yellow; }
+
+span.aqua-background { background: aqua; }
+span.black-background { background: black; }
+span.blue-background { background: blue; }
+span.fuchsia-background { background: fuchsia; }
+span.gray-background { background: gray; }
+span.green-background { background: green; }
+span.lime-background { background: lime; }
+span.maroon-background { background: maroon; }
+span.navy-background { background: navy; }
+span.olive-background { background: olive; }
+span.purple-background { background: purple; }
+span.red-background { background: red; }
+span.silver-background { background: silver; }
+span.teal-background { background: teal; }
+span.white-background { background: white; }
+span.yellow-background { background: yellow; }
+
+span.big { font-size: 2em; }
+span.small { font-size: 0.6em; }
/* Overrides for manpage documents */
h1 {
padding-top: 0.5em;
@@ -391,47 +448,6 @@ div.sectionbody {
div#toc { display: none; }
}
-/* Workarounds for IE6's broken and incomplete CSS2. */
-
-div.sidebar-content {
- background: #ffffee;
- border: 1px solid silver;
- padding: 0.5em;
-}
-div.sidebar-title, div.image-title {
- color: #527bbd;
- font-family: sans-serif;
- font-weight: bold;
- margin-top: 0.0em;
- margin-bottom: 0.5em;
-}
-
-div.listingblock div.content {
- border: 1px solid silver;
- background: #f4f4f4;
- padding: 0.5em;
-}
-
-div.quoteblock-attribution {
- padding-top: 0.5em;
- text-align: right;
-}
-
-div.verseblock-content {
- white-space: pre;
-}
-div.verseblock-attribution {
- padding-top: 0.75em;
- text-align: left;
-}
-
-div.exampleblock-content {
- border-left: 3px solid #dddddd;
- padding-left: 0.5em;
-}
-
-/* IE6 sets dynamically generated links as visited. */
-div#toc a:visited { color: blue; }
</style>
<script type="text/javascript">
/*<![CDATA[*/
@@ -567,7 +583,7 @@ footnotes: function () {
/*]]>*/
</script>
</head>
-<body>
+<body class="manpage">
<div id="header">
<h1>
zmq(7) Manual Page
@@ -580,11 +596,14 @@ zmq(7) Manual Page
</div>
</div>
<div id="content">
+<div class="sect1">
<h2 id="_synopsis">SYNOPSIS</h2>
<div class="sectionbody">
<div class="paragraph"><p><strong>#include &lt;zmq.h&gt;</strong></p></div>
<div class="paragraph"><p><strong>cc</strong> [<em>flags</em>] <em>files</em> <strong>-lzmq</strong> [<em>libraries</em>]</p></div>
</div>
+</div>
+<div class="sect1">
<h2 id="_description">DESCRIPTION</h2>
<div class="sectionbody">
<div class="paragraph"><p>The ØMQ lightweight messaging kernel is a library which extends the standard
@@ -596,7 +615,8 @@ and more.</p></div>
<div class="paragraph"><p>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.</p></div>
-<h3 id="_context">Context</h3><div style="clear:left"></div>
+<div class="sect2">
+<h3 id="_context">Context</h3>
<div class="paragraph"><p>Before using any ØMQ library functions the caller must initialise a ØMQ
<em>context</em> using <em>zmq_init()</em>. The following functions are provided to handle
initialisation and termination of a <em>context</em>:</p></div>
@@ -618,6 +638,7 @@ Terminate ØMQ context
</p>
</dd>
</dl></div>
+<div class="sect3">
<h4 id="_thread_safety">Thread safety</h4>
<div class="paragraph"><p>A ØMQ <em>context</em> is thread safe and may be shared among as many application
threads as necessary, without any additional locking required on the part of
@@ -628,12 +649,17 @@ In practice this means applications can create a socket in one thread with
<em>zmq_socket()</em> and then pass it to a <em>newly created</em> thread as part of thread
initialization, for example via a structure passed as an argument to
<em>pthread_create()</em>.</p></div>
+</div>
+<div class="sect3">
<h4 id="_multiple_contexts">Multiple contexts</h4>
<div class="paragraph"><p>Multiple <em>contexts</em> 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.</p></div>
-<h3 id="_messages">Messages</h3><div style="clear:left"></div>
+</div>
+</div>
+<div class="sect2">
+<h3 id="_messages">Messages</h3>
<div class="paragraph"><p>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
@@ -677,7 +703,9 @@ Message manipulation
</p>
</dd>
</dl></div>
-<h3 id="_sockets">Sockets</h3><div style="clear:left"></div>
+</div>
+<div class="sect2">
+<h3 id="_sockets">Sockets</h3>
<div class="paragraph"><p>ØMQ sockets present an abstraction of a asynchronous <em>message queue</em>, with the
exact queueing semantics depending on the socket type in use. See
<a href="zmq_socket.html">zmq_socket(3)</a> for the socket types provided.</p></div>
@@ -731,7 +759,9 @@ Sending and receiving messages
a set containing both ØMQ sockets and standard sockets. This mechanism mirrors
the standard <em>poll()</em> system call, and is described in detail in
<a href="zmq_poll.html">zmq_poll(3)</a>.</p></div>
-<h3 id="_transports">Transports</h3><div style="clear:left"></div>
+</div>
+<div class="sect2">
+<h3 id="_transports">Transports</h3>
<div class="paragraph"><p>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.</p></div>
@@ -770,13 +800,18 @@ Local in-process (inter-thread) communication transport
</p>
</dd>
</dl></div>
-<h3 id="_devices">Devices</h3><div style="clear:left"></div>
+</div>
+<div class="sect2">
+<h3 id="_devices">Devices</h3>
<div class="paragraph"><p>ØMQ provides <em>devices</em>, 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.</p></div>
<div class="paragraph"><p>You can start a device in an application thread, see <a href="zmq_device.html">zmq_device(3)</a>.</p></div>
</div>
+</div>
+</div>
+<div class="sect1">
<h2 id="_error_handling">ERROR HANDLING</h2>
<div class="sectionbody">
<div class="paragraph"><p>The ØMQ library functions handle errors using the standard conventions found on
@@ -790,6 +825,8 @@ to assist in these cases; for details refer to <a href="zmq_errno.html">zmq_errn
<div class="paragraph"><p>The <em>zmq_strerror()</em> function is provided to translate ØMQ-specific error codes
into error message strings; for details refer to <a href="zmq_strerror.html">zmq_strerror(3)</a>.</p></div>
</div>
+</div>
+<div class="sect1">
<h2 id="_miscellaneous">MISCELLANEOUS</h2>
<div class="sectionbody">
<div class="paragraph"><p>The following miscellaneous functions are provided:</p></div>
@@ -804,6 +841,8 @@ Report ØMQ library version
</dd>
</dl></div>
</div>
+</div>
+<div class="sect1">
<h2 id="_language_bindings">LANGUAGE BINDINGS</h2>
<div class="sectionbody">
<div class="paragraph"><p>The ØMQ library provides interfaces suitable for calling from programs in any
@@ -811,23 +850,32 @@ 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.</p></div>
-<h3 id="_c_language_binding">C++ language binding</h3><div style="clear:left"></div>
+<div class="sect2">
+<h3 id="_c_language_binding">C++ language binding</h3>
<div class="paragraph"><p>The ØMQ distribution includes a C++ language binding, which is documented
separately in <a href="zmq_cpp.html">zmq_cpp(7)</a>.</p></div>
-<h3 id="_other_language_bindings">Other language bindings</h3><div style="clear:left"></div>
+</div>
+<div class="sect2">
+<h3 id="_other_language_bindings">Other language bindings</h3>
<div class="paragraph"><p>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.</p></div>
</div>
+</div>
+</div>
+<div class="sect1">
<h2 id="_authors">AUTHORS</h2>
<div class="sectionbody">
-<div class="paragraph"><p>This ØMQ manual page was written by Martin Sustrik &lt;<a href="mailto:sustrik@250bpm.com">sustrik@250bpm.com</a>&gt; and
-Martin Lucina &lt;<a href="mailto:mato@kotelna.sk">mato@kotelna.sk</a>&gt;.</p></div>
+<div class="paragraph"><p>This manual page was written by the ØMQ community.</p></div>
</div>
+</div>
+<div class="sect1">
<h2 id="_resources">RESOURCES</h2>
<div class="sectionbody">
<div class="paragraph"><p>Main web site: <a href="http://www.zeromq.org/">http://www.zeromq.org/</a></p></div>
<div class="paragraph"><p>Report bugs to the ØMQ development mailing list: &lt;<a href="mailto:zeromq-dev@lists.zeromq.org">zeromq-dev@lists.zeromq.org</a>&gt;</p></div>
</div>
+</div>
+<div class="sect1">
<h2 id="_copying">COPYING</h2>
<div class="sectionbody">
<div class="paragraph"><p>Free use of this software is granted under the terms of the GNU Lesser General
@@ -835,11 +883,12 @@ Public License (LGPL). For details see the files <tt>COPYING</tt> and <tt>COPYIN
included with the ØMQ distribution.</p></div>
</div>
</div>
+</div>
<div id="footnotes"><hr /></div>
<div id="footer">
<div id="footer-text">
-ØMQ 2.1.7<br />
-Last updated 2011-03-14 01:40:09 CDT
+ØMQ 2.2.0<br />
+Last updated 2012-04-04 13:04:06 CEST
</div>
</div>
</body>
generated by cgit v1.2.3 (git 2.25.1) at 2024-04-28 03:39:41 +0000