Kamaelia.Chassis.Carousel.Carousel

class Carousel(Axon.Component.component)

Carousel(componentFactory,[make1stRequest]) -> new Carousel component

Create a Carousel component that makes child components one at a time (in carousel fashion) using the supplied factory function.

Keyword arguments: componentFactory -- function that takes a single argument and returns a component make1stRequest -- if True, Carousel will send an initial "NEXT" request. (default=False)

Inboxes

control :
_control : internal use: to receive 'producerFinished' or 'shutdownMicroprocess' from child
inbox : child's inbox
next : requests to replace child

Outboxes

outbox : child's outbox
signal :
_signal : internal use: for sending 'shutdownMicroprocess' to child
requestNext : for requesting new child component

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.

init(self, componentFactory, make1stRequest)

x.__init__(...) initializes x; see x.__class__.__doc__ for signature

handleFinishedChild(self)

Unplugs the child if a shutdownMicroprocess or producerFinished message is received from it. Also sends a "NEXT" request if one has not already been sent.

handleNewChild(self)

If data received on "next" inbox, removes any existing child and creates and wires in a new one.

Received data is passed as an argument to the factory function (supplied at initialisation) that creates the new child.

main(self)

Main loop

requestNext(self)

Sends 'next' out the 'requestNext' outbox

shutdown(self)

Returns True if a shutdownMicroprocess or producerFinished message was received.

unplugChildren(self)

Sends 'shutdownMicroprocess' to children and unwires and disowns them.

Feedback

Got a problem with the documentation? Something unclear, could be clearer? Want to help with improving? Constructive criticism, preferably in the form of suggested rewording is very welcome.

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

(C) 2006 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.