org.apache.hc.core5.reactor

类 DefaultListeningIOReactor

java.lang.Object

org.apache.hc.core5.reactor.DefaultListeningIOReactor

所有已实现的接口:

Closeable, AutoCloseable, ModalCloseable, ConnectionAcceptor, ConnectionInitiator, IOReactor, IOReactorService

public class DefaultListeningIOReactor
extends Object
implements ConnectionAcceptor

Multi-core I/O reactor that can act as both 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.

从以下版本开始:

4.0

构造器概要

构造器

构造器和说明
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.

方法概要

限定符和类型	方法和说明
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.

从类继承的方法 java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

构造器详细资料

DefaultListeningIOReactor

public 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.

参数:

eventHandlerFactory - the factory to create I/O event handlers.

ioReactorConfig - I/O reactor configuration.

listenerThreadFactory - the factory to create listener thread. Can be null.

从以下版本开始:

5.0

DefaultListeningIOReactor

public DefaultListeningIOReactor(IOEventHandlerFactory eventHandlerFactory,
                                 IOReactorConfig config,
                                 Callback<IOSession> sessionShutdownCallback)

Creates an instance of DefaultListeningIOReactor with the given configuration.

参数:

eventHandlerFactory - the factory to create I/O event handlers.

config - I/O reactor configuration. Can be null.

从以下版本开始:

5.0

DefaultListeningIOReactor

public DefaultListeningIOReactor(IOEventHandlerFactory eventHandlerFactory)

Creates an instance of DefaultListeningIOReactor with default configuration.

参数:

eventHandlerFactory - the factory to create I/O event handlers.

从以下版本开始:

5.0

方法详细资料

start

public void start()

从接口复制的说明: IOReactorService

Starts I/O reactor.

指定者:

start 在接口中 IOReactorService

listen

public Future<ListenerEndpoint> listen(SocketAddress address,
                                       Object attachment,
                                       FutureCallback<ListenerEndpoint> callback)

从接口复制的说明: ConnectionAcceptor

Opens a new listener endpoint with the given socket address. Once the endpoint is fully initialized it starts accepting incoming connections and propagates I/O activity notifications to the I/O event dispatcher.

指定者:

listen 在接口中 ConnectionAcceptor

参数:

address - the socket address to listen on.

attachment - the attachment object.

callback - the result callback.

返回:

listener endpoint.

listen

public Future<ListenerEndpoint> listen(SocketAddress address,
                                       FutureCallback<ListenerEndpoint> callback)

从接口复制的说明: ConnectionAcceptor

Opens a new listener endpoint with the given socket address. Once the endpoint is fully initialized it starts accepting incoming connections and propagates I/O activity notifications to the I/O event dispatcher.

指定者:

listen 在接口中 ConnectionAcceptor

参数:

address - the socket address to listen on.

callback - the result callback.

返回:

listener endpoint.

listen

public Future<ListenerEndpoint> listen(SocketAddress address)

getEndpoints

public Set<ListenerEndpoint> getEndpoints()

从接口复制的说明: ConnectionAcceptor

Returns a set of endpoints for this I/O reactor.

指定者:

getEndpoints 在接口中 ConnectionAcceptor

返回:

set of endpoints.

pause

public void pause()
           throws IOException

从接口复制的说明: ConnectionAcceptor

Suspends the I/O reactor preventing it from accepting new connections on all active endpoints.

指定者:

pause 在接口中 ConnectionAcceptor

抛出:

IOException - in case of an I/O error.

resume

public void resume()
            throws IOException

从接口复制的说明: ConnectionAcceptor

Resumes the I/O reactor restoring its ability to accept incoming connections on all active endpoints.

指定者:

resume 在接口中 ConnectionAcceptor

抛出:

IOException - in case of an I/O error.

getStatus

public IOReactorStatus getStatus()

从接口复制的说明: IOReactor

Returns the current status of the reactor.

指定者:

getStatus 在接口中 IOReactor

返回:

reactor status.

initiateShutdown

public void initiateShutdown()

从接口复制的说明: IOReactor

Initiates shutdown of the reactor without blocking. The reactor is expected to terminate all active connections, to shut down itself and to release system resources it currently holds

指定者:

initiateShutdown 在接口中 IOReactor

awaitShutdown

public void awaitShutdown(TimeValue waitTime)
                   throws InterruptedException

从接口复制的说明: IOReactor

Blocks for the given period of time in milliseconds awaiting the completion of the reactor shutdown.

指定者:

awaitShutdown 在接口中 IOReactor

参数:

waitTime - wait time.

抛出:

InterruptedException

close

public void close(CloseMode closeMode)

从接口复制的说明: IOReactor

Shuts down the I/O reactor either gracefully or immediately. During graceful shutdown individual I/O sessions should be informed about imminent termination and be given a grace period to complete the ongoing I/O sessions. During immediate shutdown all ongoing I/O sessions get aborted immediately.

指定者:

close 在接口中 ModalCloseable

指定者:

close 在接口中 IOReactor

参数:

closeMode - How to close the receiver.

close

public void close()
           throws IOException

指定者:

close 在接口中 Closeable

指定者:

close 在接口中 AutoCloseable

抛出:

IOException

connect

public final Future<IOSession> connect(NamedEndpoint remoteEndpoint,
                                       SocketAddress remoteAddress,
                                       SocketAddress localAddress,
                                       Timeout timeout,
                                       Object attachment,
                                       FutureCallback<IOSession> callback)
                                throws IOReactorShutdownException

从接口复制的说明: ConnectionInitiator

Requests a connection to a remote host.

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 在接口中 ConnectionInitiator

参数:

remoteEndpoint - 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.

返回:

session request object.

抛出:

IOReactorShutdownException