diff options
Diffstat (limited to 'sender.html')
| -rw-r--r-- | sender.html | 68 |
1 files changed, 5 insertions, 63 deletions
diff --git a/sender.html b/sender.html index e14c38b..b7c967f 100644 --- a/sender.html +++ b/sender.html | |||
| @@ -84,7 +84,9 @@ | |||
| 84 | 84 | ||
| 85 | <ul class="current"> | 85 | <ul class="current"> |
| 86 | <li class="toctree-l1 current"><a class="reference internal" href="api.html">API Documentation</a><ul class="current"> | 86 | <li class="toctree-l1 current"><a class="reference internal" href="api.html">API Documentation</a><ul class="current"> |
| 87 | <li class="toctree-l2"><a class="reference internal" href="exceptions.html"><code class="docutils literal"><span class="pre">exceptions</span></code> – Exceptions</a></li> | ||
| 87 | <li class="toctree-l2"><a class="reference internal" href="jobmanager.html"><code class="docutils literal"><span class="pre">jobmanager</span></code> – Job Manager</a></li> | 88 | <li class="toctree-l2"><a class="reference internal" href="jobmanager.html"><code class="docutils literal"><span class="pre">jobmanager</span></code> – Job Manager</a></li> |
| 89 | <li class="toctree-l2"><a class="reference internal" href="poller.html"><code class="docutils literal"><span class="pre">poller</span></code> – Poller</a></li> | ||
| 88 | <li class="toctree-l2"><a class="reference internal" href="receiver.html"><code class="docutils literal"><span class="pre">receiver</span></code> – Receiver</a></li> | 90 | <li class="toctree-l2"><a class="reference internal" href="receiver.html"><code class="docutils literal"><span class="pre">receiver</span></code> – Receiver</a></li> |
| 89 | <li class="toctree-l2"><a class="reference internal" href="router.html"><code class="docutils literal"><span class="pre">router</span></code> – Router</a></li> | 91 | <li class="toctree-l2"><a class="reference internal" href="router.html"><code class="docutils literal"><span class="pre">router</span></code> – Router</a></li> |
| 90 | <li class="toctree-l2 current"><a class="current reference internal" href=""><code class="docutils literal"><span class="pre">sender</span></code> – Sender</a></li> | 92 | <li class="toctree-l2 current"><a class="current reference internal" href=""><code class="docutils literal"><span class="pre">sender</span></code> – Sender</a></li> |
| @@ -157,9 +159,9 @@ | |||
| 157 | </dd></dl> | 159 | </dd></dl> |
| 158 | 160 | ||
| 159 | <dl class="attribute"> | 161 | <dl class="attribute"> |
| 160 | <dt> | 162 | <dt id="eventmq.sender.Sender.zcontext"> |
| 161 | <code class="descname">zcontext (</code></dt> | 163 | <code class="descname">zcontext</code><a class="headerlink" href="#eventmq.sender.Sender.zcontext" title="Permalink to this definition">¶</a></dt> |
| 162 | <dd><p>class`zmq.Context`): socket context</p> | 164 | <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> – socket context</p> |
| 163 | </dd></dl> | 165 | </dd></dl> |
| 164 | 166 | ||
| 165 | <dl class="attribute"> | 167 | <dl class="attribute"> |
| @@ -196,12 +198,6 @@ socket</li> | |||
| 196 | </table> | 198 | </table> |
| 197 | </dd></dl> | 199 | </dd></dl> |
| 198 | 200 | ||
| 199 | <dl class="attribute"> | ||
| 200 | <dt id="eventmq.sender.Sender.__weakref__"> | ||
| 201 | <code class="descname">__weakref__</code><a class="headerlink" href="#eventmq.sender.Sender.__weakref__" title="Permalink to this definition">¶</a></dt> | ||
| 202 | <dd><p>list of weak references to the object (if defined)</p> | ||
| 203 | </dd></dl> | ||
| 204 | |||
| 205 | <dl class="method"> | 201 | <dl class="method"> |
| 206 | <dt id="eventmq.sender.Sender.connect"> | 202 | <dt id="eventmq.sender.Sender.connect"> |
| 207 | <code class="descname">connect</code><span class="sig-paren">(</span><em>addr=None</em><span class="sig-paren">)</span><a class="headerlink" href="#eventmq.sender.Sender.connect" title="Permalink to this definition">¶</a></dt> | 203 | <code class="descname">connect</code><span class="sig-paren">(</span><em>addr=None</em><span class="sig-paren">)</span><a class="headerlink" href="#eventmq.sender.Sender.connect" title="Permalink to this definition">¶</a></dt> |
| @@ -251,60 +247,6 @@ False</td> | |||
| 251 | </table> | 247 | </table> |
| 252 | </dd></dl> | 248 | </dd></dl> |
| 253 | 249 | ||
| 254 | <dl class="method"> | ||
| 255 | <dt id="eventmq.sender.Sender.recv"> | ||
| 256 | <code class="descname">recv</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#eventmq.sender.Sender.recv" title="Permalink to this definition">¶</a></dt> | ||
| 257 | <dd><p>Receive a message</p> | ||
| 258 | </dd></dl> | ||
| 259 | |||
| 260 | <dl class="method"> | ||
| 261 | <dt id="eventmq.sender.Sender.recv_multipart"> | ||
| 262 | <code class="descname">recv_multipart</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#eventmq.sender.Sender.recv_multipart" title="Permalink to this definition">¶</a></dt> | ||
| 263 | <dd><p>Receive a multipart message</p> | ||
| 264 | </dd></dl> | ||
| 265 | |||
| 266 | <dl class="method"> | ||
| 267 | <dt id="eventmq.sender.Sender.send"> | ||
| 268 | <code class="descname">send</code><span class="sig-paren">(</span><em>message</em>, <em>protocol_version</em><span class="sig-paren">)</span><a class="headerlink" href="#eventmq.sender.Sender.send" title="Permalink to this definition">¶</a></dt> | ||
| 269 | <dd><p>Sends a message</p> | ||
| 270 | <table class="docutils field-list" frame="void" rules="none"> | ||
| 271 | <col class="field-name" /> | ||
| 272 | <col class="field-body" /> | ||
| 273 | <tbody valign="top"> | ||
| 274 | <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple"> | ||
| 275 | <li><strong>message</strong> – message to send to something</li> | ||
| 276 | <li><strong>protocol_version</strong> (<a class="reference external" href="https://docs.python.org/library/functions.html#str" title="(in Python v2.7)"><em>str</em></a>) – protocol version. it’s good practice, but | ||
| 277 | you may explicitly specify None to skip adding the version</li> | ||
| 278 | </ul> | ||
| 279 | </td> | ||
| 280 | </tr> | ||
| 281 | </tbody> | ||
| 282 | </table> | ||
| 283 | </dd></dl> | ||
| 284 | |||
| 285 | <dl class="method"> | ||
| 286 | <dt id="eventmq.sender.Sender.send_multipart"> | ||
| 287 | <code class="descname">send_multipart</code><span class="sig-paren">(</span><em>message</em>, <em>protocol_version</em><span class="sig-paren">)</span><a class="headerlink" href="#eventmq.sender.Sender.send_multipart" title="Permalink to this definition">¶</a></dt> | ||
| 288 | <dd><p>Send a message directly to the 0mq socket. Automatically inserts some | ||
| 289 | frames for your convience. The sent frame ends up looking something | ||
| 290 | like identity</p> | ||
| 291 | <blockquote> | ||
| 292 | <div>(this, ‘’, protocol_version) + (your, tuple)</div></blockquote> | ||
| 293 | <table class="docutils field-list" frame="void" rules="none"> | ||
| 294 | <col class="field-name" /> | ||
| 295 | <col class="field-body" /> | ||
| 296 | <tbody valign="top"> | ||
| 297 | <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple"> | ||
| 298 | <li><strong>message</strong> (<a class="reference external" href="https://docs.python.org/library/functions.html#tuple" title="(in Python v2.7)"><em>tuple</em></a>) – Raw message to send.</li> | ||
| 299 | <li><strong>protocol_version</strong> (<a class="reference external" href="https://docs.python.org/library/functions.html#str" title="(in Python v2.7)"><em>str</em></a>) – protocol version. it’s good practice but | ||
| 300 | you may explicitly specify None to skip adding the version</li> | ||
| 301 | </ul> | ||
| 302 | </td> | ||
| 303 | </tr> | ||
| 304 | </tbody> | ||
| 305 | </table> | ||
| 306 | </dd></dl> | ||
| 307 | |||
| 308 | </dd></dl> | 250 | </dd></dl> |
| 309 | 251 | ||
| 310 | </div> | 252 | </div> |