PeerBuilder (TomP2P Core 5.0-Beta1 API)

java.lang.Object
- net.tomp2p.p2p.PeerBuilder

```
public class PeerBuilder
extends Object
```
The maker / builder of a Peer class.

Author:

Thomas Bocek

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static class`	`PeerBuilder.DefaultPipelineFilter` The default filter is no filter, just return the same array.
`static class`	`PeerBuilder.EventExecutorGroupFilter` A pipeline filter that executes handlers in a thread.

Field Summary

Fields
Modifier and Type Field and Description

static PublicKey EMPTY_PUBLIC_KEY

Fields
Modifier and Type	Field and Description
`static PublicKey`	`EMPTY_PUBLIC_KEY`

Constructor Summary

Constructors
Constructor and Description
`PeerBuilder(KeyPair keyPair)` Creates a PeerBuilder with the key pair and generates out of this key pair the peer ID.
`PeerBuilder(Number160 peerId)` Creates a PeerBuilder with the peer ID and an empty key pair.

Method Summary

Methods
Modifier and Type	Method and Description
`PeerBuilder`	`behindFirewall()` Set peer to be behind a firewall and cannot be accessed directly.
`PeerBuilder`	`behindFirewall(boolean behindFirewall)`
`Bindings`	`bindings()`
`PeerBuilder`	`bindings(Bindings bindings)`
`BloomfilterFactory`	`bloomfilterFactory()`
`PeerBuilder`	`bloomfilterFactory(BloomfilterFactory bloomfilterFactory)`
`BroadcastHandler`	`broadcastHandler()`
`PeerBuilder`	`broadcastHandler(BroadcastHandler broadcastHandler)`
`ChannelClientConfiguration`	`channelClientConfiguration()`
`PeerBuilder`	`channelClientConfiguration(ChannelClientConfiguration channelClientConfiguration)`
`ChannelServerConfiguration`	`channelServerConfiguration()`
`PeerBuilder`	`channelServerConfiguration(ChannelServerConfiguration channelServerConfiguration)`
`static ChannelClientConfiguration`	`createDefaultChannelClientConfiguration()`
`static ChannelServerConfiguration`	`createDefaultChannelServerConfiguration()`
`PeerBuilder`	`enableAnnounceRPC(boolean enableAnnounceRPC)`
`PeerBuilder`	`enableBroadcast(boolean enableBroadcast)`
`PeerBuilder`	`enableDirectDataRPC(boolean enableDirectDataRPC)`
`PeerBuilder`	`enableHandShakeRPC(boolean enableHandShakeRPC)`
`PeerBuilder`	`enableMaintenance(boolean enableMaintenance)`
`PeerBuilder`	`enableNeighborRPC(boolean enableNeighborRPC)`
`PeerBuilder`	`enableQuitRPC(boolean enableQuitRPC)`
`PeerBuilder`	`enableRouting(boolean enableRouting)`
`PeerBuilder`	`init(PeerInit... inits)`
`PeerBuilder`	`init(PeerInit init)`
`boolean`	`isBehindFirewall()`
`boolean`	`isEnableAnnounceRPC()`
`boolean`	`isEnableBroadcast()`
`boolean`	`isEnableDirectDataRPC()`
`boolean`	`isEnableHandShakeRPC()`
`boolean`	`isEnableMaintenance()`
`boolean`	`isEnableNeighborRPC()`
`boolean`	`isEnableQuitRPC()`
`boolean`	`isEnableRouting()`
`KeyPair`	`keyPair()`
`PeerBuilder`	`keyPair(KeyPair keyPair)`
`MaintenanceTask`	`maintenanceTask()`
`PeerBuilder`	`maintenanceTask(MaintenanceTask maintenanceTask)`
`Peer`	`masterPeer()`
`PeerBuilder`	`masterPeer(Peer masterPeer)`
`int`	`p2pId()`
`PeerBuilder`	`p2pId(int p2pID)`
`Number160`	`peerId()`
`PeerMap`	`peerMap()`
`PeerBuilder`	`peerMap(PeerMap peerMap)`
`PeerBuilder`	`ports(int port)`
`PeerBuilder`	`portsExternal(int port)`
`Random`	`random()`
`PeerBuilder`	`random(Random random)`
`SendBehavior`	`sendBehavior()`
`PeerBuilder`	`sendBehavior(SendBehavior sendBehavior)` Set the send behavior.
`Peer`	`start()` Create a peer and start to listen for incoming connections.
`int`	`tcpPort()`
`PeerBuilder`	`tcpPort(int tcpPort)`
`int`	`tcpPortForwarding()`
`PeerBuilder`	`tcpPortForwarding(int tcpPortForwarding)`
`ScheduledExecutorService`	`timer()`
`PeerBuilder`	`timer(ScheduledExecutorService scheduledExecutorService)`
`int`	`udpPort()`
`PeerBuilder`	`udpPort(int udpPort)`
`int`	`udpPortForwarding()`
`PeerBuilder`	`udpPortForwarding(int udpPortForwarding)`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

EMPTY_PUBLIC_KEY

public static final PublicKey EMPTY_PUBLIC_KEY

Constructor Detail
- PeerBuilder
```
public PeerBuilder(Number160 peerId)
```
  Creates a PeerBuilder with the peer ID and an empty key pair.
  
  Parameters:
  peerId - The peer Id
- PeerBuilder
```
public PeerBuilder(KeyPair keyPair)
```
  Creates a PeerBuilder with the key pair and generates out of this key pair the peer ID.
  
  Parameters:
  keyPair - The public private key

Method Detail

start
```
public Peer start()
           throws IOException
```
Create a peer and start to listen for incoming connections.

Returns:
The peer that can operate in the P2P network.

Throws:

IOException - .

createDefaultChannelServerConfiguration

public static ChannelServerConfiguration createDefaultChannelServerConfiguration()

createDefaultChannelClientConfiguration

public static ChannelClientConfiguration createDefaultChannelClientConfiguration()

peerId
```
public Number160 peerId()
```

keyPair
```
public KeyPair keyPair()
```

keyPair

public PeerBuilder keyPair(KeyPair keyPair)

p2pId
```
public int p2pId()
```

p2pId
```
public PeerBuilder p2pId(int p2pID)
```

tcpPortForwarding
```
public int tcpPortForwarding()
```

tcpPortForwarding

public PeerBuilder tcpPortForwarding(int tcpPortForwarding)

tcpPort
```
public int tcpPort()
```

tcpPort

public PeerBuilder tcpPort(int tcpPort)

udpPort
```
public int udpPort()
```

udpPort

public PeerBuilder udpPort(int udpPort)

udpPortForwarding
```
public int udpPortForwarding()
```

udpPortForwarding

public PeerBuilder udpPortForwarding(int udpPortForwarding)

ports
```
public PeerBuilder ports(int port)
```

portsExternal

public PeerBuilder portsExternal(int port)

bindings

public PeerBuilder bindings(Bindings bindings)

bindings
```
public Bindings bindings()
```

peerMap
```
public PeerMap peerMap()
```

peerMap

public PeerBuilder peerMap(PeerMap peerMap)

masterPeer
```
public Peer masterPeer()
```

masterPeer

public PeerBuilder masterPeer(Peer masterPeer)

channelServerConfiguration

public ChannelServerConfiguration channelServerConfiguration()

channelServerConfiguration

public PeerBuilder channelServerConfiguration(ChannelServerConfiguration channelServerConfiguration)

channelClientConfiguration

public ChannelClientConfiguration channelClientConfiguration()

channelClientConfiguration

public PeerBuilder channelClientConfiguration(ChannelClientConfiguration channelClientConfiguration)

broadcastHandler

public BroadcastHandler broadcastHandler()

broadcastHandler

public PeerBuilder broadcastHandler(BroadcastHandler broadcastHandler)

bloomfilterFactory

public BloomfilterFactory bloomfilterFactory()

bloomfilterFactory

public PeerBuilder bloomfilterFactory(BloomfilterFactory bloomfilterFactory)

maintenanceTask

public MaintenanceTask maintenanceTask()

maintenanceTask

public PeerBuilder maintenanceTask(MaintenanceTask maintenanceTask)

random
```
public Random random()
```

random

public PeerBuilder random(Random random)

init

public PeerBuilder init(PeerInit init)

init

public PeerBuilder init(PeerInit... inits)

timer

public ScheduledExecutorService timer()

timer

public PeerBuilder timer(ScheduledExecutorService scheduledExecutorService)

isEnableHandShakeRPC
```
public boolean isEnableHandShakeRPC()
```

enableHandShakeRPC

public PeerBuilder enableHandShakeRPC(boolean enableHandShakeRPC)

isEnableNeighborRPC
```
public boolean isEnableNeighborRPC()
```

enableNeighborRPC

public PeerBuilder enableNeighborRPC(boolean enableNeighborRPC)

isEnableDirectDataRPC

public boolean isEnableDirectDataRPC()

enableDirectDataRPC

public PeerBuilder enableDirectDataRPC(boolean enableDirectDataRPC)

isEnableRouting
```
public boolean isEnableRouting()
```

enableRouting

public PeerBuilder enableRouting(boolean enableRouting)

isEnableMaintenance
```
public boolean isEnableMaintenance()
```

enableMaintenance

public PeerBuilder enableMaintenance(boolean enableMaintenance)

isEnableQuitRPC
```
public boolean isEnableQuitRPC()
```

enableQuitRPC

public PeerBuilder enableQuitRPC(boolean enableQuitRPC)

isEnableAnnounceRPC
```
public boolean isEnableAnnounceRPC()
```

enableAnnounceRPC

public PeerBuilder enableAnnounceRPC(boolean enableAnnounceRPC)

isEnableBroadcast
```
public boolean isEnableBroadcast()
```

enableBroadcast

public PeerBuilder enableBroadcast(boolean enableBroadcast)

isBehindFirewall
```
public boolean isBehindFirewall()
```
Returns:
True if this peer is behind a firewall and cannot be accessed directly

behindFirewall
```
public PeerBuilder behindFirewall(boolean behindFirewall)
```
Parameters:
behindFirewall - Set to true if this peer is behind a firewall and cannot be accessed directly

Returns:
This class

behindFirewall
```
public PeerBuilder behindFirewall()
```
Set peer to be behind a firewall and cannot be accessed directly.

Returns:
This class

sendBehavior
```
public PeerBuilder sendBehavior(SendBehavior sendBehavior)
```
Set the send behavior. If none is sent, DefaultSendBehavior is used.

Parameters:
sendBehavior - the custom send behavior for direct messages

Returns:
This class

sendBehavior
```
public SendBehavior sendBehavior()
```
Returns:
the current SendBehavior

Class PeerBuilder

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

EMPTY_PUBLIC_KEY

Constructor Detail

PeerBuilder

PeerBuilder

Method Detail

start

createDefaultChannelServerConfiguration

createDefaultChannelClientConfiguration

peerId

keyPair

keyPair

p2pId

p2pId

tcpPortForwarding

tcpPortForwarding

tcpPort

tcpPort

udpPort

udpPort

udpPortForwarding

udpPortForwarding

ports

portsExternal

bindings

bindings

peerMap

peerMap

masterPeer

masterPeer

channelServerConfiguration

channelServerConfiguration

channelClientConfiguration

channelClientConfiguration

broadcastHandler

broadcastHandler

bloomfilterFactory

bloomfilterFactory

maintenanceTask

maintenanceTask

random

random

init

init

timer

timer

isEnableHandShakeRPC

enableHandShakeRPC

isEnableNeighborRPC

enableNeighborRPC

isEnableDirectDataRPC

enableDirectDataRPC

isEnableRouting

enableRouting

isEnableMaintenance

enableMaintenance

isEnableQuitRPC

enableQuitRPC

isEnableAnnounceRPC

enableAnnounceRPC

isEnableBroadcast

enableBroadcast

isBehindFirewall

behindFirewall

behindFirewall

sendBehavior

sendBehavior