Feb 2024 - This site, and Kamaelia are being updated. There is significant work needed, and PRs are welcome.

Axon.Box.realsink

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


class realsink(list)

realsink(notify[,size]) -> new realsink object.

A working piece of storage for postboxes, that behaves a bit like a list.

Stores data given to it by calling append(), up to a limit after which Axon.AxonExceptions.noSpaceInBox exceptions are raised.

Calls the 'notify' callback when append() is called. Calls any callbacks in the self.wakeOnPop list when pop() is called.

Keyword arguments:

  • notify -- notify() is called whenever append() is called
  • size -- None, or the maximum number of items this storage can hold

Methods defined here

__init__(self, notify[, size])

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

append(self, data)

Appends item to the list, or raises Axon.AxonExceptions.noSpaceInBox exception if the number of items already meets the size limit.

Calls self.notify() callback

pop(self, index)

Returns an item from the list, or raises IndexError if there are none.

Calls all callbacks listed in self.wakeOnPop

setShowTransit(self, showtransit, tag)

Set showTransit to True to cause debugging output whenever a message is delivered to this storage. The tag can be anything you want to identify this occurrence.

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, 09 Dec 2009 at 04:00:25 UTC/GMT