aws-crt-cpp
Public Member Functions | Public Attributes | List of all members
Aws::Iot::WebsocketConfig Struct Reference

#include <MqttClient.h>

Public Member Functions

 WebsocketConfig (const Crt::String &signingRegion, Crt::Io::ClientBootstrap *bootstrap, Crt::Allocator *allocator=Crt::g_allocator) noexcept
 
 WebsocketConfig (const Crt::String &signingRegion, const std::shared_ptr< Crt::Auth::ICredentialsProvider > &credentialsProvider, Crt::Allocator *allocator=Crt::g_allocator) noexcept
 
 WebsocketConfig (const std::shared_ptr< Crt::Auth::ICredentialsProvider > &credentialsProvider, const std::shared_ptr< Crt::Auth::IHttpRequestSigner > &signer, CreateSigningConfig createSigningConfig) noexcept
 

Public Attributes

std::shared_ptr< Crt::Auth::ICredentialsProviderCredentialsProvider
 
std::shared_ptr< Crt::Auth::IHttpRequestSignerSigner
 
CreateSigningConfig CreateSigningConfigCb
 
Crt::Optional< Crt::Http::HttpClientConnectionProxyOptionsProxyOptions
 
Crt::String SigningRegion
 
Crt::String ServiceName
 

Constructor & Destructor Documentation

◆ WebsocketConfig() [1/3]

Aws::Iot::WebsocketConfig::WebsocketConfig ( const Crt::String signingRegion,
Crt::Io::ClientBootstrap bootstrap,
Crt::Allocator allocator = Crt::g_allocator 
)
noexcept

Create a websocket configuration for use with the default credentials provider chain. Signing region will be used for Sigv4 signature calculations.

◆ WebsocketConfig() [2/3]

Aws::Iot::WebsocketConfig::WebsocketConfig ( const Crt::String signingRegion,
const std::shared_ptr< Crt::Auth::ICredentialsProvider > &  credentialsProvider,
Crt::Allocator allocator = Crt::g_allocator 
)
noexcept

Create a websocket configuration for use with a custom credentials provider. Signing region will be use for Sigv4 signature calculations.

◆ WebsocketConfig() [3/3]

Aws::Iot::WebsocketConfig::WebsocketConfig ( const std::shared_ptr< Crt::Auth::ICredentialsProvider > &  credentialsProvider,
const std::shared_ptr< Crt::Auth::IHttpRequestSigner > &  signer,
Iot::CreateSigningConfig  createConfig 
)
noexcept

Create a websocket configuration for use with a custom credentials provider, and a custom signer.

You'll need to provide a function for use with creating a signing Config and pass it to createSigningConfig.

This is useful for cases use with: https://docs.aws.amazon.com/iot/latest/developerguide/custom-auth.html

Member Data Documentation

◆ CreateSigningConfigCb

CreateSigningConfig Aws::Iot::WebsocketConfig::CreateSigningConfigCb

◆ CredentialsProvider

std::shared_ptr<Crt::Auth::ICredentialsProvider> Aws::Iot::WebsocketConfig::CredentialsProvider

◆ ProxyOptions

Crt::Optional<Crt::Http::HttpClientConnectionProxyOptions> Aws::Iot::WebsocketConfig::ProxyOptions

Specify ProxyOptions to use a proxy with your websocket connection.

◆ ServiceName

Crt::String Aws::Iot::WebsocketConfig::ServiceName

◆ Signer

std::shared_ptr<Crt::Auth::IHttpRequestSigner> Aws::Iot::WebsocketConfig::Signer

◆ SigningRegion

Crt::String Aws::Iot::WebsocketConfig::SigningRegion

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