net.tomp2p.p2p.builder

Class ShutdownBuilder

java.lang.Object

net.tomp2p.connection.DefaultConnectionConfiguration

net.tomp2p.p2p.builder.DHTBuilder<ShutdownBuilder>

net.tomp2p.p2p.builder.ShutdownBuilder

All Implemented Interfaces:

ConnectionConfiguration, BasicBuilder<ShutdownBuilder>, Builder, SignatureBuilder<ShutdownBuilder>

public class ShutdownBuilder
extends DHTBuilder<ShutdownBuilder>

Set the configuration options for the shutdown command. The shutdown does first a rounting, searches for its close peers and then send a quit message so that the other peers knows that this peer is offline.

Author:

Thomas Bocek

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	ShutdownBuilder.Filter The filter can be used to add or remove peers to notify for a shutdown.

Field Summary

Fields inherited from class net.tomp2p.p2p.builder.DHTBuilder

domainKey, futureChannelCreator, locationKey, peer, requestP2PConfiguration, routingConfiguration, versionKey

Constructor Summary

Constructors

Constructor and Description
ShutdownBuilder(Peer peer) Constructor.

Method Summary

Methods

Modifier and Type	Method and Description
ShutdownBuilder.Filter	filter()
NavigableSet<PeerAddress>	filter(NavigableSet<PeerAddress> closePeers) Adds the possibility to filter the peers, to add more or remove peers for the shutdown process.
ShutdownBuilder	filter(ShutdownBuilder.Filter filter)
ShutdownBuilder	setDomainKey(Number160 domainKey)
FutureShutdown	start() Start the shutdown.

Methods inherited from class net.tomp2p.p2p.builder.DHTBuilder

createBuilder, getDomainKey, getFutureChannelCreator, getLocationKey, getRequestP2PConfiguration, getRoutingConfiguration, getVersionKey, isProtectDomain, isSign, isStreaming, keyPair, keyPair, preBuild, self, setFutureChannelCreator, setProtectDomain, setProtectDomain, setRequestP2PConfiguration, setRoutingConfiguration, setSign, setStreaming, setStreaming, setVersionKey, sign

Methods inherited from class net.tomp2p.connection.DefaultConnectionConfiguration

connectionTimeoutTCPMillis, connectionTimeoutTCPMillis, forceUDP, idleTCPSeconds, idleTCPSeconds, idleUDPSeconds, idleUDPSeconds, isForceTCP, isForceUDP, setForceTCP, setForceTCP, setForceUDP

Methods inherited from class java.lang.Object

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

Methods inherited from interface net.tomp2p.connection.ConnectionConfiguration

connectionTimeoutTCPMillis, idleTCPSeconds, idleUDPSeconds, isForceTCP, isForceUDP

Constructor Detail

ShutdownBuilder

public ShutdownBuilder(Peer peer)

Constructor.

Parameters:

peer - The peer that runs the routing and quit messages

Method Detail

filter

public ShutdownBuilder filter(ShutdownBuilder.Filter filter)

filter

public ShutdownBuilder.Filter filter()

start

public FutureShutdown start()

Start the shutdown. This method returns immediately with a future object. The future object can be used to block or add a listener.

Returns:

The future object

setDomainKey

public ShutdownBuilder setDomainKey(Number160 domainKey)

Specified by:

setDomainKey in interface BasicBuilder<ShutdownBuilder>

Overrides:

setDomainKey in class DHTBuilder<ShutdownBuilder>

filter

public NavigableSet<PeerAddress> filter(NavigableSet<PeerAddress> closePeers)

Adds the possibility to filter the peers, to add more or remove peers for the shutdown process.

Parameters:

closePeers - The close peers that were found in the peer map.

Returns:

The set modified by the user, may be the same set or a new one