aboutsummaryrefslogtreecommitdiffstats
path: root/receiver.html
diff options
context:
space:
mode:
Diffstat (limited to 'receiver.html')
-rw-r--r--receiver.html50
1 files changed, 25 insertions, 25 deletions
diff --git a/receiver.html b/receiver.html
index d81d16d..0140afa 100644
--- a/receiver.html
+++ b/receiver.html
@@ -25,7 +25,7 @@
25 <script type="text/javascript" src="_static/doctools.js"></script> 25 <script type="text/javascript" src="_static/doctools.js"></script>
26 <link rel="top" title="EventMQ 0 documentation" href="index.html" /> 26 <link rel="top" title="EventMQ 0 documentation" href="index.html" />
27 <link rel="next" title="router – Router" href="router.html" /> 27 <link rel="next" title="router – Router" href="router.html" />
28 <link rel="prev" title="Welcome to EventMQ’s documentation!" href="index.html" /> 28 <link rel="prev" title="jobmanager †Job Manager" href="jobmanager.html" />
29 </head> 29 </head>
30 <body role="document"> 30 <body role="document">
31 <div class="related" role="navigation" aria-label="related navigation"> 31 <div class="related" role="navigation" aria-label="related navigation">
@@ -41,7 +41,7 @@
41 <a href="router.html" title="router – Router" 41 <a href="router.html" title="router – Router"
42 accesskey="N">next</a> |</li> 42 accesskey="N">next</a> |</li>
43 <li class="right" > 43 <li class="right" >
44 <a href="index.html" title="Welcome to EventMQ’s documentation!" 44 <a href="jobmanager.html" title="jobmanager †Job Manager"
45 accesskey="P">previous</a> |</li> 45 accesskey="P">previous</a> |</li>
46 <li class="nav-item nav-item-0"><a href="index.html">EventMQ 0 documentation</a> &raquo;</li> 46 <li class="nav-item nav-item-0"><a href="index.html">EventMQ 0 documentation</a> &raquo;</li>
47 </ul> 47 </ul>
@@ -52,12 +52,12 @@
52 <div class="bodywrapper"> 52 <div class="bodywrapper">
53 <div class="body" role="main"> 53 <div class="body" role="main">
54 54
55 <span class="target" id="module-receiver"></span><div class="section" id="receiver-receiver"> 55 <span class="target" id="module-eventmq.receiver"></span><div class="section" id="receiver-receiver">
56<h1><a class="reference internal" href="#module-receiver" title="receiver"><code class="xref py py-mod docutils literal"><span class="pre">receiver</span></code></a> &#8211; Receiver<a class="headerlink" href="#receiver-receiver" title="Permalink to this headline">¶</a></h1> 56<h1><code class="xref py py-mod docutils literal"><span class="pre">receiver</span></code> &#8211; Receiver<a class="headerlink" href="#receiver-receiver" title="Permalink to this headline">¶</a></h1>
57<p>The receiver is responsible for receiveing messages</p> 57<p>The receiver is responsible for receiveing messages</p>
58<dl class="class"> 58<dl class="class">
59<dt id="receiver.Receiver"> 59<dt id="eventmq.receiver.Receiver">
60<em class="property">class </em><code class="descclassname">receiver.</code><code class="descname">Receiver</code><span class="sig-paren">(</span><em>*args</em>, <em>**kwargs</em><span class="sig-paren">)</span><a class="headerlink" href="#receiver.Receiver" title="Permalink to this definition">¶</a></dt> 60<em class="property">class </em><code class="descclassname">eventmq.receiver.</code><code class="descname">Receiver</code><span class="sig-paren">(</span><em>*args</em>, <em>**kwargs</em><span class="sig-paren">)</span><a class="headerlink" href="#eventmq.receiver.Receiver" title="Permalink to this definition">¶</a></dt>
61<dd><p>Receives messages and pass them to a callable.</p> 61<dd><p>Receives messages and pass them to a callable.</p>
62<div class="admonition note"> 62<div class="admonition note">
63<p class="first admonition-title">Note</p> 63<p class="first admonition-title">Note</p>
@@ -65,27 +65,27 @@
65(<code class="xref py py-mod docutils literal"><span class="pre">zmq.eventloop</span></code>).</p> 65(<code class="xref py py-mod docutils literal"><span class="pre">zmq.eventloop</span></code>).</p>
66</div> 66</div>
67<dl class="attribute"> 67<dl class="attribute">
68<dt id="receiver.Receiver.name"> 68<dt id="eventmq.receiver.Receiver.name">
69<code class="descname">name</code><a class="headerlink" href="#receiver.Receiver.name" title="Permalink to this definition">¶</a></dt> 69<code class="descname">name</code><a class="headerlink" href="#eventmq.receiver.Receiver.name" title="Permalink to this definition">¶</a></dt>
70<dd><p><em>str</em> &#8211; Name of this socket</p> 70<dd><p><em>str</em> &#8211; Name of this socket</p>
71</dd></dl> 71</dd></dl>
72 72
73<dl class="attribute"> 73<dl class="attribute">
74<dt id="receiver.Receiver.zcontext"> 74<dt id="eventmq.receiver.Receiver.zcontext">
75<code class="descname">zcontext</code><a class="headerlink" href="#receiver.Receiver.zcontext" title="Permalink to this definition">¶</a></dt> 75<code class="descname">zcontext</code><a class="headerlink" href="#eventmq.receiver.Receiver.zcontext" title="Permalink to this definition">¶</a></dt>
76<dd><p><a class="reference external" href="http://pyzmq.readthedocs.org/en/v15.0.0/api/zmq.html#zmq.Context" title="(in PyZMQ v15.0.0)"><code class="xref py py-class docutils literal"><span class="pre">zmq.Context</span></code></a> &#8211; socket context</p> 76<dd><p><a class="reference external" href="http://pyzmq.readthedocs.org/en/v15.0.0/api/zmq.html#zmq.Context" title="(in PyZMQ v15.0.0)"><code class="xref py py-class docutils literal"><span class="pre">zmq.Context</span></code></a> &#8211; socket context</p>
77</dd></dl> 77</dd></dl>
78 78
79<dl class="attribute"> 79<dl class="attribute">
80<dt id="receiver.Receiver.zsocket"> 80<dt id="eventmq.receiver.Receiver.zsocket">
81<code class="descname">zsocket</code><a class="headerlink" href="#receiver.Receiver.zsocket" title="Permalink to this definition">¶</a></dt> 81<code class="descname">zsocket</code><a class="headerlink" href="#eventmq.receiver.Receiver.zsocket" title="Permalink to this definition">¶</a></dt>
82<dd><p><a class="reference external" href="http://pyzmq.readthedocs.org/en/v15.0.0/api/zmq.html#zmq.Socket" title="(in PyZMQ v15.0.0)"><code class="xref py py-class docutils literal"><span class="pre">zmq.Socket</span></code></a> &#8211; socket wrapped up in a 82<dd><p><a class="reference external" href="http://pyzmq.readthedocs.org/en/v15.0.0/api/zmq.html#zmq.Socket" title="(in PyZMQ v15.0.0)"><code class="xref py py-class docutils literal"><span class="pre">zmq.Socket</span></code></a> &#8211; socket wrapped up in a
83<code class="xref py py-class docutils literal"><span class="pre">zmqstream.ZMQStream</span></code></p> 83<code class="xref py py-class docutils literal"><span class="pre">zmqstream.ZMQStream</span></code></p>
84</dd></dl> 84</dd></dl>
85 85
86<dl class="method"> 86<dl class="method">
87<dt id="receiver.Receiver.__init__"> 87<dt id="eventmq.receiver.Receiver.__init__">
88<code class="descname">__init__</code><span class="sig-paren">(</span><em>*args</em>, <em>**kwargs</em><span class="sig-paren">)</span><a class="headerlink" href="#receiver.Receiver.__init__" title="Permalink to this definition">¶</a></dt> 88<code class="descname">__init__</code><span class="sig-paren">(</span><em>*args</em>, <em>**kwargs</em><span class="sig-paren">)</span><a class="headerlink" href="#eventmq.receiver.Receiver.__init__" title="Permalink to this definition">¶</a></dt>
89<dd><div class="admonition note"> 89<dd><div class="admonition note">
90<p class="first admonition-title">Note</p> 90<p class="first admonition-title">Note</p>
91<p class="last">All args are optional unless otherwise noted.</p> 91<p class="last">All args are optional unless otherwise noted.</p>
@@ -116,14 +116,14 @@ socket. Callable is unused and optional when this is True</li>
116</dd></dl> 116</dd></dl>
117 117
118<dl class="attribute"> 118<dl class="attribute">
119<dt id="receiver.Receiver.__weakref__"> 119<dt id="eventmq.receiver.Receiver.__weakref__">
120<code class="descname">__weakref__</code><a class="headerlink" href="#receiver.Receiver.__weakref__" title="Permalink to this definition">¶</a></dt> 120<code class="descname">__weakref__</code><a class="headerlink" href="#eventmq.receiver.Receiver.__weakref__" title="Permalink to this definition">¶</a></dt>
121<dd><p>list of weak references to the object (if defined)</p> 121<dd><p>list of weak references to the object (if defined)</p>
122</dd></dl> 122</dd></dl>
123 123
124<dl class="method"> 124<dl class="method">
125<dt id="receiver.Receiver.connect"> 125<dt id="eventmq.receiver.Receiver.connect">
126<code class="descname">connect</code><span class="sig-paren">(</span><em>addr=None</em><span class="sig-paren">)</span><a class="headerlink" href="#receiver.Receiver.connect" title="Permalink to this definition">¶</a></dt> 126<code class="descname">connect</code><span class="sig-paren">(</span><em>addr=None</em><span class="sig-paren">)</span><a class="headerlink" href="#eventmq.receiver.Receiver.connect" title="Permalink to this definition">¶</a></dt>
127<dd><p>Connect to address defined by <cite>addr</cite></p> 127<dd><p>Connect to address defined by <cite>addr</cite></p>
128<table class="docutils field-list" frame="void" rules="none"> 128<table class="docutils field-list" frame="void" rules="none">
129<col class="field-name" /> 129<col class="field-name" />
@@ -138,8 +138,8 @@ socket. Callable is unused and optional when this is True</li>
138</dd></dl> 138</dd></dl>
139 139
140<dl class="method"> 140<dl class="method">
141<dt id="receiver.Receiver.listen"> 141<dt id="eventmq.receiver.Receiver.listen">
142<code class="descname">listen</code><span class="sig-paren">(</span><em>addr=None</em><span class="sig-paren">)</span><a class="headerlink" href="#receiver.Receiver.listen" title="Permalink to this definition">¶</a></dt> 142<code class="descname">listen</code><span class="sig-paren">(</span><em>addr=None</em><span class="sig-paren">)</span><a class="headerlink" href="#eventmq.receiver.Receiver.listen" title="Permalink to this definition">¶</a></dt>
143<dd><p>start listening on <cite>addr</cite></p> 143<dd><p>start listening on <cite>addr</cite></p>
144<table class="docutils field-list" frame="void" rules="none"> 144<table class="docutils field-list" frame="void" rules="none">
145<col class="field-name" /> 145<col class="field-name" />
@@ -154,8 +154,8 @@ socket. Callable is unused and optional when this is True</li>
154</dd></dl> 154</dd></dl>
155 155
156<dl class="attribute"> 156<dl class="attribute">
157<dt id="receiver.Receiver.ready"> 157<dt id="eventmq.receiver.Receiver.ready">
158<code class="descname">ready</code><a class="headerlink" href="#receiver.Receiver.ready" title="Permalink to this definition">¶</a></dt> 158<code class="descname">ready</code><a class="headerlink" href="#eventmq.receiver.Receiver.ready" title="Permalink to this definition">¶</a></dt>
159<dd><p>Property used to check if this receiver is ready.</p> 159<dd><p>Property used to check if this receiver is ready.</p>
160<table class="docutils field-list" frame="void" rules="none"> 160<table class="docutils field-list" frame="void" rules="none">
161<col class="field-name" /> 161<col class="field-name" />
@@ -181,8 +181,8 @@ False</td>
181 <div class="sphinxsidebar" role="navigation" aria-label="main navigation"> 181 <div class="sphinxsidebar" role="navigation" aria-label="main navigation">
182 <div class="sphinxsidebarwrapper"> 182 <div class="sphinxsidebarwrapper">
183 <h4>Previous topic</h4> 183 <h4>Previous topic</h4>
184 <p class="topless"><a href="index.html" 184 <p class="topless"><a href="jobmanager.html"
185 title="previous chapter">Welcome to EventMQ&#8217;s documentation!</a></p> 185 title="previous chapter"><code class="docutils literal"><span class="pre">jobmanager</span></code> &#8211; Job Manager</a></p>
186 <h4>Next topic</h4> 186 <h4>Next topic</h4>
187 <p class="topless"><a href="router.html" 187 <p class="topless"><a href="router.html"
188 title="next chapter"><code class="docutils literal"><span class="pre">router</span></code> &#8211; Router</a></p> 188 title="next chapter"><code class="docutils literal"><span class="pre">router</span></code> &#8211; Router</a></p>
@@ -223,7 +223,7 @@ False</td>
223 <a href="router.html" title="router – Router" 223 <a href="router.html" title="router – Router"
224 >next</a> |</li> 224 >next</a> |</li>
225 <li class="right" > 225 <li class="right" >
226 <a href="index.html" title="Welcome to EventMQ’s documentation!" 226 <a href="jobmanager.html" title="jobmanager †Job Manager"
227 >previous</a> |</li> 227 >previous</a> |</li>
228 <li class="nav-item nav-item-0"><a href="index.html">EventMQ 0 documentation</a> &raquo;</li> 228 <li class="nav-item nav-item-0"><a href="index.html">EventMQ 0 documentation</a> &raquo;</li>
229 </ul> 229 </ul>