apps.liveness
Class PokeCapsule

java.lang.Object
  |
  +--bees.core.Packet
        |
        +--bees.core.ANEPPacket
              |
              +--bees.core.Capsule
                    |
                    +--apps.liveness.PokeCapsule

All Implemented Interfaces:

NodeCache.EventHandler

public final class PokeCapsule

extends Capsule

implements NodeCache.EventHandler

A PokeCapsule is used to probe a neighbor for liveness/responsiveness.

Constructor Summary

PokeCapsule()
Construct an empty PokeCapsule.

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.
void	removed(Node node, ProtocolSession ps) This is called when the element is manually removed from from the cache.
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

PokeCapsule

public PokeCapsule()

Construct an empty PokeCapsule.

Method Detail

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)

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)

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)

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()