aboutsummaryrefslogtreecommitdiffstats
path: root/_sources
diff options
context:
space:
mode:
authorjason2016-05-24 20:19:12 -0600
committerjason2016-05-24 20:19:12 -0600
commit8a8396c454206feb589a806db2ddf8a03d2d757e (patch)
treef68b67d98bea14d0f15b0e11e3fe2c81a5376a9c /_sources
parent8fc4bcc96063b29d0726feb7a72b28acf01b109c (diff)
downloadeventmq-8a8396c454206feb589a806db2ddf8a03d2d757e.tar.gz
eventmq-8a8396c454206feb589a806db2ddf8a03d2d757e.zip
0.2.1 update
Diffstat (limited to '_sources')
-rw-r--r--_sources/index.txt2
-rw-r--r--_sources/protocol.txt13
-rw-r--r--_sources/settings_file.txt51
-rw-r--r--_sources/using.txt8
4 files changed, 66 insertions, 8 deletions
diff --git a/_sources/index.txt b/_sources/index.txt
index da6e513..25fc86f 100644
--- a/_sources/index.txt
+++ b/_sources/index.txt
@@ -5,6 +5,7 @@ EventMQ Documentation
5.. toctree:: 5.. toctree::
6 :maxdepth: 2 6 :maxdepth: 2
7 7
8 using
8 api 9 api
9 contributing 10 contributing
10 11
@@ -15,4 +16,3 @@ Indices and tables
15* :ref:`genindex` 16* :ref:`genindex`
16* :ref:`modindex` 17* :ref:`modindex`
17* :ref:`search` 18* :ref:`search`
18
diff --git a/_sources/protocol.txt b/_sources/protocol.txt
index 4c2aff0..c341403 100644
--- a/_sources/protocol.txt
+++ b/_sources/protocol.txt
@@ -71,7 +71,7 @@ FRAME Value Description
711 eMQP/1.0 Protocol version 711 eMQP/1.0 Protocol version
722 REQUEST command 722 REQUEST command
733 _MSGID_ A unique id for the msg 733 _MSGID_ A unique id for the msg
744 _QUEUE_NAME_ the name of the queue the worker belongs to 744 _QUEUE_NAME_ the name of the queue the request should be sent to
755 _HEADERS_ dictionary of headers. can be an empty set 755 _HEADERS_ dictionary of headers. can be an empty set
766 _MSG_ The message to send 766 _MSG_ The message to send
77====== ============== =========== 77====== ============== ===========
@@ -85,7 +85,7 @@ FRAME Value Description
851 eMQP/1.0 Protocol version 851 eMQP/1.0 Protocol version
862 PUBLISH command 862 PUBLISH command
873 _MSGID_ A unique id for the msg 873 _MSGID_ A unique id for the msg
884 _TOPIC_NAME_ the name of the queue the worker belongs to 884 _TOPIC_NAME_ the name of the topic this message should be published across
895 _HEADERS_ csv list of headers 895 _HEADERS_ csv list of headers
906 _MSG_ The message to send 906 _MSG_ The message to send
91====== ============== =========== 91====== ============== ===========
@@ -99,7 +99,7 @@ FRAME Value Description
991 eMQP/1.0 Protocol version 991 eMQP/1.0 Protocol version
1002 SCHEDULE command 1002 SCHEDULE command
1013 _MSGID_ A unique id for the msg 1013 _MSGID_ A unique id for the msg
1024 _TOPIC_NAME_ name of queue that the job should run in 1024 _QUEUE_NAME_ name of queue that the job should run in
1035 _HEADERS_ csv list of headers for this message 1035 _HEADERS_ csv list of headers for this message
1046 _MSG_ The message to send 1046 _MSG_ The message to send
105====== ============== =========== 105====== ============== ===========
@@ -113,7 +113,7 @@ FRAME Value Description
1131 eMQP/1.0 Protocol version 1131 eMQP/1.0 Protocol version
1142 UNSCHEDULE command 1142 UNSCHEDULE command
1153 _MSGID_ A unique id for the msg 1153 _MSGID_ A unique id for the msg
1164 _TOPIC_NAME_ ignored for this command, broadcasted to all queues 1164 _QUEUE_NAME_ ignored for this command, broadcasted to all queues
1175 _HEADERS_ csv list of headers for this message 1175 _HEADERS_ csv list of headers for this message
1186 _MSG_ The message to send 1186 _MSG_ The message to send
119====== ============== =========== 119====== ============== ===========
@@ -129,7 +129,7 @@ FRAME Value Description
1291 eMQP/1.0 Protocol version 1291 eMQP/1.0 Protocol version
1302 INFORM command 1302 INFORM command
1313 _MSGID_ A unique id for the msg 1313 _MSGID_ A unique id for the msg
1324 _QUEUE_NAME_ csv seperated names of queue the worker belongs to 1324 Queues. Unused for scheduler
1335 scheduler type of peer connecting 1335 scheduler type of peer connecting
134====== ============== =========== 134====== ============== ===========
135 135
@@ -144,7 +144,7 @@ FRAME Value Description
1441 eMQP/1.0 Protocol version 1441 eMQP/1.0 Protocol version
1452 INFORM command 1452 INFORM command
1463 _MSGID_ A unique id for the msg 1463 _MSGID_ A unique id for the msg
1474 _QUEUE_NAME_ csv seperated names of queue the worker belongs to. 1474 _QUEUES_ csv seperated arrays containing an int and a string for weight and name. e.g. [40, 'email']
1485 worker type of peer connecting 1485 worker type of peer connecting
149====== ============== =========== 149====== ============== ===========
150 150
@@ -203,7 +203,6 @@ Heartbeating
203 * If the worker detects that the broker disconnected it SHOULD restart the conversation. 203 * If the worker detects that the broker disconnected it SHOULD restart the conversation.
204 * If the broker detects that a worker has disconnected it should stop sending it a message of any type. 204 * If the broker detects that a worker has disconnected it should stop sending it a message of any type.
205 * If the scheduler detects that the broker disconnects it SHOULD restart the conversation. 205 * If the scheduler detects that the broker disconnects it SHOULD restart the conversation.
206 * If the broker detects that a scheduler has disconnected it should ??????????.
207 206
208REQUEST Headers 207REQUEST Headers
209--------------- 208---------------
diff --git a/_sources/settings_file.txt b/_sources/settings_file.txt
new file mode 100644
index 0000000..b0bc36c
--- /dev/null
+++ b/_sources/settings_file.txt
@@ -0,0 +1,51 @@
1########
2Settings
3########
4EventMQ uses a standard INI style config file found at ``/etc/eventmq.conf``.
5
6******
7Router
8******
9
10*********
11Scheduler
12*********
13
14***********
15Job Manager
16***********
17
18concurrent_jobs
19===============
20Default: 4
21
22This is the number of concurrent jobs the indiviudal job manager should execute
23at a time. If you are using the multiprocess or threading model this number
24becomes important as you will want to control the load on your server. If the
25load equals the number of cores on the server, processes will begin waiting for
26cpu cycles and things will begin to slow down.
27
28A safe number to choose if your jobs block a lot would be (2 * cores). If your
29jobs are cpu intensive you will want to set this number to the number of cores
30you have or (cores - 1) to leave cycles for the os and other processes. This is
31something that will have to be tuned based on the jobs that are
32running. Grouping similar jobs in named queues will help you tune this number.
33
34queues
35======
36Default: (10, default)
37
38Semi-colon seperated list of queues to process jobs for with thier
39weights. Example: ``queues=(10, data_process); (15, email)``. With these
40weights and the ``CONCURRENT_JOBS`` setting, you should be able to tune managers
41running jobs locally pretty efficiently. If you have a larger box with a weight
42of 50 on q1 and 8 concurrent jobs and a smaller box with a weight 30 and 4
43concurrent jobs, the q1 jobs will be sent to the large box until it is no longer
44accepting jobs. At this point jobs will start to be sent to the next highest
45number until the large box is ready to accept another q1 job.
46
47.. note::
48
49 It is recommended that you have some workers listening for jobs on your
50 default queue so that anything that is not explicitly assigned will still be
51 run.
diff --git a/_sources/using.txt b/_sources/using.txt
new file mode 100644
index 0000000..3c6a517
--- /dev/null
+++ b/_sources/using.txt
@@ -0,0 +1,8 @@
1#############
2Using EventMQ
3#############
4
5.. toctree::
6 :maxdepth: 2
7
8 settings_file