aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorjason2015-11-17 19:07:58 -0700
committerjason2015-11-17 19:07:58 -0700
commitbf4d466c75c00f3f8d92e0a8973900374f29e901 (patch)
tree30c24b1f7b4ccb31510a5cc1cecf060c1588d577
parentd124748d368ad946ed3d605c04aa6a78780315c5 (diff)
downloadeventmq-bf4d466c75c00f3f8d92e0a8973900374f29e901.tar.gz
eventmq-bf4d466c75c00f3f8d92e0a8973900374f29e901.zip
update documentation
-rw-r--r--.gitignore1
-rw-r--r--_sources/api.txt12
-rw-r--r--_sources/contributing.txt8
-rw-r--r--_sources/index.txt15
-rw-r--r--_sources/protocol.txt3
-rw-r--r--api.html217
-rw-r--r--contributing.html211
-rw-r--r--genindex.html6
-rw-r--r--index.html39
-rw-r--r--protocol.html57
-rw-r--r--py-modindex.html6
-rw-r--r--search.html6
-rw-r--r--searchindex.js2
13 files changed, 525 insertions, 58 deletions
diff --git a/.gitignore b/.gitignore
new file mode 100644
index 0000000..106a152
--- /dev/null
+++ b/.gitignore
@@ -0,0 +1 @@
.buildinfo
diff --git a/_sources/api.txt b/_sources/api.txt
new file mode 100644
index 0000000..12ccbb2
--- /dev/null
+++ b/_sources/api.txt
@@ -0,0 +1,12 @@
1#################
2API Documentation
3#################
4
5.. toctree::
6 :maxdepth: 2
7
8 jobmanager
9 receiver
10 router
11 sender
12
diff --git a/_sources/contributing.txt b/_sources/contributing.txt
new file mode 100644
index 0000000..c0a03fb
--- /dev/null
+++ b/_sources/contributing.txt
@@ -0,0 +1,8 @@
1#######################
2Contributing to EventMQ
3#######################
4
5.. toctree::
6 :maxdepth: 1
7
8 protocol
diff --git a/_sources/index.txt b/_sources/index.txt
index 6c9d065..da6e513 100644
--- a/_sources/index.txt
+++ b/_sources/index.txt
@@ -1,17 +1,12 @@
1Welcome to EventMQ's documentation! 1#####################
2=================================== 2EventMQ Documentation
3 3#####################
4:doc:`protocol`
5
6Contents:
7 4
8.. toctree:: 5.. toctree::
9 :maxdepth: 2 6 :maxdepth: 2
10 7
11 jobmanager 8 api
12 receiver 9 contributing
13 router
14 sender
15 10
16 11
17Indices and tables 12Indices and tables
diff --git a/_sources/protocol.txt b/_sources/protocol.txt
index ea01cf3..d9bd9e1 100644
--- a/_sources/protocol.txt
+++ b/_sources/protocol.txt
@@ -1,5 +1,6 @@
1******************************
1EventMQ Protocol Specification 2EventMQ Protocol Specification
2============================== 3******************************
3*The status of this document is alpha and subject to heavy change* 4*The status of this document is alpha and subject to heavy change*
4 5
5Goals 6Goals
diff --git a/api.html b/api.html
new file mode 100644
index 0000000..e04493c
--- /dev/null
+++ b/api.html
@@ -0,0 +1,217 @@
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>API Documentation &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="next" title="jobmanager – Job Manager" href="jobmanager.html"/>
35 <link rel="prev" title="EventMQ Documentation" href="index.html"/>
36
37
38 <script src="_static/js/modernizr.min.js"></script>
39
40</head>
41
42<body class="wy-body-for-nav" role="document">
43
44 <div class="wy-grid-for-nav">
45
46
47 <nav data-toggle="wy-nav-shift" class="wy-nav-side">
48 <div class="wy-side-scroll">
49 <div class="wy-side-nav-search">
50
51
52
53 <a href="index.html" class="icon icon-home"> EventMQ
54
55
56
57 </a>
58
59
60
61
62 <div class="version">
63 0
64 </div>
65
66
67
68
69<div role="search">
70 <form id="rtd-search-form" class="wy-form" action="search.html" method="get">
71 <input type="text" name="q" placeholder="Search docs" />
72 <input type="hidden" name="check_keywords" value="yes" />
73 <input type="hidden" name="area" value="default" />
74 </form>
75</div>
76
77
78 </div>
79
80 <div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
81
82
83
84 <ul class="current">
85<li class="toctree-l1 current"><a class="current reference internal" href="">API Documentation</a><ul>
86<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>
87<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>
88<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>
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</ul>
91</li>
92<li class="toctree-l1"><a class="reference internal" href="contributing.html">Contributing to EventMQ</a></li>
93</ul>
94
95
96
97 </div>
98 </div>
99 </nav>
100
101 <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
102
103
104 <nav class="wy-nav-top" role="navigation" aria-label="top navigation">
105 <i data-toggle="wy-nav-top" class="fa fa-bars"></i>
106 <a href="index.html">EventMQ</a>
107 </nav>
108
109
110
111 <div class="wy-nav-content">
112 <div class="rst-content">
113
114
115
116
117
118
119<div role="navigation" aria-label="breadcrumbs navigation">
120 <ul class="wy-breadcrumbs">
121 <li><a href="index.html">Docs</a> &raquo;</li>
122
123 <li>API Documentation</li>
124 <li class="wy-breadcrumbs-aside">
125
126
127 <a href="_sources/api.txt" rel="nofollow"> View page source</a>
128
129
130 </li>
131 </ul>
132 <hr/>
133</div>
134 <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
135 <div itemprop="articleBody">
136
137 <div class="section" id="api-documentation">
138<h1>API Documentation<a class="headerlink" href="#api-documentation" title="Permalink to this headline">¶</a></h1>
139<div class="toctree-wrapper compound">
140<ul>
141<li class="toctree-l1"><a class="reference internal" href="jobmanager.html"><code class="docutils literal"><span class="pre">jobmanager</span></code> &#8211; Job Manager</a></li>
142<li class="toctree-l1"><a class="reference internal" href="receiver.html"><code class="docutils literal"><span class="pre">receiver</span></code> &#8211; Receiver</a></li>
143<li class="toctree-l1"><a class="reference internal" href="router.html"><code class="docutils literal"><span class="pre">router</span></code> &#8211; Router</a></li>
144<li class="toctree-l1"><a class="reference internal" href="sender.html"><code class="docutils literal"><span class="pre">sender</span></code> &#8211; Sender</a></li>
145</ul>
146</div>
147</div>
148
149
150 </div>
151 </div>
152 <footer>
153
154 <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
155
156 <a href="jobmanager.html" class="btn btn-neutral float-right" title="jobmanager – Job Manager" accesskey="n">Next <span class="fa fa-arrow-circle-right"></span></a>
157
158
159 <a href="index.html" class="btn btn-neutral" title="EventMQ Documentation" accesskey="p"><span class="fa fa-arrow-circle-left"></span> Previous</a>
160
161 </div>
162
163
164 <hr/>
165
166 <div role="contentinfo">
167 <p>
168 &copy; Copyright 2015, eventboard.io.
169
170 </p>
171 </div>
172 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>.
173
174</footer>
175
176 </div>
177 </div>
178
179 </section>
180
181 </div>
182
183
184
185
186
187 <script type="text/javascript">
188 var DOCUMENTATION_OPTIONS = {
189 URL_ROOT:'./',
190 VERSION:'0',
191 COLLAPSE_INDEX:false,
192 FILE_SUFFIX:'.html',
193 HAS_SOURCE: true
194 };
195 </script>
196 <script type="text/javascript" src="_static/jquery.js"></script>
197 <script type="text/javascript" src="_static/underscore.js"></script>
198 <script type="text/javascript" src="_static/doctools.js"></script>
199
200
201
202
203
204 <script type="text/javascript" src="_static/js/theme.js"></script>
205
206
207
208
209 <script type="text/javascript">
210 jQuery(function () {
211 SphinxRtdTheme.StickyNav.enable();
212 });
213 </script>
214
215
216</body>
217</html> \ No newline at end of file
diff --git a/contributing.html b/contributing.html
new file mode 100644
index 0000000..e9cae5d
--- /dev/null
+++ b/contributing.html
@@ -0,0 +1,211 @@
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>Contributing to EventMQ &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="next" title="EventMQ Protocol Specification" href="protocol.html"/>
35 <link rel="prev" title="sender – Sender" href="sender.html"/>
36
37
38 <script src="_static/js/modernizr.min.js"></script>
39
40</head>
41
42<body class="wy-body-for-nav" role="document">
43
44 <div class="wy-grid-for-nav">
45
46
47 <nav data-toggle="wy-nav-shift" class="wy-nav-side">
48 <div class="wy-side-scroll">
49 <div class="wy-side-nav-search">
50
51
52
53 <a href="index.html" class="icon icon-home"> EventMQ
54
55
56
57 </a>
58
59
60
61
62 <div class="version">
63 0
64 </div>
65
66
67
68
69<div role="search">
70 <form id="rtd-search-form" class="wy-form" action="search.html" method="get">
71 <input type="text" name="q" placeholder="Search docs" />
72 <input type="hidden" name="check_keywords" value="yes" />
73 <input type="hidden" name="area" value="default" />
74 </form>
75</div>
76
77
78 </div>
79
80 <div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
81
82
83
84 <ul class="current">
85<li class="toctree-l1"><a class="reference internal" href="api.html">API Documentation</a></li>
86<li class="toctree-l1 current"><a class="current reference internal" href="">Contributing to EventMQ</a><ul>
87<li class="toctree-l2"><a class="reference internal" href="protocol.html">EventMQ Protocol Specification</a></li>
88</ul>
89</li>
90</ul>
91
92
93
94 </div>
95 </div>
96 </nav>
97
98 <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
99
100
101 <nav class="wy-nav-top" role="navigation" aria-label="top navigation">
102 <i data-toggle="wy-nav-top" class="fa fa-bars"></i>
103 <a href="index.html">EventMQ</a>
104 </nav>
105
106
107
108 <div class="wy-nav-content">
109 <div class="rst-content">
110
111
112
113
114
115
116<div role="navigation" aria-label="breadcrumbs navigation">
117 <ul class="wy-breadcrumbs">
118 <li><a href="index.html">Docs</a> &raquo;</li>
119
120 <li>Contributing to EventMQ</li>
121 <li class="wy-breadcrumbs-aside">
122
123
124 <a href="_sources/contributing.txt" rel="nofollow"> View page source</a>
125
126
127 </li>
128 </ul>
129 <hr/>
130</div>
131 <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
132 <div itemprop="articleBody">
133
134 <div class="section" id="contributing-to-eventmq">
135<h1>Contributing to EventMQ<a class="headerlink" href="#contributing-to-eventmq" title="Permalink to this headline">¶</a></h1>
136<div class="toctree-wrapper compound">
137<ul>
138<li class="toctree-l1"><a class="reference internal" href="protocol.html">EventMQ Protocol Specification</a></li>
139</ul>
140</div>
141</div>
142
143
144 </div>
145 </div>
146 <footer>
147
148 <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
149
150 <a href="protocol.html" class="btn btn-neutral float-right" title="EventMQ Protocol Specification" accesskey="n">Next <span class="fa fa-arrow-circle-right"></span></a>
151
152
153 <a href="sender.html" class="btn btn-neutral" title="sender – Sender" accesskey="p"><span class="fa fa-arrow-circle-left"></span> Previous</a>
154
155 </div>
156
157
158 <hr/>
159
160 <div role="contentinfo">
161 <p>
162 &copy; Copyright 2015, eventboard.io.
163
164 </p>
165 </div>
166 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>.
167
168</footer>
169
170 </div>
171 </div>
172
173 </section>
174
175 </div>
176
177
178
179
180
181 <script type="text/javascript">
182 var DOCUMENTATION_OPTIONS = {
183 URL_ROOT:'./',
184 VERSION:'0',
185 COLLAPSE_INDEX:false,
186 FILE_SUFFIX:'.html',
187 HAS_SOURCE: true
188 };
189 </script>
190 <script type="text/javascript" src="_static/jquery.js"></script>
191 <script type="text/javascript" src="_static/underscore.js"></script>
192 <script type="text/javascript" src="_static/doctools.js"></script>
193
194
195
196
197
198 <script type="text/javascript" src="_static/js/theme.js"></script>
199
200
201
202
203 <script type="text/javascript">
204 jQuery(function () {
205 SphinxRtdTheme.StickyNav.enable();
206 });
207 </script>
208
209
210</body>
211</html> \ No newline at end of file
diff --git a/genindex.html b/genindex.html
index cf9659f..13c01a8 100644
--- a/genindex.html
+++ b/genindex.html
@@ -81,10 +81,8 @@
81 81
82 82
83 <ul> 83 <ul>
84<li class="toctree-l1"><a class="reference internal" href="jobmanager.html"><code class="docutils literal"><span class="pre">jobmanager</span></code> &#8211; Job Manager</a></li> 84<li class="toctree-l1"><a class="reference internal" href="api.html">API Documentation</a></li>
85<li class="toctree-l1"><a class="reference internal" href="receiver.html"><code class="docutils literal"><span class="pre">receiver</span></code> &#8211; Receiver</a></li> 85<li class="toctree-l1"><a class="reference internal" href="contributing.html">Contributing to EventMQ</a></li>
86<li class="toctree-l1"><a class="reference internal" href="router.html"><code class="docutils literal"><span class="pre">router</span></code> &#8211; Router</a></li>
87<li class="toctree-l1"><a class="reference internal" href="sender.html"><code class="docutils literal"><span class="pre">sender</span></code> &#8211; Sender</a></li>
88</ul> 86</ul>
89 87
90 88
diff --git a/index.html b/index.html
index 2b3f962..2e2f22c 100644
--- a/index.html
+++ b/index.html
@@ -8,7 +8,7 @@
8 8
9 <meta name="viewport" content="width=device-width, initial-scale=1.0"> 9 <meta name="viewport" content="width=device-width, initial-scale=1.0">
10 10
11 <title>Welcome to EventMQ’s documentation! &mdash; EventMQ 0 documentation</title> 11 <title>EventMQ Documentation &mdash; EventMQ 0 documentation</title>
12 12
13 13
14 14
@@ -31,7 +31,7 @@
31 31
32 32
33 <link rel="top" title="EventMQ 0 documentation" href="#"/> 33 <link rel="top" title="EventMQ 0 documentation" href="#"/>
34 <link rel="next" title="jobmanager – Job Manager" href="jobmanager.html"/> 34 <link rel="next" title="API Documentation" href="api.html"/>
35 35
36 36
37 <script src="_static/js/modernizr.min.js"></script> 37 <script src="_static/js/modernizr.min.js"></script>
@@ -81,10 +81,8 @@
81 81
82 82
83 <ul> 83 <ul>
84<li class="toctree-l1"><a class="reference internal" href="jobmanager.html"><code class="docutils literal"><span class="pre">jobmanager</span></code> &#8211; Job Manager</a></li> 84<li class="toctree-l1"><a class="reference internal" href="api.html">API Documentation</a></li>
85<li class="toctree-l1"><a class="reference internal" href="receiver.html"><code class="docutils literal"><span class="pre">receiver</span></code> &#8211; Receiver</a></li> 85<li class="toctree-l1"><a class="reference internal" href="contributing.html">Contributing to EventMQ</a></li>
86<li class="toctree-l1"><a class="reference internal" href="router.html"><code class="docutils literal"><span class="pre">router</span></code> &#8211; Router</a></li>
87<li class="toctree-l1"><a class="reference internal" href="sender.html"><code class="docutils literal"><span class="pre">sender</span></code> &#8211; Sender</a></li>
88</ul> 86</ul>
89 87
90 88
@@ -115,7 +113,7 @@
115 <ul class="wy-breadcrumbs"> 113 <ul class="wy-breadcrumbs">
116 <li><a href="#">Docs</a> &raquo;</li> 114 <li><a href="#">Docs</a> &raquo;</li>
117 115
118 <li>Welcome to EventMQ&#8217;s documentation!</li> 116 <li>EventMQ Documentation</li>
119 <li class="wy-breadcrumbs-aside"> 117 <li class="wy-breadcrumbs-aside">
120 118
121 119
@@ -129,27 +127,32 @@
129 <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article"> 127 <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
130 <div itemprop="articleBody"> 128 <div itemprop="articleBody">
131 129
132 <div class="section" id="welcome-to-eventmq-s-documentation"> 130 <div class="section" id="eventmq-documentation">
133<h1>Welcome to EventMQ&#8217;s documentation!<a class="headerlink" href="#welcome-to-eventmq-s-documentation" title="Permalink to this headline">¶</a></h1> 131<h1>EventMQ Documentation<a class="headerlink" href="#eventmq-documentation" title="Permalink to this headline">¶</a></h1>
134<p><a class="reference internal" href="protocol.html"><em>EventMQ Protocol Specification</em></a></p>
135<p>Contents:</p>
136<div class="toctree-wrapper compound"> 132<div class="toctree-wrapper compound">
137<ul> 133<ul>
138<li class="toctree-l1"><a class="reference internal" href="jobmanager.html"><code class="docutils literal"><span class="pre">jobmanager</span></code> &#8211; Job Manager</a></li> 134<li class="toctree-l1"><a class="reference internal" href="api.html">API Documentation</a><ul>
139<li class="toctree-l1"><a class="reference internal" href="receiver.html"><code class="docutils literal"><span class="pre">receiver</span></code> &#8211; Receiver</a></li> 135<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>
140<li class="toctree-l1"><a class="reference internal" href="router.html"><code class="docutils literal"><span class="pre">router</span></code> &#8211; Router</a></li> 136<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>
141<li class="toctree-l1"><a class="reference internal" href="sender.html"><code class="docutils literal"><span class="pre">sender</span></code> &#8211; Sender</a></li> 137<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>
138<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>
139</ul>
140</li>
141<li class="toctree-l1"><a class="reference internal" href="contributing.html">Contributing to EventMQ</a><ul>
142<li class="toctree-l2"><a class="reference internal" href="protocol.html">EventMQ Protocol Specification</a></li>
143</ul>
144</li>
142</ul> 145</ul>
143</div>
144</div> 146</div>
145<div class="section" id="indices-and-tables"> 147<div class="section" id="indices-and-tables">
146<h1>Indices and tables<a class="headerlink" href="#indices-and-tables" title="Permalink to this headline">¶</a></h1> 148<h2>Indices and tables<a class="headerlink" href="#indices-and-tables" title="Permalink to this headline">¶</a></h2>
147<ul class="simple"> 149<ul class="simple">
148<li><a class="reference internal" href="genindex.html"><span>Index</span></a></li> 150<li><a class="reference internal" href="genindex.html"><span>Index</span></a></li>
149<li><a class="reference internal" href="py-modindex.html"><span>Module Index</span></a></li> 151<li><a class="reference internal" href="py-modindex.html"><span>Module Index</span></a></li>
150<li><a class="reference internal" href="search.html"><span>Search Page</span></a></li> 152<li><a class="reference internal" href="search.html"><span>Search Page</span></a></li>
151</ul> 153</ul>
152</div> 154</div>
155</div>
153 156
154 157
155 </div> 158 </div>
@@ -158,7 +161,7 @@
158 161
159 <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation"> 162 <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
160 163
161 <a href="jobmanager.html" class="btn btn-neutral float-right" title="jobmanager – Job Manager" accesskey="n">Next <span class="fa fa-arrow-circle-right"></span></a> 164 <a href="api.html" class="btn btn-neutral float-right" title="API Documentation" accesskey="n">Next <span class="fa fa-arrow-circle-right"></span></a>
162 165
163 166
164 </div> 167 </div>
diff --git a/protocol.html b/protocol.html
index 922f46e..6f003bd 100644
--- a/protocol.html
+++ b/protocol.html
@@ -30,7 +30,9 @@
30 30
31 31
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="Contributing to EventMQ" href="contributing.html"/>
35 <link rel="prev" title="Contributing to EventMQ" href="contributing.html"/>
34 36
35 37
36 <script src="_static/js/modernizr.min.js"></script> 38 <script src="_static/js/modernizr.min.js"></script>
@@ -79,11 +81,25 @@
79 81
80 82
81 83
82 <ul> 84 <ul class="current">
83<li class="toctree-l1"><a class="reference internal" href="jobmanager.html"><code class="docutils literal"><span class="pre">jobmanager</span></code> &#8211; Job Manager</a></li> 85<li class="toctree-l1"><a class="reference internal" href="api.html">API Documentation</a></li>
84<li class="toctree-l1"><a class="reference internal" href="receiver.html"><code class="docutils literal"><span class="pre">receiver</span></code> &#8211; Receiver</a></li> 86<li class="toctree-l1 current"><a class="reference internal" href="contributing.html">Contributing to EventMQ</a><ul class="current">
85<li class="toctree-l1"><a class="reference internal" href="router.html"><code class="docutils literal"><span class="pre">router</span></code> &#8211; Router</a></li> 87<li class="toctree-l2 current"><a class="current reference internal" href="">EventMQ Protocol Specification</a><ul>
86<li class="toctree-l1"><a class="reference internal" href="sender.html"><code class="docutils literal"><span class="pre">sender</span></code> &#8211; Sender</a></li> 88<li class="toctree-l3"><a class="reference internal" href="#goals">Goals</a></li>
89<li class="toctree-l3"><a class="reference internal" href="#license">License</a></li>
90<li class="toctree-l3"><a class="reference internal" href="#language">Language</a></li>
91<li class="toctree-l3"><a class="reference internal" href="#architecture">Architecture</a><ul>
92<li class="toctree-l4"><a class="reference internal" href="#topology">Topology</a></li>
93<li class="toctree-l4"><a class="reference internal" href="#router-addressing">ROUTER Addressing</a></li>
94<li class="toctree-l4"><a class="reference internal" href="#emqp-client">eMQP / Client</a></li>
95<li class="toctree-l4"><a class="reference internal" href="#emqp-worker">eMQP / Worker</a></li>
96<li class="toctree-l4"><a class="reference internal" href="#heartbeating">Heartbeating</a></li>
97</ul>
98</li>
99</ul>
100</li>
101</ul>
102</li>
87</ul> 103</ul>
88 104
89 105
@@ -114,6 +130,8 @@
114 <ul class="wy-breadcrumbs"> 130 <ul class="wy-breadcrumbs">
115 <li><a href="index.html">Docs</a> &raquo;</li> 131 <li><a href="index.html">Docs</a> &raquo;</li>
116 132
133 <li><a href="contributing.html">Contributing to EventMQ</a> &raquo;</li>
134
117 <li>EventMQ Protocol Specification</li> 135 <li>EventMQ Protocol Specification</li>
118 <li class="wy-breadcrumbs-aside"> 136 <li class="wy-breadcrumbs-aside">
119 137
@@ -131,9 +149,8 @@
131 <div class="section" id="eventmq-protocol-specification"> 149 <div class="section" id="eventmq-protocol-specification">
132<h1>EventMQ Protocol Specification<a class="headerlink" href="#eventmq-protocol-specification" title="Permalink to this headline">¶</a></h1> 150<h1>EventMQ Protocol Specification<a class="headerlink" href="#eventmq-protocol-specification" title="Permalink to this headline">¶</a></h1>
133<p><em>The status of this document is alpha and subject to heavy change</em></p> 151<p><em>The status of this document is alpha and subject to heavy change</em></p>
134</div>
135<div class="section" id="goals"> 152<div class="section" id="goals">
136<h1>Goals<a class="headerlink" href="#goals" title="Permalink to this headline">¶</a></h1> 153<h2>Goals<a class="headerlink" href="#goals" title="Permalink to this headline">¶</a></h2>
137<p>The EventMQ Protocol (eMQP) defines a reliable service-oriented request-reply and pub-sub dialog between a set of clients, a broker, and a set of workers. This goal is to</p> 154<p>The EventMQ Protocol (eMQP) defines a reliable service-oriented request-reply and pub-sub dialog between a set of clients, a broker, and a set of workers. This goal is to</p>
138<p>The goals are to:</p> 155<p>The goals are to:</p>
139<blockquote> 156<blockquote>
@@ -146,32 +163,32 @@
146</div></blockquote> 163</div></blockquote>
147</div> 164</div>
148<div class="section" id="license"> 165<div class="section" id="license">
149<h1>License<a class="headerlink" href="#license" title="Permalink to this headline">¶</a></h1> 166<h2>License<a class="headerlink" href="#license" title="Permalink to this headline">¶</a></h2>
150<p>This Specification is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.</p> 167<p>This Specification is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.</p>
151<p>This Specification is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.</p> 168<p>This Specification is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.</p>
152</div> 169</div>
153<div class="section" id="language"> 170<div class="section" id="language">
154<h1>Language<a class="headerlink" href="#language" title="Permalink to this headline">¶</a></h1> 171<h2>Language<a class="headerlink" href="#language" title="Permalink to this headline">¶</a></h2>
155<p>The key words &#8220;MUST&#8221;, &#8220;MUST NOT&#8221;, &#8220;REQUIRED&#8221;, &#8220;SHALL&#8221;, &#8220;SHALL NOT&#8221;, &#8220;SHOULD&#8221;, &#8220;SHOULD NOT&#8221;, &#8220;RECOMMENDED&#8221;, &#8220;MAY&#8221;, and &#8220;OPTIONAL&#8221; in this document are to be interpreted as described in RFC 2119[[1](<a class="reference external" href="http://tools.ietf.org/html/rfc2119">http://tools.ietf.org/html/rfc2119</a>)].</p> 172<p>The key words &#8220;MUST&#8221;, &#8220;MUST NOT&#8221;, &#8220;REQUIRED&#8221;, &#8220;SHALL&#8221;, &#8220;SHALL NOT&#8221;, &#8220;SHOULD&#8221;, &#8220;SHOULD NOT&#8221;, &#8220;RECOMMENDED&#8221;, &#8220;MAY&#8221;, and &#8220;OPTIONAL&#8221; in this document are to be interpreted as described in RFC 2119[[1](<a class="reference external" href="http://tools.ietf.org/html/rfc2119">http://tools.ietf.org/html/rfc2119</a>)].</p>
156</div> 173</div>
157<div class="section" id="architecture"> 174<div class="section" id="architecture">
158<h1>Architecture<a class="headerlink" href="#architecture" title="Permalink to this headline">¶</a></h1> 175<h2>Architecture<a class="headerlink" href="#architecture" title="Permalink to this headline">¶</a></h2>
159<p>insert pretty picture here</p> 176<p>insert pretty picture here</p>
160<div class="section" id="topology"> 177<div class="section" id="topology">
161<h2>Topology<a class="headerlink" href="#topology" title="Permalink to this headline">¶</a></h2> 178<h3>Topology<a class="headerlink" href="#topology" title="Permalink to this headline">¶</a></h3>
162<p>eMQP connects a set of client applications (e.g. web servers), a broker, and a pool of workers. Clients connect to the broker as well as the workers.</p> 179<p>eMQP connects a set of client applications (e.g. web servers), a broker, and a pool of workers. Clients connect to the broker as well as the workers.</p>
163<p>&#8216;Clients&#8217; is defined as application issuing requests and &#8216;workers&#8217; as applications that process these requests. (Workers consist of a <cite>JobManager</cite> and a pool of <cite>Worker</cite> resources where the job executes.)</p> 180<p>&#8216;Clients&#8217; is defined as application issuing requests and &#8216;workers&#8217; as applications that process these requests. (Workers consist of a <cite>JobManager</cite> and a pool of <cite>Worker</cite> resources where the job executes.)</p>
164<p>The EventMQ broker handles a set of named queues. The broker SHOULD serve clients on a fair request and MAY deliver requests to workers on any basis, including 0MQ&#8217;s built-in round robin or least-recently used.</p> 181<p>The EventMQ broker handles a set of named queues. The broker SHOULD serve clients on a fair request and MAY deliver requests to workers on any basis, including 0MQ&#8217;s built-in round robin or least-recently used.</p>
165</div> 182</div>
166<div class="section" id="router-addressing"> 183<div class="section" id="router-addressing">
167<h2>ROUTER Addressing<a class="headerlink" href="#router-addressing" title="Permalink to this headline">¶</a></h2> 184<h3>ROUTER Addressing<a class="headerlink" href="#router-addressing" title="Permalink to this headline">¶</a></h3>
168<p>In the case of request-reply, the broker MUST use a ROUTER socket to accept requests from both clients and workers. The broker MAY use a seperate socket implementing a subset of eMQP, or MAY use a single socket implementing all of eMQP.</p> 185<p>In the case of request-reply, the broker MUST use a ROUTER socket to accept requests from both clients and workers. The broker MAY use a seperate socket implementing a subset of eMQP, or MAY use a single socket implementing all of eMQP.</p>
169<p>From the 0MQ manual[[2](<a class="reference external" href="http://api.zeromq.org/master:zmq-socket">http://api.zeromq.org/master:zmq-socket</a>)] 186<p>From the 0MQ manual[[2](<a class="reference external" href="http://api.zeromq.org/master:zmq-socket">http://api.zeromq.org/master:zmq-socket</a>)]
170&gt; When receiving messages a ROUTER socket shall prepend a message part containing the identity of the originating peer to the message before passing it to the application. When sending messages a ROUTER socket shall remove the first part of the message and use it to determine the identity of the peer the message shall be routed to.</p> 187&gt; When receiving messages a ROUTER socket shall prepend a message part containing the identity of the originating peer to the message before passing it to the application. When sending messages a ROUTER socket shall remove the first part of the message and use it to determine the identity of the peer the message shall be routed to.</p>
171<p>This extra frame is not shown in the specifications below.</p> 188<p>This extra frame is not shown in the specifications below.</p>
172</div> 189</div>
173<div class="section" id="emqp-client"> 190<div class="section" id="emqp-client">
174<h2>eMQP / Client<a class="headerlink" href="#emqp-client" title="Permalink to this headline">¶</a></h2> 191<h3>eMQP / Client<a class="headerlink" href="#emqp-client" title="Permalink to this headline">¶</a></h3>
175<p>A <strong>REQUEST</strong> command consists of 7-frame multipart message, formatted as follows.</p> 192<p>A <strong>REQUEST</strong> command consists of 7-frame multipart message, formatted as follows.</p>
176<table border="1" class="docutils"> 193<table border="1" class="docutils">
177<colgroup> 194<colgroup>
@@ -218,7 +235,7 @@
218</table> 235</table>
219</div> 236</div>
220<div class="section" id="emqp-worker"> 237<div class="section" id="emqp-worker">
221<h2>eMQP / Worker<a class="headerlink" href="#emqp-worker" title="Permalink to this headline">¶</a></h2> 238<h3>eMQP / Worker<a class="headerlink" href="#emqp-worker" title="Permalink to this headline">¶</a></h3>
222<p>An <strong>INFORM</strong> command consists of a 5-frame multipart message, formatted as follows.</p> 239<p>An <strong>INFORM</strong> command consists of a 5-frame multipart message, formatted as follows.</p>
223<table border="1" class="docutils"> 240<table border="1" class="docutils">
224<colgroup> 241<colgroup>
@@ -389,7 +406,7 @@
389</table> 406</table>
390</div> 407</div>
391<div class="section" id="heartbeating"> 408<div class="section" id="heartbeating">
392<h2>Heartbeating<a class="headerlink" href="#heartbeating" title="Permalink to this headline">¶</a></h2> 409<h3>Heartbeating<a class="headerlink" href="#heartbeating" title="Permalink to this headline">¶</a></h3>
393<blockquote> 410<blockquote>
394<div><ul class="simple"> 411<div><ul class="simple">
395<li>HEARTBEAT commands are valid at any time after an INFORM command</li> 412<li>HEARTBEAT commands are valid at any time after an INFORM command</li>
@@ -401,12 +418,20 @@
401</div></blockquote> 418</div></blockquote>
402</div> 419</div>
403</div> 420</div>
421</div>
404 422
405 423
406 </div> 424 </div>
407 </div> 425 </div>
408 <footer> 426 <footer>
409 427
428 <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
429
430
431 <a href="contributing.html" class="btn btn-neutral" title="Contributing to EventMQ" accesskey="p"><span class="fa fa-arrow-circle-left"></span> Previous</a>
432
433 </div>
434
410 435
411 <hr/> 436 <hr/>
412 437
diff --git a/py-modindex.html b/py-modindex.html
index 74699b2..f6bdf6c 100644
--- a/py-modindex.html
+++ b/py-modindex.html
@@ -83,10 +83,8 @@
83 83
84 84
85 <ul> 85 <ul>
86<li class="toctree-l1"><a class="reference internal" href="jobmanager.html"><code class="docutils literal"><span class="pre">jobmanager</span></code> &#8211; Job Manager</a></li> 86<li class="toctree-l1"><a class="reference internal" href="api.html">API Documentation</a></li>
87<li class="toctree-l1"><a class="reference internal" href="receiver.html"><code class="docutils literal"><span class="pre">receiver</span></code> &#8211; Receiver</a></li> 87<li class="toctree-l1"><a class="reference internal" href="contributing.html">Contributing to EventMQ</a></li>
88<li class="toctree-l1"><a class="reference internal" href="router.html"><code class="docutils literal"><span class="pre">router</span></code> &#8211; Router</a></li>
89<li class="toctree-l1"><a class="reference internal" href="sender.html"><code class="docutils literal"><span class="pre">sender</span></code> &#8211; Sender</a></li>
90</ul> 88</ul>
91 89
92 90
diff --git a/search.html b/search.html
index 808f3c7..fdeb584 100644
--- a/search.html
+++ b/search.html
@@ -80,10 +80,8 @@
80 80
81 81
82 <ul> 82 <ul>
83<li class="toctree-l1"><a class="reference internal" href="jobmanager.html"><code class="docutils literal"><span class="pre">jobmanager</span></code> &#8211; Job Manager</a></li> 83<li class="toctree-l1"><a class="reference internal" href="api.html">API Documentation</a></li>
84<li class="toctree-l1"><a class="reference internal" href="receiver.html"><code class="docutils literal"><span class="pre">receiver</span></code> &#8211; Receiver</a></li> 84<li class="toctree-l1"><a class="reference internal" href="contributing.html">Contributing to EventMQ</a></li>
85<li class="toctree-l1"><a class="reference internal" href="router.html"><code class="docutils literal"><span class="pre">router</span></code> &#8211; Router</a></li>
86<li class="toctree-l1"><a class="reference internal" href="sender.html"><code class="docutils literal"><span class="pre">sender</span></code> &#8211; Sender</a></li>
87</ul> 85</ul>
88 86
89 87
diff --git a/searchindex.js b/searchindex.js
index 9530a7e..0e649cb 100644
--- a/searchindex.js
+++ b/searchindex.js
@@ -1 +1 @@
Search.setIndex({envversion:46,filenames:["index","jobmanager","protocol","receiver","router","sender"],objects:{"eventmq.jobmanager":{JobManager:[1,3,1,""]},"eventmq.jobmanager.JobManager":{"__init__":[1,2,1,""],"__weakref__":[1,1,1,""]},"eventmq.receiver":{Receiver:[3,3,1,""]},"eventmq.receiver.Receiver":{"__init__":[3,2,1,""],"__weakref__":[3,1,1,""],connect:[3,2,1,""],listen:[3,2,1,""],name:[3,1,1,""],ready:[3,1,1,""],zcontext:[3,1,1,""],zsocket:[3,1,1,""]},"eventmq.router":{Router:[4,3,1,""]},"eventmq.router.Router":{"__weakref__":[4,1,1,""],start:[4,2,1,""]},"eventmq.sender":{Sender:[5,3,1,""]},"eventmq.sender.Sender":{"__init__":[5,2,1,""],"__weakref__":[5,1,1,""],connect:[5,2,1,""],listen:[5,2,1,""],name:[5,1,1,""],ready:[5,1,1,""],send:[5,2,1,""],send_raw:[5,2,1,""],zsocket:[5,1,1,""]},eventmq:{jobmanager:[1,0,0,"-"],receiver:[3,0,0,"-"],router:[4,0,0,"-"],sender:[5,0,0,"-"]}},objnames:{"0":["py","module","Python module"],"1":["py","attribute","Python attribute"],"2":["py","method","Python method"],"3":["py","class","Python class"]},objtypes:{"0":"py:module","1":"py:attribute","2":"py:method","3":"py:class"},terms:{"0mq":[2,5],"__init__":[1,3,5],"__weakref__":[1,3,4,5],"_empty_":2,"_headers_":2,"_msg_":2,"_msgid_":2,"_queue_name_":2,"abstract":2,"case":2,"class":[1,3,4,5],"default":[1,3,5],"function":3,"public":2,"return":[3,5],"true":[3,5],"while":2,about:1,accept:2,act:2,addr:[3,5],address:[],after:2,agre:2,all:[1,2,3,5],allow:2,alpha:2,ani:2,api:2,applic:2,architectur:[],arg:[1,3,4,5],avail:[3,5],backend_addr:4,basi:2,befor:2,begin:4,belong:2,below:2,between:2,bool:[3,5],both:2,broker:2,build:5,built:2,bulid:3,call:3,callabl:3,can:2,chang:2,check:[3,5],client:[],command:2,compon:2,connction:[3,5],connect:[2,3,4,5],consist:2,contain:2,content:0,context:[3,5],convers:2,creat:[3,5],csv:2,current:[3,5],dealer:5,debug:2,defin:[1,2,3,4,5],deliv:2,describ:2,descript:2,detail:2,detect:2,determin:2,dialog:2,dictionari:2,directli:5,disconnect:2,distribut:2,either:2,empti:2,emqp:[],ensur:1,even:2,eventloop:[1,3,4,5],except:[2,3,5],execut:2,expos:1,extra:2,fair:2,fals:[3,5],first:2,fit:2,follow:2,format:2,foundat:2,frame:2,free:2,from:2,frontend_addr:4,gener:[1,2,3,5],gnu:2,goal:[],handl:2,header:2,heartbeat:[],heavi:2,here:2,hope:2,html:2,http:2,ident:2,ietf:2,implement:2,impli:2,includ:2,index:0,inform:2,insert:2,instanc:1,interpret:2,interv:2,issu:2,job:[],jobmanag:[],kei:2,kwarg:[1,3,4,5],languag:[],later:2,least:2,leav:2,licens:[],list:[1,3,4,5],listen:[3,4,5],mai:2,main:1,manag:[],manual:2,master:2,merchant:2,messag:[2,3,4,5],method:3,modifi:2,modul:0,more:2,msg:2,multipart:2,must:2,name:[1,2,3,4,5],none:[3,5],note:[1,3,5],object:[1,3,4,5],onli:[3,5],option:[1,2,3,5],org:2,orient:2,origin:2,other:2,otherwis:[1,3,5],page:0,paramet:[1,3,4,5],part:2,particular:[2,5],pass:[2,3],peer:2,pictur:2,poll:[3,5],pool:2,portion:1,prepend:2,pretti:2,process:2,properti:[3,5],protocol:[],provid:4,pub:2,publish:2,purpos:2,queue:[2,4,5],rais:[3,5],raw:5,raw_messag:5,readi:[2,3,5],receiv:[],recent:2,reciev:3,recommend:2,redistribut:2,refer:[1,3,4,5],regular:2,reliabl:2,remov:2,rep:3,repli:2,req:5,request:[2,4],requir:[2,3],resourc:[1,2],respond:2,respons:[1,3,5],restart:2,rfc2119:2,rfc:2,robin:2,round:2,rout:[2,4],router:[],run:1,search:0,see:2,send:[2,5],send_raw:5,sender:[],seper:2,serv:2,server:[1,2],servic:2,set:[2,3,5],shall:2,should:[2,3,5],shown:2,simpl:4,singl:2,skip:[3,5],skip_zmqstream:[3,5],socket:[2,3,5],softwar:2,someth:5,spawn:1,specif:[],specifi:2,start:[3,4,5],statu:2,stop:2,str:[1,3,5],string:[3,4,5],sub:2,subject:2,subset:2,tcp:4,term:2,them:3,thi:[1,2,3,4,5],thing:1,through:2,time:2,tool:2,topic:5,topolog:[],tornado:[1,4],trace:2,tupl:5,type:[2,3,5],typeerror:3,under:2,uniqu:[1,2],unless:[1,3,5],unus:3,upon:2,uuid:[1,3,5],valid:2,valu:2,version:2,via:[3,5],warranti:2,weak:[1,3,4,5],web:2,well:2,when:[2,3,5],where:2,without:2,word:2,worker:[],wrap:[3,5],you:2,your:2,zcontext:[3,5],zeromq:2,zmq:[2,3,5],zmqstream:[3,5],zsocket:[3,5]},titles:["Welcome to EventMQ&#8217;s documentation!","<code class=\"docutils literal\"><span class=\"pre\">jobmanager</span></code> &#8211; Job Manager","EventMQ Protocol Specification","<code class=\"docutils literal\"><span class=\"pre\">receiver</span></code> &#8211; Receiver","<code class=\"docutils literal\"><span class=\"pre\">router</span></code> &#8211; Router","<code class=\"docutils literal\"><span class=\"pre\">sender</span></code> &#8211; Sender"],titleterms:{address:2,architectur:2,client:2,document:0,emqp:2,eventmq:[0,2],goal:2,heartbeat:2,indic:0,job:1,jobmanag:1,languag:2,licens:2,manag:1,protocol:2,receiv:3,router:[2,4],sender:5,specif:2,tabl:0,topolog:2,welcom:0,worker:2}}) \ No newline at end of file Search.setIndex({envversion:46,filenames:["api","contributing","index","jobmanager","protocol","receiver","router","sender"],objects:{"eventmq.jobmanager":{JobManager:[3,3,1,""]},"eventmq.jobmanager.JobManager":{"__init__":[3,2,1,""],"__weakref__":[3,1,1,""]},"eventmq.receiver":{Receiver:[5,3,1,""]},"eventmq.receiver.Receiver":{"__init__":[5,2,1,""],"__weakref__":[5,1,1,""],connect:[5,2,1,""],listen:[5,2,1,""],name:[5,1,1,""],ready:[5,1,1,""],zcontext:[5,1,1,""],zsocket:[5,1,1,""]},"eventmq.router":{Router:[6,3,1,""]},"eventmq.router.Router":{"__weakref__":[6,1,1,""],start:[6,2,1,""]},"eventmq.sender":{Sender:[7,3,1,""]},"eventmq.sender.Sender":{"__init__":[7,2,1,""],"__weakref__":[7,1,1,""],connect:[7,2,1,""],listen:[7,2,1,""],name:[7,1,1,""],ready:[7,1,1,""],send:[7,2,1,""],send_raw:[7,2,1,""],zsocket:[7,1,1,""]},eventmq:{jobmanager:[3,0,0,"-"],receiver:[5,0,0,"-"],router:[6,0,0,"-"],sender:[7,0,0,"-"]}},objnames:{"0":["py","module","Python module"],"1":["py","attribute","Python attribute"],"2":["py","method","Python method"],"3":["py","class","Python class"]},objtypes:{"0":"py:module","1":"py:attribute","2":"py:method","3":"py:class"},terms:{"0mq":[4,7],"__init__":[3,5,7],"__weakref__":[3,5,6,7],"_empty_":4,"_headers_":4,"_msg_":4,"_msgid_":4,"_queue_name_":4,"abstract":4,"case":4,"class":[3,5,6,7],"default":[3,5,7],"function":5,"public":4,"return":[5,7],"true":[5,7],"while":4,about:3,accept:4,act:4,addr:[5,7],address:[],after:4,agre:4,all:[3,4,5,7],allow:4,alpha:4,ani:4,api:[],applic:4,architectur:[],arg:[3,5,6,7],avail:[5,7],backend_addr:6,basi:4,befor:4,begin:6,belong:4,below:4,between:4,bool:[5,7],both:4,broker:4,build:7,built:4,bulid:5,call:5,callabl:5,can:4,chang:4,check:[5,7],client:[],command:4,compon:4,connction:[5,7],connect:[4,5,6,7],consist:4,contain:4,content:[],context:[5,7],convers:4,creat:[5,7],csv:4,current:[5,7],dealer:7,debug:4,defin:[3,4,5,6,7],deliv:4,describ:4,descript:4,detail:4,detect:4,determin:4,dialog:4,dictionari:4,directli:7,disconnect:4,distribut:4,either:4,empti:4,emqp:[],ensur:3,even:4,eventloop:[3,5,6,7],except:[4,5,7],execut:4,expos:3,extra:4,fair:4,fals:[5,7],first:4,fit:4,follow:4,format:4,foundat:4,frame:4,free:4,from:4,frontend_addr:6,gener:[3,4,5,7],gnu:4,goal:[],handl:4,header:4,heartbeat:[],heavi:4,here:4,hope:4,html:4,http:4,ident:4,ietf:4,implement:4,impli:4,includ:4,index:2,inform:4,insert:4,instanc:3,interpret:4,interv:4,issu:4,job:[],jobmanag:[],kei:4,kwarg:[3,5,6,7],languag:[],later:4,least:4,leav:4,licens:[],list:[3,5,6,7],listen:[5,6,7],mai:4,main:3,manag:[],manual:4,master:4,merchant:4,messag:[4,5,6,7],method:5,modifi:4,modul:2,more:4,msg:4,multipart:4,must:4,name:[3,4,5,6,7],none:[5,7],note:[3,5,7],object:[3,5,6,7],onli:[5,7],option:[3,4,5,7],org:4,orient:4,origin:4,other:4,otherwis:[3,5,7],page:2,paramet:[3,5,6,7],part:4,particular:[4,7],pass:[4,5],peer:4,pictur:4,poll:[5,7],pool:4,portion:3,prepend:4,pretti:4,process:4,properti:[5,7],protocol:[],provid:6,pub:4,publish:4,purpos:4,queue:[4,6,7],rais:[5,7],raw:7,raw_messag:7,readi:[4,5,7],receiv:[],recent:4,reciev:5,recommend:4,redistribut:4,refer:[3,5,6,7],regular:4,reliabl:4,remov:4,rep:5,repli:4,req:7,request:[4,6],requir:[4,5],resourc:[3,4],respond:4,respons:[3,5,7],restart:4,rfc2119:4,rfc:4,robin:4,round:4,rout:[4,6],router:[],run:3,search:2,see:4,send:[4,7],send_raw:7,sender:[],seper:4,serv:4,server:[3,4],servic:4,set:[4,5,7],shall:4,should:[4,5,7],shown:4,simpl:6,singl:4,skip:[5,7],skip_zmqstream:[5,7],socket:[4,5,7],softwar:4,someth:7,spawn:3,specif:[],specifi:4,start:[5,6,7],statu:4,stop:4,str:[3,5,7],string:[5,6,7],sub:4,subject:4,subset:4,tcp:6,term:4,them:5,thi:[3,4,5,6,7],thing:3,through:4,time:4,tool:4,topic:7,topolog:[],tornado:[3,6],trace:4,tupl:7,type:[4,5,7],typeerror:5,under:4,uniqu:[3,4],unless:[3,5,7],unus:5,upon:4,uuid:[3,5,7],valid:4,valu:4,version:4,via:[5,7],warranti:4,weak:[3,5,6,7],web:4,well:4,when:[4,5,7],where:4,without:4,word:4,worker:[],wrap:[5,7],you:4,your:4,zcontext:[5,7],zeromq:4,zmq:[4,5,7],zmqstream:[5,7],zsocket:[5,7]},titles:["API Documentation","Contributing to EventMQ","EventMQ Documentation","<code class=\"docutils literal\"><span class=\"pre\">jobmanager</span></code> &#8211; Job Manager","EventMQ Protocol Specification","<code class=\"docutils literal\"><span class=\"pre\">receiver</span></code> &#8211; Receiver","<code class=\"docutils literal\"><span class=\"pre\">router</span></code> &#8211; Router","<code class=\"docutils literal\"><span class=\"pre\">sender</span></code> &#8211; Sender"],titleterms:{address:4,api:0,architectur:4,client:4,contribut:1,document:[0,2],emqp:4,eventmq:[1,2,4],goal:4,heartbeat:4,indic:2,job:3,jobmanag:3,languag:4,licens:4,manag:3,protocol:4,receiv:5,router:[4,6],sender:7,specif:4,tabl:2,topolog:4,welcom:[],worker:4}}) \ No newline at end of file