Kamaelia docs : Kamaelia.Util.FirstOnly

Kamaelia.Util.FirstOnly

component FirstOnly

Pass on the first item only
- Example Usage
- Behaviour

Pass on the first item only

The first item sent to FirstOnly will be passed on. All other items are ignored.

Example Usage

Displaying the frame rate, just once, from video when it is decoded:

Pipeline( ...
          DiracDecoder(),
          FirstOnly(),
          SimpleDetupler("frame_rate"),
          ConsoleEchoer(),
        )

Behaviour

The first data item sent to FirstOnly's "inbox" inbox is immediately sent on out of its "outbox" outbox.

Any subsequent data sent to its "inbox" inbox is discarded.

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.

Kamaelia.Util.FirstOnly.FirstOnly

class FirstOnly(Axon.Component.component)

FirstOnly() -> new FirstOnly component.

Passes on the first item sent to it, and discards everything else.

Inboxes

control : Shutdown signalling
inbox : Data items

Outboxes

outbox : First data item received
signal : Shutdown signalling

Methods defined here

Warning!

You should be using the inbox/outbox interface, not these methods (except construction). This documentation is designed as a roadmap as to their functionalilty for maintainers and new component developers.

main(self)

Main loop

Feedback

Got a problem with the documentation? Something unclear that could be clearer? Want to help improve it? Constructive criticism is very welcome - especially if you can suggest a better rewording!

Please leave you feedback here in reply to the documentation thread in the Kamaelia blog.

-- Automatic documentation generator, 12 Oct 2008 at 03:01:28 UTC/GMT

(C) 2005 Kamaelia Contributors, including the British Broadcasting Corporation, All Rights Reserved,
This is an ongoing community based development site. As a result the contents of this page is the opinions of the contributors of the pages involved not the organisations involved. Specificially, this page may contain personal views which are not the views of the BBC.