net.tomp2p.futures

Class FutureDHT<K extends BaseFuture>

java.lang.Object

net.tomp2p.futures.BaseFutureImpl<K>

net.tomp2p.futures.FutureDHT<K>

All Implemented Interfaces:

BaseFuture, Cancel

Direct Known Subclasses:

FutureDigest, FutureGet, FuturePut, FutureRemove, FutureSend, FutureShutdown

public abstract class FutureDHT<K extends BaseFuture>
extends BaseFutureImpl<K>

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(DHTBuilder<?> builder)

Method Summary

Methods

Modifier and Type	Method and Description
void	addFutureDHTReleaseListener(ChannelCreator channelCreator) Adds a listener to the response future and releases all aquired channels in channel creator.
K	addRequests(FutureResponse futureResponse) Adds all requests that have been created for the DHT operations.
DHTBuilder<?>	builder()
FutureForkJoin<FutureResponse>	getFutureRequests() Returns back those futures that are still running.
FutureRouting	getFutureRouting() Returns the future object that was used for the routing.
void	setFutureRouting(FutureRouting futureRouting) Sets the future object that was used for the routing.

Methods inherited from class net.tomp2p.futures.BaseFutureImpl

addCancel, addListener, addListener, await, await, awaitListeners, awaitListenersUninterruptibly, awaitUninterruptibly, awaitUninterruptibly, cancel, getFailedReason, getType, isCompleted, isFailed, isSuccess, 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

FutureDHT

public FutureDHT(DHTBuilder<?> builder)

Method Detail

builder

public DHTBuilder<?> builder()

Returns:

A reference to the builder that contains the data we were looking for

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 K 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

addFutureDHTReleaseListener

public void addFutureDHTReleaseListener(ChannelCreator channelCreator)

Adds a listener to the response future and releases all aquired channels in channel creator.

Parameters:

channelCreator - The channel creator that will be shutdown and all connections will be closed

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.

setFutureRouting

public void setFutureRouting(FutureRouting futureRouting)

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

Parameters:

futureRouting - The future object to set