apps.pathfinder
Class ConfigurationCapsule

java.lang.Object
  |
  +--bees.core.Packet
        |
        +--bees.core.ANEPPacket
              |
              +--bees.core.Capsule
                    |
                    +--apps.pathfinder.ConfigurationCapsule

All Implemented Interfaces:

NodeCache.EventHandler, ReencodableCapsule

public class ConfigurationCapsule

extends Capsule

implements ReencodableCapsule, NodeCache.EventHandler

Capsule used to tell neighbors about the path to the root of the tree. A capsule of this type will be added to the NodeCache and continuously transmitted if this node is the root of the tree or a root neighbor has been found.

Constructor Summary

ConfigurationCapsule()
Construct an empty ConfigurationCapsule.

Method Summary

IntegerPermission	collected(Node node, ProtocolSession ps) This is called when this element is up for collection, the return value specifies the new expiration time.
void	decode(Xdr xdr) Decode this Capsule's state from the given Xdr.
void	encode(Xdr xdr) Encode this Capsule's state into the given Xdr.
void	evaluate(Node node) Evaluate this capsule.
int	getHops()
void	reencode(Xdr xdr, NeighborImpl ni) Reencode this capsule for the given neighbor.
void	removed(Node node, ProtocolSession ps) This is called when the element is manually removed from from the cache.
void	setHops(int hops)
void	setRootNeighbor(Neighbor rootNeighbor)
java.lang.String	toString()

Methods inherited from class bees.core.Capsule

addToPool, checkPermission, clone, decodingException, equals, evaluate, fromCapsule, fromExternal, getCapsuleID, getFlowDesc, getSession, getSession, getSource, internalDecode, internalEncode, internalReset, reset, skipOptions, specializeCapsule

Methods inherited from class java.lang.Object

finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

ConfigurationCapsule

public ConfigurationCapsule()

Construct an empty ConfigurationCapsule.

Method Detail

setRootNeighbor

public void setRootNeighbor(Neighbor rootNeighbor)

Parameters:

rootNeighbor - Cached reference to the root Neighbor.

getHops

public int getHops()

Returns:

Hops to the root.

setHops

public void setHops(int hops)

Parameters:

hops - Hops to the root.

removed

public void removed(Node node,
                    ProtocolSession ps)

Description copied from interface: NodeCache.EventHandler

This is called when the element is manually removed from from the cache.

Specified by:

removed in interface NodeCache.EventHandler

See Also:

NodeCache.EventHandler.removed(Node, ProtocolSession)

collected

public IntegerPermission collected(Node node,
                                   ProtocolSession ps)

Description copied from interface: NodeCache.EventHandler

This is called when this element is up for collection, the return value specifies the new expiration time. Null is returned if the element should really be collected.

Specified by:

collected in interface NodeCache.EventHandler

See Also:

NodeCache.EventHandler.collected(Node, ProtocolSession)

encode

public void encode(Xdr xdr)

Description copied from class: Capsule

Encode this Capsule's state into the given Xdr.

Overrides:

encode in class Capsule

See Also:

Capsule.encode(Xdr)

reencode

public void reencode(Xdr xdr,
                     NeighborImpl ni)

Description copied from interface: ReencodableCapsule

Reencode this capsule for the given neighbor.

Specified by:

reencode in interface ReencodableCapsule

See Also:

ReencodableCapsule.reencode(Xdr, NeighborImpl)

decode

public void decode(Xdr xdr)

Description copied from class: Capsule

Decode this Capsule's state from the given Xdr.

Overrides:

decode in class Capsule

See Also:

Capsule.decode(Xdr)

evaluate

public void evaluate(Node node)

Description copied from class: Capsule

Evaluate this capsule. Basically, this is the function that performs any computation and forwarding.

Overrides:

evaluate in class Capsule

See Also:

Capsule.evaluate(Node)

toString

public java.lang.String toString()

Overrides:

toString in class Capsule

See Also:

Object.toString()