net.tomp2p.connection

Class ChannelCreator

java.lang.Object

net.tomp2p.connection.ChannelCreator

public class ChannelCreator
extends Object

Creates the channels. This class is created by Reservation.WaitReservationPermanent and should never be called directly. With this class one can create TCP or UDP channels up to a certain extend. Thus it must be know beforehand how many connections will be created.

Author:

Thomas Bocek

Method Summary

Methods

Modifier and Type	Method and Description
int	availableTCPPermits()
int	availableUDPPermits()
io.netty.channel.ChannelFuture	createTCP(SocketAddress socketAddress, int connectionTimeoutMillis, Map<String,Pair<io.netty.util.concurrent.EventExecutorGroup,io.netty.channel.ChannelHandler>> channelHandlers, FutureResponse futureResponse) Creates a channel to the given address.
io.netty.channel.ChannelFuture	createUDP(boolean broadcast, Map<String,Pair<io.netty.util.concurrent.EventExecutorGroup,io.netty.channel.ChannelHandler>> channelHandlers, FutureResponse futureResponse) Creates a "channel" to the given address.
boolean	isShutdown()
io.netty.channel.ChannelFuture	setupCloseListener(io.netty.channel.ChannelFuture channelFuture, FutureResponse futureResponse) Setup the close listener for a channel that was already created
FutureDone<Void>	shutdown() Shutdown this channel creator.
FutureDone<Void>	shutdownFuture()
String	toString()

Methods inherited from class java.lang.Object

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

Method Detail

createUDP

public io.netty.channel.ChannelFuture createUDP(boolean broadcast,
                                       Map<String,Pair<io.netty.util.concurrent.EventExecutorGroup,io.netty.channel.ChannelHandler>> channelHandlers,
                                       FutureResponse futureResponse)

Creates a "channel" to the given address. This won't send any message unlike TCP.

Parameters:

broadcast - Sets this channel to be able to broadcast

channelHandlers - The handlers to set

futureResponse - The futureResponse

Returns:

The channel future object or null if we are shut down

createTCP

public io.netty.channel.ChannelFuture createTCP(SocketAddress socketAddress,
                                       int connectionTimeoutMillis,
                                       Map<String,Pair<io.netty.util.concurrent.EventExecutorGroup,io.netty.channel.ChannelHandler>> channelHandlers,
                                       FutureResponse futureResponse)

Creates a channel to the given address. This will setup the TCP connection

Parameters:

socketAddress - The address to send future messages

connectionTimeoutMillis - The timeout for establishing a TCP connection

channelHandlers - The handlers to set

futureResponse - the futureResponse

Returns:

The channel future object or null if we are shut down.

setupCloseListener

public io.netty.channel.ChannelFuture setupCloseListener(io.netty.channel.ChannelFuture channelFuture,
                                                FutureResponse futureResponse)

Setup the close listener for a channel that was already created

Parameters:

channelFuture - The channel future

futureResponse - The future response

Returns:

The same future that was passed as an argument

isShutdown

public boolean isShutdown()

shutdown

public FutureDone<Void> shutdown()

Shutdown this channel creator. This means that no TCP or UDP connection can be established.

Returns:

The shutdown future.

shutdownFuture

public FutureDone<Void> shutdownFuture()

Returns:

The shutdown future that is used when calling shutdown()

availableUDPPermits

public int availableUDPPermits()

availableTCPPermits

public int availableTCPPermits()

toString

public String toString()

Overrides:

toString in class Object