Package org.apache.hc.core5.reactor

Class SingleCoreIOReactor

java.lang.Object

org.apache.hc.core5.reactor.AbstractSingleCoreIOReactor

org.apache.hc.core5.reactor.SingleCoreIOReactor

All Implemented Interfaces:

Closeable, AutoCloseable, ModalCloseable, ConnectionInitiator, IOReactor

class SingleCoreIOReactor
extends AbstractSingleCoreIOReactor
implements ConnectionInitiator

Field Summary

Fields

Modifier and Type	Field	Description
private final Queue<ChannelEntry>	channelQueue
private final Queue<InternalDataChannel>	closedSessions
private final IOEventHandlerFactory	eventHandlerFactory
private final Decorator<IOSession>	ioSessionDecorator
private long	lastTimeoutCheckMillis
private static final int	MAX_CHANNEL_REQUESTS
private final IOReactorConfig	reactorConfig
private final Queue<IOSessionRequest>	requestQueue
private final long	selectTimeoutMillis
private final IOSessionListener	sessionListener
private final Callback<IOSession>	sessionShutdownCallback
private final AtomicBoolean	shutdownInitiated

Fields inherited from class org.apache.hc.core5.reactor.AbstractSingleCoreIOReactor

selector

Constructor Summary

Constructors

Constructor	Description
SingleCoreIOReactor(Callback<Exception> exceptionCallback, IOEventHandlerFactory eventHandlerFactory, IOReactorConfig reactorConfig, Decorator<IOSession> ioSessionDecorator, IOSessionListener sessionListener, Callback<IOSession> sessionShutdownCallback)

Method Summary

Modifier and Type	Method	Description
private void	checkTimeout(SelectionKey key, long nowMillis)
private void	closePendingChannels()
private void	closePendingConnectionRequests()
Future<IOSession>	connect(NamedEndpoint remoteEndpoint, SocketAddress remoteAddress, SocketAddress localAddress, Timeout timeout, Object attachment, FutureCallback<IOSession> callback)	Requests a connection to a remote host.
(package private) void	doExecute()
(package private) void	doTerminate()
(package private) void	enqueueChannel(ChannelEntry entry)
private void	initiateSessionShutdown()
private void	prepareSocket(Socket socket)
private void	processClosedSessions()
private void	processConnectionRequest(SocketChannel socketChannel, IOSessionRequest sessionRequest)
private void	processEvents(Set<SelectionKey> selectedKeys)
private void	processPendingChannels()
private void	processPendingConnectionRequests()
private void	validateActiveChannels()
private void	validateAddress(SocketAddress address)

Methods inherited from class org.apache.hc.core5.reactor.AbstractSingleCoreIOReactor

awaitShutdown, close, close, close, execute, getStatus, initiateShutdown, logException, toString

Methods inherited from class java.lang.Object

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

Field Details

MAX_CHANNEL_REQUESTS

private static final int MAX_CHANNEL_REQUESTS

See Also:

• Constant Field Values

eventHandlerFactory

private final IOEventHandlerFactory eventHandlerFactory

reactorConfig

private final IOReactorConfig reactorConfig

ioSessionDecorator

private final Decorator<IOSession> ioSessionDecorator

sessionListener

private final IOSessionListener sessionListener

sessionShutdownCallback

private final Callback<IOSession> sessionShutdownCallback

closedSessions

private final Queue<InternalDataChannel> closedSessions

channelQueue

private final Queue<ChannelEntry> channelQueue

requestQueue

private final Queue<IOSessionRequest> requestQueue

shutdownInitiated

private final AtomicBoolean shutdownInitiated

selectTimeoutMillis

private final long selectTimeoutMillis

lastTimeoutCheckMillis

private volatile long lastTimeoutCheckMillis

Constructor Details

SingleCoreIOReactor

SingleCoreIOReactor(Callback<Exception> exceptionCallback,
 IOEventHandlerFactory eventHandlerFactory,
 IOReactorConfig reactorConfig,
 Decorator<IOSession> ioSessionDecorator,
 IOSessionListener sessionListener,
 Callback<IOSession> sessionShutdownCallback)

Method Details

enqueueChannel

void enqueueChannel(ChannelEntry entry)
             throws IOReactorShutdownException

Throws:

IOReactorShutdownException

doTerminate

void doTerminate()

Specified by:

doTerminate in class AbstractSingleCoreIOReactor

doExecute

void doExecute()
        throws IOException

Specified by:

doExecute in class AbstractSingleCoreIOReactor

Throws:

IOException

initiateSessionShutdown

private void initiateSessionShutdown()

validateActiveChannels

private void validateActiveChannels()

processEvents

private void processEvents(Set<SelectionKey> selectedKeys)

processPendingChannels

private void processPendingChannels()
                             throws IOException

Throws:

IOException

processClosedSessions

private void processClosedSessions()

checkTimeout

private void checkTimeout(SelectionKey key,
 long nowMillis)

connect

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

Description copied from interface: 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.

Specified by:

connect in interface ConnectionInitiator

Parameters:

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.

Returns:

session request object.

Throws:

IOReactorShutdownException

prepareSocket

private void prepareSocket(Socket socket)
                    throws IOException

Throws:

IOException

validateAddress

private void validateAddress(SocketAddress address)
                      throws UnknownHostException

Throws:

UnknownHostException

processPendingConnectionRequests

private void processPendingConnectionRequests()

processConnectionRequest

private void processConnectionRequest(SocketChannel socketChannel,
 IOSessionRequest sessionRequest)
                               throws IOException

Throws:

IOException

closePendingChannels

private void closePendingChannels()

closePendingConnectionRequests

private void closePendingConnectionRequests()