Example Usage

A way to create a component that writes data to a given filename, based on (filename,data) messages sent to its "next" inbox:

Carousel( lambda filename, data :
            Pipeline( OneShot(data),
                      SimpleFileWriter(filename),
                    ),
        )

A graphline that opens a TCP connection to myserver.com port 1500, and sends an a one off message:

Pipeline( OneShot("data to send to server"),
          TCPClient("myserver.com", 1500),
        ).run()

Shutting down a connection to myserver.com port 1500 as soon as a reply is received from the server:

Graphline( NET   = TCPClient("myserver.com", 1500),
           SPLIT = TwoWaySplitter(),
           STOP  = TriggeredOneShot(producerFinished()),
           linkages = {
               ("", "inbox" )      : ("NET", "inbox"),
               ("NET", "outbox")   : ("SPLIT", "inbox"),
               ("SPLIT", "outbox") : ("", "outbox"),

               ("SPLIT", "outbox2") : ("STOP", "inbox"),
               ("STOP", "outbox")   : ("NET", "control"),
               ("", "control")      : ("NET", "control"),
               ("NET", "signal")    : ("SPLIT", "control"),
               ("SPLIT", "signal")  : ("", "signal"),
               ("SPLIT", "signal2"),: ("STOP", "control"),
           },
         )

OneShot Behaviour

At initialisation, specify the message to be sent by OneShot.

As soon as OneShot is activated, the specified message is sent out of the "outbox" outbox. A producerFinished message is also sent out of the "signal" outbox. The component then immediately terminates.

TriggeredOneShot Behaviour

At initialisation, specify the message to be sent by TriggeredOneShot.

Send anything to the "inbox" inbox and TriggeredOneShot will immediately send the specified message out of the "outbox" outbox. A producerFinished message is also sent out of the "signal" outbox. The component then immediately terminates.

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 OneShot(Axon.Component.component)

OneShot(msg) -> new OneShot component.

Immediately sends the specified message and terminates.

Keyword arguments:

- msg  -- the message to send out

class TriggeredOneShot(Axon.Component.component)

OneShot(msg) -> new OneShot component.

Waits for anything to arrive at its "inbox" inbox, then immediately sends the specified message and terminates.

Keyword arguments:

- msg  -- the message to send out