Mercurial Mercurial > pyams > pyams_user_guide / diff
summary | shortlog | changelog | graph | tags | bookmarks | branches | files | changeset | file | latest | revisions | annotate | diff | comparison | raw | help
Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
src/build/html/pyams_zmq.html
changeset 0 d153941bb745 
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/src/build/html/pyams_zmq.html	Sun Jan 14 11:48:51 2018 +0100
@@ -0,0 +1,274 @@
+
+<!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>pyams_zmq package &#8212; PyAMS User Guide 0.1.0 documentation</title>
+    <link rel="stylesheet" href="_static/pyramid.css" type="text/css" />
+    <link rel="stylesheet" href="_static/pygments.css" type="text/css" />
+    <script type="text/javascript">
+      var DOCUMENTATION_OPTIONS = {
+        URL_ROOT:    './',
+        VERSION:     '0.1.0',
+        COLLAPSE_INDEX: false,
+        FILE_SUFFIX: '.html',
+        HAS_SOURCE:  true,
+        SOURCELINK_SUFFIX: '.txt'
+      };
+    </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="index" title="Index" href="genindex.html" />
+    <link rel="search" title="Search" href="search.html" />
+<link rel="stylesheet" href="https://fonts.googleapis.com/css?family=Neuton&amp;subset=latin" type="text/css" media="screen" charset="utf-8" />
+<link rel="stylesheet" href="https://fonts.googleapis.com/css?family=Nobile:regular,italic,bold,bolditalic&amp;subset=latin" type="text/css" media="screen" charset="utf-8" />
+<!--[if lte IE 6]>
+<link rel="stylesheet" href="_static/ie6.css" type="text/css" media="screen" charset="utf-8" />
+<![endif]-->
+
+  </head>
+  <body>
+
+    <div class="related" role="navigation" aria-label="related navigation">
+      <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="nav-item nav-item-0"><a href="index.html">PyAMS User Guide 0.1.0 documentation</a> &#187;</li> 
+      </ul>
+    </div>  
+
+    <div class="document">
+      <div class="documentwrapper">
+        <div class="bodywrapper">
+          <div class="body" role="main">
+            
+  <div class="section" id="pyams-zmq-package">
+<h1>pyams_zmq package<a class="headerlink" href="#pyams-zmq-package" title="Permalink to this headline">¶</a></h1>
+<div class="section" id="subpackages">
+<h2>Subpackages<a class="headerlink" href="#subpackages" title="Permalink to this headline">¶</a></h2>
+<div class="toctree-wrapper compound">
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="pyams_zmq.interfaces.html">pyams_zmq.interfaces package</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="pyams_zmq.interfaces.html#module-pyams_zmq.interfaces">Module contents</a></li>
+</ul>
+</li>
+<li class="toctree-l1"><a class="reference internal" href="pyams_zmq.tests.html">pyams_zmq.tests package</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="pyams_zmq.tests.html#submodules">Submodules</a></li>
+<li class="toctree-l2"><a class="reference internal" href="pyams_zmq.tests.html#module-pyams_zmq.tests.test_utilsdocs">pyams_zmq.tests.test_utilsdocs module</a></li>
+<li class="toctree-l2"><a class="reference internal" href="pyams_zmq.tests.html#module-pyams_zmq.tests.test_utilsdocstrings">pyams_zmq.tests.test_utilsdocstrings module</a></li>
+<li class="toctree-l2"><a class="reference internal" href="pyams_zmq.tests.html#module-pyams_zmq.tests">Module contents</a></li>
+</ul>
+</li>
+</ul>
+</div>
+</div>
+<div class="section" id="submodules">
+<h2>Submodules<a class="headerlink" href="#submodules" title="Permalink to this headline">¶</a></h2>
+</div>
+<div class="section" id="module-pyams_zmq.handler">
+<span id="pyams-zmq-handler-module"></span><h2>pyams_zmq.handler module<a class="headerlink" href="#module-pyams_zmq.handler" title="Permalink to this headline">¶</a></h2>
+<dl class="class">
+<dt id="pyams_zmq.handler.ZMQMessageHandler">
+<em class="property">class </em><code class="descclassname">pyams_zmq.handler.</code><code class="descname">ZMQMessageHandler</code><span class="sig-paren">(</span><em>process</em>, <em>stream</em>, <em>stop</em>, <em>handler=None</em>, <em>json_load=-1</em><span class="sig-paren">)</span><a class="headerlink" href="#pyams_zmq.handler.ZMQMessageHandler" title="Permalink to this definition">¶</a></dt>
+<dd><p>Bases: <code class="xref py py-class docutils literal"><span class="pre">object</span></code></p>
+<p>Base class for message handlers for a <code class="xref py py-class docutils literal"><span class="pre">pyams_zmq.process.Process</span></code>.</p>
+<p>Inheriting classes only need to implement a handler function for each
+message type.</p>
+<dl class="attribute">
+<dt id="pyams_zmq.handler.ZMQMessageHandler.handler">
+<code class="descname">handler</code><em class="property"> = None</em><a class="headerlink" href="#pyams_zmq.handler.ZMQMessageHandler.handler" title="Permalink to this definition">¶</a></dt>
+<dd></dd></dl>
+
+</dd></dl>
+
+</div>
+<div class="section" id="module-pyams_zmq.process">
+<span id="pyams-zmq-process-module"></span><h2>pyams_zmq.process module<a class="headerlink" href="#module-pyams_zmq.process" title="Permalink to this headline">¶</a></h2>
+<dl class="class">
+<dt id="pyams_zmq.process.ZMQProcess">
+<em class="property">class </em><code class="descclassname">pyams_zmq.process.</code><code class="descname">ZMQProcess</code><span class="sig-paren">(</span><em>bind_addr</em>, <em>handler</em><span class="sig-paren">)</span><a class="headerlink" href="#pyams_zmq.process.ZMQProcess" title="Permalink to this definition">¶</a></dt>
+<dd><p>Bases: <code class="xref py py-class docutils literal"><span class="pre">multiprocessing.context.Process</span></code></p>
+<p>This is the base for all processes and offers utility methods
+for setup and creating new streams.</p>
+<dl class="attribute">
+<dt id="pyams_zmq.process.ZMQProcess.context">
+<code class="descname">context</code><em class="property"> = None</em><a class="headerlink" href="#pyams_zmq.process.ZMQProcess.context" title="Permalink to this definition">¶</a></dt>
+<dd><p>The ØMQ <code class="xref py py-class docutils literal"><span class="pre">Context</span></code> instance.</p>
+</dd></dl>
+
+<dl class="method">
+<dt id="pyams_zmq.process.ZMQProcess.exit">
+<code class="descname">exit</code><span class="sig-paren">(</span><em>num</em>, <em>frame</em><span class="sig-paren">)</span><a class="headerlink" href="#pyams_zmq.process.ZMQProcess.exit" title="Permalink to this definition">¶</a></dt>
+<dd></dd></dl>
+
+<dl class="method">
+<dt id="pyams_zmq.process.ZMQProcess.initStream">
+<code class="descname">initStream</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#pyams_zmq.process.ZMQProcess.initStream" title="Permalink to this definition">¶</a></dt>
+<dd><p>Initialize response stream</p>
+</dd></dl>
+
+<dl class="attribute">
+<dt id="pyams_zmq.process.ZMQProcess.loop">
+<code class="descname">loop</code><em class="property"> = None</em><a class="headerlink" href="#pyams_zmq.process.ZMQProcess.loop" title="Permalink to this definition">¶</a></dt>
+<dd><p>PyZMQ’s event loop (<code class="xref py py-class docutils literal"><span class="pre">IOLoop</span></code>).</p>
+</dd></dl>
+
+<dl class="method">
+<dt id="pyams_zmq.process.ZMQProcess.run">
+<code class="descname">run</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#pyams_zmq.process.ZMQProcess.run" title="Permalink to this definition">¶</a></dt>
+<dd><p>Sets up everything and starts the event loop.</p>
+</dd></dl>
+
+<dl class="method">
+<dt id="pyams_zmq.process.ZMQProcess.setup">
+<code class="descname">setup</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#pyams_zmq.process.ZMQProcess.setup" title="Permalink to this definition">¶</a></dt>
+<dd><p>Creates a <a class="reference internal" href="#pyams_zmq.process.ZMQProcess.context" title="pyams_zmq.process.ZMQProcess.context"><code class="xref py py-attr docutils literal"><span class="pre">context</span></code></a> and an event <a class="reference internal" href="#pyams_zmq.process.ZMQProcess.loop" title="pyams_zmq.process.ZMQProcess.loop"><code class="xref py py-attr docutils literal"><span class="pre">loop</span></code></a> for the process.</p>
+</dd></dl>
+
+<dl class="attribute">
+<dt id="pyams_zmq.process.ZMQProcess.socket_type">
+<code class="descname">socket_type</code><em class="property"> = 4</em><a class="headerlink" href="#pyams_zmq.process.ZMQProcess.socket_type" title="Permalink to this definition">¶</a></dt>
+<dd></dd></dl>
+
+<dl class="method">
+<dt id="pyams_zmq.process.ZMQProcess.stop">
+<code class="descname">stop</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#pyams_zmq.process.ZMQProcess.stop" title="Permalink to this definition">¶</a></dt>
+<dd><p>Stops the event loop.</p>
+</dd></dl>
+
+<dl class="method">
+<dt id="pyams_zmq.process.ZMQProcess.stream">
+<code class="descname">stream</code><span class="sig-paren">(</span><em>sock_type</em>, <em>addr</em>, <em>bind</em>, <em>callback=None</em>, <em>subscribe=b''</em><span class="sig-paren">)</span><a class="headerlink" href="#pyams_zmq.process.ZMQProcess.stream" title="Permalink to this definition">¶</a></dt>
+<dd><p>Creates a <code class="xref py py-class docutils literal"><span class="pre">ZMQStream</span></code>.</p>
+<table class="docutils field-list" frame="void" rules="none">
+<col class="field-name" />
+<col class="field-body" />
+<tbody valign="top">
+<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
+<li><strong>sock_type</strong> – The ØMQ socket type (e.g. <code class="docutils literal"><span class="pre">zmq.REQ</span></code>)</li>
+<li><strong>addr</strong> – <p>Address to bind or connect to formatted as <em>host:port</em>,
+<em>(host, port)</em> or <em>host</em> (bind to random port).
+If <em>bind</em> is <code class="docutils literal"><span class="pre">True</span></code>, <em>host</em> may be:</p>
+<ul>
+<li>the wild-card <code class="docutils literal"><span class="pre">*</span></code>, meaning all available interfaces,</li>
+<li>the primary IPv4 address assigned to the interface, in its</li>
+</ul>
+<p>numeric representation or
+- the interface name as defined by the operating system.</p>
+<p>If <em>bind</em> is <code class="docutils literal"><span class="pre">False</span></code>, <em>host</em> may be:</p>
+<ul>
+<li>the DNS name of the peer or</li>
+<li>the IPv4 address of the peer, in its numeric representation.</li>
+</ul>
+<p>If <em>addr</em> is just a host name without a port and <em>bind</em> is
+<code class="docutils literal"><span class="pre">True</span></code>, the socket will be bound to a random port.</p>
+</li>
+<li><strong>bind</strong> – Binds to <em>addr</em> if <code class="docutils literal"><span class="pre">True</span></code> or tries to connect to it
+otherwise.</li>
+<li><strong>callback</strong> – A callback for
+<code class="xref py py-meth docutils literal"><span class="pre">on_recv()</span></code>, optional</li>
+<li><strong>subscribe</strong> – Subscription pattern for <em>SUB</em> sockets, optional,
+defaults to <code class="docutils literal"><span class="pre">b''</span></code>.</li>
+</ul>
+</td>
+</tr>
+<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first last">A tuple containg the stream and the port number.</p>
+</td>
+</tr>
+</tbody>
+</table>
+</dd></dl>
+
+</dd></dl>
+
+<dl class="function">
+<dt id="pyams_zmq.process.process_exit_func">
+<code class="descclassname">pyams_zmq.process.</code><code class="descname">process_exit_func</code><span class="sig-paren">(</span><em>process=None</em><span class="sig-paren">)</span><a class="headerlink" href="#pyams_zmq.process.process_exit_func" title="Permalink to this definition">¶</a></dt>
+<dd></dd></dl>
+
+</div>
+<div class="section" id="module-pyams_zmq.socket">
+<span id="pyams-zmq-socket-module"></span><h2>pyams_zmq.socket module<a class="headerlink" href="#module-pyams_zmq.socket" title="Permalink to this headline">¶</a></h2>
+<dl class="function">
+<dt id="pyams_zmq.socket.zmq_response">
+<code class="descclassname">pyams_zmq.socket.</code><code class="descname">zmq_response</code><span class="sig-paren">(</span><em>socket</em>, <em>flags=1</em>, <em>timeout=10</em><span class="sig-paren">)</span><a class="headerlink" href="#pyams_zmq.socket.zmq_response" title="Permalink to this definition">¶</a></dt>
+<dd><p>Get response from given socket</p>
+</dd></dl>
+
+<dl class="function">
+<dt id="pyams_zmq.socket.zmq_socket">
+<code class="descclassname">pyams_zmq.socket.</code><code class="descname">zmq_socket</code><span class="sig-paren">(</span><em>address</em>, <em>socket_type=3</em>, <em>linger=0</em>, <em>protocol='tcp'</em><span class="sig-paren">)</span><a class="headerlink" href="#pyams_zmq.socket.zmq_socket" title="Permalink to this definition">¶</a></dt>
+<dd><p>Get ØMQ socket</p>
+</dd></dl>
+
+</div>
+<div class="section" id="module-pyams_zmq">
+<span id="module-contents"></span><h2>Module contents<a class="headerlink" href="#module-pyams_zmq" title="Permalink to this headline">¶</a></h2>
+<dl class="function">
+<dt id="pyams_zmq.includeme">
+<code class="descclassname">pyams_zmq.</code><code class="descname">includeme</code><span class="sig-paren">(</span><em>config</em><span class="sig-paren">)</span><a class="headerlink" href="#pyams_zmq.includeme" title="Permalink to this definition">¶</a></dt>
+<dd><p>Pyramid include</p>
+</dd></dl>
+
+</div>
+</div>
+
+
+          </div>
+        </div>
+      </div>
+      <div class="sphinxsidebar" role="navigation" aria-label="main navigation">
+        <div class="sphinxsidebarwrapper">
+  <h3><a href="index.html">Table Of Contents</a></h3>
+  <ul>
+<li><a class="reference internal" href="#">pyams_zmq package</a><ul>
+<li><a class="reference internal" href="#subpackages">Subpackages</a></li>
+<li><a class="reference internal" href="#submodules">Submodules</a></li>
+<li><a class="reference internal" href="#module-pyams_zmq.handler">pyams_zmq.handler module</a></li>
+<li><a class="reference internal" href="#module-pyams_zmq.process">pyams_zmq.process module</a></li>
+<li><a class="reference internal" href="#module-pyams_zmq.socket">pyams_zmq.socket module</a></li>
+<li><a class="reference internal" href="#module-pyams_zmq">Module contents</a></li>
+</ul>
+</li>
+</ul>
+
+<div id="searchbox" style="display: none" role="search">
+  <h3>Quick search</h3>
+    <form class="search" action="search.html" method="get">
+      <div><input type="text" name="q" /></div>
+      <div><input type="submit" value="Go" /></div>
+      <input type="hidden" name="check_keywords" value="yes" />
+      <input type="hidden" name="area" value="default" />
+    </form>
+</div>
+<script type="text/javascript">$('#searchbox').show(0);</script>
+        </div>
+      </div>
+      <div class="clearer"></div>
+    </div>
+    <div class="related" role="navigation" aria-label="related navigation">
+      <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="nav-item nav-item-0"><a href="index.html">PyAMS User Guide 0.1.0 documentation</a> &#187;</li> 
+      </ul>
+    </div>
+    <div class="footer" role="contentinfo">
+        &#169; Copyright 2017, Thierry Florac.
+      Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.6.5.
+    </div>
+  </body>
+</html>
\ No newline at end of file
pyams/pyams_user_guide