Class NioClientSocketChannelFactory
- java.lang.Object
-
- org.jboss.netty.channel.socket.nio.NioClientSocketChannelFactory
-
- All Implemented Interfaces:
ChannelFactory
,ClientSocketChannelFactory
,ExternalResourceReleasable
public class NioClientSocketChannelFactory extends java.lang.Object implements ClientSocketChannelFactory
AClientSocketChannelFactory
which creates a client-side NIO-basedSocketChannel
. It utilizes the non-blocking I/O mode which was introduced with NIO to serve many number of concurrent connections efficiently.How threads work
There are two types of threads in a
NioClientSocketChannelFactory
; one is boss thread and the other is worker thread.Boss thread
One
NioClientSocketChannelFactory
has one boss thread. It makes a connection attempt on request. Once a connection attempt succeeds, the boss thread passes the connectedChannel
to one of the worker threads that theNioClientSocketChannelFactory
manages.Worker threads
One
NioClientSocketChannelFactory
can have one or more worker threads. A worker thread performs non-blocking read and write for one or moreChannel
s in a non-blocking mode.Life cycle of threads and graceful shutdown
All threads are acquired from the
Executor
s which were specified when aNioClientSocketChannelFactory
was created. A boss thread is acquired from thebossExecutor
, and worker threads are acquired from theworkerExecutor
. Therefore, you should make sure the specifiedExecutor
s are able to lend the sufficient number of threads. It is the best bet to specify a cached thread pool.Both boss and worker threads are acquired lazily, and then released when there's nothing left to process. All the related resources such as
Selector
are also released when the boss and worker threads are released. Therefore, to shut down a service gracefully, you should do the following:- close all channels created by the factory usually using
ChannelGroup.close()
, and - call
releaseExternalResources()
.
RejectedExecutionException
and the related resources might not be released properly.
-
-
Field Summary
Fields Modifier and Type Field Description private BossPool<NioClientBoss>
bossPool
private static int
DEFAULT_BOSS_COUNT
private boolean
releasePools
private NioClientSocketPipelineSink
sink
private WorkerPool<NioWorker>
workerPool
-
Constructor Summary
Constructors Constructor Description NioClientSocketChannelFactory()
Creates a newNioClientSocketChannelFactory
which usesExecutors.newCachedThreadPool()
for the worker and boss executors.NioClientSocketChannelFactory(java.util.concurrent.Executor bossExecutor, int bossCount, WorkerPool<NioWorker> workerPool)
Creates a new instance.NioClientSocketChannelFactory(java.util.concurrent.Executor bossExecutor, int bossCount, WorkerPool<NioWorker> workerPool, Timer timer)
Creates a new instance.NioClientSocketChannelFactory(java.util.concurrent.Executor bossExecutor, java.util.concurrent.Executor workerExecutor)
Creates a new instance.NioClientSocketChannelFactory(java.util.concurrent.Executor bossExecutor, java.util.concurrent.Executor workerExecutor, int workerCount)
Creates a new instance.NioClientSocketChannelFactory(java.util.concurrent.Executor bossExecutor, java.util.concurrent.Executor workerExecutor, int bossCount, int workerCount)
Creates a new instance.NioClientSocketChannelFactory(BossPool<NioClientBoss> bossPool, WorkerPool<NioWorker> workerPool)
Creates a new instance.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description SocketChannel
newChannel(ChannelPipeline pipeline)
void
releaseExternalResources()
Releases the external resources that this factory depends on to function.private void
releasePools()
void
shutdown()
Shudown the ChannelFactory and all the resource it created internal.
-
-
-
Field Detail
-
DEFAULT_BOSS_COUNT
private static final int DEFAULT_BOSS_COUNT
- See Also:
- Constant Field Values
-
bossPool
private final BossPool<NioClientBoss> bossPool
-
workerPool
private final WorkerPool<NioWorker> workerPool
-
sink
private final NioClientSocketPipelineSink sink
-
releasePools
private boolean releasePools
-
-
Constructor Detail
-
NioClientSocketChannelFactory
public NioClientSocketChannelFactory()
Creates a newNioClientSocketChannelFactory
which usesExecutors.newCachedThreadPool()
for the worker and boss executors. SeeNioClientSocketChannelFactory(Executor, Executor)
-
NioClientSocketChannelFactory
public NioClientSocketChannelFactory(java.util.concurrent.Executor bossExecutor, java.util.concurrent.Executor workerExecutor)
Creates a new instance. Calling this constructor is same with callingNioClientSocketChannelFactory(Executor, Executor, int, int)
with 1 and (2 * the number of available processors in the machine) for bossCount and workerCount respectively. The number of available processors is obtained byRuntime.availableProcessors()
.- Parameters:
bossExecutor
- theExecutor
which will execute the boss threadworkerExecutor
- theExecutor
which will execute the worker threads
-
NioClientSocketChannelFactory
public NioClientSocketChannelFactory(java.util.concurrent.Executor bossExecutor, java.util.concurrent.Executor workerExecutor, int workerCount)
Creates a new instance. Calling this constructor is same with callingNioClientSocketChannelFactory(Executor, Executor, int, int)
with 1 as bossCount.- Parameters:
bossExecutor
- theExecutor
which will execute the boss threadworkerExecutor
- theExecutor
which will execute the worker threadsworkerCount
- the maximum number of I/O worker threads
-
NioClientSocketChannelFactory
public NioClientSocketChannelFactory(java.util.concurrent.Executor bossExecutor, java.util.concurrent.Executor workerExecutor, int bossCount, int workerCount)
Creates a new instance.- Parameters:
bossExecutor
- theExecutor
which will execute the boss threadworkerExecutor
- theExecutor
which will execute the worker threadsbossCount
- the maximum number of boss threadsworkerCount
- the maximum number of I/O worker threads
-
NioClientSocketChannelFactory
public NioClientSocketChannelFactory(java.util.concurrent.Executor bossExecutor, int bossCount, WorkerPool<NioWorker> workerPool)
Creates a new instance.- Parameters:
bossExecutor
- theExecutor
which will execute the boss threadbossCount
- the maximum number of boss threadsworkerPool
- theWorkerPool
to use to do the IO
-
NioClientSocketChannelFactory
public NioClientSocketChannelFactory(java.util.concurrent.Executor bossExecutor, int bossCount, WorkerPool<NioWorker> workerPool, Timer timer)
Creates a new instance.- Parameters:
bossExecutor
- theExecutor
which will execute the boss threadbossCount
- the maximum number of boss threadsworkerPool
- theWorkerPool
to use to do the IOtimer
- theTimer
to use to handle the connection timeouts
-
NioClientSocketChannelFactory
public NioClientSocketChannelFactory(BossPool<NioClientBoss> bossPool, WorkerPool<NioWorker> workerPool)
Creates a new instance.- Parameters:
bossPool
- theBossPool
to use to handle the connectsworkerPool
- theWorkerPool
to use to do the IO
-
-
Method Detail
-
newChannel
public SocketChannel newChannel(ChannelPipeline pipeline)
Description copied from interface:ChannelFactory
- Specified by:
newChannel
in interfaceChannelFactory
- Specified by:
newChannel
in interfaceClientSocketChannelFactory
- Parameters:
pipeline
- theChannelPipeline
which is going to be attached to the newChannel
- Returns:
- the newly open channel
-
shutdown
public void shutdown()
Description copied from interface:ChannelFactory
Shudown the ChannelFactory and all the resource it created internal.- Specified by:
shutdown
in interfaceChannelFactory
-
releaseExternalResources
public void releaseExternalResources()
Description copied from interface: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,Executor
s 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 callChannelFactory.shutdown()
before do any action- Specified by:
releaseExternalResources
in interfaceChannelFactory
- Specified by:
releaseExternalResources
in interfaceExternalResourceReleasable
-
releasePools
private void releasePools()
-
-