diff options
Diffstat (limited to 'utils/messages.html')
| -rw-r--r-- | utils/messages.html | 21 |
1 files changed, 12 insertions, 9 deletions
diff --git a/utils/messages.html b/utils/messages.html index 8f06b99..8c09dc5 100644 --- a/utils/messages.html +++ b/utils/messages.html | |||
| @@ -30,6 +30,9 @@ | |||
| 30 | 30 | ||
| 31 | 31 | ||
| 32 | 32 | ||
| 33 | <link rel="index" title="Index" | ||
| 34 | href="../genindex.html"/> | ||
| 35 | <link rel="search" title="Search" href="../search.html"/> | ||
| 33 | <link rel="top" title="EventMQ 0 documentation" href="../index.html"/> | 36 | <link rel="top" title="EventMQ 0 documentation" href="../index.html"/> |
| 34 | <link rel="up" title="utils – Utilities" href="index.html"/> | 37 | <link rel="up" title="utils – Utilities" href="index.html"/> |
| 35 | <link rel="next" title="settings – Settings Utilities" href="settings.html"/> | 38 | <link rel="next" title="settings – Settings Utilities" href="settings.html"/> |
| @@ -61,7 +64,7 @@ | |||
| 61 | 64 | ||
| 62 | 65 | ||
| 63 | <div class="version"> | 66 | <div class="version"> |
| 64 | 0.2.6.2 | 67 | 0.2.6.3 |
| 65 | </div> | 68 | </div> |
| 66 | 69 | ||
| 67 | 70 | ||
| @@ -95,7 +98,7 @@ | |||
| 95 | <li class="toctree-l2 current"><a class="reference internal" href="index.html"><code class="docutils literal"><span class="pre">utils</span></code> – Utilities</a><ul class="current"> | 98 | <li class="toctree-l2 current"><a class="reference internal" href="index.html"><code class="docutils literal"><span class="pre">utils</span></code> – Utilities</a><ul class="current"> |
| 96 | <li class="toctree-l3"><a class="reference internal" href="classes.html"><code class="docutils literal"><span class="pre">classes</span></code> – Utility Classes</a></li> | 99 | <li class="toctree-l3"><a class="reference internal" href="classes.html"><code class="docutils literal"><span class="pre">classes</span></code> – Utility Classes</a></li> |
| 97 | <li class="toctree-l3"><a class="reference internal" href="devices.html"><code class="docutils literal"><span class="pre">devices</span></code> – Device Utilities</a></li> | 100 | <li class="toctree-l3"><a class="reference internal" href="devices.html"><code class="docutils literal"><span class="pre">devices</span></code> – Device Utilities</a></li> |
| 98 | <li class="toctree-l3 current"><a class="current reference internal" href=""><code class="docutils literal"><span class="pre">messages</span></code> – Message Utilities</a></li> | 101 | <li class="toctree-l3 current"><a class="current reference internal" href="#"><code class="docutils literal"><span class="pre">messages</span></code> – Message Utilities</a></li> |
| 99 | <li class="toctree-l3"><a class="reference internal" href="settings.html"><code class="docutils literal"><span class="pre">settings</span></code> – Settings Utilities</a></li> | 102 | <li class="toctree-l3"><a class="reference internal" href="settings.html"><code class="docutils literal"><span class="pre">settings</span></code> – Settings Utilities</a></li> |
| 100 | <li class="toctree-l3"><a class="reference internal" href="timeutils.html"><code class="docutils literal"><span class="pre">timeutils</span></code> – Time Utilites</a></li> | 103 | <li class="toctree-l3"><a class="reference internal" href="timeutils.html"><code class="docutils literal"><span class="pre">timeutils</span></code> – Time Utilites</a></li> |
| 101 | </ul> | 104 | </ul> |
| @@ -125,7 +128,7 @@ | |||
| 125 | <div class="rst-content"> | 128 | <div class="rst-content"> |
| 126 | 129 | ||
| 127 | 130 | ||
| 128 | 131 | ||
| 129 | 132 | ||
| 130 | 133 | ||
| 131 | 134 | ||
| @@ -163,8 +166,8 @@ | |||
| 163 | <tbody valign="top"> | 166 | <tbody valign="top"> |
| 164 | <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple"> | 167 | <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple"> |
| 165 | <li><strong>socket</strong> – socket to send the message with</li> | 168 | <li><strong>socket</strong> – socket to send the message with</li> |
| 166 | <li><strong>recipient_id</strong> (<a class="reference external" href="https://docs.python.org/library/functions.html#str" title="(in Python v2.7)"><em>str</em></a>) – the id of the connected device to reply to</li> | 169 | <li><strong>recipient_id</strong> (<a class="reference external" href="https://docs.python.org/2/library/functions.html#str" title="(in Python v2.7)"><em>str</em></a>) – the id of the connected device to reply to</li> |
| 167 | <li><strong>payload</strong> (<a class="reference external" href="https://docs.python.org/library/functions.html#tuple" title="(in Python v2.7)"><em>tuple</em></a>) – The message to send. The first frame should be an | 170 | <li><strong>payload</strong> (<a class="reference external" href="https://docs.python.org/2/library/functions.html#tuple" title="(in Python v2.7)"><em>tuple</em></a>) – The message to send. The first frame should be an |
| 168 | empty string</li> | 171 | empty string</li> |
| 169 | </ul> | 172 | </ul> |
| 170 | </td> | 173 | </td> |
| @@ -182,7 +185,7 @@ be prefixed with <cite>prefix</cite>.</p> | |||
| 182 | <col class="field-name" /> | 185 | <col class="field-name" /> |
| 183 | <col class="field-body" /> | 186 | <col class="field-body" /> |
| 184 | <tbody valign="top"> | 187 | <tbody valign="top"> |
| 185 | <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>prefix</strong> (<a class="reference external" href="https://docs.python.org/library/functions.html#str" title="(in Python v2.7)"><em>str</em></a>) – Value to prefix on to the random part of the id. Useful | 188 | <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>prefix</strong> (<a class="reference external" href="https://docs.python.org/2/library/functions.html#str" title="(in Python v2.7)"><em>str</em></a>) – Value to prefix on to the random part of the id. Useful |
| 186 | for prefixing some meta data to use for things</td> | 189 | for prefixing some meta data to use for things</td> |
| 187 | </tr> | 190 | </tr> |
| 188 | </tbody> | 191 | </tbody> |
| @@ -245,7 +248,7 @@ parts.</p> | |||
| 245 | <tbody valign="top"> | 248 | <tbody valign="top"> |
| 246 | <tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body">Message id for this message</td> | 249 | <tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body">Message id for this message</td> |
| 247 | </tr> | 250 | </tr> |
| 248 | <tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><a class="reference external" href="https://docs.python.org/library/functions.html#str" title="(in Python v2.7)">str</a></td> | 251 | <tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><a class="reference external" href="https://docs.python.org/2/library/functions.html#str" title="(in Python v2.7)">str</a></td> |
| 249 | </tr> | 252 | </tr> |
| 250 | </tbody> | 253 | </tbody> |
| 251 | </table> | 254 | </table> |
| @@ -262,8 +265,8 @@ used by a <code class="xref py py-attr docutils literal"><span class="pre">zmq.R | |||
| 262 | <tbody valign="top"> | 265 | <tbody valign="top"> |
| 263 | <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple"> | 266 | <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple"> |
| 264 | <li><strong>socket</strong> – socket to send the message with</li> | 267 | <li><strong>socket</strong> – socket to send the message with</li> |
| 265 | <li><strong>recipient_id</strong> (<a class="reference external" href="https://docs.python.org/library/functions.html#str" title="(in Python v2.7)"><em>str</em></a>) – the id of the connected device to reply to</li> | 268 | <li><strong>recipient_id</strong> (<a class="reference external" href="https://docs.python.org/2/library/functions.html#str" title="(in Python v2.7)"><em>str</em></a>) – the id of the connected device to reply to</li> |
| 266 | <li><strong>command</strong> (<a class="reference external" href="https://docs.python.org/library/functions.html#str" title="(in Python v2.7)"><em>str</em></a>) – the eMQP command to send</li> | 269 | <li><strong>command</strong> (<a class="reference external" href="https://docs.python.org/2/library/functions.html#str" title="(in Python v2.7)"><em>str</em></a>) – the eMQP command to send</li> |
| 267 | <li><strong>message</strong> – a msg tuple to send</li> | 270 | <li><strong>message</strong> – a msg tuple to send</li> |
| 268 | </ul> | 271 | </ul> |
| 269 | </td> | 272 | </td> |