aboutsummaryrefslogtreecommitdiffstats
path: root/utils.html
diff options
context:
space:
mode:
Diffstat (limited to 'utils.html')
-rw-r--r--utils.html236
1 files changed, 236 insertions, 0 deletions
diff --git a/utils.html b/utils.html
new file mode 100644
index 0000000..f115675
--- /dev/null
+++ b/utils.html
@@ -0,0 +1,236 @@
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>utils – 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="API Documentation" href="api.html"/>
35 <link rel="next" title="&lt;no title&gt;" href="exceptions.html"/>
36 <link rel="prev" title="sender – Sender" href="sender.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="jobmanager.html"><code class="docutils literal"><span class="pre">jobmanager</span></code> &#8211; Job Manager</a></li>
88<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>
89<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>
90<li class="toctree-l2 current"><a class="current reference internal" href=""><code class="docutils literal"><span class="pre">utils</span></code> &#8211; Utilities</a></li>
91</ul>
92</li>
93<li class="toctree-l1"><a class="reference internal" href="contributing.html">Contributing to EventMQ</a></li>
94</ul>
95
96
97
98 </div>
99 </div>
100 </nav>
101
102 <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
103
104
105 <nav class="wy-nav-top" role="navigation" aria-label="top navigation">
106 <i data-toggle="wy-nav-top" class="fa fa-bars"></i>
107 <a href="index.html">EventMQ</a>
108 </nav>
109
110
111
112 <div class="wy-nav-content">
113 <div class="rst-content">
114
115
116
117
118
119
120<div role="navigation" aria-label="breadcrumbs navigation">
121 <ul class="wy-breadcrumbs">
122 <li><a href="index.html">Docs</a> &raquo;</li>
123
124 <li><a href="api.html">API Documentation</a> &raquo;</li>
125
126 <li><code class="docutils literal"><span class="pre">utils</span></code> &#8211; Utilities</li>
127 <li class="wy-breadcrumbs-aside">
128
129
130 <a href="_sources/utils.txt" rel="nofollow"> View page source</a>
131
132
133 </li>
134 </ul>
135 <hr/>
136</div>
137 <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
138 <div itemprop="articleBody">
139
140 <span class="target" id="module-eventmq.utils"></span><div class="section" id="utils-utilities">
141<h1><code class="xref py py-mod docutils literal"><span class="pre">utils</span></code> &#8211; Utilities<a class="headerlink" href="#utils-utilities" title="Permalink to this headline">¶</a></h1>
142<p>This module contains a handful of utility classes to make dealing with things
143like creating message more simple.</p>
144<dl class="function">
145<dt id="eventmq.utils.generate_msgid">
146<code class="descclassname">eventmq.utils.</code><code class="descname">generate_msgid</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#eventmq.utils.generate_msgid" title="Permalink to this definition">¶</a></dt>
147<dd><p>Returns a (universally) unique id to be used for messages</p>
148</dd></dl>
149
150<dl class="function">
151<dt id="eventmq.utils.parse_message">
152<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>
153<dd><p>Parses the generic format of an eMQP/1.0 message and returns the
154parts.</p>
155<table class="docutils field-list" frame="void" rules="none">
156<col class="field-name" />
157<col class="field-body" />
158<tbody valign="top">
159<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>
160</tr>
161</tbody>
162</table>
163<p>Returns (tuple) (sender_id, command, message_id, (message_body, and_data))</p>
164</dd></dl>
165
166</div>
167
168
169 </div>
170 </div>
171 <footer>
172
173 <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
174
175 <a href="exceptions.html" class="btn btn-neutral float-right" title="&lt;no title&gt;" accesskey="n">Next <span class="fa fa-arrow-circle-right"></span></a>
176
177
178 <a href="sender.html" class="btn btn-neutral" title="sender – Sender" accesskey="p"><span class="fa fa-arrow-circle-left"></span> Previous</a>
179
180 </div>
181
182
183 <hr/>
184
185 <div role="contentinfo">
186 <p>
187 &copy; Copyright 2015, eventboard.io.
188
189 </p>
190 </div>
191 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>.
192
193</footer>
194
195 </div>
196 </div>
197
198 </section>
199
200 </div>
201
202
203
204
205
206 <script type="text/javascript">
207 var DOCUMENTATION_OPTIONS = {
208 URL_ROOT:'./',
209 VERSION:'0',
210 COLLAPSE_INDEX:false,
211 FILE_SUFFIX:'.html',
212 HAS_SOURCE: true
213 };
214 </script>
215 <script type="text/javascript" src="_static/jquery.js"></script>
216 <script type="text/javascript" src="_static/underscore.js"></script>
217 <script type="text/javascript" src="_static/doctools.js"></script>
218
219
220
221
222
223 <script type="text/javascript" src="_static/js/theme.js"></script>
224
225
226
227
228 <script type="text/javascript">
229 jQuery(function () {
230 SphinxRtdTheme.StickyNav.enable();
231 });
232 </script>
233
234
235</body>
236</html> \ No newline at end of file
generated by cgit v1.2.1 (git 2.18.0) at 2026-01-12 04:57:24 +0000