aboutsummaryrefslogtreecommitdiffstats
path: root/utils/messages.html
diff options
context:
space:
mode:
Diffstat (limited to 'utils/messages.html')
-rw-r--r--utils/messages.html301
1 files changed, 301 insertions, 0 deletions
diff --git a/utils/messages.html b/utils/messages.html
new file mode 100644
index 0000000..c0d4e60
--- /dev/null
+++ b/utils/messages.html
@@ -0,0 +1,301 @@
1
2
3<!DOCTYPE html>
4<!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]-->
5<!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]-->
6<head>
7 <meta charset="utf-8">
8
9 <meta name="viewport" content="width=device-width, initial-scale=1.0">
10
11 <title>messages – Message Utilities &mdash; EventMQ 0 documentation</title>
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27 <link rel="stylesheet" href="../_static/css/theme.css" type="text/css" />
28
29
30
31
32
33 <link rel="top" title="EventMQ 0 documentation" href="../index.html"/>
34 <link rel="up" title="utils – Utilities" href="../utils.html"/>
35 <link rel="next" title="Contributing to EventMQ" href="../contributing.html"/>
36 <link rel="prev" title="classes – Utility Classes" href="classes.html"/>
37
38
39 <script src="../_static/js/modernizr.min.js"></script>
40
41</head>
42
43<body class="wy-body-for-nav" role="document">
44
45 <div class="wy-grid-for-nav">
46
47
48 <nav data-toggle="wy-nav-shift" class="wy-nav-side">
49 <div class="wy-side-scroll">
50 <div class="wy-side-nav-search">
51
52
53
54 <a href="../index.html" class="icon icon-home"> EventMQ
55
56
57
58 </a>
59
60
61
62
63 <div class="version">
64 0
65 </div>
66
67
68
69
70<div role="search">
71 <form id="rtd-search-form" class="wy-form" action="../search.html" method="get">
72 <input type="text" name="q" placeholder="Search docs" />
73 <input type="hidden" name="check_keywords" value="yes" />
74 <input type="hidden" name="area" value="default" />
75 </form>
76</div>
77
78
79 </div>
80
81 <div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
82
83
84
85 <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> &#8211; Exceptions</a></li>
88<li class="toctree-l2"><a class="reference internal" href="../jobmanager.html"><code class="docutils literal"><span class="pre">jobmanager</span></code> &#8211; 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> &#8211; Poller</a></li>
90<li class="toctree-l2"><a class="reference internal" href="../receiver.html"><code class="docutils literal"><span class="pre">receiver</span></code> &#8211; Receiver</a></li>
91<li class="toctree-l2"><a class="reference internal" href="../router.html"><code class="docutils literal"><span class="pre">router</span></code> &#8211; Router</a></li>
92<li class="toctree-l2"><a class="reference internal" href="../sender.html"><code class="docutils literal"><span class="pre">sender</span></code> &#8211; Sender</a></li>
93<li class="toctree-l2 current"><a class="reference internal" href="../utils.html"><code class="docutils literal"><span class="pre">utils</span></code> &#8211; Utilities</a><ul class="current">
94<li class="toctree-l3"><a class="reference internal" href="classes.html"><code class="docutils literal"><span class="pre">classes</span></code> &#8211; Utility Classes</a></li>
95<li class="toctree-l3 current"><a class="current reference internal" href=""><code class="docutils literal"><span class="pre">messages</span></code> &#8211; Message Utilities</a></li>
96</ul>
97</li>
98</ul>
99</li>
100<li class="toctree-l1"><a class="reference internal" href="../contributing.html">Contributing to EventMQ</a></li>
101</ul>
102
103
104
105 </div>
106 </div>
107 </nav>
108
109 <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
110
111
112 <nav class="wy-nav-top" role="navigation" aria-label="top navigation">
113 <i data-toggle="wy-nav-top" class="fa fa-bars"></i>
114 <a href="../index.html">EventMQ</a>
115 </nav>
116
117
118
119 <div class="wy-nav-content">
120 <div class="rst-content">
121
122
123
124
125
126
127<div role="navigation" aria-label="breadcrumbs navigation">
128 <ul class="wy-breadcrumbs">
129 <li><a href="../index.html">Docs</a> &raquo;</li>
130
131 <li><a href="../api.html">API Documentation</a> &raquo;</li>
132
133 <li><a href="../utils.html"><code class="docutils literal"><span class="pre">utils</span></code> &#8211; Utilities</a> &raquo;</li>
134
135 <li><code class="docutils literal"><span class="pre">messages</span></code> &#8211; Message Utilities</li>
136 <li class="wy-breadcrumbs-aside">
137
138
139 <a href="../_sources/utils/messages.txt" rel="nofollow"> View page source</a>
140
141
142 </li>
143 </ul>
144 <hr/>
145</div>
146 <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
147 <div itemprop="articleBody">
148
149 <span class="target" id="module-eventmq.utils.messages"></span><div class="section" id="messages-message-utilities">
150<h1><code class="xref py py-mod docutils literal"><span class="pre">messages</span></code> &#8211; Message Utilities<a class="headerlink" href="#messages-message-utilities" title="Permalink to this headline">¶</a></h1>
151<dl class="function">
152<dt id="eventmq.utils.messages.generate_msgid">
153<code class="descclassname">eventmq.utils.messages.</code><code class="descname">generate_msgid</code><span class="sig-paren">(</span><em>prefix=None</em><span class="sig-paren">)</span><a class="headerlink" href="#eventmq.utils.messages.generate_msgid" title="Permalink to this definition">¶</a></dt>
154<dd><p>Returns a random string to be used for message ids. Optionally the ID can
155be prefixed with <cite>prefix</cite>.</p>
156<table class="docutils field-list" frame="void" rules="none">
157<col class="field-name" />
158<col class="field-body" />
159<tbody valign="top">
160<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>) &#8211; Value to prefix on to the random part of the id. Useful
161for prefixing some meta data to use for things</td>
162</tr>
163</tbody>
164</table>
165</dd></dl>
166
167<dl class="function">
168<dt id="eventmq.utils.messages.parse_message">
169<code class="descclassname">eventmq.utils.messages.</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.messages.parse_message" title="Permalink to this definition">¶</a></dt>
170<dd><p>Parses the generic format of an eMQP/1.0 message and returns the
171parts.</p>
172<table class="docutils field-list" frame="void" rules="none">
173<col class="field-name" />
174<col class="field-body" />
175<tbody valign="top">
176<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>message</strong> &#8211; the message you wish to have parsed</td>
177</tr>
178</tbody>
179</table>
180<p>Returns (tuple) (command, message_id, (message_body, and_data))</p>
181</dd></dl>
182
183<dl class="function">
184<dt id="eventmq.utils.messages.parse_router_message">
185<code class="descclassname">eventmq.utils.messages.</code><code class="descname">parse_router_message</code><span class="sig-paren">(</span><em>message</em><span class="sig-paren">)</span><a class="headerlink" href="#eventmq.utils.messages.parse_router_message" title="Permalink to this definition">¶</a></dt>
186<dd><p>Parses the generic format of an eMQP/1.0 message and returns the
187parts.</p>
188<table class="docutils field-list" frame="void" rules="none">
189<col class="field-name" />
190<col class="field-body" />
191<tbody valign="top">
192<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>message</strong> &#8211; the message you wish to have parsed</td>
193</tr>
194</tbody>
195</table>
196<p>Returns (tuple) (sender_id, command, message_id, (message_body, and_data))</p>
197</dd></dl>
198
199<dl class="function">
200<dt id="eventmq.utils.messages.send_emqp_message">
201<code class="descclassname">eventmq.utils.messages.</code><code class="descname">send_emqp_message</code><span class="sig-paren">(</span><em>socket</em>, <em>command</em>, <em>message=None</em><span class="sig-paren">)</span><a class="headerlink" href="#eventmq.utils.messages.send_emqp_message" title="Permalink to this definition">¶</a></dt>
202<dd><p>Formats and sends an eMQP message</p>
203<p>Args:</p>
204<p>Raises:</p>
205<p>Returns</p>
206</dd></dl>
207
208<dl class="function">
209<dt id="eventmq.utils.messages.send_emqp_router_message">
210<code class="descclassname">eventmq.utils.messages.</code><code class="descname">send_emqp_router_message</code><span class="sig-paren">(</span><em>socket</em>, <em>recipient_id</em>, <em>command</em>, <em>message=None</em><span class="sig-paren">)</span><a class="headerlink" href="#eventmq.utils.messages.send_emqp_router_message" title="Permalink to this definition">¶</a></dt>
211<dd><p>Formats and sends an eMQP message taking into account the recipient frame
212used by a <code class="xref py py-attr docutils literal"><span class="pre">zmq.ROUTER</span></code> device.</p>
213<table class="docutils field-list" frame="void" rules="none">
214<col class="field-name" />
215<col class="field-body" />
216<tbody valign="top">
217<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
218<li><strong>socket</strong> &#8211; socket to send the message with</li>
219<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>) &#8211; the id of the connected device to reply to</li>
220<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>) &#8211; the eMQP command to send</li>
221<li><strong>message</strong> &#8211; a msg tuple to send</li>
222</ul>
223</td>
224</tr>
225</tbody>
226</table>
227<p>Raises:</p>
228<p>Returns</p>
229</dd></dl>
230
231</div>
232
233
234 </div>
235 </div>
236 <footer>
237
238 <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
239
240 <a href="../contributing.html" class="btn btn-neutral float-right" title="Contributing to EventMQ" accesskey="n">Next <span class="fa fa-arrow-circle-right"></span></a>
241
242
243 <a href="classes.html" class="btn btn-neutral" title="classes – Utility Classes" accesskey="p"><span class="fa fa-arrow-circle-left"></span> Previous</a>
244
245 </div>
246
247
248 <hr/>
249
250 <div role="contentinfo">
251 <p>
252 &copy; Copyright 2015, eventboard.io.
253
254 </p>
255 </div>
256 Built with <a href="http://sphinx-doc.org/">Sphinx</a> using a <a href="https://github.com/snide/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>.
257
258</footer>
259
260 </div>
261 </div>
262
263 </section>
264
265 </div>
266
267
268
269
270
271 <script type="text/javascript">
272 var DOCUMENTATION_OPTIONS = {
273 URL_ROOT:'../',
274 VERSION:'0',
275 COLLAPSE_INDEX:false,
276 FILE_SUFFIX:'.html',
277 HAS_SOURCE: true
278 };
279 </script>
280 <script type="text/javascript" src="../_static/jquery.js"></script>
281 <script type="text/javascript" src="../_static/underscore.js"></script>
282 <script type="text/javascript" src="../_static/doctools.js"></script>
283
284
285
286
287
288 <script type="text/javascript" src="../_static/js/theme.js"></script>
289
290
291
292
293 <script type="text/javascript">
294 jQuery(function () {
295 SphinxRtdTheme.StickyNav.enable();
296 });
297 </script>
298
299
300</body>
301</html> \ No newline at end of file
generated by cgit v1.2.1 (git 2.18.0) at 2026-01-12 04:55:55 +0000