public class DefaultListeningIOReactor extends Object implements ConnectionAcceptor
ConnectionInitiator
and ConnectionAcceptor. Internally this I/O reactor distributes newly created
I/O session equally across multiple I/O worker threads 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.| Constructor and Description |
|---|
DefaultListeningIOReactor(IOEventHandlerFactory eventHandlerFactory)
Creates an instance of DefaultListeningIOReactor with default configuration.
|
DefaultListeningIOReactor(IOEventHandlerFactory eventHandlerFactory,
IOReactorConfig config,
Callback<IOSession> sessionShutdownCallback)
Creates an instance of DefaultListeningIOReactor with the given configuration.
|
DefaultListeningIOReactor(IOEventHandlerFactory eventHandlerFactory,
IOReactorConfig ioReactorConfig,
ThreadFactory dispatchThreadFactory,
ThreadFactory listenerThreadFactory,
Decorator<IOSession> ioSessionDecorator,
Callback<Exception> exceptionCallback,
IOSessionListener sessionListener,
Callback<IOSession> sessionShutdownCallback)
Creates an instance of DefaultListeningIOReactor with the given configuration.
|
| Modifier and Type | Method and Description |
|---|---|
void |
awaitShutdown(TimeValue waitTime)
Blocks for the given period of time in milliseconds awaiting
the completion of the reactor shutdown.
|
void |
close() |
void |
close(CloseMode closeMode)
Shuts down the I/O reactor either gracefully or immediately.
|
Future<IOSession> |
connect(NamedEndpoint remoteEndpoint,
SocketAddress remoteAddress,
SocketAddress localAddress,
Timeout timeout,
Object attachment,
FutureCallback<IOSession> callback)
Requests a connection to a remote host.
|
Set<ListenerEndpoint> |
getEndpoints()
Returns a set of endpoints for this I/O reactor.
|
IOReactorStatus |
getStatus()
Returns the current status of the reactor.
|
void |
initiateShutdown()
Initiates shutdown of the reactor without blocking.
|
Future<ListenerEndpoint> |
listen(SocketAddress address) |
Future<ListenerEndpoint> |
listen(SocketAddress address,
FutureCallback<ListenerEndpoint> callback)
Opens a new listener endpoint with the given socket address.
|
Future<ListenerEndpoint> |
listen(SocketAddress address,
Object attachment,
FutureCallback<ListenerEndpoint> callback)
Opens a new listener endpoint with the given socket address.
|
void |
pause()
Suspends the I/O reactor preventing it from accepting new connections on
all active endpoints.
|
void |
resume()
Resumes the I/O reactor restoring its ability to accept incoming
connections on all active endpoints.
|
void |
start()
Starts I/O reactor.
|
public DefaultListeningIOReactor(IOEventHandlerFactory eventHandlerFactory, IOReactorConfig ioReactorConfig, ThreadFactory dispatchThreadFactory, ThreadFactory listenerThreadFactory, Decorator<IOSession> ioSessionDecorator, Callback<Exception> exceptionCallback, IOSessionListener sessionListener, Callback<IOSession> sessionShutdownCallback)
eventHandlerFactory - the factory to create I/O event handlers.ioReactorConfig - I/O reactor configuration.listenerThreadFactory - the factory to create listener thread.
Can be null.public DefaultListeningIOReactor(IOEventHandlerFactory eventHandlerFactory, IOReactorConfig config, Callback<IOSession> sessionShutdownCallback)
eventHandlerFactory - the factory to create I/O event handlers.config - I/O reactor configuration.
Can be null.public DefaultListeningIOReactor(IOEventHandlerFactory eventHandlerFactory)
eventHandlerFactory - the factory to create I/O event handlers.public void start()
IOReactorServicestart in interface IOReactorServicepublic Future<ListenerEndpoint> listen(SocketAddress address, Object attachment, FutureCallback<ListenerEndpoint> callback)
ConnectionAcceptorlisten in interface ConnectionAcceptoraddress - the socket address to listen on.attachment - the attachment object.callback - the result callback.public Future<ListenerEndpoint> listen(SocketAddress address, FutureCallback<ListenerEndpoint> callback)
ConnectionAcceptorlisten in interface ConnectionAcceptoraddress - the socket address to listen on.callback - the result callback.public Future<ListenerEndpoint> listen(SocketAddress address)
public Set<ListenerEndpoint> getEndpoints()
ConnectionAcceptorgetEndpoints in interface ConnectionAcceptorpublic void pause()
throws IOException
ConnectionAcceptorpause in interface ConnectionAcceptorIOException - in case of an I/O error.public void resume()
throws IOException
ConnectionAcceptorresume in interface ConnectionAcceptorIOException - in case of an I/O error.public IOReactorStatus getStatus()
IOReactorpublic void initiateShutdown()
IOReactorinitiateShutdown in interface IOReactorpublic void awaitShutdown(TimeValue waitTime) throws InterruptedException
IOReactorawaitShutdown in interface IOReactorwaitTime - wait time.InterruptedExceptionpublic void close(CloseMode closeMode)
IOReactorclose in interface ModalCloseableclose in interface IOReactorcloseMode - How to close the receiver.public void close()
throws IOException
close in interface Closeableclose in interface AutoCloseableIOExceptionpublic final Future<IOSession> connect(NamedEndpoint remoteEndpoint, SocketAddress remoteAddress, SocketAddress localAddress, Timeout timeout, Object attachment, FutureCallback<IOSession> callback) throws IOReactorShutdownException
ConnectionInitiator
Opening a connection to a remote host usually tends to be a time
consuming process and may take a while to complete. One can monitor and
control the process of session initialization by means of the
Future interface.
There are several parameters one can use to exert a greater control over the process of session initialization:
A non-null local socket address parameter can be used to bind the socket to a specific local address.
An attachment object can added to the new session's context upon initialization. This object can be used to pass an initial processing state to the protocol handler.
It is often desirable to be able to react to the completion of a session
request asynchronously without having to wait for it, blocking the
current thread of execution. One can optionally provide an implementation
FutureCallback instance to get notified of events related
to session requests, such as request completion, cancellation, failure or
timeout.
connect in interface ConnectionInitiatorremoteEndpoint - name of the remote host.remoteAddress - remote socket address.localAddress - local socket address. Can be null,
in which can the default local address and a random port will be used.timeout - connect timeout.attachment - the attachment object. Can be null.callback - interface. Can be null.IOReactorShutdownExceptionCopyright © 2005–2021 The Apache Software Foundation. All rights reserved.