diff options
Diffstat (limited to 'utils.html')
| -rw-r--r-- | utils.html | 41 |
1 files changed, 18 insertions, 23 deletions
| @@ -32,7 +32,7 @@ | |||
| 32 | 32 | ||
| 33 | <link rel="top" title="EventMQ 0 documentation" href="index.html"/> | 33 | <link rel="top" title="EventMQ 0 documentation" href="index.html"/> |
| 34 | <link rel="up" title="API Documentation" href="api.html"/> | 34 | <link rel="up" title="API Documentation" href="api.html"/> |
| 35 | <link rel="next" title="exceptions – Exceptions" href="exceptions.html"/> | 35 | <link rel="next" title="classes – Utility Classes" href="utils/classes.html"/> |
| 36 | <link rel="prev" title="sender – Sender" href="sender.html"/> | 36 | <link rel="prev" title="sender – Sender" href="sender.html"/> |
| 37 | 37 | ||
| 38 | 38 | ||
| @@ -84,12 +84,17 @@ | |||
| 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"><a class="reference internal" href="sender.html"><code class="docutils literal"><span class="pre">sender</span></code> – Sender</a></li> | 92 | <li class="toctree-l2"><a class="reference internal" href="sender.html"><code class="docutils literal"><span class="pre">sender</span></code> – Sender</a></li> |
| 91 | <li class="toctree-l2 current"><a class="current reference internal" href=""><code class="docutils literal"><span class="pre">utils</span></code> – Utilities</a></li> | 93 | <li class="toctree-l2 current"><a class="current reference internal" href=""><code class="docutils literal"><span class="pre">utils</span></code> – Utilities</a><ul> |
| 92 | <li class="toctree-l2"><a class="reference internal" href="exceptions.html"><code class="docutils literal"><span class="pre">exceptions</span></code> – Exceptions</a></li> | 94 | <li class="toctree-l3"><a class="reference internal" href="utils/classes.html"><code class="docutils literal"><span class="pre">classes</span></code> – Utility Classes</a></li> |
| 95 | <li class="toctree-l3"><a class="reference internal" href="utils/messages.html"><code class="docutils literal"><span class="pre">messages</span></code> – Message Utilities</a></li> | ||
| 96 | </ul> | ||
| 97 | </li> | ||
| 93 | </ul> | 98 | </ul> |
| 94 | </li> | 99 | </li> |
| 95 | <li class="toctree-l1"><a class="reference internal" href="contributing.html">Contributing to EventMQ</a></li> | 100 | <li class="toctree-l1"><a class="reference internal" href="contributing.html">Contributing to EventMQ</a></li> |
| @@ -143,26 +148,16 @@ | |||
| 143 | <h1><code class="xref py py-mod docutils literal"><span class="pre">utils</span></code> – Utilities<a class="headerlink" href="#utils-utilities" title="Permalink to this headline">¶</a></h1> | 148 | <h1><code class="xref py py-mod docutils literal"><span class="pre">utils</span></code> – Utilities<a class="headerlink" href="#utils-utilities" title="Permalink to this headline">¶</a></h1> |
| 144 | <p>This module contains a handful of utility classes to make dealing with things | 149 | <p>This module contains a handful of utility classes to make dealing with things |
| 145 | like creating message more simple.</p> | 150 | like creating message more simple.</p> |
| 151 | <div class="toctree-wrapper compound"> | ||
| 152 | <ul> | ||
| 153 | <li class="toctree-l1"><a class="reference internal" href="utils/classes.html"><code class="docutils literal"><span class="pre">classes</span></code> – Utility Classes</a></li> | ||
| 154 | <li class="toctree-l1"><a class="reference internal" href="utils/messages.html"><code class="docutils literal"><span class="pre">messages</span></code> – Message Utilities</a></li> | ||
| 155 | </ul> | ||
| 156 | </div> | ||
| 146 | <dl class="function"> | 157 | <dl class="function"> |
| 147 | <dt id="eventmq.utils.generate_msgid"> | 158 | <dt id="eventmq.utils.random_characters"> |
| 148 | <code class="descclassname">eventmq.utils.</code><code class="descname">generate_msgid</code><span class="sig-paren">(</span><em>prefix=''</em><span class="sig-paren">)</span><a class="headerlink" href="#eventmq.utils.generate_msgid" title="Permalink to this definition">¶</a></dt> | 159 | <code class="descclassname">eventmq.utils.</code><code class="descname">random_characters</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#eventmq.utils.random_characters" title="Permalink to this definition">¶</a></dt> |
| 149 | <dd><p>Returns a (universally) unique id to be used for messages</p> | 160 | <dd><p>Returns some random characters of a specified length</p> |
| 150 | </dd></dl> | ||
| 151 | |||
| 152 | <dl class="function"> | ||
| 153 | <dt id="eventmq.utils.parse_message"> | ||
| 154 | <code class="descclassname">eventmq.utils.</code><code class="descname">parse_message</code><span class="sig-paren">(</span><em>message</em><span class="sig-paren">)</span><a class="headerlink" href="#eventmq.utils.parse_message" title="Permalink to this definition">¶</a></dt> | ||
| 155 | <dd><p>Parses the generic format of an eMQP/1.0 message and returns the | ||
| 156 | parts.</p> | ||
| 157 | <table class="docutils field-list" frame="void" rules="none"> | ||
| 158 | <col class="field-name" /> | ||
| 159 | <col class="field-body" /> | ||
| 160 | <tbody valign="top"> | ||
| 161 | <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>message</strong> – the message you wish to have parsed</td> | ||
| 162 | </tr> | ||
| 163 | </tbody> | ||
| 164 | </table> | ||
| 165 | <p>Returns (tuple) (sender_id, command, message_id, (message_body, and_data))</p> | ||
| 166 | </dd></dl> | 161 | </dd></dl> |
| 167 | 162 | ||
| 168 | </div> | 163 | </div> |
| @@ -174,7 +169,7 @@ parts.</p> | |||
| 174 | 169 | ||
| 175 | <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation"> | 170 | <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation"> |
| 176 | 171 | ||
| 177 | <a href="exceptions.html" class="btn btn-neutral float-right" title="exceptions – Exceptions" accesskey="n">Next <span class="fa fa-arrow-circle-right"></span></a> | 172 | <a href="utils/classes.html" class="btn btn-neutral float-right" title="classes – Utility Classes" accesskey="n">Next <span class="fa fa-arrow-circle-right"></span></a> |
| 178 | 173 | ||
| 179 | 174 | ||
| 180 | <a href="sender.html" class="btn btn-neutral" title="sender – Sender" accesskey="p"><span class="fa fa-arrow-circle-left"></span> Previous</a> | 175 | <a href="sender.html" class="btn btn-neutral" title="sender – Sender" accesskey="p"><span class="fa fa-arrow-circle-left"></span> Previous</a> |