Kamaelia docs : Kamaelia.Util.Introspector

Detecting the topology of a running Kamaelia system

The Introspector component introspects the current local topology of a Kamaelia system - that is what components there are and how they are wired up.

It continually outputs any changes that occur to the topology.

Example Usage

Introspect and display whats going on inside the system:


Pipeline( Introspector(),

How does it work?

Once activated, this component introspects the current local topology of a Kamaelia system.

Local? This component examines its scheduler to find components and postmen. It then examines them to determine their inboxes and outboxes and the linkages between them. In effect, it determines the current topology of the system.

If this component is not active, then it will see no scheduler and will report nothing.

What is output is how the topology changes. Immediately after activation, the topology is assumed to be empty, so the first set of changes describes adding nodes and linkages to the topology to build up the current state of it.

Subsequent output just describes the changes - adding or deleting linkages and nodes as appropriate.

Nodes in the topology represent components and postboxes. A linkage between a component node and a postbox node expresses the fact that that postbox belongs to that component. A linkage between two postboxes represents a linkage in the Axon system, from one component to another.

This topology change data is output as string containing one or more lines. It is output through the "outbox" outbox. Each line may be one of the following:

  • "DEL ALL"
    • the first thing sent immediately after activation - to ensure that the receiver of this data understand that we are starting from nothing
  • "ADD NODE <id> <name> randompos component"
  • "ADD NODE <id> <name> randompos inbox"
  • "ADD NODE <id> <name> randompos outbox"
    • an instruction to add a node to the topology, representing a component, inbox or outbox. <id> is a unique identifier. <name> is a 'friendly' textual label for the node.
  • "DEL NODE <id>"
    • an instruction to delete a node, specified by its unique id
  • "ADD LINK <id1> <id2>"
    • an instruction to add a link between the two identified nodes. The link is deemed to be directional, from <id1> to <id2>
  • "DEL LINK <id1> <id2>"
    • an instruction to delete any link between the two identified nodes. Again, the directionality is from <id1> to <id2>.

the <id> and <name> fields may be encapsulated in double quote marks ("). This will definitely be so if they contain space characters.

If there are no topology changes then nothing is output.

This component ignores anything arriving at its "inbox" inbox.

If a shutdownMicroprocess message is received on the "control" inbox, it is sent on to the "signal" outbox and the component will terminate.


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, 05 Jun 2009 at 03:01:38 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)