public abstract class AbstractMultiworkerIOReactor extends Object implements IOReactor
IOReactor
that can run multiple
BaseIOReactor
instance in separate worker threads and distribute
newly created I/O session equally across those I/O reactors for a more
optimal resource utilization and a better I/O performance. Usually it is
recommended to have one worker I/O reactor per physical CPU core.
Important note about exception handling
Protocol specific exceptions as well as those I/O exceptions thrown in the course of interaction with the session's channel are to be expected are to be dealt with by specific protocol handlers. These exceptions may result in termination of an individual session but should not affect the I/O reactor and all other active sessions. There are situations, however, when the I/O reactor itself encounters an internal problem such as an I/O exception in the underlying NIO classes or an unhandled runtime exception. Those types of exceptions are usually fatal and will cause the I/O reactor to shut down automatically.
There is a possibility to override this behavior and prevent I/O reactors
from shutting down automatically in case of a runtime exception or an I/O
exception in internal classes. This can be accomplished by providing a custom
implementation of the IOReactorExceptionHandler
interface.
If an I/O reactor is unable to automatically recover from an I/O or a runtime
exception it will enter the shutdown mode. First off, it cancel all pending
new session requests. Then it will attempt to close all active I/O sessions
gracefully giving them some time to flush pending output data and terminate
cleanly. Lastly, it will forcibly shut down those I/O sessions that still
remain active after the grace period. This is a fairly complex process, where
many things can fail at the same time and many different exceptions can be
thrown in the course of the shutdown process. The I/O reactor will record all
exceptions thrown during the shutdown process, including the original one
that actually caused the shutdown in the first place, in an audit log. One
can obtain the audit log using getAuditLog()
, examine exceptions
thrown by the I/O reactor prior and in the course of the reactor shutdown
and decide whether it is safe to restart the I/O reactor.
Constructor and Description |
---|
AbstractMultiworkerIOReactor()
Creates an instance of AbstractMultiworkerIOReactor with default configuration.
|
AbstractMultiworkerIOReactor(int workerCount,
ThreadFactory threadFactory,
HttpParams params)
Deprecated.
|
AbstractMultiworkerIOReactor(IOReactorConfig config,
ThreadFactory threadFactory)
Creates an instance of AbstractMultiworkerIOReactor with the given configuration.
|
Modifier and Type | Method and Description |
---|---|
void |
execute(IOEventDispatch eventDispatch)
Activates the main I/O reactor as well as all worker I/O reactors.
|
List<ExceptionEvent> |
getAuditLog()
Returns the audit log containing exceptions thrown by the I/O reactor
prior and in the course of the reactor shutdown.
|
IOReactorStatus |
getStatus()
Returns the current status of the reactor.
|
void |
setExceptionHandler(IOReactorExceptionHandler exceptionHandler)
Sets exception handler for this I/O reactor.
|
void |
shutdown()
Initiates shutdown of the reactor and blocks for a default period of
time waiting for the reactor to terminate all active connections, to shut
down itself and to release system resources it currently holds.
|
void |
shutdown(long waitMs)
Initiates shutdown of the reactor and blocks approximately for the given
period of time in milliseconds waiting for the reactor to terminate all
active connections, to shut down itself and to release system resources
it currently holds.
|
public AbstractMultiworkerIOReactor(IOReactorConfig config, ThreadFactory threadFactory) throws IOReactorException
config
- I/O reactor configuration.threadFactory
- the factory to create threads.
Can be null
.IOReactorException
- in case if a non-recoverable I/O error.public AbstractMultiworkerIOReactor() throws IOReactorException
IOReactorException
- in case if a non-recoverable I/O error.@Deprecated public AbstractMultiworkerIOReactor(int workerCount, ThreadFactory threadFactory, HttpParams params) throws IOReactorException
AbstractMultiworkerIOReactor(IOReactorConfig, ThreadFactory)
workerCount
- number of worker I/O reactors.threadFactory
- the factory to create threads.
Can be null
.params
- HTTP parameters.IOReactorException
- in case if a non-recoverable I/O error.public IOReactorStatus getStatus()
IOReactor
public List<ExceptionEvent> getAuditLog()
public void setExceptionHandler(IOReactorExceptionHandler exceptionHandler)
exceptionHandler
- the exception handler.public void execute(IOEventDispatch eventDispatch) throws InterruptedIOException, IOReactorException
IOEventDispatch
interface.
This method will enter the infinite I/O select loop on
the Selector
instance associated with this I/O reactor and used
to manage creation of new I/O channels. Once a new I/O channel has been
created the processing of I/O events on that channel will be delegated
to one of the worker I/O reactors.
The method will remain blocked unto the I/O reactor is shut down or the execution thread is interrupted.
execute
in interface IOReactor
eventDispatch
- the I/O event dispatch.InterruptedIOException
- if the dispatch thread is interrupted.IOReactorException
- in case if a non-recoverable I/O error.processEvents(int)
,
cancelRequests()
public void shutdown() throws IOException
IOReactor
shutdown
in interface IOReactor
IOException
- in case of an I/O error.public void shutdown(long waitMs) throws IOException
IOReactor
shutdown
in interface IOReactor
waitMs
- wait time in milliseconds.IOException
- in case of an I/O error.Copyright © 2010 - 2020 Adobe. All Rights Reserved