Add first cut at Performer docs
#112
Conversation
Co-Authored-By: Rob Brackett <74178+mr0grog@users.noreply.github.com>
Mr0grog
force-pushed
the
performer-does-things-you-might-want-to-know-about
branch
from
847b95d to
5f97faa
Compare
Mr0grog
force-pushed
the
performer-does-things-you-might-want-to-know-about
branch
from
5f97faa to
9711a3d
Compare
| @@ -1,18 +1,46 @@ | |||
| module GoodJob | |||
| # | |||
| # Performer queries the database for jobs and performs them on behalf of a | |||
There was a problem hiding this comment.
This is the applied purpose for the Perfomer. Though the performer is intended to be generic/ignorant of the nature of the task.
The practical reason for the performer is to enforce a callable that does not rely on scoped/closures variables because they might not be available when executed in a different thread. Or alternatively, it describes an interface that is compatible with the Scheduler.
| def next | ||
| @target.public_send(@method_name) | ||
| end | ||
|
|
||
| # Tests whether this performer should be used in GoodJob's current state by |
There was a problem hiding this comment.
"State" is the generic. Practically, the state is a LISTEN/NOTIFY message that is passed down from the Notifier to the Scheduler, and the Scheduler then is able to ask the Performer "does this message relate to you?" and allow the Performer to say "no, don't bother waking up thread".
I took a few minutes to go through
Performerand attempt to document it after we finished talking this afternoon. Feel free to use or toss!Note: this is targeted at the
code_docsbranch for #111.