public class NioClientSocketChannelFactory extends Object implements ClientSocketChannelFactory
ClientSocketChannelFactory
which creates a client-side NIO-based
SocketChannel
. It utilizes the non-blocking I/O mode which was
introduced with NIO to serve many number of concurrent connections
efficiently.
There are two types of threads in a NioClientSocketChannelFactory
;
one is boss thread and the other is worker thread.
One NioClientSocketChannelFactory
has one boss thread. It makes
a connection attempt on request. Once a connection attempt succeeds,
the boss thread passes the connected Channel
to one of the worker
threads that the NioClientSocketChannelFactory
manages.
One NioClientSocketChannelFactory
can have one or more worker
threads. A worker thread performs non-blocking read and write for one or
more Channel
s in a non-blocking mode.
All threads are acquired from the Executor
s which were specified
when a NioClientSocketChannelFactory
was created. A boss thread is
acquired from the bossExecutor
, and worker threads are acquired from
the workerExecutor
. Therefore, you should make sure the specified
Executor
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:
ChannelGroup.close()
, andreleaseExternalResources()
.RejectedExecutionException
and the related resources might not be released properly.Constructor and Description |
---|
NioClientSocketChannelFactory()
Creates a new
NioClientSocketChannelFactory which uses Executors.newCachedThreadPool()
for the worker and boss executors. |
NioClientSocketChannelFactory(BossPool<NioClientBoss> bossPool,
WorkerPool<NioWorker> workerPool)
Creates a new instance.
|
NioClientSocketChannelFactory(Executor bossExecutor,
Executor workerExecutor)
Creates a new instance.
|
NioClientSocketChannelFactory(Executor bossExecutor,
Executor workerExecutor,
int workerCount)
Creates a new instance.
|
NioClientSocketChannelFactory(Executor bossExecutor,
Executor workerExecutor,
int bossCount,
int workerCount)
Creates a new instance.
|
NioClientSocketChannelFactory(Executor bossExecutor,
int bossCount,
WorkerPool<NioWorker> workerPool)
Creates a new instance.
|
NioClientSocketChannelFactory(Executor bossExecutor,
int bossCount,
WorkerPool<NioWorker> workerPool,
Timer timer)
Creates a new instance.
|
Modifier and Type | Method and Description |
---|---|
SocketChannel |
newChannel(ChannelPipeline pipeline)
|
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.
|
public NioClientSocketChannelFactory()
NioClientSocketChannelFactory
which uses Executors.newCachedThreadPool()
for the worker and boss executors.
See NioClientSocketChannelFactory(Executor, Executor)
public NioClientSocketChannelFactory(Executor bossExecutor, Executor workerExecutor)
NioClientSocketChannelFactory(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 by Runtime.availableProcessors()
.public NioClientSocketChannelFactory(Executor bossExecutor, Executor workerExecutor, int workerCount)
NioClientSocketChannelFactory(Executor, Executor, int, int)
with
1 as bossCount.public NioClientSocketChannelFactory(Executor bossExecutor, Executor workerExecutor, int bossCount, int workerCount)
public NioClientSocketChannelFactory(Executor bossExecutor, int bossCount, WorkerPool<NioWorker> workerPool)
bossExecutor
- the Executor
which will execute the boss threadbossCount
- the maximum number of boss threadsworkerPool
- the WorkerPool
to use to do the IOpublic NioClientSocketChannelFactory(Executor bossExecutor, int bossCount, WorkerPool<NioWorker> workerPool, Timer timer)
bossExecutor
- the Executor
which will execute the boss threadbossCount
- the maximum number of boss threadsworkerPool
- the WorkerPool
to use to do the IOtimer
- the Timer
to use to handle the connection timeoutspublic NioClientSocketChannelFactory(BossPool<NioClientBoss> bossPool, WorkerPool<NioWorker> workerPool)
bossPool
- the BossPool
to use to handle the connectsworkerPool
- the WorkerPool
to use to do the IOpublic SocketChannel newChannel(ChannelPipeline pipeline)
ChannelFactory
newChannel
in interface ChannelFactory
newChannel
in interface ClientSocketChannelFactory
pipeline
- the ChannelPipeline
which is going to be
attached to the new Channel
public void shutdown()
ChannelFactory
shutdown
in interface ChannelFactory
public void releaseExternalResources()
ChannelFactory
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 call ChannelFactory.shutdown()
before do any actionreleaseExternalResources
in interface ChannelFactory
releaseExternalResources
in interface ExternalResourceReleasable
Copyright © 2008-2014 The Netty Project. All Rights Reserved.