org.jboss.netty.channel.socket.oio

类 OioClientSocketChannelFactory

java.lang.Object

org.jboss.netty.channel.socket.oio.OioClientSocketChannelFactory

所有已实现的接口:

ChannelFactory, ClientSocketChannelFactory, ExternalResourceReleasable

public class OioClientSocketChannelFactory
extends java.lang.Object
implements ClientSocketChannelFactory

A ClientSocketChannelFactory which creates a client-side blocking I/O based SocketChannel. It utilizes the good old blocking I/O API which is known to yield better throughput and latency when there are relatively small number of connections to serve.

How threads work

There is only one type of threads in OioClientSocketChannelFactory; worker threads.

Worker threads

Each connected Channel has a dedicated worker thread, just like a traditional blocking I/O thread model.

Life cycle of threads and graceful shutdown

Worker threads are acquired from the Executor which was specified when a OioClientSocketChannelFactory was created (i.e. workerExecutor.) Therefore, you should make sure the specified Executor is able to lend the sufficient number of threads.

Worker threads are acquired lazily, and then released when there's nothing left to process. All the related resources are also released when the worker threads are released. Therefore, to shut down a service gracefully, you should do the following:

1. close all channels created by the factory usually using ChannelGroup.close(), and
2. call releaseExternalResources().

Please make sure not to shut down the executor until all channels are closed. Otherwise, you will end up with a RejectedExecutionException and the related resources might not be released properly.

Limitation

A SocketChannel created by this factory does not support asynchronous operations. Any I/O requests such as "connect" and "write" will be performed in a blocking manner.

构造器概要

构造器

构造器和说明
OioClientSocketChannelFactory() Creates a new instance with a Executors.newCachedThreadPool() as worker executor.
OioClientSocketChannelFactory(java.util.concurrent.Executor workerExecutor) Creates a new instance.
OioClientSocketChannelFactory(java.util.concurrent.Executor workerExecutor, ThreadNameDeterminer determiner) Creates a new instance.

方法概要

方法

限定符和类型	方法和说明
SocketChannel	newChannel(ChannelPipeline pipeline) Creates and opens a new Channel and attaches the specified ChannelPipeline to the new Channel.
void	releaseExternalResources() Releases the external resources that this factory depends on to function.
void	shutdown() Shudown the ChannelFactory and all the resource it created internal.

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

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

构造器详细资料

OioClientSocketChannelFactory

public OioClientSocketChannelFactory()

Creates a new instance with a Executors.newCachedThreadPool() as worker executor. See OioClientSocketChannelFactory(Executor)

OioClientSocketChannelFactory

public OioClientSocketChannelFactory(java.util.concurrent.Executor workerExecutor)

Creates a new instance.

参数:

workerExecutor - the Executor which will execute the I/O worker threads

OioClientSocketChannelFactory

public OioClientSocketChannelFactory(java.util.concurrent.Executor workerExecutor,
                             ThreadNameDeterminer determiner)

Creates a new instance.

参数:

workerExecutor - the Executor which will execute the I/O worker threads

determiner - the ThreadNameDeterminer to set the thread names.

方法详细资料

newChannel

public SocketChannel newChannel(ChannelPipeline pipeline)

从接口复制的说明: ChannelFactory

Creates and opens a new Channel and attaches the specified ChannelPipeline to the new Channel.

指定者:

newChannel 在接口中 ChannelFactory

指定者:

newChannel 在接口中 ClientSocketChannelFactory

参数:

pipeline - the ChannelPipeline which is going to be attached to the new Channel

返回:

the newly open channel

shutdown

public void shutdown()

从接口复制的说明: ChannelFactory

Shudown the ChannelFactory and all the resource it created internal.

指定者:

shutdown 在接口中 ChannelFactory

releaseExternalResources

public void releaseExternalResources()

从接口复制的说明: ChannelFactory

Releases the external resources that this factory depends on to function. An external resource is a resource that this factory didn't create by itself. For example, Executors that you specified in the factory constructor are external resources. You can call this method to release all external resources conveniently when the resources are not used by this factory or any other part of your application. An unexpected behavior will be resulted in if the resources are released when there's an open channel which is managed by this factory. This will also call ChannelFactory.shutdown() before do any action

指定者:

releaseExternalResources 在接口中 ChannelFactory

指定者:

releaseExternalResources 在接口中 ExternalResourceReleasable