bees.core
Class CapsuleReceiver

java.lang.Object
  |
  +--bees.core.CapsuleReceiver

public class CapsuleReceiver

extends java.lang.Object

Class used to receive Capsules from the NeighborImpl and dispatch to the protocol.

Method Summary

edu.utah.janos.nodeos.DemultiplexKey	createDemultiplexKey() Create a DemultiplexKey that matches the enclosed Capsule type.
void	evaluate(Capsule cap) Evaluate the capsule.
int	getBufferCount()
TypeID	getCapsuleID()
java.lang.String	getCapsuleName()
Neighbor	getNeighbor()
TypeID	getSpecializedCapsuleID()
int	getThreadCount()
Capsule	receive(edu.utah.janos.nodeos.BufferHandle bh, int offset) Receive a Capsule from the NeighborImpl.
java.lang.String	toString()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Method Detail

getNeighbor

public Neighbor getNeighbor()

Returns:

The domain local object representing the Neighbor.

getCapsuleName

public java.lang.String getCapsuleName()

Returns:

The class name of the Capsule type received by this object.

getCapsuleID

public TypeID getCapsuleID()

Returns:

The unique identifier for this Capsule type.

getSpecializedCapsuleID

public TypeID getSpecializedCapsuleID()

Returns:

The unique specialized identifier for this companion Capsule type.

getThreadCount

public int getThreadCount()

Returns:

The maximum thread count for Capsules.

getBufferCount

public int getBufferCount()

Returns:

The maximum buffer count for Capsules.

createDemultiplexKey

public edu.utah.janos.nodeos.DemultiplexKey createDemultiplexKey()

Create a DemultiplexKey that matches the enclosed Capsule type.

Returns:

The manufactured DemultiplexKey.

receive

public Capsule receive(edu.utah.janos.nodeos.BufferHandle bh,
                       int offset)

Receive a Capsule from the NeighborImpl.

Parameters:

bh - A BufferHandle holding an encoded Capsule.

offset - The offset into "bh" where the payload begins.

Returns:

The Capsule decoded capsule.

evaluate

public void evaluate(Capsule cap)

Evaluate the capsule.

Parameters:

cap - The capsule to evaluate.

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

See Also:

Object.toString()