Package org.apache.http.impl.nio.reactor

Class DefaultConnectingIOReactor

java.lang.Object

org.apache.http.impl.nio.reactor.AbstractMultiworkerIOReactor

org.apache.http.impl.nio.reactor.DefaultConnectingIOReactor

All Implemented Interfaces:

ConnectingIOReactor, IOReactor

public class DefaultConnectingIOReactor
extends AbstractMultiworkerIOReactor
implements ConnectingIOReactor

Default implementation of ConnectingIOReactor. This class extends AbstractMultiworkerIOReactor with capability to connect to remote hosts.

Since:

4.0

Nested Class Summary

Nested classes/interfaces inherited from class org.apache.http.impl.nio.reactor.AbstractMultiworkerIOReactor

AbstractMultiworkerIOReactor.DefaultThreadFactory, AbstractMultiworkerIOReactor.Worker

Field Summary

Fields

Modifier and Type	Field	Description
private long	lastTimeoutCheck
private java.util.Queue<SessionRequestImpl>	requestQueue

Fields inherited from class org.apache.http.impl.nio.reactor.AbstractMultiworkerIOReactor

auditLog, config, exceptionHandler, interestOpsQueueing, params, selector, selectTimeout, status

Constructor Summary

Constructors

Constructor	Description
DefaultConnectingIOReactor()	Creates an instance of DefaultConnectingIOReactor with default configuration.
DefaultConnectingIOReactor(int workerCount, java.util.concurrent.ThreadFactory threadFactory, HttpParams params)	Deprecated. (4.2) use DefaultConnectingIOReactor(IOReactorConfig, ThreadFactory)
DefaultConnectingIOReactor(int workerCount, HttpParams params)	Deprecated. (4.2) use DefaultConnectingIOReactor(IOReactorConfig)
DefaultConnectingIOReactor(IOReactorConfig config)	Creates an instance of DefaultConnectingIOReactor with the given configuration.
DefaultConnectingIOReactor(IOReactorConfig config, java.util.concurrent.ThreadFactory threadFactory)	Creates an instance of DefaultConnectingIOReactor with the given configuration.

Method Summary

Modifier and Type	Method	Description
protected void	cancelRequests()	Triggered to cancel pending session requests.
SessionRequest	connect(java.net.SocketAddress remoteAddress, java.net.SocketAddress localAddress, java.lang.Object attachment, SessionRequestCallback callback)	Requests a connection to a remote host.
private void	processEvent(java.nio.channels.SelectionKey key)
protected void	processEvents(int readyCount)	Triggered to process I/O events registered by the main Selector.
private void	processSessionRequests()
private void	processTimeouts(java.util.Set<java.nio.channels.SelectionKey> keys)
private void	validateAddress(java.net.SocketAddress address)

Methods inherited from class org.apache.http.impl.nio.reactor.AbstractMultiworkerIOReactor

addChannel, addExceptionEvent, addExceptionEvent, awaitShutdown, closeChannel, convert, doShutdown, execute, getAuditLog, getStatus, prepareSocket, registerChannel, setExceptionHandler, shutdown, shutdown

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.apache.http.nio.reactor.IOReactor

execute, getStatus, shutdown, shutdown

Field Detail

requestQueue

private final java.util.Queue<SessionRequestImpl> requestQueue

lastTimeoutCheck

private long lastTimeoutCheck

Constructor Detail

DefaultConnectingIOReactor

public DefaultConnectingIOReactor(IOReactorConfig config,
                                  java.util.concurrent.ThreadFactory threadFactory)
                           throws IOReactorException

Creates an instance of DefaultConnectingIOReactor with the given configuration.

Parameters:

config - I/O reactor configuration.

threadFactory - the factory to create threads. Can be null.

Throws:

IOReactorException - in case if a non-recoverable I/O error.

Since:

4.2

DefaultConnectingIOReactor

public DefaultConnectingIOReactor(IOReactorConfig config)
                           throws IOReactorException

Creates an instance of DefaultConnectingIOReactor with the given configuration.

Parameters:

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

Throws:

IOReactorException - in case if a non-recoverable I/O error.

Since:

4.2

DefaultConnectingIOReactor

public DefaultConnectingIOReactor()
                           throws IOReactorException

Creates an instance of DefaultConnectingIOReactor with default configuration.

Throws:

IOReactorException - in case if a non-recoverable I/O error.

Since:

4.2

DefaultConnectingIOReactor

@Deprecated
public DefaultConnectingIOReactor(int workerCount,
                                  java.util.concurrent.ThreadFactory threadFactory,
                                  HttpParams params)
                           throws IOReactorException

Deprecated.

(4.2) use DefaultConnectingIOReactor(IOReactorConfig, ThreadFactory)

Throws:

IOReactorException

DefaultConnectingIOReactor

@Deprecated
public DefaultConnectingIOReactor(int workerCount,
                                  HttpParams params)
                           throws IOReactorException

Deprecated.

(4.2) use DefaultConnectingIOReactor(IOReactorConfig)

Throws:

IOReactorException

Method Detail

cancelRequests

protected void cancelRequests()
                       throws IOReactorException

Description copied from class: AbstractMultiworkerIOReactor

Triggered to cancel pending session requests.

Super-classes can implement this method to react to the event.

Specified by:

cancelRequests in class AbstractMultiworkerIOReactor

Throws:

IOReactorException - in case if a non-recoverable I/O error.

processEvents

protected void processEvents(int readyCount)
                      throws IOReactorException

Description copied from class: AbstractMultiworkerIOReactor

Triggered to process I/O events registered by the main Selector.

Super-classes can implement this method to react to the event.

Specified by:

processEvents in class AbstractMultiworkerIOReactor

Parameters:

readyCount - event count.

Throws:

IOReactorException - in case if a non-recoverable I/O error.

processEvent

private void processEvent(java.nio.channels.SelectionKey key)

processTimeouts

private void processTimeouts(java.util.Set<java.nio.channels.SelectionKey> keys)

connect

public SessionRequest connect(java.net.SocketAddress remoteAddress,
                              java.net.SocketAddress localAddress,
                              java.lang.Object attachment,
                              SessionRequestCallback callback)

Description copied from interface: ConnectingIOReactor

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 SessionRequest 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 SessionRequestCallback instance to get notified of events related to session requests, such as request completion, cancellation, failure or timeout.

Specified by:

connect in interface ConnectingIOReactor

Parameters:

remoteAddress - the socket address of the remote host.

localAddress - the local socket address. Can be null, in which can the default local address and a random port will be used.

attachment - the attachment object. Can be null.

callback - interface. Can be null.

Returns:

session request object.

validateAddress

private void validateAddress(java.net.SocketAddress address)
                      throws java.net.UnknownHostException

Throws:

java.net.UnknownHostException

processSessionRequests

private void processSessionRequests()
                             throws IOReactorException

Throws:

IOReactorException