Class OioDatagramChannelFactory
- All Implemented Interfaces:
ChannelFactory
,DatagramChannelFactory
,ExternalResourceReleasable
DatagramChannelFactory
which creates a blocking I/O based
DatagramChannel
. 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 Channel
has 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 Executor
which was specified
when a OioDatagramChannelFactory
was created (i.e. workerExecutor
.)
Therefore, you should make sure the specified Executor
is 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()
.
RejectedExecutionException
and the related resources might not be released properly.
Limitation
A DatagramChannel
created by this factory does not support asynchronous
operations. Any I/O requests such as "write"
will be performed in a
blocking manner.
-
Field Summary
FieldsModifier and TypeFieldDescriptionprivate boolean
(package private) final OioDatagramPipelineSink
private final Executor
-
Constructor Summary
ConstructorsConstructorDescriptionCreates a new instance with aExecutors.newCachedThreadPool()
SeeOioDatagramChannelFactory(Executor)
OioDatagramChannelFactory
(Executor workerExecutor) Creates a new instance.OioDatagramChannelFactory
(Executor workerExecutor, ThreadNameDeterminer determiner) Creates a new instance. -
Method Summary
Modifier and TypeMethodDescriptionnewChannel
(ChannelPipeline pipeline) void
Releases the external resources that this factory depends on to function.void
shutdown()
Shudown the ChannelFactory and all the resource it created internal.
-
Field Details
-
workerExecutor
-
sink
-
shutdownExecutor
private boolean shutdownExecutor
-
-
Constructor Details
-
OioDatagramChannelFactory
public OioDatagramChannelFactory()Creates a new instance with aExecutors.newCachedThreadPool()
SeeOioDatagramChannelFactory(Executor)
-
OioDatagramChannelFactory
Creates a new instance.- Parameters:
workerExecutor
- theExecutor
which will execute the I/O worker threads
-
OioDatagramChannelFactory
Creates a new instance.- Parameters:
workerExecutor
- theExecutor
which will execute the I/O worker threadsdeterminer
- theThreadNameDeterminer
to set the thread names.
-
-
Method Details
-
newChannel
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
-