org.apache.mina.transport.socket.nio

类 NioSocketConnector

java.lang.Object

org.apache.mina.core.service.AbstractIoService

org.apache.mina.core.service.AbstractIoConnector

org.apache.mina.core.polling.AbstractPollingIoConnector<NioSession,java.nio.channels.SocketChannel>

org.apache.mina.transport.socket.nio.NioSocketConnector

所有已实现的接口:

IoConnector, IoService, SocketConnector

public final class NioSocketConnector
extends AbstractPollingIoConnector<NioSession,java.nio.channels.SocketChannel>
implements SocketConnector

IoConnector for socket transport (TCP/IP).

作者:

Apache MINA Project

嵌套类概要

从类继承的嵌套类/接口 org.apache.mina.core.polling.AbstractPollingIoConnector

AbstractPollingIoConnector.ConnectionRequest

从类继承的嵌套类/接口 org.apache.mina.core.service.AbstractIoService

AbstractIoService.ServiceOperationFuture

字段概要

从类继承的字段 org.apache.mina.core.service.AbstractIoService

disposalLock, sessionConfig

构造器概要

构造器

构造器和说明
NioSocketConnector() Constructor for NioSocketConnector with default configuration (multiple thread model).
NioSocketConnector(java.lang.Class<? extends IoProcessor<NioSession>> processorClass) Constructor for NioSocketConnector with default configuration with default configuration which will use a built-in thread pool executor to manage the default number of processor instances.
NioSocketConnector(java.lang.Class<? extends IoProcessor<NioSession>> processorClass, int processorCount) Constructor for NioSocketConnector with default configuration which will use a built-in thread pool executor to manage the given number of processor instances.
NioSocketConnector(java.util.concurrent.Executor executor, IoProcessor<NioSession> processor) Constructor for NioSocketConnector 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.
NioSocketConnector(int processorCount) Constructor for NioSocketConnector with default configuration, and given number of NioProcessor for multithreading I/O operations
NioSocketConnector(IoProcessor<NioSession> processor) Constructor for NioSocketConnector with default configuration but a specific IoProcessor, useful for sharing the same processor over multiple IoService of the same type.

方法概要

方法

限定符和类型	方法和说明
protected java.util.Iterator<java.nio.channels.SocketChannel>	allHandles() Iterator for all the client sockets polled for connection.
protected void	close(java.nio.channels.SocketChannel handle) Close a client socket.
protected boolean	connect(java.nio.channels.SocketChannel 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.nio.channels.SocketChannel 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.nio.channels.SocketChannel handle) get the AbstractPollingIoConnector.ConnectionRequest for a given client socket handle
java.net.InetSocketAddress	getDefaultRemoteAddress()
SocketSessionConfig	getSessionConfig()
TransportMetadata	getTransportMetadata()
protected void	init() Initialize the polling system, will be called at construction time.
protected java.nio.channels.SocketChannel	newHandle(java.net.SocketAddress localAddress) Create a new client socket handle from a local SocketAddress
protected NioSession	newSession(IoProcessor<NioSession> processor, java.nio.channels.SocketChannel handle) Create a new IoSession from a connected socket client handle.
protected void	register(java.nio.channels.SocketChannel 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.nio.channels.SocketChannel>	selectedHandles() Iterator for the set of client sockets found connected or failed to connect during the last AbstractPollingIoConnector.select(int) call.
void	setDefaultRemoteAddress(java.net.InetSocketAddress defaultRemoteAddress) Sets the default remote InetSocketAddress to connect to when no argument is specified in IoConnector.connect() method.
protected void	wakeup() Interrupt the AbstractPollingIoConnector.select(int) method.

从类继承的方法 org.apache.mina.core.polling.AbstractPollingIoConnector

connect0, dispose0

从类继承的方法 org.apache.mina.core.service.AbstractIoConnector

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

从类继承的方法 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

从类继承的方法 java.lang.Object

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

从接口继承的方法 org.apache.mina.core.service.IoConnector

connect, connect, connect, connect, connect, connect, getConnectTimeout, getConnectTimeoutMillis, getDefaultLocalAddress, setConnectTimeout, setConnectTimeoutMillis, setDefaultLocalAddress, setDefaultRemoteAddress

从接口继承的方法 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

构造器详细资料

NioSocketConnector

public NioSocketConnector()

Constructor for NioSocketConnector with default configuration (multiple thread model).

NioSocketConnector

public NioSocketConnector(int processorCount)

Constructor for NioSocketConnector with default configuration, and given number of NioProcessor for multithreading I/O operations

参数:

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

NioSocketConnector

public NioSocketConnector(IoProcessor<NioSession> processor)

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

参数:

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

NioSocketConnector

public NioSocketConnector(java.util.concurrent.Executor executor,
                  IoProcessor<NioSession> processor)

Constructor for NioSocketConnector 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.

参数:

executor - the executor for connection

processor - the processor for I/O operations

NioSocketConnector

public NioSocketConnector(java.lang.Class<? extends IoProcessor<NioSession>> processorClass,
                  int processorCount)

Constructor for NioSocketConnector with default configuration which will use a built-in thread pool executor to manage the given number of processor instances. The processor class must have a constructor that accepts ExecutorService or Executor as its single argument, or, failing that, a no-arg constructor.

参数:

processorClass - the processor class.

processorCount - the number of processors to instantiate.

从以下版本开始:

2.0.0-M4

另请参阅:

SimpleIoProcessorPool.SimpleIoProcessorPool(Class, Executor, int, java.nio.channels.spi.SelectorProvider)

NioSocketConnector

public NioSocketConnector(java.lang.Class<? extends IoProcessor<NioSession>> processorClass)

Constructor for NioSocketConnector with default configuration with default configuration which will use a built-in thread pool executor to manage the default number of processor instances. The processor class must have a constructor that accepts ExecutorService or Executor as its single argument, or, failing that, a no-arg constructor. The default number of instances is equal to the number of processor cores in the system, plus one.

参数:

processorClass - the processor class.

从以下版本开始:

2.0.0-M4

另请参阅:

SimpleIoProcessorPool.SimpleIoProcessorPool(Class, Executor, int, java.nio.channels.spi.SelectorProvider), SimpleIoProcessorPool.DEFAULT_SIZE

方法详细资料

init

protected void init()
             throws java.lang.Exception

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

指定者:

init 在类中 AbstractPollingIoConnector<NioSession,java.nio.channels.SocketChannel>

抛出:

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.

指定者:

destroy 在类中 AbstractPollingIoConnector<NioSession,java.nio.channels.SocketChannel>

抛出:

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

getTransportMetadata

public TransportMetadata getTransportMetadata()

指定者:

getTransportMetadata 在接口中 IoService

返回:

the TransportMetadata that this service runs on.

getSessionConfig

public SocketSessionConfig getSessionConfig()

指定者:

getSessionConfig 在接口中 IoService

指定者:

getSessionConfig 在接口中 SocketConnector

返回:

the default configuration of the new SocketSessions created by this connect service.

getDefaultRemoteAddress

public java.net.InetSocketAddress getDefaultRemoteAddress()

指定者:

getDefaultRemoteAddress 在接口中 IoConnector

指定者:

getDefaultRemoteAddress 在接口中 SocketConnector

覆盖:

getDefaultRemoteAddress 在类中 AbstractIoConnector

返回:

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

setDefaultRemoteAddress

public void setDefaultRemoteAddress(java.net.InetSocketAddress defaultRemoteAddress)

Sets the default remote InetSocketAddress to connect to when no argument is specified in IoConnector.connect() method. This method overrides the IoConnector.setDefaultRemoteAddress(java.net.SocketAddress) method.

指定者:

setDefaultRemoteAddress 在接口中 SocketConnector

参数:

defaultRemoteAddress - The remote address to set

allHandles

protected java.util.Iterator<java.nio.channels.SocketChannel> allHandles()

Iterator for all the client sockets polled for connection.

指定者:

allHandles 在类中 AbstractPollingIoConnector<NioSession,java.nio.channels.SocketChannel>

返回:

the list of client sockets currently polled for connection

connect

protected boolean connect(java.nio.channels.SocketChannel 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.

指定者:

connect 在类中 AbstractPollingIoConnector<NioSession,java.nio.channels.SocketChannel>

参数:

handle - the client socket handle

remoteAddress - the remote address where to connect

返回:

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

抛出:

java.lang.Exception - If the connect failed

getConnectionRequest

protected AbstractPollingIoConnector.ConnectionRequest getConnectionRequest(java.nio.channels.SocketChannel handle)

get the AbstractPollingIoConnector.ConnectionRequest for a given client socket handle

指定者:

getConnectionRequest 在类中 AbstractPollingIoConnector<NioSession,java.nio.channels.SocketChannel>

参数:

handle - the socket client handle

返回:

the connection request if the socket is connecting otherwise null

close

protected void close(java.nio.channels.SocketChannel handle)
              throws java.lang.Exception

Close a client socket.

指定者:

close 在类中 AbstractPollingIoConnector<NioSession,java.nio.channels.SocketChannel>

参数:

handle - the client socket

抛出:

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

finishConnect

protected boolean finishConnect(java.nio.channels.SocketChannel 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.

指定者:

finishConnect 在类中 AbstractPollingIoConnector<NioSession,java.nio.channels.SocketChannel>

参数:

handle - the client socket handle to finish to connect

返回:

true if the socket is connected

抛出:

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

newHandle

protected java.nio.channels.SocketChannel newHandle(java.net.SocketAddress localAddress)
                                             throws java.lang.Exception

Create a new client socket handle from a local SocketAddress

指定者:

newHandle 在类中 AbstractPollingIoConnector<NioSession,java.nio.channels.SocketChannel>

参数:

localAddress - the socket address for binding the new client socket

返回:

a new client socket handle

抛出:

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

newSession

protected NioSession newSession(IoProcessor<NioSession> processor,
                    java.nio.channels.SocketChannel handle)

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.

指定者:

newSession 在类中 AbstractPollingIoConnector<NioSession,java.nio.channels.SocketChannel>

参数:

processor - the processor in charge of this session

handle - the newly connected client socket handle

返回:

a new IoSession

register

protected void register(java.nio.channels.SocketChannel handle,
            AbstractPollingIoConnector.ConnectionRequest request)
                 throws java.lang.Exception

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

指定者:

register 在类中 AbstractPollingIoConnector<NioSession,java.nio.channels.SocketChannel>

参数:

handle - client socket handle

request - the associated AbstractPollingIoConnector.ConnectionRequest

抛出:

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()

指定者:

select 在类中 AbstractPollingIoConnector<NioSession,java.nio.channels.SocketChannel>

参数:

timeout - The timeout for the select() method

返回:

The number of socket having received some data

抛出:

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

selectedHandles

protected java.util.Iterator<java.nio.channels.SocketChannel> selectedHandles()

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

指定者:

selectedHandles 在类中 AbstractPollingIoConnector<NioSession,java.nio.channels.SocketChannel>

返回:

the list of client socket handles to process

wakeup

protected void wakeup()

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

指定者:

wakeup 在类中 AbstractPollingIoConnector<NioSession,java.nio.channels.SocketChannel>