Class NioDatagramChannelFactory
- java.lang.Object
-
- org.jboss.netty.channel.socket.nio.NioDatagramChannelFactory
-
- All Implemented Interfaces:
ChannelFactory
,DatagramChannelFactory
,ExternalResourceReleasable
public class NioDatagramChannelFactory extends Object implements DatagramChannelFactory
ADatagramChannelFactory
that creates a NIO-based connectionlessDatagramChannel
. 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 is only one thread type in a
NioDatagramChannelFactory
; worker threads.Worker threads
One
NioDatagramChannelFactory
can have one or more worker threads. A worker thread performs non-blocking read and write for one or moreDatagramChannel
s in a non-blocking mode.Life cycle of threads and graceful shutdown
All worker threads are acquired from the
Executor
which was specified when aNioDatagramChannelFactory
was created. Therefore, you should make sure the specifiedExecutor
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:- close all channels created by the factory usually using
ChannelGroup.close()
, and - call
releaseExternalResources()
.
RejectedExecutionException
and the related resources might not be released properly.Limitation
Multicast is not supported. Please use
OioDatagramChannelFactory
instead.
-
-
Constructor Summary
Constructors Constructor Description NioDatagramChannelFactory()
Create a newNioDatagramChannelFactory
with aExecutors.newCachedThreadPool()
and without preferredInternetProtocolFamily
.NioDatagramChannelFactory(Executor workerExecutor)
Creates a new instance.NioDatagramChannelFactory(Executor workerExecutor, int workerCount)
Creates a new instance.NioDatagramChannelFactory(Executor workerExecutor, int workerCount, InternetProtocolFamily family)
Creates a new instance.NioDatagramChannelFactory(Executor workerExecutor, InternetProtocolFamily family)
Creates a new instance.NioDatagramChannelFactory(InternetProtocolFamily family)
Create a newNioDatagramChannelFactory
with aExecutors.newCachedThreadPool()
.NioDatagramChannelFactory(WorkerPool<NioDatagramWorker> workerPool)
Creates a new instance.NioDatagramChannelFactory(WorkerPool<NioDatagramWorker> workerPool, InternetProtocolFamily family)
Creates a new instance.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description DatagramChannel
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.
-
-
-
Constructor Detail
-
NioDatagramChannelFactory
public NioDatagramChannelFactory()
Create a newNioDatagramChannelFactory
with aExecutors.newCachedThreadPool()
and without preferredInternetProtocolFamily
. Please note that theInternetProtocolFamily
of the channel will be platform (and possibly configuration) dependent and therefore unspecified. UseNioDatagramChannelFactory(InternetProtocolFamily)
if unsure. SeeNioDatagramChannelFactory(Executor)
-
NioDatagramChannelFactory
public NioDatagramChannelFactory(InternetProtocolFamily family)
Create a newNioDatagramChannelFactory
with aExecutors.newCachedThreadPool()
. SeeNioDatagramChannelFactory(Executor)
-
NioDatagramChannelFactory
public NioDatagramChannelFactory(Executor workerExecutor)
Creates a new instance. Calling this constructor is same with callingNioDatagramChannelFactory(Executor, int)
with 2 * the number of available processors in the machine. The number of available processors is obtained byRuntime.availableProcessors()
.Please note that the
InternetProtocolFamily
of the channel will be platform (and possibly configuration) dependent and therefore unspecified. UseNioDatagramChannelFactory(Executor, InternetProtocolFamily)
if unsure.- Parameters:
workerExecutor
- theExecutor
which will execute the I/O worker threads
-
NioDatagramChannelFactory
public NioDatagramChannelFactory(Executor workerExecutor, int workerCount)
Creates a new instance.Please note that the
InternetProtocolFamily
of the channel will be platform (and possibly configuration) dependent and therefore unspecified. UseNioDatagramChannelFactory(Executor, int, InternetProtocolFamily)
if unsure.- Parameters:
workerExecutor
- theExecutor
which will execute the I/O worker threadsworkerCount
- the maximum number of I/O worker threads
-
NioDatagramChannelFactory
public NioDatagramChannelFactory(WorkerPool<NioDatagramWorker> workerPool)
Creates a new instance.Please note that the
InternetProtocolFamily
of the channel will be platform (and possibly configuration) dependent and therefore unspecified. UseNioDatagramChannelFactory(WorkerPool, InternetProtocolFamily)
if unsure.- Parameters:
workerPool
- theWorkerPool
which will be used to obtain theNioDatagramWorker
that execute the I/O worker threads
-
NioDatagramChannelFactory
public NioDatagramChannelFactory(Executor workerExecutor, InternetProtocolFamily family)
Creates a new instance. Calling this constructor is same with callingNioDatagramChannelFactory(Executor, int)
with 2 * the number of available processors in the machine. The number of available processors is obtained byRuntime.availableProcessors()
.- Parameters:
workerExecutor
- theExecutor
which will execute the I/O worker threadsfamily
- theInternetProtocolFamily
to use. This should be used for UDP multicast. Be aware that this option is only considered when running on java7+
-
NioDatagramChannelFactory
public NioDatagramChannelFactory(Executor workerExecutor, int workerCount, InternetProtocolFamily family)
Creates a new instance.- Parameters:
workerExecutor
- theExecutor
which will execute the I/O worker threadsworkerCount
- the maximum number of I/O worker threadsfamily
- theInternetProtocolFamily
to use. This should be used for UDP multicast. Be aware that this option is only considered when running on java7+
-
NioDatagramChannelFactory
public NioDatagramChannelFactory(WorkerPool<NioDatagramWorker> workerPool, InternetProtocolFamily family)
Creates a new instance.- Parameters:
workerPool
- theWorkerPool
which will be used to obtain theWorker
that execute the I/O worker threadsfamily
- theInternetProtocolFamily
to use. This should be used for UDP multicast. Be aware that this option is only considered when running on java7+
-
-
Method Detail
-
newChannel
public DatagramChannel newChannel(ChannelPipeline pipeline)
Description copied from interface:ChannelFactory
- Specified by:
newChannel
in interfaceChannelFactory
- Specified by:
newChannel
in interfaceDatagramChannelFactory
- 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
-
-