Class AbstractIoConnector

java.lang.Object

org.apache.mina.core.service.AbstractIoService

org.apache.mina.core.service.AbstractIoConnector

All Implemented Interfaces:

IoConnector, IoService

Direct Known Subclasses:

AbstractPollingIoConnector, ProxyConnector, VmPipeConnector

public abstract class AbstractIoConnector
extends AbstractIoService
implements IoConnector

A base implementation of IoConnector.

Nested Class Summary

Nested classes/interfaces inherited from class AbstractIoService

AbstractIoService.ServiceOperationFuture

Field Summary

Fields

Modifier and Type	Field	Description
private long	connectTimeoutCheckInterval	The minimum timeout value that is supported (in milliseconds).
private long	connectTimeoutInMillis
private SocketAddress	defaultLocalAddress	The local address
private SocketAddress	defaultRemoteAddress	The remote address we are connected to

Fields inherited from class AbstractIoService

disposalLock, LOGGER, sessionConfig

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	AbstractIoConnector(IoSessionConfig sessionConfig, Executor executor)	Constructor for AbstractIoConnector.

Method Summary

Modifier and Type	Method	Description
final ConnectFuture	connect()	Connects to the default remote address.
final ConnectFuture	connect(SocketAddress remoteAddress)	Connects to the specified remote address.
ConnectFuture	connect(SocketAddress remoteAddress, SocketAddress localAddress)	Connects to the specified remote address binding to the specified local address.
final ConnectFuture	connect(SocketAddress remoteAddress, SocketAddress localAddress, IoSessionInitializer<? extends ConnectFuture> sessionInitializer)	Connects to the specified remote address binding to the specified local address and and invokes the ioSessionInitializer when the IoSession is created but before IoHandler.sessionCreated(IoSession) is invoked.
ConnectFuture	connect(SocketAddress remoteAddress, IoSessionInitializer<? extends ConnectFuture> sessionInitializer)	Connects to the specified remote address and invokes the ioSessionInitializer when the IoSession is created but before IoHandler.sessionCreated(IoSession) is invoked.
ConnectFuture	connect(IoSessionInitializer<? extends ConnectFuture> sessionInitializer)	Connects to the default remote address and invokes the ioSessionInitializer when the IoSession is created but before IoHandler.sessionCreated(IoSession) is invoked.
protected abstract ConnectFuture	connect0(SocketAddress remoteAddress, SocketAddress localAddress, IoSessionInitializer<? extends ConnectFuture> sessionInitializer)	Implement this method to perform the actual connect operation.
protected final void	finishSessionInitialization0(IoSession session, IoFuture future)	Adds required internal attributes and IoFutureListeners related with event notifications to the specified session and future.
final int	getConnectTimeout()	Deprecated. Take a look at getConnectTimeoutMillis()
long	getConnectTimeoutCheckInterval()
final long	getConnectTimeoutMillis()
final SocketAddress	getDefaultLocalAddress()
SocketAddress	getDefaultRemoteAddress()
final void	setConnectTimeout(int connectTimeout)	Deprecated. Take a look at setConnectTimeoutMillis(long)
void	setConnectTimeoutCheckInterval(long minimumConnectTimeout)	Sets the timeout for the connection check
final void	setConnectTimeoutMillis(long connectTimeoutInMillis)	Sets the connect timeout value in milliseconds.
final void	setDefaultLocalAddress(SocketAddress localAddress)	Sets the default local address
final void	setDefaultRemoteAddress(SocketAddress defaultRemoteAddress)	Sets the default remote address to connect to when no argument is specified in IoConnector.connect() method.
String	toString()

Methods inherited from class AbstractIoService

addListener, broadcast, dispose, dispose, dispose0, 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 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, getSessionConfig, getSessionDataStructureFactory, getStatistics, getTransportMetadata, isActive, isDisposed, isDisposing, removeListener, setFilterChainBuilder, setHandler, setSessionDataStructureFactory

Field Details

connectTimeoutCheckInterval

private long connectTimeoutCheckInterval

The minimum timeout value that is supported (in milliseconds).

connectTimeoutInMillis

private long connectTimeoutInMillis

defaultRemoteAddress

private SocketAddress defaultRemoteAddress

The remote address we are connected to

defaultLocalAddress

private SocketAddress defaultLocalAddress

The local address

Constructor Details

AbstractIoConnector

protected AbstractIoConnector(IoSessionConfig sessionConfig,
 Executor executor)

Constructor for AbstractIoConnector. You need to provide a default session configuration and an Executor for handling I/O events. If null Executor is provided, a default one will be created using Executors.newCachedThreadPool().

Parameters:

sessionConfig - the default configuration for the managed IoSession

executor - the Executor used for handling execution of I/O events. Can be null.

See Also:

• AbstractIoService(IoSessionConfig, Executor)

Method Details

getConnectTimeoutCheckInterval

public long getConnectTimeoutCheckInterval()

Returns:

The minimum time that this connector can have for a connection timeout in milliseconds.

setConnectTimeoutCheckInterval

public void setConnectTimeoutCheckInterval(long minimumConnectTimeout)

Sets the timeout for the connection check

Parameters:

minimumConnectTimeout - The delay we wait before checking the connection

getConnectTimeout

@Deprecated
public final int getConnectTimeout()

Deprecated.

Take a look at getConnectTimeoutMillis()

Specified by:

getConnectTimeout in interface IoConnector

Returns:

the connect timeout in seconds. The default value is 1 minute.

getConnectTimeoutMillis

public final long getConnectTimeoutMillis()

Specified by:

getConnectTimeoutMillis in interface IoConnector

Returns:

the connect timeout in milliseconds. The default value is 1 minute.

setConnectTimeout

@Deprecated
public final void setConnectTimeout(int connectTimeout)

Deprecated.

Take a look at setConnectTimeoutMillis(long)

Description copied from interface: IoConnector

Sets the connect timeout in seconds. The default value is 1 minute.

Specified by:

setConnectTimeout in interface IoConnector

Parameters:

connectTimeout - The time out for the connection

setConnectTimeoutMillis

public final void setConnectTimeoutMillis(long connectTimeoutInMillis)

Sets the connect timeout value in milliseconds.

Specified by:

setConnectTimeoutMillis in interface IoConnector

Parameters:

connectTimeoutInMillis - The time out for the connection

getDefaultRemoteAddress

public SocketAddress getDefaultRemoteAddress()

Specified by:

getDefaultRemoteAddress in interface IoConnector

Returns:

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

setDefaultLocalAddress

public final void setDefaultLocalAddress(SocketAddress localAddress)

Sets the default local address

Specified by:

setDefaultLocalAddress in interface IoConnector

Parameters:

localAddress - The default local address

getDefaultLocalAddress

public final SocketAddress getDefaultLocalAddress()

Specified by:

getDefaultLocalAddress in interface IoConnector

Returns:

the default local address

setDefaultRemoteAddress

public final void setDefaultRemoteAddress(SocketAddress defaultRemoteAddress)

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

Specified by:

setDefaultRemoteAddress in interface IoConnector

Parameters:

defaultRemoteAddress - The default remote address

connect

public final ConnectFuture connect()

Connects to the default remote address.

Specified by:

connect in interface IoConnector

Returns:

the ConnectFuture instance which is completed when the connection attempt initiated by this call succeeds or fails.

connect

public ConnectFuture connect(IoSessionInitializer<? extends ConnectFuture> sessionInitializer)

Connects to the default remote address and invokes the ioSessionInitializer when the IoSession is created but before IoHandler.sessionCreated(IoSession) is invoked. There is no guarantee that the ioSessionInitializer will be invoked before this method returns.

Specified by:

connect in interface IoConnector

Parameters:

sessionInitializer - the callback to invoke when the IoSession object is created

Returns:

the ConnectFuture instance which is completed when the connection attempt initiated by this call succeeds or fails.

connect

public final ConnectFuture connect(SocketAddress remoteAddress)

Connects to the specified remote address.

Specified by:

connect in interface IoConnector

Parameters:

remoteAddress - The remote address to connect to

Returns:

the ConnectFuture instance which is completed when the connection attempt initiated by this call succeeds or fails.

connect

public ConnectFuture connect(SocketAddress remoteAddress,
 IoSessionInitializer<? extends ConnectFuture> sessionInitializer)

Connects to the specified remote address and invokes the ioSessionInitializer when the IoSession is created but before IoHandler.sessionCreated(IoSession) is invoked. There is no guarantee that the ioSessionInitializer will be invoked before this method returns.

Specified by:

connect in interface IoConnector

Parameters:

remoteAddress - the remote address to connect to

sessionInitializer - the callback to invoke when the IoSession object is created

Returns:

the ConnectFuture instance which is completed when the connection attempt initiated by this call succeeds or fails.

connect

public ConnectFuture connect(SocketAddress remoteAddress,
 SocketAddress localAddress)

Connects to the specified remote address binding to the specified local address.

Specified by:

connect in interface IoConnector

Parameters:

remoteAddress - The remote address to connect

localAddress - The local address to bind

Returns:

the ConnectFuture instance which is completed when the connection attempt initiated by this call succeeds or fails.

connect

public final ConnectFuture connect(SocketAddress remoteAddress,
 SocketAddress localAddress,
 IoSessionInitializer<? extends ConnectFuture> sessionInitializer)

Connects to the specified remote address binding to the specified local address and and invokes the ioSessionInitializer when the IoSession is created but before IoHandler.sessionCreated(IoSession) is invoked. There is no guarantee that the ioSessionInitializer will be invoked before this method returns.

Specified by:

connect in interface IoConnector

Parameters:

remoteAddress - the remote address to connect to

localAddress - the local interface to bind to

sessionInitializer - the callback to invoke when the IoSession object is created

Returns:

the ConnectFuture instance which is completed when the connection attempt initiated by this call succeeds or fails.

connect0

protected abstract ConnectFuture connect0(SocketAddress remoteAddress,
 SocketAddress localAddress,
 IoSessionInitializer<? extends ConnectFuture> sessionInitializer)

Implement this method to perform the actual connect operation.

Parameters:

remoteAddress - The remote address to connect from

localAddress - null if no local address is specified

sessionInitializer - The IoSessionInitializer to use when the connection s successful

Returns:

The ConnectFuture associated with this asynchronous operation

finishSessionInitialization0

protected final void finishSessionInitialization0(IoSession session,
 IoFuture future)

Adds required internal attributes and IoFutureListeners related with event notifications to the specified session and future. Do not call this method directly;

Overrides:

finishSessionInitialization0 in class AbstractIoService

Parameters:

session - The session to initialize

future - The Future to use

toString

public String toString()

Overrides:

toString in class Object