aws-crt-cpp
C++ wrapper around the aws-c-* libraries. Provides Cross-Platform Transport Protocols and SSL/TLS implementations for C++.
Public Member Functions | Public Attributes | List of all members
Aws::Crt::Http::HttpClientConnectionOptions Class Reference

#include <HttpConnection.h>

Public Member Functions

 HttpClientConnectionOptions ()
 
 HttpClientConnectionOptions (const HttpClientConnectionOptions &rhs)=default
 
 HttpClientConnectionOptions (HttpClientConnectionOptions &&rhs)=default
 
 ~HttpClientConnectionOptions ()=default
 
HttpClientConnectionOptionsoperator= (const HttpClientConnectionOptions &rhs)=default
 
HttpClientConnectionOptionsoperator= (HttpClientConnectionOptions &&rhs)=default
 

Public Attributes

Io::ClientBootstrapBootstrap
 
size_t InitialWindowSize
 
OnConnectionSetup OnConnectionSetupCallback
 
OnConnectionShutdown OnConnectionShutdownCallback
 
String HostName
 
uint32_t Port
 
Io::SocketOptions SocketOptions
 
Optional< Io::TlsConnectionOptionsTlsOptions
 
Optional< HttpClientConnectionProxyOptionsProxyOptions
 
bool ManualWindowManagement
 

Detailed Description

Configuration structure holding all options relating to http connection establishment

Constructor & Destructor Documentation

Aws::Crt::Http::HttpClientConnectionOptions::HttpClientConnectionOptions ( )
Aws::Crt::Http::HttpClientConnectionOptions::HttpClientConnectionOptions ( const HttpClientConnectionOptions rhs)
default
Aws::Crt::Http::HttpClientConnectionOptions::HttpClientConnectionOptions ( HttpClientConnectionOptions &&  rhs)
default
Aws::Crt::Http::HttpClientConnectionOptions::~HttpClientConnectionOptions ( )
default

Member Function Documentation

HttpClientConnectionOptions& Aws::Crt::Http::HttpClientConnectionOptions::operator= ( const HttpClientConnectionOptions rhs)
default
HttpClientConnectionOptions& Aws::Crt::Http::HttpClientConnectionOptions::operator= ( HttpClientConnectionOptions &&  rhs)
default

Member Data Documentation

Io::ClientBootstrap* Aws::Crt::Http::HttpClientConnectionOptions::Bootstrap

The client bootstrap to use for setting up and tearing down connections. Note: If null, then the default ClientBootstrap is used (see Aws::Crt::ApiHandle::GetOrCreateStaticDefaultClientBootstrap)

String Aws::Crt::Http::HttpClientConnectionOptions::HostName

The name of the http server to connect to. Required.

size_t Aws::Crt::Http::HttpClientConnectionOptions::InitialWindowSize

The TCP read window allowed for Http 1.1 connections and Initial Windows for H2 connections.

bool Aws::Crt::Http::HttpClientConnectionOptions::ManualWindowManagement

If set to true, then the TCP read back pressure mechanism will be enabled. You should only use this if you're allowing http response body data to escape the callbacks. E.g. you're putting the data into a queue for another thread to process and need to make sure the memory usage is bounded. If this is enabled, you must call HttpStream::UpdateWindow() for every byte read from the OnIncomingBody callback.

OnConnectionSetup Aws::Crt::Http::HttpClientConnectionOptions::OnConnectionSetupCallback

The callback invoked on connection establishment, whether success or failure. See OnConnectionSetup for more info. Required.

OnConnectionShutdown Aws::Crt::Http::HttpClientConnectionOptions::OnConnectionShutdownCallback

The callback invoked on connection shutdown. See OnConnectionShutdown for more info. Required.

uint32_t Aws::Crt::Http::HttpClientConnectionOptions::Port

The port of the http server to connect to. Required.

Optional<HttpClientConnectionProxyOptions> Aws::Crt::Http::HttpClientConnectionOptions::ProxyOptions

The proxy options for the http connection. Optional.

Io::SocketOptions Aws::Crt::Http::HttpClientConnectionOptions::SocketOptions

The socket options of the connection. Required.

Optional<Io::TlsConnectionOptions> Aws::Crt::Http::HttpClientConnectionOptions::TlsOptions

The TLS options for the http connection. Optional.


The documentation for this class was generated from the following files: