public class NioDatagramChannelFactory extends Object implements DatagramChannelFactory
DatagramChannelFactory
that creates a NIO-based connectionless
DatagramChannel
. It utilizes the non-blocking I/O mode which
was introduced with NIO to serve many number of concurrent connections
efficiently.
There is only one thread type in a NioDatagramChannelFactory
;
worker threads.
One NioDatagramChannelFactory
can have one or more worker
threads. A worker thread performs non-blocking read and write for one or
more DatagramChannel
s in a non-blocking mode.
All worker threads are acquired from the Executor
which was specified
when a NioDatagramChannelFactory
was created. Therefore, you should
make sure the specified Executor
is able to lend the sufficient
number of threads. It is the best bet to specify
a cached thread pool.
All 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 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.
Multicast is not supported. Please use OioDatagramChannelFactory
instead.
Constructor and Description |
---|
NioDatagramChannelFactory()
Create a new
NioDatagramChannelFactory with a Executors.newCachedThreadPool()
and without preferred InternetProtocolFamily . |
NioDatagramChannelFactory(Executor workerExecutor)
Creates a new instance.
|
NioDatagramChannelFactory(Executor workerExecutor,
int workerCount)
Creates a new instance.
|
NioDatagramChannelFactory(Executor workerExecutor,
InternetProtocolFamily family)
Creates a new instance.
|
NioDatagramChannelFactory(Executor workerExecutor,
int workerCount,
InternetProtocolFamily family)
Creates a new instance.
|
NioDatagramChannelFactory(InternetProtocolFamily family)
Create a new
NioDatagramChannelFactory with a Executors.newCachedThreadPool() . |
NioDatagramChannelFactory(WorkerPool<NioDatagramWorker> workerPool)
Creates a new instance.
|
NioDatagramChannelFactory(WorkerPool<NioDatagramWorker> workerPool,
InternetProtocolFamily family)
Creates a new instance.
|
Modifier and Type | Method and Description |
---|---|
DatagramChannel |
newChannel(ChannelPipeline pipeline)
|
void |
releaseExternalResources()
Releases the external resources that this factory depends on to function.
|
public NioDatagramChannelFactory()
NioDatagramChannelFactory
with a Executors.newCachedThreadPool()
and without preferred InternetProtocolFamily
. Please note that the InternetProtocolFamily
of the channel will be platform (and possibly configuration) dependent and therefore
unspecified. Use NioDatagramChannelFactory(InternetProtocolFamily)
if unsure.
See NioDatagramChannelFactory(Executor)
public NioDatagramChannelFactory(InternetProtocolFamily family)
NioDatagramChannelFactory
with a Executors.newCachedThreadPool()
.
See NioDatagramChannelFactory(Executor)
public NioDatagramChannelFactory(Executor workerExecutor)
NioDatagramChannelFactory(Executor, int)
with 2 * the number of
available processors in the machine. The number of available processors
is obtained by Runtime.availableProcessors()
.
Please note that the InternetProtocolFamily
of the channel will be platform (and possibly
configuration) dependent and therefore unspecified.
Use NioDatagramChannelFactory(Executor, InternetProtocolFamily)
if unsure.
workerExecutor
- the Executor
which will execute the I/O worker threadspublic NioDatagramChannelFactory(Executor workerExecutor, int workerCount)
Please note that the InternetProtocolFamily
of the channel will be platform (and possibly
configuration) dependent and therefore unspecified.
Use NioDatagramChannelFactory(Executor, int, InternetProtocolFamily)
if unsure.
workerExecutor
- the Executor
which will execute the I/O worker threadsworkerCount
- the maximum number of I/O worker threadspublic NioDatagramChannelFactory(WorkerPool<NioDatagramWorker> workerPool)
Please note that the InternetProtocolFamily
of the channel will be platform (and possibly
configuration) dependent and therefore unspecified.
Use NioDatagramChannelFactory(WorkerPool, InternetProtocolFamily)
if unsure.
workerPool
- the WorkerPool
which will be used to obtain the NioDatagramWorker
that execute
the I/O worker threadspublic NioDatagramChannelFactory(Executor workerExecutor, InternetProtocolFamily family)
NioDatagramChannelFactory(Executor, int)
with 2 * the number of
available processors in the machine. The number of available processors
is obtained by Runtime.availableProcessors()
.workerExecutor
- the Executor
which will execute the I/O worker threadsfamily
- the InternetProtocolFamily
to use. This should be used for UDP multicast.
Be aware that this option is only considered when running on java7+public NioDatagramChannelFactory(Executor workerExecutor, int workerCount, InternetProtocolFamily family)
workerExecutor
- the Executor
which will execute the I/O worker threadsworkerCount
- the maximum number of I/O worker threadsfamily
- the InternetProtocolFamily
to use. This should be used for UDP multicast.
Be aware that this option is only considered when running on java7+public NioDatagramChannelFactory(WorkerPool<NioDatagramWorker> workerPool, InternetProtocolFamily family)
workerPool
- the WorkerPool
which will be used to obtain the Worker
that execute
the I/O worker threadsfamily
- the InternetProtocolFamily
to use. This should be used for UDP multicast.
Be aware that this option is only considered when running on java7+public DatagramChannel newChannel(ChannelPipeline pipeline)
ChannelFactory
newChannel
in interface ChannelFactory
newChannel
in interface DatagramChannelFactory
pipeline
- the ChannelPipeline
which is going to be
attached to the new Channel
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.releaseExternalResources
in interface ChannelFactory
releaseExternalResources
in interface ExternalResourceReleasable
Copyright © 2008-2013 The Netty Project. All Rights Reserved.