Example Usage

Wait for two tasks to finish, before propagating the shutdown message:

Graphline( A    = TaskA(),
           B    = TaskB(),
           SYNC = Sync(2),
           linkages = {
               ("A", "signal") : ("SYNC", "inbox"),
               ("B", "signal") : ("SYNC", "inbox"),

               ("SYNC", "outbox") : ("SYNC", "control"),
               ("SYNC", "signal") : ("", "signal"),
           }

The slightly strange wiring is to make sure the Sync component is also shut down. The shutdown message is used to shutdown Sync itself. The shutdown message it emits is then the one that propogates out of the graphline.

Behaviour

At initialisation, specify the number of items Sync should wait for.

Once that number of items have arrived at Sync's "inbox" inbox; the first that arrived is sent on out of its "outbox" outbox. This process is repeated until Sync is shut down.

If more han the specified number of items arrive in one go; the excess items roll over to the next cycle. They are not ignored or lost.

If a producerFinished or shutdownMicroprocess message is received on the "control" inbox. It is immediately sent on out of the "signal" outbox and the component then immediately terminates.

class Sync(Axon.Component.component)

Sync([n]) -> new Sync component.

After ever 'n' items received, the first in each batch received is sent on.

Keyword arguments:

- n  -- The number of items to expect (default=2)