Apache HttpComponents Core HTTP/1.1 5.2.4 · org.apache.hc.core5.reactor.AbstractIOReactorBase

Access	Constructor and Description
pack-priv	AbstractIOReactorBase()

Method Summary

Modifier and Type Method and Description

Modifier and Type	Method and Description
public final Future<IOSession>	connect(final NamedEndpoint name of the remote host. remoteEndpoint, final SocketAddress remote socket address. remoteAddress, final SocketAddress local socket address. Can be `null`, in which can the default local address and a random port will be used. localAddress, final Timeout connect timeout. timeout, final Object the attachment object. Can be `null`. attachment, final FutureCallback<IOSession> interface. Can be `null`. callback) Implements org.apache.hc.core5.reactor.ConnectionInitiator.connect. Requests a connection to a remote host.
pack-priv abstract IOWorkers.Selector	getWorkerSelector()

public final Future<IOSession>

connect(final NamedEndpoint

name of the remote host.

remoteEndpoint, final SocketAddress

remote socket address.

remoteAddress, final SocketAddress

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

localAddress, final Timeout

connect timeout.

timeout, final Object

the attachment object. Can be null.

attachment, final FutureCallback<IOSession>

interface. Can be null.

callback)

Implements org.apache.hc.core5.reactor.ConnectionInitiator.connect.

Requests a connection to a remote host.

pack-priv abstract IOWorkers.Selector

getWorkerSelector()

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

AbstractIOReactorBase	back to summary
pack-priv AbstractIOReactorBase()

Method Detail

connect back to summary

connect	back to summary
public final Future<IOSession> connect(final NamedEndpoint remoteEndpoint, final SocketAddress remoteAddress, final SocketAddress localAddress, final Timeout timeout, final Object attachment, final FutureCallback<IOSession> callback) throws IOReactorShutdownException Implements org.apache.hc.core5.reactor.ConnectionInitiator.connect. Doc from org.apache.hc.core5.reactor.ConnectionInitiator.connect. 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. Parameters remoteEndpoint:NamedEndpoint name of the remote host. remoteAddress:SocketAddress remote socket address. localAddress:SocketAddress local socket address. Can be `null`, in which can the default local address and a random port will be used. timeout:Timeout connect timeout. attachment:Object the attachment object. Can be `null`. callback:FutureCallback<IOSession> interface. Can be `null`. Returns:Future<IOSession> session request object. Annotations @Override

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

Implements org.apache.hc.core5.reactor.ConnectionInitiator.connect.

Doc from org.apache.hc.core5.reactor.ConnectionInitiator.connect.

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.

Parameters

remoteEndpoint:NamedEndpoint: name of the remote host.
remoteAddress:SocketAddress: remote socket address.
localAddress:SocketAddress: local socket address. Can be null, in which can the default local address and a random port will be used.
timeout:Timeout: connect timeout.
attachment:Object: the attachment object. Can be null.
callback:FutureCallback<IOSession>: interface. Can be null.

Returns:Future<IOSession>

session request object.

Annotations

@Override

getWorkerSelector	back to summary
pack-priv abstract IOWorkers.Selector getWorkerSelector()

pack-priv abstract Class AbstractIOReactorBase

Constructor Summary

Method Summary

Constructor Detail

Method Detail