Kamaelia docs : Axon.AdaptiveCommsComponent._AdaptiveCommsable

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


class _AdaptiveCommsable(object)

Mixin for making a component 'adaptable' so that it can create and destroy extra inboxes and outboxes at runtime.

Methods defined here

_newInboxName(self[, name])

Allocates a new inbox with name based on the name provided.

If this name is available it will be returned unchanged. Otherwise the name will be returned with a number appended

_newOutboxName(self[, name])

Allocates a new outbox name based on the name provided.

If this name is available it will be returned unchanged. Otherwise the name will be returned with a number appended

addInbox(self, *args)

Allocates a new inbox with name based on the name provided. If a box with the suggested name already exists then a variant is used instead.

Returns the name of the inbox added.

addOutbox(self, *args)

Allocates a new outbox with name based on the name provided. If a box with the suggested name already exists then a variant is used instead.

Returns the name of the outbox added.

ceaseTrackingResource(self, resource)

Stop tracking a resource and release references to it

deleteInbox(self, name)

Deletes the named inbox. Any messages in it are lost.

Try to ensure any linkages to involving this outbox have been destroyed - not just ones created by this component, but by others too! Behaviour is undefined if this is not the case, and should be avoided.

deleteOutbox(self, name)

Deletes the named outbox.

Try to ensure any linkages to involving this outbox have been destroyed - not just ones created by this component, but by others too! Behaviour is undefined if this is not the case, and should be avoided.

retrieveTrackedResource(self, inbox)

Retrieve the resource that has been associated with the named inbox.

retrieveTrackedResourceInformation(self, resource)

Retrieve a tuple (inboxes, outboxes, otherdata) that has been stored as the specified resource.

trackResource(self, resource, inbox)

Associate the specified resource with the named inbox.

trackResourceInformation(self, resource, inboxes, outboxes, information)

Store a list of inboxes, outboxes and other information as the specified resource.

The inboxes and outboxes specified must exist.

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)