net.tomp2p.connection

Class Reservation

java.lang.Object

net.tomp2p.connection.Reservation

public class Reservation
extends Object

Reserves a block of connections.

Author:

Thomas Bocek

Constructor Summary

Constructors

Constructor and Description
Reservation(io.netty.channel.EventLoopGroup workerGroup, ChannelClientConfiguration channelClientConfiguration) Creates a new reservation class with the 3 permits.

Method Summary

Methods

Modifier and Type	Method and Description
FutureChannelCreator	create(int permitsUDP, int permitsTCP) Create a connection creator for short-lived connections.
FutureChannelCreator	create(RoutingConfiguration routingConfiguration, RequestConfiguration requestP2PConfiguration, DefaultConnectionConfiguration builder) This will calculate the number of required connection for routing and request messages.
FutureChannelCreator	createPermanent(int permitsPermanentTCP) Create a connection creator for permanent connections.
int	pendingRequests()
FutureDone<Void>	shutdown() Shutdown all the channel creators out there.
FutureDone<Void>	shutdownFuture()

Methods inherited from class java.lang.Object

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

Constructor Detail

Reservation

public Reservation(io.netty.channel.EventLoopGroup workerGroup,
           ChannelClientConfiguration channelClientConfiguration)

Creates a new reservation class with the 3 permits.

Parameters:

workerGroup - The worker group for both UDP and TCP channels. This will not be shutdown in this class, you need to shutdown it outside.

channelClientConfiguration - Sets maxPermitsUDP: the number of maximum short-lived UDP connections, maxPermitsTCP: the number of maximum short-lived TCP connections, maxPermitsPermanentTCP: the number of maximum permanent TCP connections

Method Detail

pendingRequests

public int pendingRequests()

Returns:

The pending number of requests that are scheduled but not executed yet.

create

public FutureChannelCreator create(RoutingConfiguration routingConfiguration,
                          RequestConfiguration requestP2PConfiguration,
                          DefaultConnectionConfiguration builder)

This will calculate the number of required connection for routing and request messages.

Parameters:

routingConfiguration - Contains the number of routing requests in parallel

requestP2PConfiguration - Contains the number of requests for P2P operations in parallel

builder - The builder that tells us if we should use TCP or UPD

Returns:

The future channel creator

create

public FutureChannelCreator create(int permitsUDP,
                          int permitsTCP)

Create a connection creator for short-lived connections. Always call ChannelCreator.shutdown() to release all resources. This needs to be done in any case, whetere FutureChannelCreator return failed or success!

Parameters:

permitsUDP - The number of short-lived UDP connections

permitsTCP - The number of short-lived TCP connections

Returns:

The future channel creator

createPermanent

public FutureChannelCreator createPermanent(int permitsPermanentTCP)

Create a connection creator for permanent connections.

Parameters:

permitsPermanentTCP - The number of long-lived TCP connections

Returns:

The future channel creator

shutdown

public FutureDone<Void> shutdown()

Shutdown all the channel creators out there.

Returns:

The future when the shutdown is complete

shutdownFuture

public FutureDone<Void> shutdownFuture()

Returns:

The shutdown future that is used when calling shutdown()