AbstractLookup Class Reference

#include <AbstractLookup.h>

Inheritance diagram for AbstractLookup:

IterativeLookup RecursiveLookup

List of all members.


Detailed Description

This class declares an abstract iterative lookup.

Author:
Sebastian Mies

Public Member Functions

virtual ~AbstractLookup ()
 Virtual destructor.
virtual void lookup (const OverlayKey &key, int numSiblings=1, int hopCountMax=0, int retries=0, LookupListener *listener=NULL)=0
 Lookup siblings for a key.
virtual const NodeVectorgetResult () const =0
 Returns the result of the lookup.
virtual bool isValid () const =0
 Returns true, if the lookup was successful.
virtual void abortLookup ()=0
 Aborts a running lookup.
virtual uint getAccumulatedHops () const =0
 Returns the total number of hops for all lookup paths.

Constructor & Destructor Documentation

AbstractLookup::~AbstractLookup (  )  [virtual]

Virtual destructor.

00044 {}


Member Function Documentation

virtual void AbstractLookup::lookup ( const OverlayKey key,
int  numSiblings = 1,
int  hopCountMax = 0,
int  retries = 0,
LookupListener listener = NULL 
) [pure virtual]

Lookup siblings for a key.

Parameters:
key The key to lookup
numSiblings Number of siblings to lookup
hopCountMax Maximum hop count
retries Number of retries if lookup fails
listener Listener to inform, when the lookup is done

Implemented in IterativeLookup, and RecursiveLookup.

Referenced by Bamboo::doGlobalTuning(), Kademlia::handleBucketRefreshTimerExpired(), BaseOverlay::lookupRpc(), and BaseOverlay::sendToKey().

virtual const NodeVector& AbstractLookup::getResult (  )  const [pure virtual]

Returns the result of the lookup.

Returns:
The result node vector.

Implemented in IterativeLookup, and RecursiveLookup.

Referenced by SendToKeyListener::lookupFinished().

virtual bool AbstractLookup::isValid (  )  const [pure virtual]

Returns true, if the lookup was successful.

Returns:
true, if the lookup was successful.

Implemented in IterativeLookup, and RecursiveLookup.

Referenced by KademliaLookupListener::lookupFinished(), SendToKeyListener::lookupFinished(), and Bamboo::lookupFinished().

virtual void AbstractLookup::abortLookup (  )  [pure virtual]

Aborts a running lookup.

This method aborts a running lookup without calling the listener and delete the lookup object.

Implemented in IterativeLookup, and RecursiveLookup.

virtual uint AbstractLookup::getAccumulatedHops (  )  const [pure virtual]

Returns the total number of hops for all lookup paths.

Returns:
The accumulated number of hops.

Implemented in IterativeLookup, and RecursiveLookup.

Referenced by SendToKeyListener::lookupFinished().


The documentation for this class was generated from the following files:

Generated on Fri Sep 19 13:05:05 2008 for ITM OverSim by  doxygen 1.5.5