software.amazon.awssdk.crt.http

Class HttpConnection

java.lang.Object

software.amazon.awssdk.crt.CrtResource

software.amazon.awssdk.crt.http.HttpConnection

All Implemented Interfaces:

AutoCloseable

public class HttpConnection
extends CrtResource

This class wraps aws-c-http to provide the basic HTTP request/response functionality via the AWS Common Runtime. HttpConnection represents a single connection to a HTTP service endpoint. This class is not thread safe and should not be called from different threads.

Method Summary

Modifier and Type	Method and Description
void	close() Closes and frees this HttpConnection and any native sub-resources associated with this connection
static CompletableFuture<HttpConnection>	createConnection(URI uri, ClientBootstrap bootstrap, SocketOptions socketOptions, TlsContext tlsContext) Creates a new CompletableFuture for a new HttpConnection.
static CompletableFuture<HttpConnection>	createConnection(URI uri, ClientBootstrap bootstrap, SocketOptions socketOptions, TlsContext tlsContext, int windowSize) Creates a new CompletableFuture for a new HttpConnection.
CompletableFuture<Void>	getShutdownFuture() Returns the Shutdown Future
HttpStream	makeRequest(HttpRequest request, CrtHttpStreamHandler streamHandler) Schedules an HttpRequest on the Native EventLoop for this HttpConnection.
CompletableFuture<Void>	shutdown() Schedules a task on the Native EventLoop to shut down the current connection

Methods inherited from class software.amazon.awssdk.crt.CrtResource

acquire, getAllocatedNativeResourceCount, getAllocatedNativeResources, isNull, native_ptr, own, release

Methods inherited from class java.lang.Object

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

Method Detail

createConnection

public static CompletableFuture<HttpConnection> createConnection(URI uri,
                                                                 ClientBootstrap bootstrap,
                                                                 SocketOptions socketOptions,
                                                                 TlsContext tlsContext)
                                                          throws CrtRuntimeException

Creates a new CompletableFuture for a new HttpConnection.

Parameters:

uri - Must be non-null and contain a hostname

bootstrap - The ClientBootstrap to use for the Connection

socketOptions - The SocketOptions to use for the Connection

tlsContext - The TlsContext to use for the Connection

Returns:

CompletableFuture indicating when the connection has completed

Throws:

CrtRuntimeException - if Native threw a CrtRuntimeException

createConnection

public static CompletableFuture<HttpConnection> createConnection(URI uri,
                                                                 ClientBootstrap bootstrap,
                                                                 SocketOptions socketOptions,
                                                                 TlsContext tlsContext,
                                                                 int windowSize)
                                                          throws CrtRuntimeException

Creates a new CompletableFuture for a new HttpConnection.

Parameters:

uri - Must be non-null and contain a hostname

bootstrap - The ClientBootstrap to use for the Connection

socketOptions - The SocketOptions to use for the Connection

tlsContext - The TlsContext to use for the Connection

windowSize - The Initial Window size for requests made on this connection

Returns:

CompletableFuture indicating when the connection has completed

Throws:

CrtRuntimeException - if Native threw a CrtRuntimeException

makeRequest

public HttpStream makeRequest(HttpRequest request,
                              CrtHttpStreamHandler streamHandler)
                       throws CrtRuntimeException

Schedules an HttpRequest on the Native EventLoop for this HttpConnection.

Parameters:

request - The Request to make to the Server.

streamHandler - The Stream Handler to be called from the Native EventLoop

Returns:

The HttpStream that represents this Request/Response Pair. It can be closed at any time during the request/response, but must be closed by the user thread making this request when it's done.

Throws:

CrtRuntimeException

close

public void close()

Closes and frees this HttpConnection and any native sub-resources associated with this connection

Specified by:

close in interface AutoCloseable

Overrides:

close in class CrtResource

getShutdownFuture

public CompletableFuture<Void> getShutdownFuture()

Returns the Shutdown Future

Returns:

CompletableFuture that will be completed when the connection is shut down.

shutdown

public CompletableFuture<Void> shutdown()

Schedules a task on the Native EventLoop to shut down the current connection

Returns:

When this future completes, the shutdown is complete