<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<title>The PyZMQ API — PyZMQ v2.2.0.1 documentation</title>
<link rel="stylesheet" href="../_static/default.css" type="text/css" />
<link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT: '../',
VERSION: '2.2.0.1',
COLLAPSE_INDEX: false,
FILE_SUFFIX: '.html',
HAS_SOURCE: true
};
</script>
<script type="text/javascript" src="../_static/jquery.js"></script>
<script type="text/javascript" src="../_static/underscore.js"></script>
<script type="text/javascript" src="../_static/doctools.js"></script>
<link rel="shortcut icon" href="../_static/zeromq.ico"/>
<link rel="top" title="PyZMQ v2.2.0.1 documentation" href="../index.html" />
<link rel="next" title="zmq" href="generated/zmq.html" />
<link rel="prev" title="Tunneling PyZMQ Connections with SSH" href="../ssh.html" />
</head>
<body>
<div style="background-color: white; text-align: left; padding: 10px 10px 15px 15px">
<a href="../index.html"><img src="../_static/logo.png" border="0" alt="PyZMQ Documentation"/></a>
</div>
<div class="related">
<h3>Navigation</h3>
<ul>
<li class="right" style="margin-right: 10px">
<a href="../genindex.html" title="General Index"
accesskey="I">index</a></li>
<li class="right" >
<a href="../py-modindex.html" title="Python Module Index"
>modules</a> |</li>
<li class="right" >
<a href="generated/zmq.html" title="zmq"
accesskey="N">next</a> |</li>
<li class="right" >
<a href="../ssh.html" title="Tunneling PyZMQ Connections with SSH"
accesskey="P">previous</a> |</li>
<li><a href="../index.html">home</a>| </li>
<li><a href="../search.html">search</a>| </li>
<li><a href="#">API</a> »</li>
</ul>
</div>
<div class="sphinxsidebar">
<div class="sphinxsidebarwrapper">
<h4>Previous topic</h4>
<p class="topless"><a href="../ssh.html"
title="previous chapter">Tunneling PyZMQ Connections with SSH</a></p>
<h4>Next topic</h4>
<p class="topless"><a href="generated/zmq.html"
title="next chapter">zmq</a></p>
<h3>This Page</h3>
<ul class="this-page-menu">
<li><a href="../_sources/api/index.txt"
rel="nofollow">Show Source</a></li>
</ul>
<div id="searchbox" style="display: none">
<h3>Quick search</h3>
<form class="search" action="../search.html" method="get">
<input type="text" name="q" size="18" />
<input type="submit" value="Go" />
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
<p class="searchtip" style="font-size: 90%">
Enter search terms or a module, class or function name.
</p>
</div>
<script type="text/javascript">$('#searchbox').show(0);</script>
</div>
</div>
<div class="document">
<div class="documentwrapper">
<div class="bodywrapper">
<div class="body">
<div class="section" id="the-pyzmq-api">
<span id="api-index"></span><h1>The PyZMQ API<a class="headerlink" href="#the-pyzmq-api" title="Permalink to this headline">¶</a></h1>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field"><th class="field-name">Release:</th><td class="field-body">2.2.0.1</td>
</tr>
<tr class="field"><th class="field-name">Date:</th><td class="field-body">August 21, 2012</td>
</tr>
</tbody>
</table>
<div class="toctree-wrapper compound">
<ul>
<li class="toctree-l1"><a class="reference internal" href="generated/zmq.html">zmq</a><ul>
<li class="toctree-l2"><a class="reference internal" href="generated/zmq.html#id1"><tt class="docutils literal"><span class="pre">zmq</span></tt></a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="generated/zmq.core.poll.html">core.poll</a><ul>
<li class="toctree-l2"><a class="reference internal" href="generated/zmq.core.poll.html#module-zmq.core.poll">Module: <tt class="docutils literal"><span class="pre">core.poll</span></tt></a></li>
<li class="toctree-l2"><a class="reference internal" href="generated/zmq.core.poll.html#poller"><tt class="docutils literal"><span class="pre">Poller</span></tt></a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="generated/zmq.core.pysocket.html">core.pysocket</a><ul>
<li class="toctree-l2"><a class="reference internal" href="generated/zmq.core.pysocket.html#module-zmq.core.pysocket">Module: <tt class="docutils literal"><span class="pre">core.pysocket</span></tt></a></li>
<li class="toctree-l2"><a class="reference internal" href="generated/zmq.core.pysocket.html#functions">Functions</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="generated/zmq.core.version.html">core.version</a><ul>
<li class="toctree-l2"><a class="reference internal" href="generated/zmq.core.version.html#module-zmq.core.version">Module: <tt class="docutils literal"><span class="pre">core.version</span></tt></a></li>
<li class="toctree-l2"><a class="reference internal" href="generated/zmq.core.version.html#functions">Functions</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="generated/zmq.devices.basedevice.html">devices.basedevice</a><ul>
<li class="toctree-l2"><a class="reference internal" href="generated/zmq.devices.basedevice.html#module-zmq.devices.basedevice">Module: <tt class="docutils literal"><span class="pre">devices.basedevice</span></tt></a><ul>
<li class="toctree-l3"><a class="reference internal" href="generated/zmq.devices.basedevice.html#authors">Authors</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="generated/zmq.devices.basedevice.html#classes">Classes</a><ul>
<li class="toctree-l3"><a class="reference internal" href="generated/zmq.devices.basedevice.html#backgrounddevice"><tt class="docutils literal"><span class="pre">BackgroundDevice</span></tt></a></li>
<li class="toctree-l3"><a class="reference internal" href="generated/zmq.devices.basedevice.html#device"><tt class="docutils literal"><span class="pre">Device</span></tt></a></li>
<li class="toctree-l3"><a class="reference internal" href="generated/zmq.devices.basedevice.html#processdevice"><tt class="docutils literal"><span class="pre">ProcessDevice</span></tt></a></li>
<li class="toctree-l3"><a class="reference internal" href="generated/zmq.devices.basedevice.html#threaddevice"><tt class="docutils literal"><span class="pre">ThreadDevice</span></tt></a></li>
</ul>
</li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="generated/zmq.devices.monitoredqueuedevice.html">devices.monitoredqueuedevice</a><ul>
<li class="toctree-l2"><a class="reference internal" href="generated/zmq.devices.monitoredqueuedevice.html#module-zmq.devices.monitoredqueuedevice">Module: <tt class="docutils literal"><span class="pre">devices.monitoredqueuedevice</span></tt></a><ul>
<li class="toctree-l3"><a class="reference internal" href="generated/zmq.devices.monitoredqueuedevice.html#authors">Authors</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="generated/zmq.devices.monitoredqueuedevice.html#classes">Classes</a><ul>
<li class="toctree-l3"><a class="reference internal" href="generated/zmq.devices.monitoredqueuedevice.html#monitoredqueue"><tt class="docutils literal"><span class="pre">MonitoredQueue</span></tt></a></li>
<li class="toctree-l3"><a class="reference internal" href="generated/zmq.devices.monitoredqueuedevice.html#monitoredqueuebase"><tt class="docutils literal"><span class="pre">MonitoredQueueBase</span></tt></a></li>
<li class="toctree-l3"><a class="reference internal" href="generated/zmq.devices.monitoredqueuedevice.html#processmonitoredqueue"><tt class="docutils literal"><span class="pre">ProcessMonitoredQueue</span></tt></a></li>
<li class="toctree-l3"><a class="reference internal" href="generated/zmq.devices.monitoredqueuedevice.html#threadmonitoredqueue"><tt class="docutils literal"><span class="pre">ThreadMonitoredQueue</span></tt></a></li>
</ul>
</li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="generated/zmq.eventloop.ioloop.html">eventloop.ioloop</a><ul>
<li class="toctree-l2"><a class="reference internal" href="generated/zmq.eventloop.ioloop.html#module-zmq.eventloop.ioloop">Module: <tt class="docutils literal"><span class="pre">eventloop.ioloop</span></tt></a></li>
<li class="toctree-l2"><a class="reference internal" href="generated/zmq.eventloop.ioloop.html#classes">Classes</a><ul>
<li class="toctree-l3"><a class="reference internal" href="generated/zmq.eventloop.ioloop.html#delayedcallback"><tt class="docutils literal"><span class="pre">DelayedCallback</span></tt></a></li>
<li class="toctree-l3"><a class="reference internal" href="generated/zmq.eventloop.ioloop.html#ioloop"><tt class="docutils literal"><span class="pre">IOLoop</span></tt></a></li>
<li class="toctree-l3"><a class="reference internal" href="generated/zmq.eventloop.ioloop.html#periodiccallback"><tt class="docutils literal"><span class="pre">PeriodicCallback</span></tt></a></li>
<li class="toctree-l3"><a class="reference internal" href="generated/zmq.eventloop.ioloop.html#zmqpoller"><tt class="docutils literal"><span class="pre">ZMQPoller</span></tt></a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="generated/zmq.eventloop.ioloop.html#function">Function</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="generated/zmq.eventloop.stack_context.html">eventloop.stack_context</a><ul>
<li class="toctree-l2"><a class="reference internal" href="generated/zmq.eventloop.stack_context.html#module-zmq.eventloop.stack_context">Module: <tt class="docutils literal"><span class="pre">eventloop.stack_context</span></tt></a></li>
<li class="toctree-l2"><a class="reference internal" href="generated/zmq.eventloop.stack_context.html#classes">Classes</a><ul>
<li class="toctree-l3"><a class="reference internal" href="generated/zmq.eventloop.stack_context.html#exceptionstackcontext"><tt class="docutils literal"><span class="pre">ExceptionStackContext</span></tt></a></li>
<li class="toctree-l3"><a class="reference internal" href="generated/zmq.eventloop.stack_context.html#nullcontext"><tt class="docutils literal"><span class="pre">NullContext</span></tt></a></li>
<li class="toctree-l3"><a class="reference internal" href="generated/zmq.eventloop.stack_context.html#stackcontext"><tt class="docutils literal"><span class="pre">StackContext</span></tt></a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="generated/zmq.eventloop.stack_context.html#function">Function</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="generated/zmq.eventloop.zmqstream.html">eventloop.zmqstream</a><ul>
<li class="toctree-l2"><a class="reference internal" href="generated/zmq.eventloop.zmqstream.html#module-zmq.eventloop.zmqstream">Module: <tt class="docutils literal"><span class="pre">eventloop.zmqstream</span></tt></a></li>
<li class="toctree-l2"><a class="reference internal" href="generated/zmq.eventloop.zmqstream.html#zmqstream"><tt class="docutils literal"><span class="pre">ZMQStream</span></tt></a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="generated/zmq.log.handlers.html">log.handlers</a><ul>
<li class="toctree-l2"><a class="reference internal" href="generated/zmq.log.handlers.html#module-zmq.log.handlers">Module: <tt class="docutils literal"><span class="pre">log.handlers</span></tt></a><ul>
<li class="toctree-l3"><a class="reference internal" href="generated/zmq.log.handlers.html#authors">Authors</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="generated/zmq.log.handlers.html#classes">Classes</a><ul>
<li class="toctree-l3"><a class="reference internal" href="generated/zmq.log.handlers.html#pubhandler"><tt class="docutils literal"><span class="pre">PUBHandler</span></tt></a></li>
<li class="toctree-l3"><a class="reference internal" href="generated/zmq.log.handlers.html#topiclogger"><tt class="docutils literal"><span class="pre">TopicLogger</span></tt></a></li>
</ul>
</li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="generated/zmq.ssh.forward.html">ssh.forward</a><ul>
<li class="toctree-l2"><a class="reference internal" href="generated/zmq.ssh.forward.html#module-zmq.ssh.forward">Module: <tt class="docutils literal"><span class="pre">ssh.forward</span></tt></a></li>
<li class="toctree-l2"><a class="reference internal" href="generated/zmq.ssh.forward.html#classes">Classes</a><ul>
<li class="toctree-l3"><a class="reference internal" href="generated/zmq.ssh.forward.html#forwardserver"><tt class="docutils literal"><span class="pre">ForwardServer</span></tt></a></li>
<li class="toctree-l3"><a class="reference internal" href="generated/zmq.ssh.forward.html#handler"><tt class="docutils literal"><span class="pre">Handler</span></tt></a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="generated/zmq.ssh.forward.html#function">Function</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="generated/zmq.ssh.tunnel.html">ssh.tunnel</a><ul>
<li class="toctree-l2"><a class="reference internal" href="generated/zmq.ssh.tunnel.html#module-zmq.ssh.tunnel">Module: <tt class="docutils literal"><span class="pre">ssh.tunnel</span></tt></a><ul>
<li class="toctree-l3"><a class="reference internal" href="generated/zmq.ssh.tunnel.html#authors">Authors</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="generated/zmq.ssh.tunnel.html#functions">Functions</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="generated/zmq.utils.jsonapi.html">utils.jsonapi</a><ul>
<li class="toctree-l2"><a class="reference internal" href="generated/zmq.utils.jsonapi.html#module-zmq.utils.jsonapi">Module: <tt class="docutils literal"><span class="pre">utils.jsonapi</span></tt></a><ul>
<li class="toctree-l3"><a class="reference internal" href="generated/zmq.utils.jsonapi.html#authors">Authors</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="generated/zmq.utils.jsonapi.html#functions">Functions</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="generated/zmq.web.proxy.html">web.proxy</a><ul>
<li class="toctree-l2"><a class="reference internal" href="generated/zmq.web.proxy.html#module-web-proxy">Module: <tt class="docutils literal"><span class="pre">web.proxy</span></tt></a></li>
<li class="toctree-l2"><a class="reference internal" href="generated/zmq.web.proxy.html#classes">Classes</a><ul>
<li class="toctree-l3"><a class="reference internal" href="generated/zmq.web.proxy.html#zmqapplicationproxy"><tt class="docutils literal"><span class="pre">ZMQApplicationProxy</span></tt></a></li>
<li class="toctree-l3"><a class="reference internal" href="generated/zmq.web.proxy.html#zmqrequesthandlerproxy"><tt class="docutils literal"><span class="pre">ZMQRequestHandlerProxy</span></tt></a></li>
<li class="toctree-l3"><a class="reference internal" href="generated/zmq.web.proxy.html#zmqstreamingapplicationproxy"><tt class="docutils literal"><span class="pre">ZMQStreamingApplicationProxy</span></tt></a></li>
</ul>
</li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="generated/zmq.web.zmqweb.html">web.zmqweb</a><ul>
<li class="toctree-l2"><a class="reference internal" href="generated/zmq.web.zmqweb.html#module-web-zmqweb">Module: <tt class="docutils literal"><span class="pre">web.zmqweb</span></tt></a></li>
<li class="toctree-l2"><a class="reference internal" href="generated/zmq.web.zmqweb.html#classes">Classes</a><ul>
<li class="toctree-l3"><a class="reference internal" href="generated/zmq.web.zmqweb.html#zmqapplication"><tt class="docutils literal"><span class="pre">ZMQApplication</span></tt></a></li>
<li class="toctree-l3"><a class="reference internal" href="generated/zmq.web.zmqweb.html#zmqhttprequest"><tt class="docutils literal"><span class="pre">ZMQHTTPRequest</span></tt></a></li>
<li class="toctree-l3"><a class="reference internal" href="generated/zmq.web.zmqweb.html#zmqstreaminghttprequest"><tt class="docutils literal"><span class="pre">ZMQStreamingHTTPRequest</span></tt></a></li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
</div>
</div>
</div>
</div>
<div class="clearer"></div>
</div>
<div class="related">
<h3>Navigation</h3>
<ul>
<li class="right" style="margin-right: 10px">
<a href="../genindex.html" title="General Index"
>index</a></li>
<li class="right" >
<a href="../py-modindex.html" title="Python Module Index"
>modules</a> |</li>
<li class="right" >
<a href="generated/zmq.html" title="zmq"
>next</a> |</li>
<li class="right" >
<a href="../ssh.html" title="Tunneling PyZMQ Connections with SSH"
>previous</a> |</li>
<li><a href="../index.html">home</a>| </li>
<li><a href="../search.html">search</a>| </li>
<li><a href="#">API</a> »</li>
</ul>
</div>
<div class="footer">
© Copyright 2010-2011, Brian E. Granger & Min Ragan-Kelley.
ØMQ logo © iMatix Corportation, used under the Creative Commons Attribution-Share Alike 3.0 License.
Python logo ™ of the Python Software Foundation, used by Min RK with permission from the Foundation.
Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 1.0.7.
</div>
</body>
</html>
distrib
>
Mandriva
>
2010.2
>
i586
>
media
>
contrib-backports
>
by-pkgid
>
b9ca70a7484981df9126f0365edf0863
>
files
>
250
