Class OioDatagramChannelFactory
- java.lang.Object
-
- org.jboss.netty.channel.socket.oio.OioDatagramChannelFactory
-
- All Implemented Interfaces:
ChannelFactory,DatagramChannelFactory,ExternalResourceReleasable
public class OioDatagramChannelFactory extends java.lang.Object implements DatagramChannelFactory
ADatagramChannelFactorywhich creates a blocking I/O basedDatagramChannel. It utilizes the good old blocking I/O API which has support for multicast.How threads work
There is only one type of threads in
OioDatagramChannelFactory; worker threads.Worker threads
Each
Channelhas 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
Executorwhich was specified when aOioDatagramChannelFactorywas created (i.e.workerExecutor.) Therefore, you should make sure the specifiedExecutoris 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:
- close all channels created by the factory usually using
ChannelGroup.close(), and - call
releaseExternalResources().
RejectedExecutionExceptionand the related resources might not be released properly.Limitation
A
DatagramChannelcreated by this factory does not support asynchronous operations. Any I/O requests such as"write"will be performed in a blocking manner.
-
-
Field Summary
Fields Modifier and Type Field Description private booleanshutdownExecutor(package private) OioDatagramPipelineSinksinkprivate java.util.concurrent.ExecutorworkerExecutor
-
Constructor Summary
Constructors Constructor Description OioDatagramChannelFactory()Creates a new instance with aExecutors.newCachedThreadPool()SeeOioDatagramChannelFactory(Executor)OioDatagramChannelFactory(java.util.concurrent.Executor workerExecutor)Creates a new instance.OioDatagramChannelFactory(java.util.concurrent.Executor workerExecutor, ThreadNameDeterminer determiner)Creates a new instance.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description DatagramChannelnewChannel(ChannelPipeline pipeline)voidreleaseExternalResources()Releases the external resources that this factory depends on to function.voidshutdown()Shudown the ChannelFactory and all the resource it created internal.
-
-
-
Field Detail
-
workerExecutor
private final java.util.concurrent.Executor workerExecutor
-
sink
final OioDatagramPipelineSink sink
-
shutdownExecutor
private boolean shutdownExecutor
-
-
Constructor Detail
-
OioDatagramChannelFactory
public OioDatagramChannelFactory()
Creates a new instance with aExecutors.newCachedThreadPool()SeeOioDatagramChannelFactory(Executor)
-
OioDatagramChannelFactory
public OioDatagramChannelFactory(java.util.concurrent.Executor workerExecutor)
Creates a new instance.- Parameters:
workerExecutor- theExecutorwhich will execute the I/O worker threads
-
OioDatagramChannelFactory
public OioDatagramChannelFactory(java.util.concurrent.Executor workerExecutor, ThreadNameDeterminer determiner)Creates a new instance.- Parameters:
workerExecutor- theExecutorwhich will execute the I/O worker threadsdeterminer- theThreadNameDeterminerto set the thread names.
-
-
Method Detail
-
newChannel
public DatagramChannel newChannel(ChannelPipeline pipeline)
Description copied from interface:ChannelFactory- Specified by:
newChannelin interfaceChannelFactory- Specified by:
newChannelin interfaceDatagramChannelFactory- Parameters:
pipeline- theChannelPipelinewhich is going to be attached to the newChannel- Returns:
- the newly open channel
-
shutdown
public void shutdown()
Description copied from interface:ChannelFactoryShudown the ChannelFactory and all the resource it created internal.- Specified by:
shutdownin interfaceChannelFactory
-
releaseExternalResources
public void releaseExternalResources()
Description copied from interface:ChannelFactoryReleases 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 callChannelFactory.shutdown()before do any action- Specified by:
releaseExternalResourcesin interfaceChannelFactory- Specified by:
releaseExternalResourcesin interfaceExternalResourceReleasable
-
-