<!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>devices.basedevice — 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="up" title="The PyZMQ API" href="../index.html" />
<link rel="next" title="devices.monitoredqueuedevice" href="zmq.devices.monitoredqueuedevice.html" />
<link rel="prev" title="core.version" href="zmq.core.version.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="zmq.devices.monitoredqueuedevice.html" title="devices.monitoredqueuedevice"
accesskey="N">next</a> |</li>
<li class="right" >
<a href="zmq.core.version.html" title="core.version"
accesskey="P">previous</a> |</li>
<li><a href="../../index.html">home</a>| </li>
<li><a href="../../search.html">search</a>| </li>
<li><a href="../index.html">API</a> »</li>
<li><a href="../index.html" accesskey="U">The PyZMQ API</a> »</li>
</ul>
</div>
<div class="sphinxsidebar">
<div class="sphinxsidebarwrapper">
<h3><a href="../../index.html">Table Of Contents</a></h3>
<ul>
<li><a class="reference internal" href="#">devices.basedevice</a><ul>
<li><a class="reference internal" href="#module-zmq.devices.basedevice">Module: <tt class="docutils literal"><span class="pre">devices.basedevice</span></tt></a><ul>
<li><a class="reference internal" href="#authors">Authors</a></li>
</ul>
</li>
<li><a class="reference internal" href="#classes">Classes</a><ul>
<li><a class="reference internal" href="#backgrounddevice"><tt class="docutils literal"><span class="pre">BackgroundDevice</span></tt></a></li>
<li><a class="reference internal" href="#device"><tt class="docutils literal"><span class="pre">Device</span></tt></a></li>
<li><a class="reference internal" href="#processdevice"><tt class="docutils literal"><span class="pre">ProcessDevice</span></tt></a></li>
<li><a class="reference internal" href="#threaddevice"><tt class="docutils literal"><span class="pre">ThreadDevice</span></tt></a></li>
</ul>
</li>
</ul>
</li>
</ul>
<h4>Previous topic</h4>
<p class="topless"><a href="zmq.core.version.html"
title="previous chapter">core.version</a></p>
<h4>Next topic</h4>
<p class="topless"><a href="zmq.devices.monitoredqueuedevice.html"
title="next chapter">devices.monitoredqueuedevice</a></p>
<h3>This Page</h3>
<ul class="this-page-menu">
<li><a href="../../_sources/api/generated/zmq.devices.basedevice.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="devices-basedevice">
<h1>devices.basedevice<a class="headerlink" href="#devices-basedevice" title="Permalink to this headline">¶</a></h1>
<div class="section" id="module-zmq.devices.basedevice">
<span id="module-devices-basedevice"></span><h2>Module: <tt class="xref py py-mod docutils literal"><span class="pre">devices.basedevice</span></tt><a class="headerlink" href="#module-zmq.devices.basedevice" title="Permalink to this headline">¶</a></h2>
<p>Classes for running 0MQ Devices in the background.</p>
<div class="section" id="authors">
<h3>Authors<a class="headerlink" href="#authors" title="Permalink to this headline">¶</a></h3>
<ul class="simple">
<li>MinRK</li>
<li>Brian Granger</li>
</ul>
</div>
</div>
<div class="section" id="classes">
<h2>Classes<a class="headerlink" href="#classes" title="Permalink to this headline">¶</a></h2>
<div class="section" id="backgrounddevice">
<h3><a class="reference internal" href="#zmq.devices.basedevice.BackgroundDevice" title="zmq.devices.basedevice.BackgroundDevice"><tt class="xref py py-class docutils literal"><span class="pre">BackgroundDevice</span></tt></a><a class="headerlink" href="#backgrounddevice" title="Permalink to this headline">¶</a></h3>
<dl class="class">
<dt id="zmq.devices.basedevice.BackgroundDevice">
<em class="property">class </em><tt class="descclassname">zmq.devices.basedevice.</tt><tt class="descname">BackgroundDevice</tt><big>(</big><em>device_type</em>, <em>in_type</em>, <em>out_type</em><big>)</big><a class="headerlink" href="#zmq.devices.basedevice.BackgroundDevice" title="Permalink to this definition">¶</a></dt>
<dd><p>Base class for launching Devices in background processes and threads.</p>
<dl class="method">
<dt id="zmq.devices.basedevice.BackgroundDevice.bind_in">
<tt class="descname">bind_in</tt><big>(</big><em>addr</em><big>)</big><a class="headerlink" href="#zmq.devices.basedevice.BackgroundDevice.bind_in" title="Permalink to this definition">¶</a></dt>
<dd><p>Enqueue ZMQ address for binding on in_socket.</p>
<p>See zmq.Socket.bind for details.</p>
</dd></dl>
<dl class="method">
<dt id="zmq.devices.basedevice.BackgroundDevice.bind_out">
<tt class="descname">bind_out</tt><big>(</big><em>iface</em><big>)</big><a class="headerlink" href="#zmq.devices.basedevice.BackgroundDevice.bind_out" title="Permalink to this definition">¶</a></dt>
<dd><p>Enqueue ZMQ address for binding on out_socket.</p>
<p>See zmq.Socket.bind for details.</p>
</dd></dl>
<dl class="method">
<dt id="zmq.devices.basedevice.BackgroundDevice.connect_in">
<tt class="descname">connect_in</tt><big>(</big><em>addr</em><big>)</big><a class="headerlink" href="#zmq.devices.basedevice.BackgroundDevice.connect_in" title="Permalink to this definition">¶</a></dt>
<dd><p>Enqueue ZMQ address for connecting on in_socket.</p>
<p>See zmq.Socket.connect for details.</p>
</dd></dl>
<dl class="method">
<dt id="zmq.devices.basedevice.BackgroundDevice.connect_out">
<tt class="descname">connect_out</tt><big>(</big><em>iface</em><big>)</big><a class="headerlink" href="#zmq.devices.basedevice.BackgroundDevice.connect_out" title="Permalink to this definition">¶</a></dt>
<dd><p>Enqueue ZMQ address for connecting on out_socket.</p>
<p>See zmq.Socket.connect for details.</p>
</dd></dl>
<dl class="staticmethod">
<dt id="zmq.devices.basedevice.BackgroundDevice.context_factory">
<em class="property">static </em><tt class="descname">context_factory</tt><big>(</big><big>)</big><a class="headerlink" href="#zmq.devices.basedevice.BackgroundDevice.context_factory" title="Permalink to this definition">¶</a></dt>
<dd><p>Returns a global Context instance.</p>
<p>Most single-threaded applications have a single, global Context.
Use this method instead of passing around Context instances
throughout your code.</p>
<p>A common pattern for classes that depend on Contexts is to use
a default argument to enable programs with multiple Contexts
but not require the argument for simpler applications:</p>
<blockquote>
<div><dl class="docutils">
<dt>class MyClass(object):</dt>
<dd><dl class="first last docutils">
<dt>def __init__(self, context=None):</dt>
<dd>self.context = context or Context.instance()</dd>
</dl>
</dd>
</dl>
</div></blockquote>
</dd></dl>
<dl class="method">
<dt id="zmq.devices.basedevice.BackgroundDevice.join">
<tt class="descname">join</tt><big>(</big><em>timeout=None</em><big>)</big><a class="headerlink" href="#zmq.devices.basedevice.BackgroundDevice.join" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="method">
<dt id="zmq.devices.basedevice.BackgroundDevice.run">
<tt class="descname">run</tt><big>(</big><big>)</big><a class="headerlink" href="#zmq.devices.basedevice.BackgroundDevice.run" title="Permalink to this definition">¶</a></dt>
<dd><p>The runner method.</p>
<p>Do not call me directly, instead call <tt class="docutils literal"><span class="pre">self.start()</span></tt>, just like a
Thread.</p>
</dd></dl>
<dl class="method">
<dt id="zmq.devices.basedevice.BackgroundDevice.setsockopt_in">
<tt class="descname">setsockopt_in</tt><big>(</big><em>opt</em>, <em>value</em><big>)</big><a class="headerlink" href="#zmq.devices.basedevice.BackgroundDevice.setsockopt_in" title="Permalink to this definition">¶</a></dt>
<dd><p>Enqueue setsockopt(opt, value) for in_socket</p>
<p>See zmq.Socket.setsockopt for details.</p>
</dd></dl>
<dl class="method">
<dt id="zmq.devices.basedevice.BackgroundDevice.setsockopt_out">
<tt class="descname">setsockopt_out</tt><big>(</big><em>opt</em>, <em>value</em><big>)</big><a class="headerlink" href="#zmq.devices.basedevice.BackgroundDevice.setsockopt_out" title="Permalink to this definition">¶</a></dt>
<dd><p>Enqueue setsockopt(opt, value) for out_socket</p>
<p>See zmq.Socket.setsockopt for details.</p>
</dd></dl>
<dl class="method">
<dt id="zmq.devices.basedevice.BackgroundDevice.start">
<tt class="descname">start</tt><big>(</big><big>)</big><a class="headerlink" href="#zmq.devices.basedevice.BackgroundDevice.start" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
</dd></dl>
</div>
<div class="section" id="device">
<h3><a class="reference internal" href="#zmq.devices.basedevice.Device" title="zmq.devices.basedevice.Device"><tt class="xref py py-class docutils literal"><span class="pre">Device</span></tt></a><a class="headerlink" href="#device" title="Permalink to this headline">¶</a></h3>
<dl class="class">
<dt id="zmq.devices.basedevice.Device">
<em class="property">class </em><tt class="descclassname">zmq.devices.basedevice.</tt><tt class="descname">Device</tt><big>(</big><em>device_type</em>, <em>in_type</em>, <em>out_type</em><big>)</big><a class="headerlink" href="#zmq.devices.basedevice.Device" title="Permalink to this definition">¶</a></dt>
<dd><p>A Threadsafe 0MQ Device.</p>
<p><em>Warning</em> as with most ‘threadsafe’ Python objects, this is only
threadsafe as long as you do not use private methods or attributes.
Private names are prefixed with ‘_’, such as <tt class="docutils literal"><span class="pre">self._setup_socket()</span></tt>.</p>
<p>For thread safety, you do not pass Sockets to this, but rather Socket
types:</p>
<div class="highlight-python"><div class="highlight"><pre><span class="n">Device</span><span class="p">(</span><span class="n">device_type</span><span class="p">,</span> <span class="n">in_socket_type</span><span class="p">,</span> <span class="n">out_socket_type</span><span class="p">)</span>
</pre></div>
</div>
<p>For instance:</p>
<div class="highlight-python"><div class="highlight"><pre><span class="n">dev</span> <span class="o">=</span> <span class="n">Device</span><span class="p">(</span><span class="n">zmq</span><span class="o">.</span><span class="n">QUEUE</span><span class="p">,</span> <span class="n">zmq</span><span class="o">.</span><span class="n">DEALER</span><span class="p">,</span> <span class="n">zmq</span><span class="o">.</span><span class="n">ROUTER</span><span class="p">)</span>
</pre></div>
</div>
<p>Similar to zmq.device, but socket types instead of sockets themselves are
passed, and the sockets are created in the work thread, to avoid issues
with thread safety. As a result, additional bind_{in|out} and
connect_{in|out} methods and setsockopt_{in|out} allow users to specify
connections for the sockets.</p>
<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">Parameters :</th><td class="field-body"><p class="first"><strong>device_type</strong> : int</p>
<blockquote>
<div><p>The 0MQ Device type</p>
</div></blockquote>
<p><strong>{in|out}_type</strong> : int</p>
<blockquote>
<div><p>zmq socket types, to be passed later to context.socket(). e.g.
zmq.PUB, zmq.SUB, zmq.REQ. If out_type is < 0, then in_socket is used
for both in_socket and out_socket.</p>
</div></blockquote>
</td>
</tr>
<tr class="field"><th class="field-name">Attributes :</th><td class="field-body"><p class="first"><strong>daemon</strong> : int</p>
<blockquote>
<div><p>sets whether the thread should be run as a daemon
Default is true, because if it is false, the thread will not
exit unless it is killed</p>
</div></blockquote>
<p><strong>context_factory</strong> : callable (class attribute)</p>
<blockquote>
<div><p>Function for creating the Context. This will be Context.intance
in ThreadDevices, and Context in ProcessDevices. The only reason
it is not instance() in ProcessDevices is that there may be a stale
Context instance already initialized, and the forked environment
should <em>never</em> try to use it.</p>
</div></blockquote>
</td>
</tr>
<tr class="field"><th class="field-name">Methods :</th><td class="field-body"><p class="first"><strong>bind_{in_out}(iface)</strong> :</p>
<blockquote>
<div><p>passthrough for <tt class="docutils literal"><span class="pre">{in|out}_socket.bind(iface)</span></tt>, to be called in the thread</p>
</div></blockquote>
<p><strong>connect_{in_out}(iface)</strong> :</p>
<blockquote>
<div><p>passthrough for <tt class="docutils literal"><span class="pre">{in|out}_socket.connect(iface)</span></tt>, to be called in the
thread</p>
</div></blockquote>
<p><strong>setsockopt_{in_out}(opt,value)</strong> :</p>
<blockquote class="last">
<div><p>passthrough for <tt class="docutils literal"><span class="pre">{in|out}_socket.setsockopt(opt,</span> <span class="pre">value)</span></tt>, to be called in
the thread</p>
</div></blockquote>
</td>
</tr>
</tbody>
</table>
<dl class="method">
<dt id="zmq.devices.basedevice.Device.bind_in">
<tt class="descname">bind_in</tt><big>(</big><em>addr</em><big>)</big><a class="headerlink" href="#zmq.devices.basedevice.Device.bind_in" title="Permalink to this definition">¶</a></dt>
<dd><p>Enqueue ZMQ address for binding on in_socket.</p>
<p>See zmq.Socket.bind for details.</p>
</dd></dl>
<dl class="method">
<dt id="zmq.devices.basedevice.Device.bind_out">
<tt class="descname">bind_out</tt><big>(</big><em>iface</em><big>)</big><a class="headerlink" href="#zmq.devices.basedevice.Device.bind_out" title="Permalink to this definition">¶</a></dt>
<dd><p>Enqueue ZMQ address for binding on out_socket.</p>
<p>See zmq.Socket.bind for details.</p>
</dd></dl>
<dl class="method">
<dt id="zmq.devices.basedevice.Device.connect_in">
<tt class="descname">connect_in</tt><big>(</big><em>addr</em><big>)</big><a class="headerlink" href="#zmq.devices.basedevice.Device.connect_in" title="Permalink to this definition">¶</a></dt>
<dd><p>Enqueue ZMQ address for connecting on in_socket.</p>
<p>See zmq.Socket.connect for details.</p>
</dd></dl>
<dl class="method">
<dt id="zmq.devices.basedevice.Device.connect_out">
<tt class="descname">connect_out</tt><big>(</big><em>iface</em><big>)</big><a class="headerlink" href="#zmq.devices.basedevice.Device.connect_out" title="Permalink to this definition">¶</a></dt>
<dd><p>Enqueue ZMQ address for connecting on out_socket.</p>
<p>See zmq.Socket.connect for details.</p>
</dd></dl>
<dl class="staticmethod">
<dt id="zmq.devices.basedevice.Device.context_factory">
<em class="property">static </em><tt class="descname">context_factory</tt><big>(</big><big>)</big><a class="headerlink" href="#zmq.devices.basedevice.Device.context_factory" title="Permalink to this definition">¶</a></dt>
<dd><p>Returns a global Context instance.</p>
<p>Most single-threaded applications have a single, global Context.
Use this method instead of passing around Context instances
throughout your code.</p>
<p>A common pattern for classes that depend on Contexts is to use
a default argument to enable programs with multiple Contexts
but not require the argument for simpler applications:</p>
<blockquote>
<div><dl class="docutils">
<dt>class MyClass(object):</dt>
<dd><dl class="first last docutils">
<dt>def __init__(self, context=None):</dt>
<dd>self.context = context or Context.instance()</dd>
</dl>
</dd>
</dl>
</div></blockquote>
</dd></dl>
<dl class="method">
<dt id="zmq.devices.basedevice.Device.join">
<tt class="descname">join</tt><big>(</big><em>timeout=None</em><big>)</big><a class="headerlink" href="#zmq.devices.basedevice.Device.join" title="Permalink to this definition">¶</a></dt>
<dd><p>wait for me to finish, like Thread.join.</p>
<p>Reimplemented appropriately by sublcasses.</p>
</dd></dl>
<dl class="method">
<dt id="zmq.devices.basedevice.Device.run">
<tt class="descname">run</tt><big>(</big><big>)</big><a class="headerlink" href="#zmq.devices.basedevice.Device.run" title="Permalink to this definition">¶</a></dt>
<dd><p>The runner method.</p>
<p>Do not call me directly, instead call <tt class="docutils literal"><span class="pre">self.start()</span></tt>, just like a
Thread.</p>
</dd></dl>
<dl class="method">
<dt id="zmq.devices.basedevice.Device.setsockopt_in">
<tt class="descname">setsockopt_in</tt><big>(</big><em>opt</em>, <em>value</em><big>)</big><a class="headerlink" href="#zmq.devices.basedevice.Device.setsockopt_in" title="Permalink to this definition">¶</a></dt>
<dd><p>Enqueue setsockopt(opt, value) for in_socket</p>
<p>See zmq.Socket.setsockopt for details.</p>
</dd></dl>
<dl class="method">
<dt id="zmq.devices.basedevice.Device.setsockopt_out">
<tt class="descname">setsockopt_out</tt><big>(</big><em>opt</em>, <em>value</em><big>)</big><a class="headerlink" href="#zmq.devices.basedevice.Device.setsockopt_out" title="Permalink to this definition">¶</a></dt>
<dd><p>Enqueue setsockopt(opt, value) for out_socket</p>
<p>See zmq.Socket.setsockopt for details.</p>
</dd></dl>
<dl class="method">
<dt id="zmq.devices.basedevice.Device.start">
<tt class="descname">start</tt><big>(</big><big>)</big><a class="headerlink" href="#zmq.devices.basedevice.Device.start" title="Permalink to this definition">¶</a></dt>
<dd><p>Start the device. Override me in subclass for other launchers.</p>
</dd></dl>
</dd></dl>
</div>
<div class="section" id="processdevice">
<h3><a class="reference internal" href="#zmq.devices.basedevice.ProcessDevice" title="zmq.devices.basedevice.ProcessDevice"><tt class="xref py py-class docutils literal"><span class="pre">ProcessDevice</span></tt></a><a class="headerlink" href="#processdevice" title="Permalink to this headline">¶</a></h3>
<dl class="class">
<dt id="zmq.devices.basedevice.ProcessDevice">
<em class="property">class </em><tt class="descclassname">zmq.devices.basedevice.</tt><tt class="descname">ProcessDevice</tt><big>(</big><em>device_type</em>, <em>in_type</em>, <em>out_type</em><big>)</big><a class="headerlink" href="#zmq.devices.basedevice.ProcessDevice" title="Permalink to this definition">¶</a></dt>
<dd><p>A Device that will be run in a background Process.</p>
<p>See Device for details.</p>
<dl class="method">
<dt id="zmq.devices.basedevice.ProcessDevice.bind_in">
<tt class="descname">bind_in</tt><big>(</big><em>addr</em><big>)</big><a class="headerlink" href="#zmq.devices.basedevice.ProcessDevice.bind_in" title="Permalink to this definition">¶</a></dt>
<dd><p>Enqueue ZMQ address for binding on in_socket.</p>
<p>See zmq.Socket.bind for details.</p>
</dd></dl>
<dl class="method">
<dt id="zmq.devices.basedevice.ProcessDevice.bind_out">
<tt class="descname">bind_out</tt><big>(</big><em>iface</em><big>)</big><a class="headerlink" href="#zmq.devices.basedevice.ProcessDevice.bind_out" title="Permalink to this definition">¶</a></dt>
<dd><p>Enqueue ZMQ address for binding on out_socket.</p>
<p>See zmq.Socket.bind for details.</p>
</dd></dl>
<dl class="method">
<dt id="zmq.devices.basedevice.ProcessDevice.connect_in">
<tt class="descname">connect_in</tt><big>(</big><em>addr</em><big>)</big><a class="headerlink" href="#zmq.devices.basedevice.ProcessDevice.connect_in" title="Permalink to this definition">¶</a></dt>
<dd><p>Enqueue ZMQ address for connecting on in_socket.</p>
<p>See zmq.Socket.connect for details.</p>
</dd></dl>
<dl class="method">
<dt id="zmq.devices.basedevice.ProcessDevice.connect_out">
<tt class="descname">connect_out</tt><big>(</big><em>iface</em><big>)</big><a class="headerlink" href="#zmq.devices.basedevice.ProcessDevice.connect_out" title="Permalink to this definition">¶</a></dt>
<dd><p>Enqueue ZMQ address for connecting on out_socket.</p>
<p>See zmq.Socket.connect for details.</p>
</dd></dl>
<dl class="attribute">
<dt id="zmq.devices.basedevice.ProcessDevice.context_factory">
<tt class="descname">context_factory</tt><a class="headerlink" href="#zmq.devices.basedevice.ProcessDevice.context_factory" title="Permalink to this definition">¶</a></dt>
<dd><p>alias of <tt class="xref py py-class docutils literal"><span class="pre">Context</span></tt></p>
</dd></dl>
<dl class="method">
<dt id="zmq.devices.basedevice.ProcessDevice.join">
<tt class="descname">join</tt><big>(</big><em>timeout=None</em><big>)</big><a class="headerlink" href="#zmq.devices.basedevice.ProcessDevice.join" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="method">
<dt id="zmq.devices.basedevice.ProcessDevice.run">
<tt class="descname">run</tt><big>(</big><big>)</big><a class="headerlink" href="#zmq.devices.basedevice.ProcessDevice.run" title="Permalink to this definition">¶</a></dt>
<dd><p>The runner method.</p>
<p>Do not call me directly, instead call <tt class="docutils literal"><span class="pre">self.start()</span></tt>, just like a
Thread.</p>
</dd></dl>
<dl class="method">
<dt id="zmq.devices.basedevice.ProcessDevice.setsockopt_in">
<tt class="descname">setsockopt_in</tt><big>(</big><em>opt</em>, <em>value</em><big>)</big><a class="headerlink" href="#zmq.devices.basedevice.ProcessDevice.setsockopt_in" title="Permalink to this definition">¶</a></dt>
<dd><p>Enqueue setsockopt(opt, value) for in_socket</p>
<p>See zmq.Socket.setsockopt for details.</p>
</dd></dl>
<dl class="method">
<dt id="zmq.devices.basedevice.ProcessDevice.setsockopt_out">
<tt class="descname">setsockopt_out</tt><big>(</big><em>opt</em>, <em>value</em><big>)</big><a class="headerlink" href="#zmq.devices.basedevice.ProcessDevice.setsockopt_out" title="Permalink to this definition">¶</a></dt>
<dd><p>Enqueue setsockopt(opt, value) for out_socket</p>
<p>See zmq.Socket.setsockopt for details.</p>
</dd></dl>
<dl class="method">
<dt id="zmq.devices.basedevice.ProcessDevice.start">
<tt class="descname">start</tt><big>(</big><big>)</big><a class="headerlink" href="#zmq.devices.basedevice.ProcessDevice.start" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
</dd></dl>
</div>
<div class="section" id="threaddevice">
<h3><a class="reference internal" href="#zmq.devices.basedevice.ThreadDevice" title="zmq.devices.basedevice.ThreadDevice"><tt class="xref py py-class docutils literal"><span class="pre">ThreadDevice</span></tt></a><a class="headerlink" href="#threaddevice" title="Permalink to this headline">¶</a></h3>
<dl class="class">
<dt id="zmq.devices.basedevice.ThreadDevice">
<em class="property">class </em><tt class="descclassname">zmq.devices.basedevice.</tt><tt class="descname">ThreadDevice</tt><big>(</big><em>device_type</em>, <em>in_type</em>, <em>out_type</em><big>)</big><a class="headerlink" href="#zmq.devices.basedevice.ThreadDevice" title="Permalink to this definition">¶</a></dt>
<dd><p>A Device that will be run in a background Thread.</p>
<p>See Device for details.</p>
<dl class="method">
<dt id="zmq.devices.basedevice.ThreadDevice.bind_in">
<tt class="descname">bind_in</tt><big>(</big><em>addr</em><big>)</big><a class="headerlink" href="#zmq.devices.basedevice.ThreadDevice.bind_in" title="Permalink to this definition">¶</a></dt>
<dd><p>Enqueue ZMQ address for binding on in_socket.</p>
<p>See zmq.Socket.bind for details.</p>
</dd></dl>
<dl class="method">
<dt id="zmq.devices.basedevice.ThreadDevice.bind_out">
<tt class="descname">bind_out</tt><big>(</big><em>iface</em><big>)</big><a class="headerlink" href="#zmq.devices.basedevice.ThreadDevice.bind_out" title="Permalink to this definition">¶</a></dt>
<dd><p>Enqueue ZMQ address for binding on out_socket.</p>
<p>See zmq.Socket.bind for details.</p>
</dd></dl>
<dl class="method">
<dt id="zmq.devices.basedevice.ThreadDevice.connect_in">
<tt class="descname">connect_in</tt><big>(</big><em>addr</em><big>)</big><a class="headerlink" href="#zmq.devices.basedevice.ThreadDevice.connect_in" title="Permalink to this definition">¶</a></dt>
<dd><p>Enqueue ZMQ address for connecting on in_socket.</p>
<p>See zmq.Socket.connect for details.</p>
</dd></dl>
<dl class="method">
<dt id="zmq.devices.basedevice.ThreadDevice.connect_out">
<tt class="descname">connect_out</tt><big>(</big><em>iface</em><big>)</big><a class="headerlink" href="#zmq.devices.basedevice.ThreadDevice.connect_out" title="Permalink to this definition">¶</a></dt>
<dd><p>Enqueue ZMQ address for connecting on out_socket.</p>
<p>See zmq.Socket.connect for details.</p>
</dd></dl>
<dl class="staticmethod">
<dt id="zmq.devices.basedevice.ThreadDevice.context_factory">
<em class="property">static </em><tt class="descname">context_factory</tt><big>(</big><big>)</big><a class="headerlink" href="#zmq.devices.basedevice.ThreadDevice.context_factory" title="Permalink to this definition">¶</a></dt>
<dd><p>Returns a global Context instance.</p>
<p>Most single-threaded applications have a single, global Context.
Use this method instead of passing around Context instances
throughout your code.</p>
<p>A common pattern for classes that depend on Contexts is to use
a default argument to enable programs with multiple Contexts
but not require the argument for simpler applications:</p>
<blockquote>
<div><dl class="docutils">
<dt>class MyClass(object):</dt>
<dd><dl class="first last docutils">
<dt>def __init__(self, context=None):</dt>
<dd>self.context = context or Context.instance()</dd>
</dl>
</dd>
</dl>
</div></blockquote>
</dd></dl>
<dl class="method">
<dt id="zmq.devices.basedevice.ThreadDevice.join">
<tt class="descname">join</tt><big>(</big><em>timeout=None</em><big>)</big><a class="headerlink" href="#zmq.devices.basedevice.ThreadDevice.join" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="method">
<dt id="zmq.devices.basedevice.ThreadDevice.run">
<tt class="descname">run</tt><big>(</big><big>)</big><a class="headerlink" href="#zmq.devices.basedevice.ThreadDevice.run" title="Permalink to this definition">¶</a></dt>
<dd><p>The runner method.</p>
<p>Do not call me directly, instead call <tt class="docutils literal"><span class="pre">self.start()</span></tt>, just like a
Thread.</p>
</dd></dl>
<dl class="method">
<dt id="zmq.devices.basedevice.ThreadDevice.setsockopt_in">
<tt class="descname">setsockopt_in</tt><big>(</big><em>opt</em>, <em>value</em><big>)</big><a class="headerlink" href="#zmq.devices.basedevice.ThreadDevice.setsockopt_in" title="Permalink to this definition">¶</a></dt>
<dd><p>Enqueue setsockopt(opt, value) for in_socket</p>
<p>See zmq.Socket.setsockopt for details.</p>
</dd></dl>
<dl class="method">
<dt id="zmq.devices.basedevice.ThreadDevice.setsockopt_out">
<tt class="descname">setsockopt_out</tt><big>(</big><em>opt</em>, <em>value</em><big>)</big><a class="headerlink" href="#zmq.devices.basedevice.ThreadDevice.setsockopt_out" title="Permalink to this definition">¶</a></dt>
<dd><p>Enqueue setsockopt(opt, value) for out_socket</p>
<p>See zmq.Socket.setsockopt for details.</p>
</dd></dl>
<dl class="method">
<dt id="zmq.devices.basedevice.ThreadDevice.start">
<tt class="descname">start</tt><big>(</big><big>)</big><a class="headerlink" href="#zmq.devices.basedevice.ThreadDevice.start" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
</dd></dl>
</div>
</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="zmq.devices.monitoredqueuedevice.html" title="devices.monitoredqueuedevice"
>next</a> |</li>
<li class="right" >
<a href="zmq.core.version.html" title="core.version"
>previous</a> |</li>
<li><a href="../../index.html">home</a>| </li>
<li><a href="../../search.html">search</a>| </li>
<li><a href="../index.html">API</a> »</li>
<li><a href="../index.html" >The PyZMQ 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>
