net.tomp2p.futures

Class FutureDHT

java.lang.Object

net.tomp2p.futures.BaseFutureImpl

net.tomp2p.futures.FutureDHT

All Implemented Interfaces:

BaseFuture, Cancellable, FutureCleanup

public class FutureDHT
extends BaseFutureImpl
implements FutureCleanup

The future object for the get() and put() operations including routing.

Author:

Thomas Bocek

Nested Class Summary

Nested classes/interfaces inherited from interface net.tomp2p.futures.BaseFuture

BaseFuture.FutureType

Field Summary

Fields inherited from class net.tomp2p.futures.BaseFutureImpl

completed, lock, reason, type

Constructor Summary

Constructors

Constructor and Description
FutureDHT() Deprecated.
FutureDHT(int min, EvaluatingSchemeDHT evaluationScheme, FutureCreate<FutureDHT> futureCreate, FutureRouting futureRouting) Creates a new DHT future object that keeps track of the status of the DHT operations.

Method Summary

Methods

Modifier and Type	Method and Description
void	addCleanup(Cancellable cancellable) Call to add cleanup classes for the future e.g.
void	addRequests(FutureResponse futureResponse) Adds all requests that have been created for the DHT operations.
void	created(FutureDHT futureDHT) Deprecated.
Object	getChannelBuffer() Return the data from send_direct (Netty buffer) after evaluation.
Map<Number160,Data>	getData() Return the data from get() after evaluation.
FutureCreate<FutureDHT>	getFutureCreate() Returns the future object that keeps information about future object, based on this object
FutureForkJoin<FutureResponse>	getFutureRequests() Returns back those futures that are still running.
FutureRouting	getFutureRouting() Returns the future object that was used for the routing.
Collection<Number160>	getKeys() Returns the keys that have been stored or removed after evaluation.
Object	getObject() Return the data from send_direct (Object) after evaluation.
Map<PeerAddress,Map<Number160,Data>>	getRawData() Returns the raw data from the get operation
Map<PeerAddress,org.jboss.netty.buffer.ChannelBuffer>	getRawDirectData1() Return raw data from send_dircet (Netty buffer).
Map<PeerAddress,Object>	getRawDirectData2() Return raw data from send_dircet (Object).
Map<PeerAddress,Collection<Number160>>	getRawKeys() Returns the raw keys from the storage or removal operation
boolean	isMinReached() Checks if the minimum of expected results have been reached.
void	repeated(FutureDHT futureDHT) Called for futures created based on this future.
void	setDirectData1(Map<PeerAddress,org.jboss.netty.buffer.ChannelBuffer> rawChannels) Finish the future and set the keys and data that have send directly using the Netty buffer.
void	setDirectData2(Map<PeerAddress,Object> rawObjects) Finish the future and set the keys and data that have send directly using an object.
void	setReceivedData(Map<PeerAddress,Map<Number160,Data>> rawData) Finish the future and set the keys and data that have been received.
void	setRemovedKeys(Map<PeerAddress,Collection<Number160>> rawKeys) Finish the future and set the keys that have been removed.
void	setStoredKeys(Map<PeerAddress,Collection<Number160>> rawKeys, boolean ifAbsent) Finish the future and set the keys that have been stored.
void	shutdown()

Methods inherited from class net.tomp2p.futures.BaseFutureImpl

addCancellation, addListener, await, await, awaitUninterruptibly, awaitUninterruptibly, cancel, getFailedReason, getType, isCompleted, isFailed, isSuccess, notifyListerenrs, removeCancellation, removeListener, setCompletedAndNotify, setFailed

Methods inherited from class java.lang.Object

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

Constructor Detail

FutureDHT

@Deprecated
public FutureDHT()

Deprecated.

FutureDHT

public FutureDHT(int min,
         EvaluatingSchemeDHT evaluationScheme,
         FutureCreate<FutureDHT> futureCreate,
         FutureRouting futureRouting)

Creates a new DHT future object that keeps track of the status of the DHT operations.

Parameters:

min - The minimum of expected results

evaluationScheme - The scheme to evaluate results from multiple peers

futureCreate - The object to keep track of the futures created based on this future

futureRouting - The futures from the routing process.

Method Detail

created

@Deprecated
public void created(FutureDHT futureDHT)

Deprecated.

setRemovedKeys

public void setRemovedKeys(Map<PeerAddress,Collection<Number160>> rawKeys)

Finish the future and set the keys that have been removed.

Parameters:

rawKeys - The removed keys with information from which peer it has been removed

setStoredKeys

public void setStoredKeys(Map<PeerAddress,Collection<Number160>> rawKeys,
                 boolean ifAbsent)

Finish the future and set the keys that have been stored. The flag isAbsent influences minreached.

Parameters:

rawKeys - The keys that have been stored with information on which peer it has been stored

ifAbsent - Flag if the user requested putIfAbsent

setReceivedData

public void setReceivedData(Map<PeerAddress,Map<Number160,Data>> rawData)

Finish the future and set the keys and data that have been received.

Parameters:

rawData - The keys and data that have been received with information from which peer it has been received.

setDirectData1

public void setDirectData1(Map<PeerAddress,org.jboss.netty.buffer.ChannelBuffer> rawChannels)

Finish the future and set the keys and data that have send directly using the Netty buffer.

Parameters:

rawChannels - The raw data that have been sent directly with information on which peer it has been sent

setDirectData2

public void setDirectData2(Map<PeerAddress,Object> rawObjects)

Finish the future and set the keys and data that have send directly using an object.

Parameters:

rawObjects - The objects that have been sent directly with information on which peer it has been sent

getRawKeys

public Map<PeerAddress,Collection<Number160>> getRawKeys()

Returns the raw keys from the storage or removal operation

Returns:

The raw keys and the information which peer has been contacted

getRawData

public Map<PeerAddress,Map<Number160,Data>> getRawData()

Returns the raw data from the get operation

Returns:

The raw data and the information which peer has been contacted

getRawDirectData1

public Map<PeerAddress,org.jboss.netty.buffer.ChannelBuffer> getRawDirectData1()

Return raw data from send_dircet (Netty buffer).

Returns:

The raw data from send_dircet and the information which peer has been contacted

getRawDirectData2

public Map<PeerAddress,Object> getRawDirectData2()

Return raw data from send_dircet (Object).

Returns:

The raw data from send_dircet and the information which peer has been contacted

isMinReached

public boolean isMinReached()

Checks if the minimum of expected results have been reached. This flag is also used for determining the success or failure of this future for put and send_direct.

Returns:

True, if expected minimum results have been reached.

getKeys

public Collection<Number160> getKeys()

Returns the keys that have been stored or removed after evaluation. The evaluation gets rid of the PeerAddress information, by either a majority vote or cumulation.

Returns:

The keys that have been stored or removed

getData

public Map<Number160,Data> getData()

Return the data from get() after evaluation. The evaluation gets rid of the PeerAddress information, by either a majority vote or cumulation.

Returns:

The data that have been received.

getObject

public Object getObject()

Return the data from send_direct (Object) after evaluation. The evaluation gets rid of the PeerAddress information, by either a majority vote or cumulation.

Returns:

The data that have been received.

getChannelBuffer

public Object getChannelBuffer()

Return the data from send_direct (Netty buffer) after evaluation. The evaluation gets rid of the PeerAddress information, by either a majority vote or cumulation.

Returns:

The data that have been received.

getFutureCreate

public FutureCreate<FutureDHT> getFutureCreate()

Returns the future object that keeps information about future object, based on this object

Returns:

FutureCreate object.

getFutureRouting

public FutureRouting getFutureRouting()

Returns the future object that was used for the routing. Before the FutureDHT is used, FutureRouting has to be completed successfully.

Returns:

The future object during the previous routing, or null if routing failed completely.

getFutureRequests

public FutureForkJoin<FutureResponse> getFutureRequests()

Returns back those futures that are still running. If 6 storage futures are started at the same time and 5 of them finish, and we specified that we are fine if 5 finishes, then futureDHT returns success. However, the future that may still be running is the one that stores the content to the closest peer. For testing this is not acceptable, thus after waiting for futureDHT, one needs to wait for the running futures as well.

Returns:

A future that finishes if all running futures are finished.

addRequests

public void addRequests(FutureResponse futureResponse)

Adds all requests that have been created for the DHT operations. Those were created after the routing process.

Parameters:

futureResponse - The futurRepsonse that has been created

repeated

public void repeated(FutureDHT futureDHT)

Called for futures created based on this future. This is used for scheduled futures.

Parameters:

futureDHT - The newly created future

addCleanup

public void addCleanup(Cancellable cancellable)

Description copied from interface: FutureCleanup

Call to add cleanup classes for the future e.g. to stop creating more scheduled futures.

Specified by:

addCleanup in interface FutureCleanup

Parameters:

cancellable - The cleanup classes

shutdown

public void shutdown()