org.apache.james.protocols.netty

Class AbstractAsyncServer

java.lang.Object

org.apache.james.protocols.netty.AbstractAsyncServer

All Implemented Interfaces:

ProtocolServer

Direct Known Subclasses:

NettyServer

public abstract class AbstractAsyncServer
extends Object
implements ProtocolServer

Abstract base class for Servers which want to use async io

Field Summary

Fields

Modifier and Type	Field and Description
static int	DEFAULT_IO_WORKER_COUNT

Constructor Summary

Constructors

Constructor and Description
AbstractAsyncServer()

Method Summary

Methods

Modifier and Type	Method and Description
void	bind() Start the server
protected void	configureBootstrap(org.jboss.netty.bootstrap.ServerBootstrap bootstrap) Configure the bootstrap before it get bound
protected Executor	createBossExecutor() Create a new Executor used for dispatch messages to the workers.
protected abstract org.jboss.netty.channel.ChannelPipelineFactory	createPipelineFactory(org.jboss.netty.channel.group.ChannelGroup group) Create ChannelPipelineFactory to use by this Server implementation
protected org.jboss.netty.channel.socket.ServerSocketChannelFactory	createSocketChannelFactory()
protected Executor	createWorkerExecutor() Create a new Executor used for workers.
int	getBacklog() Return the backlog for the socket
int	getIoWorkerCount() Return the IO worker thread count to use
List<InetSocketAddress>	getListenAddresses() Return the ips on which the server listen for connections
int	getTimeout() Return the read/write timeout in seconds for the socket.
boolean	isBound() return true if the server is bound
void	setBacklog(int backlog) Set the Backlog for the socket.
void	setIoWorkerCount(int ioWorker) Set the IO-worker thread count to use.
void	setListenAddresses(InetSocketAddress... addresses)
void	setTimeout(int timeout) Set the read/write timeout for the server.
void	unbind() Stop the server

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_IO_WORKER_COUNT

public static final int DEFAULT_IO_WORKER_COUNT

Constructor Detail

AbstractAsyncServer

public AbstractAsyncServer()

Method Detail

setListenAddresses

public void setListenAddresses(InetSocketAddress... addresses)

setIoWorkerCount

public void setIoWorkerCount(int ioWorker)

Set the IO-worker thread count to use. Default is nCores * 2

Parameters:

ioWorker -

getIoWorkerCount

public int getIoWorkerCount()

Return the IO worker thread count to use

Returns:

ioWorker

bind

public void bind()
          throws Exception

Description copied from interface: ProtocolServer

Start the server

Specified by:

bind in interface ProtocolServer

Throws:

Exception

configureBootstrap

protected void configureBootstrap(org.jboss.netty.bootstrap.ServerBootstrap bootstrap)

Configure the bootstrap before it get bound

Parameters:

bootstrap -

createSocketChannelFactory

protected org.jboss.netty.channel.socket.ServerSocketChannelFactory createSocketChannelFactory()

unbind

public void unbind()

Description copied from interface: ProtocolServer

Stop the server

Specified by:

unbind in interface ProtocolServer

getListenAddresses

public List<InetSocketAddress> getListenAddresses()

Description copied from interface: ProtocolServer

Return the ips on which the server listen for connections

Specified by:

getListenAddresses in interface ProtocolServer

Returns:

ips

createPipelineFactory

protected abstract org.jboss.netty.channel.ChannelPipelineFactory createPipelineFactory(org.jboss.netty.channel.group.ChannelGroup group)

Create ChannelPipelineFactory to use by this Server implementation

Returns:

factory

setTimeout

public void setTimeout(int timeout)

Set the read/write timeout for the server. This will throw a IllegalStateException if the server is running.

Parameters:

timeout -

setBacklog

public void setBacklog(int backlog)

Set the Backlog for the socket. This will throw a IllegalStateException if the server is running.

Parameters:

backlog -

getBacklog

public int getBacklog()

Description copied from interface: ProtocolServer

Return the backlog for the socket

Specified by:

getBacklog in interface ProtocolServer

Returns:

backlog

getTimeout

public int getTimeout()

Description copied from interface: ProtocolServer

Return the read/write timeout in seconds for the socket.

Specified by:

getTimeout in interface ProtocolServer

Returns:

the timeout

createBossExecutor

protected Executor createBossExecutor()

Create a new Executor used for dispatch messages to the workers. One Thread will be used per port which is bound. This can get overridden if needed, by default it use a Executors.newCachedThreadPool()

Returns:

bossExecutor

createWorkerExecutor

protected Executor createWorkerExecutor()

Create a new Executor used for workers. This can get overridden if needed, by default it use a Executors.newCachedThreadPool()

Returns:

workerExecutor

isBound

public boolean isBound()

Description copied from interface: ProtocolServer

return true if the server is bound

Specified by:

isBound in interface ProtocolServer

Returns:

bound