aboutsummaryrefslogtreecommitdiffstats
path: root/utils/index.html
diff options
context:
space:
mode:
Diffstat (limited to 'utils/index.html')
-rw-r--r--utils/index.html256
1 files changed, 256 insertions, 0 deletions
diff --git a/utils/index.html b/utils/index.html
new file mode 100644
index 0000000..d58c3a3
--- /dev/null
+++ b/utils/index.html
@@ -0,0 +1,256 @@
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="classes – Utility Classes" href="classes.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="../client.html"><code class="docutils literal"><span class="pre">client</span></code> &#8211; Client Utilities</a></li>
88<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>
89<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>
90<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>
91<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>
92<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>
93<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>
94<li class="toctree-l2 current"><a class="current reference internal" href=""><code class="docutils literal"><span class="pre">utils</span></code> &#8211; Utilities</a><ul>
95<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>
96<li class="toctree-l3"><a class="reference internal" href="devices.html"><code class="docutils literal"><span class="pre">devices</span></code> &#8211; Device Utilities</a></li>
97<li class="toctree-l3"><a class="reference internal" href="messages.html"><code class="docutils literal"><span class="pre">messages</span></code> &#8211; Message Utilities</a></li>
98<li class="toctree-l3"><a class="reference internal" href="settings.html"><code class="docutils literal"><span class="pre">settings</span></code> &#8211; Settings Utilities</a></li>
99<li class="toctree-l3"><a class="reference internal" href="timeutils.html"><code class="docutils literal"><span class="pre">timeutils</span></code> &#8211; Time Utilites</a></li>
100</ul>
101</li>
102</ul>
103</li>
104<li class="toctree-l1"><a class="reference internal" href="../contributing.html">Contributing to EventMQ</a></li>
105</ul>
106
107
108
109 </div>
110 </div>
111 </nav>
112
113 <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
114
115
116 <nav class="wy-nav-top" role="navigation" aria-label="top navigation">
117 <i data-toggle="wy-nav-top" class="fa fa-bars"></i>
118 <a href="../index.html">EventMQ</a>
119 </nav>
120
121
122
123 <div class="wy-nav-content">
124 <div class="rst-content">
125
126
127
128
129
130
131<div role="navigation" aria-label="breadcrumbs navigation">
132 <ul class="wy-breadcrumbs">
133 <li><a href="../index.html">Docs</a> &raquo;</li>
134
135 <li><a href="../api.html">API Documentation</a> &raquo;</li>
136
137 <li><code class="docutils literal"><span class="pre">utils</span></code> &#8211; Utilities</li>
138 <li class="wy-breadcrumbs-aside">
139
140
141 <a href="../_sources/utils/index.txt" rel="nofollow"> View page source</a>
142
143
144 </li>
145 </ul>
146 <hr/>
147</div>
148 <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
149 <div itemprop="articleBody">
150
151 <span class="target" id="module-eventmq.utils"></span><div class="section" id="utils-utilities">
152<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>
153<p>This module contains a handful of utility classes to make dealing with things
154like creating message more simple.</p>
155<div class="toctree-wrapper compound">
156<ul>
157<li class="toctree-l1"><a class="reference internal" href="classes.html"><code class="docutils literal"><span class="pre">classes</span></code> &#8211; Utility Classes</a></li>
158<li class="toctree-l1"><a class="reference internal" href="devices.html"><code class="docutils literal"><span class="pre">devices</span></code> &#8211; Device Utilities</a></li>
159<li class="toctree-l1"><a class="reference internal" href="messages.html"><code class="docutils literal"><span class="pre">messages</span></code> &#8211; Message Utilities</a></li>
160<li class="toctree-l1"><a class="reference internal" href="settings.html"><code class="docutils literal"><span class="pre">settings</span></code> &#8211; Settings Utilities</a></li>
161<li class="toctree-l1"><a class="reference internal" href="timeutils.html"><code class="docutils literal"><span class="pre">timeutils</span></code> &#8211; Time Utilites</a></li>
162</ul>
163</div>
164<dl class="function">
165<dt id="eventmq.utils.random_characters">
166<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>
167<dd><table class="docutils field-list" frame="void" rules="none">
168<col class="field-name" />
169<col class="field-body" />
170<tbody valign="top">
171<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body">some random characters of a specified length</td>
172</tr>
173<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>
174</tr>
175</tbody>
176</table>
177</dd></dl>
178
179<dl class="function">
180<dt id="eventmq.utils.zero_index_cmp">
181<code class="descclassname">eventmq.utils.</code><code class="descname">zero_index_cmp</code><span class="sig-paren">(</span><em>a</em>, <em>b</em><span class="sig-paren">)</span><a class="headerlink" href="#eventmq.utils.zero_index_cmp" title="Permalink to this definition">¶</a></dt>
182<dd><p>same as <code class="docutils literal"><span class="pre">cmp</span></code> but using the 0-index in a list as the compare value. Used
183when sorting the values in <code class="xref py py-attr docutils literal"><span class="pre">router.Router.queues</span></code>.</p>
184</dd></dl>
185
186</div>
187
188
189 </div>
190 </div>
191 <footer>
192
193 <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
194
195 <a href="classes.html" class="btn btn-neutral float-right" title="classes – Utility Classes" accesskey="n">Next <span class="fa fa-arrow-circle-right"></span></a>
196
197
198 <a href="../sender.html" class="btn btn-neutral" title="sender – Sender" accesskey="p"><span class="fa fa-arrow-circle-left"></span> Previous</a>
199
200 </div>
201
202
203 <hr/>
204
205 <div role="contentinfo">
206 <p>
207 &copy; Copyright 2015, eventboard.io.
208
209 </p>
210 </div>
211 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>.
212
213</footer>
214
215 </div>
216 </div>
217
218 </section>
219
220 </div>
221
222
223
224
225
226 <script type="text/javascript">
227 var DOCUMENTATION_OPTIONS = {
228 URL_ROOT:'../',
229 VERSION:'0',
230 COLLAPSE_INDEX:false,
231 FILE_SUFFIX:'.html',
232 HAS_SOURCE: true
233 };
234 </script>
235 <script type="text/javascript" src="../_static/jquery.js"></script>
236 <script type="text/javascript" src="../_static/underscore.js"></script>
237 <script type="text/javascript" src="../_static/doctools.js"></script>
238
239
240
241
242
243 <script type="text/javascript" src="../_static/js/theme.js"></script>
244
245
246
247
248 <script type="text/javascript">
249 jQuery(function () {
250 SphinxRtdTheme.StickyNav.enable();
251 });
252 </script>
253
254
255</body>
256</html> \ No newline at end of file