Class AprSocketAcceptor

java.lang.Object

org.apache.mina.core.service.AbstractIoService

org.apache.mina.core.service.AbstractIoAcceptor

org.apache.mina.core.polling.AbstractPollingIoAcceptor<AprSession, Long>

org.apache.mina.transport.socket.apr.AprSocketAcceptor

All Implemented Interfaces:

IoAcceptor, IoService

public final class AprSocketAcceptor
extends AbstractPollingIoAcceptor<AprSession, Long>

IoAcceptor for APR based socket transport (TCP/IP).

Nested Class Summary

Nested classes/interfaces inherited from class AbstractIoAcceptor

AbstractIoAcceptor.AcceptorOperationFuture

Nested classes/interfaces inherited from class AbstractIoService

AbstractIoService.ServiceOperationFuture

Field Summary

Fields

Modifier and Type	Field	Description
private static final int	APR_TIMEUP_ERROR	This constant is deduced from the APR code.
private final Queue<Long>	polledHandles
private final long[]	polledSockets
private long	pollset
private static final int	POLLSET_SIZE
private long	pool
private boolean	toBeWakenUp
private final Object	wakeupLock
private long	wakeupSocket

Fields inherited from class AbstractPollingIoAcceptor

backlog, reuseAddress

Fields inherited from class AbstractIoAcceptor

bindLock

Fields inherited from class AbstractIoService

disposalLock, LOGGER, sessionConfig

Constructor Summary

Constructors

Constructor	Description
AprSocketAcceptor()	Constructor for AprSocketAcceptor using default parameters (multiple thread model).
AprSocketAcceptor(int processorCount)	Constructor for AprSocketAcceptor using default parameters, and given number of AprIoProcessor for multithreading I/O operations.
AprSocketAcceptor(Executor executor, IoProcessor<AprSession> processor)	Constructor for AprSocketAcceptor with a given Executor for handling connection events and a given AprIoProcessor for handling I/O events, useful for sharing the same processor and executor over multiple IoService of the same type.
AprSocketAcceptor(IoProcessor<AprSession> processor)	Constructor for AprSocketAcceptor with default configuration but a specific AprIoProcessor, useful for sharing the same processor over multiple IoService of the same type.

Method Summary

Modifier and Type	Method	Description
protected AprSession	accept(IoProcessor<AprSession> processor, Long handle)	Accept a client connection for a server socket and return a new IoSession associated with the given IoProcessor
protected void	close(Long handle)	Close a server socket.
protected void	destroy()	Destroy the polling system, will be called when this IoAcceptor implementation will be disposed.
InetSocketAddress	getDefaultLocalAddress()	Returns the default local address to bind when no argument is specified in IoAcceptor.bind() method.
InetSocketAddress	getLocalAddress()	Returns the local address which is bound currently.
TransportMetadata	getTransportMetadata()
protected void	init()	Initialize the polling system, will be called at construction time.
protected void	init(SelectorProvider selectorProvider)	Initialize the polling system, will be called at construction time.
protected SocketAddress	localAddress(Long handle)	Get the local address associated with a given server socket
protected Long	open(SocketAddress localAddress)	Open a server socket for a given local address.
protected int	select()	Check for acceptable connections, interrupt when at least a server is ready for accepting.
protected Iterator<Long>	selectedHandles()	Iterator for the set of server sockets found with acceptable incoming connections during the last AbstractPollingIoAcceptor.select() call.
void	setDefaultLocalAddress(InetSocketAddress localAddress)
private void	throwException(int code)	Convert an APR code into an Exception with the corresponding message
protected void	wakeup()	Interrupt the AbstractPollingIoAcceptor.select() method.

Methods inherited from class AbstractPollingIoAcceptor

bindInternal, bindRequestAdded, dispose0, getBacklog, getSessionConfig, handleUnbound, hasUnbindings, isReuseAddress, newSession, processHandles, setBacklog, setReuseAddress, unbind0

Methods inherited from class AbstractIoAcceptor

bind, bind, bind, bind, bind, getDefaultLocalAddresses, getLocalAddresses, isCloseOnDeactivation, setCloseOnDeactivation, setDefaultLocalAddress, setDefaultLocalAddresses, setDefaultLocalAddresses, setDefaultLocalAddresses, toString, unbind, unbind, unbind, unbind

Methods inherited from class AbstractIoService

addListener, broadcast, dispose, dispose, executeWorker, executeWorker, finishSessionInitialization0, getActivationTime, getFilterChain, getFilterChainBuilder, getHandler, getListeners, getManagedSessionCount, getManagedSessions, getScheduledWriteBytes, getScheduledWriteMessages, getSessionDataStructureFactory, getStatistics, initSession, isActive, isDisposed, isDisposing, removeListener, setFilterChainBuilder, setHandler, setSessionDataStructureFactory

Methods inherited from class Object

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

Methods inherited from interface IoService

addListener, broadcast, dispose, dispose, getActivationTime, getFilterChain, getFilterChainBuilder, getHandler, getManagedSessionCount, getManagedSessions, getScheduledWriteBytes, getScheduledWriteMessages, getSessionDataStructureFactory, getStatistics, isActive, isDisposed, isDisposing, removeListener, setFilterChainBuilder, setHandler, setSessionDataStructureFactory

Field Details

APR_TIMEUP_ERROR

private static final int APR_TIMEUP_ERROR

This constant is deduced from the APR code. It is used when the timeout has expired while doing a poll() operation.

See Also:

• Constant Field Values

POLLSET_SIZE

private static final int POLLSET_SIZE

See Also:

• Constant Field Values

wakeupLock

private final Object wakeupLock

wakeupSocket

private volatile long wakeupSocket

toBeWakenUp

private volatile boolean toBeWakenUp

pool

private volatile long pool

pollset

private volatile long pollset

polledSockets

private final long[] polledSockets

polledHandles

private final Queue<Long> polledHandles

Constructor Details

AprSocketAcceptor

public AprSocketAcceptor()

Constructor for AprSocketAcceptor using default parameters (multiple thread model).

AprSocketAcceptor

public AprSocketAcceptor(int processorCount)

Constructor for AprSocketAcceptor using default parameters, and given number of AprIoProcessor for multithreading I/O operations.

Parameters:

processorCount - the number of processor to create and place in a SimpleIoProcessorPool

AprSocketAcceptor

public AprSocketAcceptor(IoProcessor<AprSession> processor)

Constructor for AprSocketAcceptor with default configuration but a specific AprIoProcessor, useful for sharing the same processor over multiple IoService of the same type.

Parameters:

processor - the processor to use for managing I/O events

AprSocketAcceptor

public AprSocketAcceptor(Executor executor,
 IoProcessor<AprSession> processor)

Constructor for AprSocketAcceptor with a given Executor for handling connection events and a given AprIoProcessor for handling I/O events, useful for sharing the same processor and executor over multiple IoService of the same type.

Parameters:

executor - the executor for connection

processor - the processor for I/O operations

Method Details

accept

protected AprSession accept(IoProcessor<AprSession> processor,
 Long handle)
                     throws Exception

Accept a client connection for a server socket and return a new IoSession associated with the given IoProcessor

Specified by:

accept in class AbstractPollingIoAcceptor<AprSession, Long>

Parameters:

processor - the IoProcessor to associate with the IoSession

handle - the server handle

Returns:

the created IoSession

Throws:

Exception - any exception thrown by the underlying systems calls

open

protected Long open(SocketAddress localAddress)
             throws Exception

Open a server socket for a given local address.

Specified by:

open in class AbstractPollingIoAcceptor<AprSession, Long>

Parameters:

localAddress - the associated local address

Returns:

the opened server socket

Throws:

Exception - any exception thrown by the underlying systems calls

init

protected void init()
             throws Exception

Initialize the polling system, will be called at construction time.

Specified by:

init in class AbstractPollingIoAcceptor<AprSession, Long>

Throws:

Exception - any exception thrown by the underlying system calls

destroy

protected void destroy()
                throws Exception

Destroy the polling system, will be called when this IoAcceptor implementation will be disposed.

Specified by:

destroy in class AbstractPollingIoAcceptor<AprSession, Long>

Throws:

Exception - any exception thrown by the underlying systems calls

localAddress

protected SocketAddress localAddress(Long handle)
                              throws Exception

Get the local address associated with a given server socket

Specified by:

localAddress in class AbstractPollingIoAcceptor<AprSession, Long>

Parameters:

handle - the server socket

Returns:

the local SocketAddress associated with this handle

Throws:

Exception - any exception thrown by the underlying systems calls

select

protected int select()
              throws Exception

Check for acceptable connections, interrupt when at least a server is ready for accepting. All the ready server socket descriptors need to be returned by AbstractPollingIoAcceptor.selectedHandles()

Specified by:

select in class AbstractPollingIoAcceptor<AprSession, Long>

Returns:

The number of sockets having got incoming client

Throws:

Exception - any exception thrown by the underlying systems calls

selectedHandles

protected Iterator<Long> selectedHandles()

Iterator for the set of server sockets found with acceptable incoming connections during the last AbstractPollingIoAcceptor.select() call.

Specified by:

selectedHandles in class AbstractPollingIoAcceptor<AprSession, Long>

Returns:

the list of server handles ready

close

protected void close(Long handle)
              throws Exception

Close a server socket.

Specified by:

close in class AbstractPollingIoAcceptor<AprSession, Long>

Parameters:

handle - the server socket

Throws:

Exception - any exception thrown by the underlying systems calls

wakeup

protected void wakeup()

Interrupt the AbstractPollingIoAcceptor.select() method. Used when the poll set need to be modified.

Specified by:

wakeup in class AbstractPollingIoAcceptor<AprSession, Long>

getLocalAddress

public InetSocketAddress getLocalAddress()

Returns the local address which is bound currently. If more than one address are bound, only one of them will be returned, but it's not necessarily the firstly bound address.

Specified by:

getLocalAddress in interface IoAcceptor

Overrides:

getLocalAddress in class AbstractIoAcceptor

Returns:

The bound LocalAddress

getDefaultLocalAddress

public InetSocketAddress getDefaultLocalAddress()

Returns the default local address to bind when no argument is specified in IoAcceptor.bind() method. Please note that the default will not be used if any local address is specified. If more than one address are set, only one of them will be returned, but it's not necessarily the firstly specified address in IoAcceptor.setDefaultLocalAddresses(List).

Specified by:

getDefaultLocalAddress in interface IoAcceptor

Overrides:

getDefaultLocalAddress in class AbstractIoAcceptor

Returns:

The default bound LocalAddress

setDefaultLocalAddress

public void setDefaultLocalAddress(InetSocketAddress localAddress)

Parameters:

localAddress - The localAddress to set

See Also:

• AbstractIoAcceptor.setDefaultLocalAddress(SocketAddress)

getTransportMetadata

public TransportMetadata getTransportMetadata()

Returns:

the TransportMetadata that this service runs on.

throwException

private void throwException(int code)
                     throws IOException

Convert an APR code into an Exception with the corresponding message

Parameters:

code - error number

Throws:

IOException - the generated exception

init

protected void init(SelectorProvider selectorProvider)
             throws Exception

Description copied from class: AbstractPollingIoAcceptor

Initialize the polling system, will be called at construction time.

Specified by:

init in class AbstractPollingIoAcceptor<AprSession, Long>

Parameters:

selectorProvider - The Selector Provider that will be used by this polling acceptor

Throws:

Exception - any exception thrown by the underlying system calls