Package software.amazon.awssdk.crt.http

Class HttpClientConnectionManager

java.lang.Object

software.amazon.awssdk.crt.CrtResource

software.amazon.awssdk.crt.http.HttpClientConnectionManager

All Implemented Interfaces:

AutoCloseable

public class HttpClientConnectionManager
extends CrtResource

Manages a Pool of Http Connections

Nested Class Summary

Nested classes/interfaces inherited from class software.amazon.awssdk.crt.CrtResource

CrtResource.ResourceInstance

Method Summary

Modifier and Type	Method	Description
CompletableFuture<HttpClientConnection>	acquireConnection()	Request a HttpClientConnection from the Connection Pool.
protected boolean	canReleaseReferencesImmediately()	Determines whether a resource releases its dependencies at the same time the native handle is released or if it waits.
static HttpClientConnectionManager	create(HttpClientConnectionManagerOptions options)	Factory function for HttpClientConnectionManager instances
int	getMaxConnections()
CompletableFuture<Void>	getShutdownCompleteFuture()
URI	getUri()
int	getWindowSize()
void	releaseConnection(HttpClientConnection conn)	Releases this HttpClientConnection back into the Connection Pool, and allows another Request to acquire this connection.
protected void	releaseNativeHandle()	Closes this Connection Pool and any pending Connection Acquisitions

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

acquireNativeHandle, addRef, addReferenceTo, close, collectNativeResource, collectNativeResources, decRef, getNativeHandle, getResourceLogDescription, isNull, logNativeResources, releaseReferences, removeReferenceTo, setDescription, swapReferenceTo, waitForNoResources

Methods inherited from class java.lang.Object

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

Method Detail

create

public static HttpClientConnectionManager create(HttpClientConnectionManagerOptions options)

Factory function for HttpClientConnectionManager instances

Parameters:

options - configuration options

Returns:

a new instance of an HttpClientConnectionManager

acquireConnection

public CompletableFuture<HttpClientConnection> acquireConnection()

Request a HttpClientConnection from the Connection Pool.

Returns:

A Future for a HttpClientConnection that will be completed when a connection is acquired.

releaseConnection

public void releaseConnection(HttpClientConnection conn)

Releases this HttpClientConnection back into the Connection Pool, and allows another Request to acquire this connection.

Parameters:

conn - Connection to release

canReleaseReferencesImmediately

protected boolean canReleaseReferencesImmediately()

Determines whether a resource releases its dependencies at the same time the native handle is released or if it waits. Resources that wait are responsible for calling releaseReferences() manually.

Specified by:

canReleaseReferencesImmediately in class CrtResource

Returns:

true if this resource releases synchronously, false if this resource performs async shutdown

releaseNativeHandle

protected void releaseNativeHandle()

Closes this Connection Pool and any pending Connection Acquisitions

Specified by:

releaseNativeHandle in class CrtResource

getShutdownCompleteFuture

public CompletableFuture<Void> getShutdownCompleteFuture()

getMaxConnections

public int getMaxConnections()

Returns:

maximum number of connections this connection manager will pool

getWindowSize

public int getWindowSize()

Returns:

size of the per-connection streaming read window for response handling

getUri

public URI getUri()

Returns:

uri the connection manager is making connections to