net.tomp2p.futures

Class FutureRemove

java.lang.Object

net.tomp2p.futures.BaseFutureImpl<K>

net.tomp2p.futures.FutureDHT<FutureRemove>

net.tomp2p.futures.FutureRemove

All Implemented Interfaces:

BaseFuture, Cancel

public class FutureRemove
extends FutureDHT<FutureRemove>

The future object for 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
FutureRemove(DHTBuilder<?> builder)
FutureRemove(DHTBuilder<?> builder, int dataSize) Default constructor.
FutureRemove(DHTBuilder<?> builder, int min, EvaluatingSchemeDHT evaluationScheme, int dataSize) 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
double	getAvgStoredKeys()
Map<Number640,Data>	getDataMap() Return the data from get() after evaluation.
Collection<Number640>	getEvalKeys() Returns the keys that have been stored or removed after evaluation.
Map<PeerAddress,Map<Number640,Data>>	getRawData() Returns the raw data from the get operation.
Map<PeerAddress,Map<Number640,Byte>>	getRawKeys() Returns the raw keys from the storage or removal operation.
Map<Number640,Integer>	getResult() Returns the keys that have been stored or removed after evaluation.
boolean	isMinReached() Checks if the minimum of expected results have been reached.
boolean	isSuccess() Returns the opposite of isFailed (returns !isFailed).
void	setReceivedData(Map<PeerAddress,Map<Number640,Data>> rawData) Finish the future and set the keys and data that have been received.
void	setStoredKeys(Map<PeerAddress,Map<Number640,Byte>> rawKeys640) Finish the future and set the keys that have been stored.

Methods inherited from class net.tomp2p.futures.FutureDHT

addFutureDHTReleaseListener, addRequests, builder, getFutureRequests, getFutureRouting, setFutureRouting

Methods inherited from class net.tomp2p.futures.BaseFutureImpl

addCancel, addListener, addListener, await, await, awaitListeners, awaitListenersUninterruptibly, awaitUninterruptibly, awaitUninterruptibly, cancel, getFailedReason, getType, isCompleted, isFailed, notifyListeners, removeCancel, removeListener, self, setCompletedAndNotify, setFailed, setFailed, setFailed, setFailed, setFailed

Methods inherited from class java.lang.Object

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

Constructor Detail

FutureRemove

public FutureRemove(DHTBuilder<?> builder)

FutureRemove

public FutureRemove(DHTBuilder<?> builder,
            int dataSize)

Default constructor.

FutureRemove

public FutureRemove(DHTBuilder<?> builder,
            int min,
            EvaluatingSchemeDHT evaluationScheme,
            int dataSize)

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

Method Detail

setStoredKeys

public void setStoredKeys(Map<PeerAddress,Map<Number640,Byte>> rawKeys640)

Finish the future and set the keys that have been stored. Success or failure is determined if the communication was successful. This means that we need to further check if the other peers have denied the storage (e.g., due to no storage space, no security permissions). Further evaluation can be retrieved with getAvgStoredKeys() or if the evaluation should be done by the user, use getRawKeys().

Parameters:

domainKey - The domain key

locationKey - The location key

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

rawKeys480 - The keys with locationKey and domainKey Flag if the user requested putIfAbsent

getAvgStoredKeys

public double getAvgStoredKeys()

Returns:

The average keys received from the DHT. Only evaluates rawKeys.

setReceivedData

public void setReceivedData(Map<PeerAddress,Map<Number640,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.

getRawKeys

public Map<PeerAddress,Map<Number640,Byte>> getRawKeys()

Returns the raw keys from the storage or removal operation.

Returns:

The raw keys 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.

getEvalKeys

public Collection<Number640> getEvalKeys()

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. Use getEvalKeys() instead of this method.

Returns:

The keys that have been stored or removed

getRawData

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

Returns the raw data from the get operation.

Returns:

The raw data and the information which peer has been contacted

getDataMap

public Map<Number640,Data> getDataMap()

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

Returns:

The evaluated data that have been received.

getResult

public Map<Number640,Integer> getResult()

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. Use FuturePut#getEvalKeys() instead of this method.

Returns:

The keys that have been stored or removed

isSuccess

public boolean isSuccess()

Description copied from interface: BaseFuture

Returns the opposite of isFailed (returns !isFailed). Use this method if you are an optimist ;) otherwise use isFailed

Specified by:

isSuccess in interface BaseFuture

Overrides:

isSuccess in class BaseFutureImpl<FutureRemove>

Returns:

true if operation succeeded, false if there was no reply