net.tomp2p.peers

Class PeerMapConfiguration

java.lang.Object

net.tomp2p.peers.PeerMapConfiguration

public class PeerMapConfiguration
extends Object

The class that holds configuration settings for the PeerMap.

Author:

Thomas Bocek

Constructor Summary

Constructors

Constructor and Description
PeerMapConfiguration(Number160 self) Constructor with reasonable defaults.

Method Summary

Methods

Modifier and Type	Method and Description
PeerMapConfiguration	addMapPeerFilter(PeerMapFilter peerMapFilter)
int	exceptionTimeout()
PeerMapConfiguration	exceptionTimeout(int exceptionTimeout)
int	getOverflowBagSize(int bag)
int[]	getOverflowBagSizes()
PeerStatisticComparator	getPeerStatisticComparator()
int	getVerifiedBagSize(int bag)
int[]	getVerifiedBagSizes()
boolean	isPeerVerification()
Maintenance	maintenance()
PeerMapConfiguration	maintenance(Maintenance maintenance)
int	offlineCount()
PeerMapConfiguration	offlineCount(int offlineCount)
int	offlineTimeout()
PeerMapConfiguration	offlineTimeout(int offlineTimeout)
Collection<PeerMapFilter>	peerMapFilters()
PeerMapConfiguration	peerNoVerification()
PeerMapConfiguration	peerVerification(boolean reerVerification)
Number160	self()
PeerMapConfiguration	setBagSizesOverflow(int[] bagSizesOverflow) Allows to define custom bag sizes for the overflow peers
PeerMapConfiguration	setBagSizesVerified(int[] bagSizesVerified) Allows to define custom bag sizes for the verified peers
PeerMapConfiguration	setDoublingOverflowBagSizes() Sets the bag sizes for the overflow peers to (8, 8, 8, ...
PeerMapConfiguration	setDoublingVerifiedBagSizes() Sets the bag sizes for the verified peers to (8, 8, 8, ...
PeerMapConfiguration	setFixedOverflowBagSizes(int fixedOverflowBagSize) Sets the bag size for the overflow peers to a fixed number
PeerMapConfiguration	setFixedVerifiedBagSizes(int fixedVerifiedBagSize) Sets the bag size for the verified peers to a fixed number
PeerMapConfiguration	setPeerStatisticComparator(PeerStatisticComparator peerStatisticComparator)
int	shutdownTimeout()
PeerMapConfiguration	shutdownTimeout(int shutdownTimeout)

Methods inherited from class java.lang.Object

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

Constructor Detail

PeerMapConfiguration

public PeerMapConfiguration(Number160 self)

Constructor with reasonable defaults.

Parameters:

self - The peer ID of this peer

Method Detail

self

public Number160 self()

Returns:

The peer ID of this peer

getVerifiedBagSize

public int getVerifiedBagSize(int bag)

Parameters:

bag - The bit distance with 0 being the closest, 159 being the most distant

Returns:

The size of the bag of the given bit distance.

getVerifiedBagSizes

public int[] getVerifiedBagSizes()

Returns:

The array of sizes for the verified peer bags

setFixedVerifiedBagSizes

public PeerMapConfiguration setFixedVerifiedBagSizes(int fixedVerifiedBagSize)

Sets the bag size for the verified peers to a fixed number

Parameters:

fixedVerifiedBagSize - The size for each bag to be set

Returns:

This PeerMapConfiguration object

setDoublingVerifiedBagSizes

public PeerMapConfiguration setDoublingVerifiedBagSizes()

Sets the bag sizes for the verified peers to (8, 8, 8, ... 8, 16, 32, 64, 128)

Returns:

This PeerMapConfiguration object

setBagSizesVerified

public PeerMapConfiguration setBagSizesVerified(int[] bagSizesVerified)

Allows to define custom bag sizes for the verified peers

Parameters:

bagSizesVerified - Array of length Number160.BITS, specifying the size for each bag. bagSizesVerified[0] is the closest bag, bagSizesVerified[159] is the most distant bag.

Returns:

This PeerMapConfiguration object

getOverflowBagSize

public int getOverflowBagSize(int bag)

Parameters:

bag - The bit distance with 0 being the closest, 159 being the most distant

Returns:

The size of the bag of the given bit distance.

getOverflowBagSizes

public int[] getOverflowBagSizes()

Returns:

The array of sizes for the overflow peer bags

setFixedOverflowBagSizes

public PeerMapConfiguration setFixedOverflowBagSizes(int fixedOverflowBagSize)

Sets the bag size for the overflow peers to a fixed number

Parameters:

fixedOverflowBagSize - The size for each bag to be set

Returns:

This PeerMapConfiguration object

setDoublingOverflowBagSizes

public PeerMapConfiguration setDoublingOverflowBagSizes()

Sets the bag sizes for the overflow peers to (8, 8, 8, ... 8, 16, 32, 64, 128)

Returns:

This PeerMapConfiguration object

setBagSizesOverflow

public PeerMapConfiguration setBagSizesOverflow(int[] bagSizesOverflow)

Allows to define custom bag sizes for the overflow peers

Parameters:

bagSizesOverflow - Array of length Number160.BITS, specifying the size for each bag. bagSizesOverflow[0] is the closest bag, bagSizesOverflow[159] is the most distant bag.

Returns:

This PeerMapConfiguration object

offlineTimeout

public int offlineTimeout()

Returns:

The time a peer is considered offline in seconds. This is important, since we see that a peer is offline and an other peer reports this peer, we don't want to add it into our map. Thus, there is a map that keeps track of such peers. This also means that a fast reconnect is not possible and a peer has to wait until the timeout to rejoin

offlineTimeout

public PeerMapConfiguration offlineTimeout(int offlineTimeout)

Parameters:

offlineTimeout - The time a peer is considered offline in seconds. This is important, since we see that a peer is offline and an other peer reports this peer, we don't want to add it into our map. Thus, there is a map that keeps track of such peers. This also means that a fast reconnect is not possible and a peer has to wait until the timeout to rejoin

Returns:

this class

offlineCount

public int offlineCount()

Returns:

The number of times that the peer is not reachabel. After that the peer is considered offline

offlineCount

public PeerMapConfiguration offlineCount(int offlineCount)

Parameters:

offlineCount - The number of times that the peer is not reachabel. After that the peer is considered offline

Returns:

this class

peerMapFilters

public Collection<PeerMapFilter> peerMapFilters()

Returns:

This filter can be set to not accept certain peers

addMapPeerFilter

public PeerMapConfiguration addMapPeerFilter(PeerMapFilter peerMapFilter)

Parameters:

peerMapFilter - This filter can be set to not accept certain peers

Returns:

this class

maintenance

public Maintenance maintenance()

Returns:

The class that is responsible for maintenance

maintenance

public PeerMapConfiguration maintenance(Maintenance maintenance)

Parameters:

maintenance - The class that is responsible for maintenance

Returns:

this class

shutdownTimeout

public int shutdownTimeout()

Returns:

The time a peer is considered offline (shutdown) in seconds. This is important, since we see that a peer is offline and an other peer reports this peer, we don't want to add it into our map. Thus, there is a map that keeps track of such peers. This also means that a fast reconnect is not possible and a peer has to wait until the timeout to rejoin

shutdownTimeout

public PeerMapConfiguration shutdownTimeout(int shutdownTimeout)

Parameters:

shutdownTimeout - The time a peer is considered offline (shutdown) in seconds. This is important, since we see that a peer is offline and an other peer reports this peer, we don't want to add it into our map. Thus, there is a map that keeps track of such peers. This also means that a fast reconnect is not possible and a peer has to wait until the timeout to rejoin

Returns:

this class

exceptionTimeout

public int exceptionTimeout()

Returns:

The time a peer is considered offline (exception) in seconds. This is important, since we see that a peer is offline and an other peer reports this peer, we don't want to add it into our map. Thus, there is a map that keeps track of such peers. This also means that a fast reconnect is not possible and a peer has to wait until the timeout to rejoin

exceptionTimeout

public PeerMapConfiguration exceptionTimeout(int exceptionTimeout)

Parameters:

exceptionTimeout - The time a peer is considered offline (exception) in seconds. This is important, since we see that a peer is offline and an other peer reports this peer, we don't want to add it into our map. Thus, there is a map that keeps track of such peers. This also means that a fast reconnect is not possible and a peer has to wait until the timeout to rejoin

Returns:

this class

isPeerVerification

public boolean isPeerVerification()

peerNoVerification

public PeerMapConfiguration peerNoVerification()

peerVerification

public PeerMapConfiguration peerVerification(boolean reerVerification)

getPeerStatisticComparator

public PeerStatisticComparator getPeerStatisticComparator()

setPeerStatisticComparator

public PeerMapConfiguration setPeerStatisticComparator(PeerStatisticComparator peerStatisticComparator)