org.apache.mina.transport.socket.apr

Class AprSocketConnector

java.lang.Object

org.apache.mina.core.service.AbstractIoService

org.apache.mina.core.service.AbstractIoConnector

org.apache.mina.core.polling.AbstractPollingIoConnector<AprSession,java.lang.Long>

org.apache.mina.transport.socket.apr.AprSocketConnector

All Implemented Interfaces:

IoConnector, IoService, SocketConnector

public final class AprSocketConnector
extends AbstractPollingIoConnector<AprSession,java.lang.Long>
implements SocketConnector

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

Author:

Apache MINA Project

Nested Class Summary

Nested classes/interfaces inherited from class org.apache.mina.core.polling.AbstractPollingIoConnector

AbstractPollingIoConnector.ConnectionRequest

Nested classes/interfaces inherited from class org.apache.mina.core.service.AbstractIoService

AbstractIoService.ServiceOperationFuture

Field Summary

Fields inherited from class org.apache.mina.core.service.AbstractIoService

disposalLock

Constructor Summary

Constructors

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

Method Summary

Methods

Modifier and Type	Method and Description
protected java.util.Iterator<java.lang.Long>	allHandles() Iterator for all the client sockets polled for connection.
protected void	close(java.lang.Long handle) Close a client socket.
protected boolean	connect(java.lang.Long handle, java.net.SocketAddress remoteAddress) Connect a newly created client socket handle to a remote SocketAddress.
protected void	destroy() Destroy the polling system, will be called when this IoConnector implementation will be disposed.
protected boolean	finishConnect(java.lang.Long handle) Finish the connection process of a client socket after it was marked as ready to process by the AbstractPollingIoConnector.select(int) call.
protected AbstractPollingIoConnector.ConnectionRequest	getConnectionRequest(java.lang.Long handle) get the AbstractPollingIoConnector.ConnectionRequest for a given client socket handle
java.net.InetSocketAddress	getDefaultRemoteAddress() Returns the default remote address to connect to when no argument is specified in IoConnector.connect() method.
SocketSessionConfig	getSessionConfig() Returns the default configuration of the new IoSessions created by this service.
TransportMetadata	getTransportMetadata() Returns the TransportMetadata that this service runs on.
protected void	init() Initialize the polling system, will be called at construction time.
protected java.lang.Long	newHandle(java.net.SocketAddress localAddress) Create a new client socket handle from a local SocketAddress
protected AprSession	newSession(IoProcessor<AprSession> processor, java.lang.Long handle) Create a new IoSession from a connected socket client handle.
protected void	register(java.lang.Long handle, AbstractPollingIoConnector.ConnectionRequest request) Register a new client socket for connection, add it to connection polling
protected int	select(int timeout) Check for connected sockets, interrupt when at least a connection is processed (connected or failed to connect).
protected java.util.Iterator<java.lang.Long>	selectedHandles() Iterator for the set of client sockets found connected or failed to connect during the last #select() call.
void	setDefaultRemoteAddress(java.net.InetSocketAddress defaultRemoteAddress) TODO : add documentation
protected void	wakeup() Interrupt the #select() method.

Methods inherited from class org.apache.mina.core.polling.AbstractPollingIoConnector

connect0, dispose0

Methods inherited from class org.apache.mina.core.service.AbstractIoConnector

connect, connect, connect, connect, connect, connect, finishSessionInitialization0, getConnectTimeout, getConnectTimeoutCheckInterval, getConnectTimeoutMillis, setConnectTimeout, setConnectTimeoutCheckInterval, setConnectTimeoutMillis, setDefaultRemoteAddress, toString

Methods inherited from class org.apache.mina.core.service.AbstractIoService

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

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.apache.mina.core.service.IoConnector

connect, connect, connect, connect, connect, connect, getConnectTimeout, getConnectTimeoutMillis, setConnectTimeout, setConnectTimeoutMillis, setDefaultRemoteAddress

Methods inherited from interface org.apache.mina.core.service.IoService

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

Constructor Detail

AprSocketConnector

public AprSocketConnector()

Create an AprSocketConnector with default configuration (multiple thread model).

AprSocketConnector

public AprSocketConnector(int processorCount)

Constructor for AprSocketConnector with default configuration, and given number of AprIoProcessor for multithreading I/O operations

Parameters:

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

AprSocketConnector

public AprSocketConnector(IoProcessor<AprSession> processor)

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

Parameters:

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

AprSocketConnector

public AprSocketConnector(java.util.concurrent.Executor executor,
                  IoProcessor<AprSession> processor)

Constructor for AprSocketConnector with a given Executor for handling connection events and a given IoProcessor 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 Detail

init

protected void init()
             throws java.lang.Exception

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

Specified by:

init in class AbstractPollingIoConnector<AprSession,java.lang.Long>

Throws:

java.lang.Exception - any exception thrown by the underlying system calls

destroy

protected void destroy()
                throws java.lang.Exception

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

Specified by:

destroy in class AbstractPollingIoConnector<AprSession,java.lang.Long>

Throws:

java.lang.Exception - any exception thrown by the underlying systems calls

allHandles

protected java.util.Iterator<java.lang.Long> allHandles()

Iterator for all the client sockets polled for connection.

Specified by:

allHandles in class AbstractPollingIoConnector<AprSession,java.lang.Long>

Returns:

the list of client sockets currently polled for connection

connect

protected boolean connect(java.lang.Long handle,
              java.net.SocketAddress remoteAddress)
                   throws java.lang.Exception

Connect a newly created client socket handle to a remote SocketAddress. This operation is non-blocking, so at end of the call the socket can be still in connection process.

Specified by:

connect in class AbstractPollingIoConnector<AprSession,java.lang.Long>

Parameters:

handle - the client socket handle

remoteAddress - the remote address where to connect

Returns:

true if a connection was established, false if this client socket is in non-blocking mode and the connection operation is in progress

Throws:

java.lang.Exception

getConnectionRequest

protected AbstractPollingIoConnector.ConnectionRequest getConnectionRequest(java.lang.Long handle)

get the AbstractPollingIoConnector.ConnectionRequest for a given client socket handle

Specified by:

getConnectionRequest in class AbstractPollingIoConnector<AprSession,java.lang.Long>

Parameters:

handle - the socket client handle

Returns:

the connection request if the socket is connecting otherwise null

close

protected void close(java.lang.Long handle)
              throws java.lang.Exception

Close a client socket.

Specified by:

close in class AbstractPollingIoConnector<AprSession,java.lang.Long>

Parameters:

handle - the client socket

Throws:

java.lang.Exception - any exception thrown by the underlying systems calls

finishConnect

protected boolean finishConnect(java.lang.Long handle)
                         throws java.lang.Exception

Finish the connection process of a client socket after it was marked as ready to process by the AbstractPollingIoConnector.select(int) call. The socket will be connected or reported as connection failed.

Specified by:

finishConnect in class AbstractPollingIoConnector<AprSession,java.lang.Long>

Parameters:

handle - the client socket handle to finsh to connect

Returns:

true if the socket is connected

Throws:

java.lang.Exception - any exception thrown by the underlying systems calls

newHandle

protected java.lang.Long newHandle(java.net.SocketAddress localAddress)
                            throws java.lang.Exception

Create a new client socket handle from a local SocketAddress

Specified by:

newHandle in class AbstractPollingIoConnector<AprSession,java.lang.Long>

Parameters:

localAddress - the socket address for binding the new client socket

Returns:

a new client socket handle

Throws:

java.lang.Exception - any exception thrown by the underlying systems calls

newSession

protected AprSession newSession(IoProcessor<AprSession> processor,
                    java.lang.Long handle)
                         throws java.lang.Exception

Create a new IoSession from a connected socket client handle. Will assign the created IoSession to the given IoProcessor for managing future I/O events.

Specified by:

newSession in class AbstractPollingIoConnector<AprSession,java.lang.Long>

Parameters:

processor - the processor in charge of this session

handle - the newly connected client socket handle

Returns:

a new IoSession

Throws:

java.lang.Exception - any exception thrown by the underlying systems calls

register

protected void register(java.lang.Long handle,
            AbstractPollingIoConnector.ConnectionRequest request)
                 throws java.lang.Exception

Register a new client socket for connection, add it to connection polling

Specified by:

register in class AbstractPollingIoConnector<AprSession,java.lang.Long>

Parameters:

handle - client socket handle

request - the associated AbstractPollingIoConnector.ConnectionRequest

Throws:

java.lang.Exception - any exception thrown by the underlying systems calls

select

protected int select(int timeout)
              throws java.lang.Exception

Check for connected sockets, interrupt when at least a connection is processed (connected or failed to connect). All the client socket descriptors processed need to be returned by AbstractPollingIoConnector.selectedHandles()

Specified by:

select in class AbstractPollingIoConnector<AprSession,java.lang.Long>

Returns:

The number of socket having received some data

Throws:

java.lang.Exception - any exception thrown by the underlying systems calls

selectedHandles

protected java.util.Iterator<java.lang.Long> selectedHandles()

Iterator for the set of client sockets found connected or failed to connect during the last #select() call.

Specified by:

selectedHandles in class AbstractPollingIoConnector<AprSession,java.lang.Long>

Returns:

the list of client socket handles to process

wakeup

protected void wakeup()

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

Specified by:

wakeup in class AbstractPollingIoConnector<AprSession,java.lang.Long>

getTransportMetadata

public TransportMetadata getTransportMetadata()

Returns the TransportMetadata that this service runs on.

Specified by:

getTransportMetadata in interface IoService

getSessionConfig

public SocketSessionConfig getSessionConfig()

Returns the default configuration of the new IoSessions created by this service.

Specified by:

getSessionConfig in interface IoService

Specified by:

getSessionConfig in interface SocketConnector

Overrides:

getSessionConfig in class AbstractIoService

getDefaultRemoteAddress

public java.net.InetSocketAddress getDefaultRemoteAddress()

Returns the default remote address to connect to when no argument is specified in IoConnector.connect() method.

Specified by:

getDefaultRemoteAddress in interface IoConnector

Specified by:

getDefaultRemoteAddress in interface SocketConnector

Overrides:

getDefaultRemoteAddress in class AbstractIoConnector

setDefaultRemoteAddress

public void setDefaultRemoteAddress(java.net.InetSocketAddress defaultRemoteAddress)

TODO : add documentation

Specified by:

setDefaultRemoteAddress in interface SocketConnector