Kamaelia docs : Axon.experimental._pprocess_support.likefile

Axon.experimental._pprocess_support.likefile

For examples and more explanations, see the module level docs.

class likefile(object)

An interface to the message queues from a wrapped component, which is activated on a backgrounded scheduler.

Methods defined here

init(self, child[, extraInboxes][, extraOutboxes][, wrapDefault])

empty(self[, boxname])

Return True if there is no data pending collection on boxname, False otherwise.

get(self[, boxname][, blocking][, timeout])

Performs a blocking read on the queue corresponding to the named outbox on the wrapped component. raises AttributeError if the likefile is not alive. Optional parameters blocking and timeout function the same way as in Queue objects, since that is what's used under the surface.

get_nowait(self[, boxname])

Equivalent to get(boxname, False)

put(self, msg[, boxname])

Places an object on a queue which will be directed to a named inbox on the wrapped component.

qsize(self[, boxname])

Returns the approximate number of pending data items awaiting collection from boxname. Will never be smaller than the actual amount.

shutdown(self)

Sends terminatory signals to the wrapped component, and shut down the componentWrapper. will warn if the shutdown took too long to confirm in action.

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, 27 Aug 2008 at 03:00:34 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.