Bees v0.5.0 API

bees.core
Class DataRequestCapsule

java.lang.Object
  |
  +--bees.core.Packet
        |
        +--bees.core.ANEPPacket
              |
              +--bees.core.Capsule
                    |
                    +--bees.core.DataRequestCapsule
Direct Known Subclasses:
ReliableDataRequestCapsule

public abstract class DataRequestCapsule
extends Capsule

A DataRequestCapsule is base class used for capsules that wish to request some "large" data from a peer node.


Constructor Summary
protected DataRequestCapsule()
          Construct an empty DataRequestCapsule.
protected DataRequestCapsule(DataAggregator da)
          Construct and initialize DataRequestCapsule from the given DataAggregator.
 
Method Summary
 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.
protected  int getCurrentWindow()
           
protected  long getWindowChunks()
           
 java.lang.String toString()
           
 
Methods inherited from class bees.core.Capsule
addToPool, checkPermission, clone, decodingException, equals, evaluate, 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

DataRequestCapsule

protected DataRequestCapsule()
Construct an empty DataRequestCapsule.

DataRequestCapsule

protected DataRequestCapsule(DataAggregator da)
Construct and initialize DataRequestCapsule from the given DataAggregator.
Parameters:
da - The DataAggregator object that should be used in determining the needed window and chunk set. If NULL, the current window is assumed to be zero and the needed chunks set is all one's.
Method Detail

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)

getCurrentWindow

protected int getCurrentWindow()
Returns:
The DataAggregator window that is being requested.

getWindowChunks

protected long getWindowChunks()
Returns:
The set of DataAggregator chunks that is being requested.

toString

public java.lang.String toString()
Overrides:
toString in class Capsule
See Also:
Object.toString()

Bees v0.5.0 API

This documentation is Copyright (C) 2002 The University of Utah. All Rights Reserved. See the individual source files for distribution terms.
Documentation, software, and mailing lists for Bees v0.5.0 can be found at the Janos Project: http://www.cs.utah.edu/flux/janos/