Kamaelia docs : Axon.Postoffice.postoffice

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


class postoffice(object)

The post office looks after linkages between postboxes, thereby ensuring deliveries along linkages occur as intended.

There is one post office per component.

A Postoffice can have a debug name - this is to help differentiate between postoffices if problems arise.

Methods defined here

__init__(self[, debugname])

Constructor. If a debug name is assigned this will be stored as a debugname attribute.

__str__(self)

Provides a string representation of a postoffice, designed for debugging

islinkageregistered(self, linkage)

Returns a true value if the linkage given is registered with the postoffie.

link(self, source, sink, *optionalargs, **kwoptionalargs)

link((component,boxname),(component,boxname),**otherargs) -> new linkage

Creates a linkage from a named box on one component to a named box on another. See linkage class for meanings of other arguments. A linkage object is returned as a handle representing the linkage created.

The linkage is registered with this postoffice.

Throws Axon.AxonExceptions.BoxAlreadyLinkedToDestination if the source is already linked to somewhere else (Axon does not permit one-to-many).

unlink(self[, thecomponent][, thelinkage])

unlink([thecomponent][,thelinkage] -> destroys linkage(s).

Destroys the specified linkage, or linkages for the specified component.

Note, it only destroys linkages registered in this postoffice.

unlinkAll(self)

Destroys all linkages made with this postoffice.

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, 01 Feb 2010 at 04:00:28 UTC/GMT

 

Kamaelia is an open source project originated from and guided by BBC Research. For more information browse the site or get in contact.

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. (the site is powered by a wiki engine)

(C) Copyright 2008 Kamaelia Contributors, including the British Broadcasting Corporation, All Rights Reserved

This web site is powered by the same code created for the bicker manor project. For more details, contact Michael Sparks at BBC Research directly (cf contact)