org.apache.http.nio.reactor.ConnectingIOReactor Maven / Gradle / Ivy
Show all versions of httpcore-nio Show documentation
/*
* ====================================================================
* Licensed to the Apache Software Foundation (ASF) under one
* or more contributor license agreements. See the NOTICE file
* distributed with this work for additional information
* regarding copyright ownership. The ASF licenses this file
* to you under the Apache License, Version 2.0 (the
* "License"); you may not use this file except in compliance
* with the License. You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing,
* software distributed under the License is distributed on an
* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
* KIND, either express or implied. See the License for the
* specific language governing permissions and limitations
* under the License.
* ====================================================================
*
* This software consists of voluntary contributions made by many
* individuals on behalf of the Apache Software Foundation. For more
* information on the Apache Software Foundation, please see
* .
*
*/
package org.apache.http.nio.reactor;
import java.net.SocketAddress;
/**
* ConnectingIOReactor represents an I/O reactor capable of establishing
* connections to remote hosts.
*
* @since 4.0
*/
public interface ConnectingIOReactor extends IOReactor {
/**
* 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
* {@link 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
* {@link SessionRequestCallback} instance to get notified of events related
* to session requests, such as request completion, cancellation, failure or
* timeout.
*
* @param remoteAddress the socket address of the remote host.
* @param localAddress the local socket address. Can be {@code null},
* in which can the default local address and a random port will be used.
* @param attachment the attachment object. Can be {@code null}.
* @param callback interface. Can be {@code null}.
* @return session request object.
*/
SessionRequest connect(
SocketAddress remoteAddress,
SocketAddress localAddress,
Object attachment,
SessionRequestCallback callback);
}