Permalink
Browse files

link readme to source of participants and receiver

  • Loading branch information...
1 parent 85bc738 commit 0071538fc5637603e8736d4c0aaaa2c0e35f1c44 @jmettraux jmettraux committed Mar 21, 2013
Showing with 15 additions and 2 deletions.
  1. +12 −2 README.md
  2. +3 −0 TODO.txt
View
@@ -16,9 +16,12 @@ For a tiny example that shows the engine communicating by bouncing a message on
Here are the two Participant classes and the Receiver classes offered by ruote-amqp:
+
### Ruote::Amqp::Participant
-Publishing messages
+Publishing messages.
+
+This participant, upon receiving a workitem, posts a message on an AMQP exchange. By default it just turns the workitem to JSON and uses that string as the message. Feel free to subclass this participant to change that, or just pass a :message option.
```ruby
$dashboard.register(
@@ -36,6 +39,9 @@ $dashboard.launch(pdef)
# ...
```
+The [source](lib/ruote/amqp/participant.rb).
+
+
### Ruote::Amqp::AlertParticipant
Ambushing messages from a process definition. The alert participant when
@@ -64,7 +70,8 @@ according to the message.
It's also OK to override the #on_workitem method of this participant if one
waits to wait for more than 1 message.
-See the AlertParticipant rdoc for more.
+The [source](lib/ruote/amqp/alert_participant.rb).
+
### Ruote::Amqp::Receiver
@@ -99,6 +106,9 @@ receiver = Ruote::Amqp::Receiver.new(
# ...
```
+The [source](lib/ruote/amqp/receiver.rb).
+
+
### Controlling the connection (AMQP session)
The Ruote::Amqp module has a handy singleton for connections (actually
View
@@ -14,3 +14,6 @@
[ ] incorporate
https://github.com/marsbomber/ruote-amqp/commit/0f36a41f4a0254847a7b9a7c4b2098c8164f21f3
+[ ] :message => proc(workitem), general opt => proc
+ :exchange too?
+

0 comments on commit 0071538

Please sign in to comment.