org.asyncflows.protocol.http.client.AHttpRequest Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of asyncflows-protocol-http Show documentation
This component contains implementation of HTTP 1.1 protocol.
There is a newer version: 0.1.1
Show newest version
/*
 * Copyright (c) 2018 Konstantin Plotnikov
 *
 * Permission is hereby granted, free of charge, to any person obtaining
 * a copy of this software and associated documentation files (the
 * "Software"), to deal in the Software without restriction, including
 * without limitation the rights to use, copy, modify, merge, publish,
 * distribute, sublicense, and/or sell copies of the Software, and to
 * permit persons to whom the Software is furnished to do so, subject to
 * the following conditions:
 *
 * The above copyright notice and this permission notice shall be
 * included in all copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
 * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
 * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
 * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
 * LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
 * OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
 * WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
 */

package org.asyncflows.protocol.http.client;

import org.asyncflows.core.Promise;
import org.asyncflows.core.function.ACloseable;
import org.asyncflows.core.function.AResolver;
import org.asyncflows.io.AOutput;
import org.asyncflows.protocol.http.common.Scope;
import org.asyncflows.protocol.http.common.headers.HttpHeaders;

import java.net.SocketAddress;
import java.net.URI;
import java.nio.ByteBuffer;

/**
 * The HTTP request interface.
 *
 * @see org.asyncflows.protocol.http.common.HttpScopeUtil for addtional keys.
 */
public interface AHttpRequest extends ACloseable {
    // TODO additional transfer encodings
    /**
     * The continue listener. If it the version of the request is 1.1, then the listener is notified when the
     * continue intermediate reply is received. Note that this reply might never be received in case if the server
     * does not understand this header, so the client should watch some timer to check for the response.
     */
    Scope.Key> CONTINUE_LISTENER
            = new Scope.Key<>(AHttpRequest.class, "continueListener");

    /**
     * Set this key on the scope, if the request should connect to the host, that is different from the host specified
     * by URL.
     */
    Scope.Key CONNECTION_HOST = new Scope.Key<>(AHttpRequest.class, "connectionHost");
    /**
     * The constant meaning no-content.
     */
    long NO_CONTENT = -1L;

    /**
     * @return the remote address for the socket (hop only)
     */
    Promise getRemoteAddress();

    /**
     * @return the remote address for the socket (hop only)
     */
    Promise getLocalAddress();

    /**
     * Connect the specified server.
     *
     * @param scope   the scope that is used to provide additional parameters to the request .
     * @param method  the request method
     * @param uri     the url to connect to
     * @param headers the request headers
     * @param length  the content length or null ({@link #NO_CONTENT value means that there is no content})
     * @return a promise for the output stream associated with the request.
     */
    Promise> request(Scope scope, String method, URI uri,
                                         HttpHeaders headers, Long length);

    /**
     * @return the promise for HTTP response, when response type becomes finally known.
     */
    Promise getResponse();
}