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

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

__init__(self, *args, **argd)

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