AWS IoT Device SDK C++ v2
1.34.0
AWS IoT Device SDK C++ v2
|
#include <MqttCommon.h>
Public Member Functions | |
WebsocketConfig (const Crt::String &signingRegion, Crt::Io::ClientBootstrap *bootstrap, Crt::Allocator *allocator=Crt::ApiAllocator()) noexcept | |
WebsocketConfig (const Crt::String &signingRegion, Crt::Allocator *allocator=Crt::ApiAllocator()) noexcept | |
WebsocketConfig (const Crt::String &signingRegion, const std::shared_ptr< Crt::Auth::ICredentialsProvider > &credentialsProvider, Crt::Allocator *allocator=Crt::ApiAllocator()) 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::ICredentialsProvider > | CredentialsProvider |
std::shared_ptr< Crt::Auth::IHttpRequestSigner > | Signer |
CreateSigningConfig | CreateSigningConfigCb |
Crt::Optional< Crt::Http::HttpClientConnectionProxyOptions > | ProxyOptions |
Crt::String | SigningRegion |
Crt::String | ServiceName |
Class encapsulating configuration for establishing an Aws IoT mqtt connection via websockets
|
noexcept |
Create a websocket configuration for use with the default credentials provider chain. Signing region will be used for Sigv4 signature calculations.
signingRegion | Aws region that is being connected to. Required in order to properly sign the handshake upgrade request |
bootstrap | client bootstrap to establish any connections needed by the default credentials provider chain which will get built for the user |
allocator | memory allocator to use |
|
noexcept |
Create a websocket configuration for use with the default credentials provider chain and default ClientBootstrap. Signing region will be used for Sigv4 signature calculations.
For more information on the default ClientBootstrap see Aws::Crt::ApiHandle::GetOrCreateDefaultClientBootstrap
signingRegion | Aws region that is being connected to. Required in order to properly sign the handshake upgrade request |
allocator | memory allocator to use |
|
noexcept |
Create a websocket configuration for use with a custom credentials provider. Signing region will be used for Sigv4 signature calculations.
signingRegion | Aws region that is being connected to. Required in order to properly sign the handshake upgrade request |
credentialsProvider | credentials provider to source AWS credentials from |
allocator | memory allocator to use |
|
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
credentialsProvider | credentials provider |
signer | HTTP request signer |
createSigningConfig | function that creates a signing config |
CreateSigningConfig Aws::Iot::WebsocketConfig::CreateSigningConfigCb |
std::shared_ptr<Crt::Auth::ICredentialsProvider> Aws::Iot::WebsocketConfig::CredentialsProvider |
Crt::Optional<Crt::Http::HttpClientConnectionProxyOptions> Aws::Iot::WebsocketConfig::ProxyOptions |
If MqttClientConnectionConfigBuilder::m_proxyOptions is valid, then that will be used over this value.
Crt::String Aws::Iot::WebsocketConfig::ServiceName |
std::shared_ptr<Crt::Auth::IHttpRequestSigner> Aws::Iot::WebsocketConfig::Signer |
Crt::String Aws::Iot::WebsocketConfig::SigningRegion |