diff --git a/docs/_allocator_8cpp.html b/docs/_allocator_8cpp.html new file mode 100644 index 000000000..e267f7376 --- /dev/null +++ b/docs/_allocator_8cpp.html @@ -0,0 +1,100 @@ + + +
+ + + + +
+ aws-crt-cpp
+
+ C++ wrapper around the aws-c-* libraries. Provides Cross-Platform Transport Protocols and SSL/TLS implementations for C++.
+ |
+
#include <aws/crt/Allocator.h>
+Namespaces | |
Aws | |
Aws::Crt | |
+Functions | |
AWS_CRT_CPP_API Allocator * | Aws::Crt::DefaultAllocatorImplementation () noexcept |
AWS_CRT_CPP_API Allocator * | Aws::Crt::DefaultAllocator () noexcept |
AWS_CRT_CPP_API Allocator * | Aws::Crt::ApiAllocator () noexcept |
+ aws-crt-cpp
+
+ C++ wrapper around the aws-c-* libraries. Provides Cross-Platform Transport Protocols and SSL/TLS implementations for C++.
+ |
+
Go to the source code of this file.
++Namespaces | |
Aws | |
Aws::Crt | |
+Typedefs | |
using | Aws::Crt::Allocator = aws_allocator |
+Functions | |
AWS_CRT_CPP_API Allocator * | Aws::Crt::ApiAllocator () noexcept |
AWS_CRT_CPP_API Allocator * | Aws::Crt::DefaultAllocatorImplementation () noexcept |
AWS_CRT_CPP_API Allocator * | Aws::Crt::DefaultAllocator () noexcept |
+Variables | |
AWS_CRT_CPP_API Allocator * | Aws::Crt::g_allocator = Aws::Crt::DefaultAllocatorImplementation() |
+ aws-crt-cpp
+
+ C++ wrapper around the aws-c-* libraries. Provides Cross-Platform Transport Protocols and SSL/TLS implementations for C++.
+ |
+
+ aws-crt-cpp
+
+ C++ wrapper around the aws-c-* libraries. Provides Cross-Platform Transport Protocols and SSL/TLS implementations for C++.
+ |
+
#include <aws/crt/Api.h>
#include <aws/crt/Config.h>
#include <aws/crt/JsonObject.h>
#include <aws/crt/StlAllocator.h>
#include <aws/crt/io/TlsOptions.h>
#include <aws/auth/auth.h>
#include <aws/common/ref_count.h>
#include <aws/event-stream/event_stream.h>
#include <aws/http/http.h>
#include <aws/mqtt/mqtt.h>
#include <aws/s3/s3.h>
#include <thread>
+Namespaces | |
Aws | |
Aws::Crt | |
+Functions | |
AWS_CRT_CPP_API const char * | Aws::Crt::ErrorDebugString (int error) noexcept |
AWS_CRT_CPP_API int | Aws::Crt::LastError () noexcept |
AWS_CRT_CPP_API int | Aws::Crt::LastErrorOrUnknown () noexcept |
+Variables | |
static Crypto::CreateHashCallback | Aws::Crt::s_BYOCryptoNewMD5Callback |
static Crypto::CreateHashCallback | Aws::Crt::s_BYOCryptoNewSHA256Callback |
static Crypto::CreateHMACCallback | Aws::Crt::s_BYOCryptoNewSHA256HMACCallback |
static Io::NewClientTlsHandlerCallback | Aws::Crt::s_BYOCryptoNewClientTlsHandlerCallback |
static Io::NewTlsContextImplCallback | Aws::Crt::s_BYOCryptoNewTlsContextImplCallback |
static Io::DeleteTlsContextImplCallback | Aws::Crt::s_BYOCryptoDeleteTlsContextImplCallback |
static Io::IsTlsAlpnSupportedCallback | Aws::Crt::s_BYOCryptoIsTlsAlpnSupportedCallback |
+ aws-crt-cpp
+
+ C++ wrapper around the aws-c-* libraries. Provides Cross-Platform Transport Protocols and SSL/TLS implementations for C++.
+ |
+
#include <aws/crt/Types.h>
#include <aws/crt/crypto/HMAC.h>
#include <aws/crt/crypto/Hash.h>
#include <aws/crt/mqtt/Mqtt5Client.h>
#include <aws/crt/mqtt/MqttClient.h>
#include <aws/common/logging.h>
Go to the source code of this file.
++Classes | |
class | Aws::Crt::ApiHandle |
struct | Aws::Crt::ApiHandle::Version |
+Namespaces | |
Aws | |
Aws::Crt | |
+Enumerations | |
enum class | Aws::Crt::LogLevel { + Aws::Crt::None = AWS_LL_NONE +, Aws::Crt::Fatal = AWS_LL_FATAL +, Aws::Crt::Error = AWS_LL_ERROR +, Aws::Crt::Warn = AWS_LL_WARN +, + Aws::Crt::Info = AWS_LL_INFO +, Aws::Crt::Debug = AWS_LL_DEBUG +, Aws::Crt::Trace = AWS_LL_TRACE +, Aws::Crt::Count + + } |
enum class | Aws::Crt::ApiHandleShutdownBehavior { Aws::Crt::Blocking +, Aws::Crt::NonBlocking + } |
+Functions | |
AWS_CRT_CPP_API const char * | Aws::Crt::ErrorDebugString (int error) noexcept |
AWS_CRT_CPP_API int | Aws::Crt::LastError () noexcept |
AWS_CRT_CPP_API int | Aws::Crt::LastErrorOrUnknown () noexcept |
+ aws-crt-cpp
+
+ C++ wrapper around the aws-c-* libraries. Provides Cross-Platform Transport Protocols and SSL/TLS implementations for C++.
+ |
+
+ aws-crt-cpp
+
+ C++ wrapper around the aws-c-* libraries. Provides Cross-Platform Transport Protocols and SSL/TLS implementations for C++.
+ |
+
+Namespaces | |
Aws | |
Aws::Crt | |
Aws::Crt::Io | |
+ aws-crt-cpp
+
+ C++ wrapper around the aws-c-* libraries. Provides Cross-Platform Transport Protocols and SSL/TLS implementations for C++.
+ |
+
#include <aws/crt/Exports.h>
#include <aws/crt/Types.h>
#include <aws/crt/io/EventLoopGroup.h>
#include <aws/crt/io/HostResolver.h>
#include <aws/io/channel_bootstrap.h>
#include <aws/io/host_resolver.h>
#include <future>
Go to the source code of this file.
++Classes | |
class | Aws::Crt::Io::ClientBootstrap |
+Namespaces | |
Aws | |
Aws::Crt | |
Aws::Crt::Io | |
+Typedefs | |
using | Aws::Crt::Io::OnClientBootstrapShutdownComplete = std::function< void()> |
+ aws-crt-cpp
+
+ C++ wrapper around the aws-c-* libraries. Provides Cross-Platform Transport Protocols and SSL/TLS implementations for C++.
+ |
+
+ aws-crt-cpp
+
+ C++ wrapper around the aws-c-* libraries. Provides Cross-Platform Transport Protocols and SSL/TLS implementations for C++.
+ |
+
+Classes | |
struct | Aws::Crt::Io::ChannelHandler |
struct | Aws::Crt::Io::TaskWrapper |
struct | Aws::Crt::Io::TaskWrapper::task |
+Namespaces | |
Aws | |
Aws::Crt | |
Aws::Crt::Io | |
+Functions | |
static void | Aws::Crt::Io::s_ChannelTaskCallback (struct aws_channel_task *, void *arg, enum aws_task_status status) |
+ aws-crt-cpp
+
+ C++ wrapper around the aws-c-* libraries. Provides Cross-Platform Transport Protocols and SSL/TLS implementations for C++.
+ |
+
#include <aws/crt/Exports.h>
#include <aws/crt/Types.h>
#include <aws/io/channel.h>
#include <chrono>
#include <cstddef>
Go to the source code of this file.
++Classes | |
struct | Aws::Crt::Io::ChannelHandler |
+Namespaces | |
Aws | |
Aws::Crt | |
Aws::Crt::Io | |
+Enumerations | |
enum class | Aws::Crt::Io::ChannelDirection { Aws::Crt::Io::Read +, Aws::Crt::Io::Write + } |
enum class | Aws::Crt::Io::MessageType { Aws::Crt::Io::ApplicationData + } |
enum class | Aws::Crt::Io::TaskStatus { Aws::Crt::Io::RunReady +, Aws::Crt::Io::Canceled + } |
+ aws-crt-cpp
+
+ C++ wrapper around the aws-c-* libraries. Provides Cross-Platform Transport Protocols and SSL/TLS implementations for C++.
+ |
+
+ aws-crt-cpp
+
+ C++ wrapper around the aws-c-* libraries. Provides Cross-Platform Transport Protocols and SSL/TLS implementations for C++.
+ |
+
#include <aws/crt/auth/Credentials.h>
#include <aws/crt/http/HttpConnection.h>
#include <aws/crt/http/HttpProxyStrategy.h>
#include <aws/auth/credentials.h>
#include <aws/common/string.h>
#include <algorithm>
#include <aws/http/connection.h>
#include <aws/crt/Api.h>
+Classes | |
struct | Aws::Crt::Auth::CredentialsProviderCallbackArgs |
struct | Aws::Crt::Auth::DelegateCredentialsProviderCallbackArgs |
+Namespaces | |
Aws | |
Aws::Crt | |
Aws::Crt::Auth | |
+Functions | |
static std::shared_ptr< ICredentialsProvider > | Aws::Crt::Auth::s_CreateWrappedProvider (struct aws_credentials_provider *raw_provider, Allocator *allocator) |
static int | Aws::Crt::Auth::s_onDelegateGetCredentials (void *delegate_user_data, aws_on_get_credentials_callback_fn callback, void *callback_user_data) |
static void | Aws::Crt::Auth::s_onDelegateShutdownComplete (void *user_data) |
+ aws-crt-cpp
+
+ C++ wrapper around the aws-c-* libraries. Provides Cross-Platform Transport Protocols and SSL/TLS implementations for C++.
+ |
+
#include <aws/crt/Exports.h>
#include <aws/crt/Types.h>
#include <aws/crt/http/HttpConnection.h>
#include <aws/crt/io/TlsOptions.h>
#include <chrono>
#include <functional>
Go to the source code of this file.
++Classes | |
class | Aws::Crt::Auth::Credentials |
class | Aws::Crt::Auth::ICredentialsProvider |
struct | Aws::Crt::Auth::CredentialsProviderStaticConfig |
struct | Aws::Crt::Auth::CredentialsProviderProfileConfig |
struct | Aws::Crt::Auth::CredentialsProviderImdsConfig |
struct | Aws::Crt::Auth::CredentialsProviderChainConfig |
struct | Aws::Crt::Auth::CredentialsProviderCachedConfig |
struct | Aws::Crt::Auth::CredentialsProviderChainDefaultConfig |
struct | Aws::Crt::Auth::CredentialsProviderX509Config |
struct | Aws::Crt::Auth::CredentialsProviderDelegateConfig |
struct | Aws::Crt::Auth::CognitoLoginPair |
struct | Aws::Crt::Auth::CredentialsProviderCognitoConfig |
struct | Aws::Crt::Auth::CredentialsProviderSTSConfig |
class | Aws::Crt::Auth::CredentialsProvider |
+Namespaces | |
Aws | |
Aws::Crt | |
Aws::Crt::Io | |
Aws::Crt::Http | |
Aws::Crt::Auth | |
+Typedefs | |
using | Aws::Crt::Auth::OnCredentialsResolved = std::function< void(std::shared_ptr< Credentials >, int errorCode)> |
using | Aws::Crt::Auth::GetCredentialsHandler = std::function< std::shared_ptr< Credentials >()> |
+ aws-crt-cpp
+
+ C++ wrapper around the aws-c-* libraries. Provides Cross-Platform Transport Protocols and SSL/TLS implementations for C++.
+ |
+
+ aws-crt-cpp
+
+ C++ wrapper around the aws-c-* libraries. Provides Cross-Platform Transport Protocols and SSL/TLS implementations for C++.
+ |
+
+ aws-crt-cpp
+
+ C++ wrapper around the aws-c-* libraries. Provides Cross-Platform Transport Protocols and SSL/TLS implementations for C++.
+ |
+
#include <aws/crt/Exports.h>
#include <aws/crt/Types.h>
#include <aws/common/date_time.h>
#include <chrono>
Go to the source code of this file.
++Classes | |
class | Aws::Crt::DateTime |
+Namespaces | |
Aws | |
Aws::Crt | |
+Enumerations | |
enum class | Aws::Crt::DateFormat { Aws::Crt::RFC822 = AWS_DATE_FORMAT_RFC822 +, Aws::Crt::ISO_8601 = AWS_DATE_FORMAT_ISO_8601 +, Aws::Crt::AutoDetect = AWS_DATE_FORMAT_AUTO_DETECT + } |
enum class | Aws::Crt::Month { + Aws::Crt::January = AWS_DATE_MONTH_JANUARY +, Aws::Crt::February = AWS_DATE_MONTH_FEBRUARY +, Aws::Crt::March = AWS_DATE_MONTH_MARCH +, Aws::Crt::April = AWS_DATE_MONTH_APRIL +, + Aws::Crt::May = AWS_DATE_MONTH_MAY +, Aws::Crt::June = AWS_DATE_MONTH_JUNE +, Aws::Crt::July = AWS_DATE_MONTH_JULY +, Aws::Crt::August = AWS_DATE_MONTH_AUGUST +, + Aws::Crt::September = AWS_DATE_MONTH_SEPTEMBER +, Aws::Crt::October = AWS_DATE_MONTH_OCTOBER +, Aws::Crt::November = AWS_DATE_MONTH_NOVEMBER +, Aws::Crt::December = AWS_DATE_MONTH_DECEMBER + + } |
enum class | Aws::Crt::DayOfWeek { + Aws::Crt::Sunday = AWS_DATE_DAY_OF_WEEK_SUNDAY +, Aws::Crt::Monday = AWS_DATE_DAY_OF_WEEK_MONDAY +, Aws::Crt::Tuesday = AWS_DATE_DAY_OF_WEEK_TUESDAY +, Aws::Crt::Wednesday = AWS_DATE_DAY_OF_WEEK_WEDNESDAY +, + Aws::Crt::Thursday = AWS_DATE_DAY_OF_WEEK_THURSDAY +, Aws::Crt::Friday = AWS_DATE_DAY_OF_WEEK_FRIDAY +, Aws::Crt::Saturday = AWS_DATE_DAY_OF_WEEK_SATURDAY + + } |
+ aws-crt-cpp
+
+ C++ wrapper around the aws-c-* libraries. Provides Cross-Platform Transport Protocols and SSL/TLS implementations for C++.
+ |
+
+ aws-crt-cpp
+
+ C++ wrapper around the aws-c-* libraries. Provides Cross-Platform Transport Protocols and SSL/TLS implementations for C++.
+ |
+
+Namespaces | |
Aws | |
Aws::Crt | |
Aws::Crt::Io | |
+ aws-crt-cpp
+
+ C++ wrapper around the aws-c-* libraries. Provides Cross-Platform Transport Protocols and SSL/TLS implementations for C++.
+ |
+
Go to the source code of this file.
++Classes | |
class | Aws::Crt::Io::EventLoopGroup |
+Namespaces | |
Aws | |
Aws::Crt | |
Aws::Crt::Io | |
+ aws-crt-cpp
+
+ C++ wrapper around the aws-c-* libraries. Provides Cross-Platform Transport Protocols and SSL/TLS implementations for C++.
+ |
+
+ aws-crt-cpp
+
+ C++ wrapper around the aws-c-* libraries. Provides Cross-Platform Transport Protocols and SSL/TLS implementations for C++.
+ |
+
Go to the source code of this file.
++Macros | |
#define | AWS_CRT_CPP_API |
#define AWS_CRT_CPP_API | +
+ aws-crt-cpp
+
+ C++ wrapper around the aws-c-* libraries. Provides Cross-Platform Transport Protocols and SSL/TLS implementations for C++.
+ |
+
+ aws-crt-cpp
+
+ C++ wrapper around the aws-c-* libraries. Provides Cross-Platform Transport Protocols and SSL/TLS implementations for C++.
+ |
+
+Namespaces | |
Aws | |
Aws::Crt | |
Aws::Crt::Crypto | |
+Functions | |
bool AWS_CRT_CPP_API | Aws::Crt::Crypto::ComputeSHA256HMAC (Allocator *allocator, const ByteCursor &secret, const ByteCursor &input, ByteBuf &output, size_t truncateTo=0) noexcept |
bool AWS_CRT_CPP_API | Aws::Crt::Crypto::ComputeSHA256HMAC (const ByteCursor &secret, const ByteCursor &input, ByteBuf &output, size_t truncateTo=0) noexcept |
+ aws-crt-cpp
+
+ C++ wrapper around the aws-c-* libraries. Provides Cross-Platform Transport Protocols and SSL/TLS implementations for C++.
+ |
+
Go to the source code of this file.
++Classes | |
class | Aws::Crt::Crypto::HMAC |
class | Aws::Crt::Crypto::ByoHMAC |
+Namespaces | |
Aws | |
Aws::Crt | |
Aws::Crt::Crypto | |
+Typedefs | |
using | Aws::Crt::Crypto::CreateHMACCallback = std::function< std::shared_ptr< ByoHMAC >(size_t digestSize, const ByteCursor &secret, Allocator *)> |
+Functions | |
bool AWS_CRT_CPP_API | Aws::Crt::Crypto::ComputeSHA256HMAC (Allocator *allocator, const ByteCursor &secret, const ByteCursor &input, ByteBuf &output, size_t truncateTo=0) noexcept |
bool AWS_CRT_CPP_API | Aws::Crt::Crypto::ComputeSHA256HMAC (const ByteCursor &secret, const ByteCursor &input, ByteBuf &output, size_t truncateTo=0) noexcept |
+Variables | |
static const size_t | Aws::Crt::Crypto::SHA256_HMAC_DIGEST_SIZE = 32 |
+ aws-crt-cpp
+
+ C++ wrapper around the aws-c-* libraries. Provides Cross-Platform Transport Protocols and SSL/TLS implementations for C++.
+ |
+
+ aws-crt-cpp
+
+ C++ wrapper around the aws-c-* libraries. Provides Cross-Platform Transport Protocols and SSL/TLS implementations for C++.
+ |
+
+Namespaces | |
Aws | |
Aws::Crt | |
Aws::Crt::Crypto | |
+Functions | |
bool AWS_CRT_CPP_API | Aws::Crt::Crypto::ComputeSHA256 (Allocator *allocator, const ByteCursor &input, ByteBuf &output, size_t truncateTo=0) noexcept |
bool AWS_CRT_CPP_API | Aws::Crt::Crypto::ComputeSHA256 (const ByteCursor &input, ByteBuf &output, size_t truncateTo=0) noexcept |
bool AWS_CRT_CPP_API | Aws::Crt::Crypto::ComputeMD5 (Allocator *allocator, const ByteCursor &input, ByteBuf &output, size_t truncateTo=0) noexcept |
bool AWS_CRT_CPP_API | Aws::Crt::Crypto::ComputeMD5 (const ByteCursor &input, ByteBuf &output, size_t truncateTo=0) noexcept |
+ aws-crt-cpp
+
+ C++ wrapper around the aws-c-* libraries. Provides Cross-Platform Transport Protocols and SSL/TLS implementations for C++.
+ |
+
Go to the source code of this file.
++Classes | |
class | Aws::Crt::Crypto::Hash |
class | Aws::Crt::Crypto::ByoHash |
+Namespaces | |
Aws | |
Aws::Crt | |
Aws::Crt::Crypto | |
+Typedefs | |
using | Aws::Crt::Crypto::CreateHashCallback = std::function< std::shared_ptr< ByoHash >(size_t digestSize, Allocator *)> |
+Functions | |
bool AWS_CRT_CPP_API | Aws::Crt::Crypto::ComputeSHA256 (Allocator *allocator, const ByteCursor &input, ByteBuf &output, size_t truncateTo=0) noexcept |
bool AWS_CRT_CPP_API | Aws::Crt::Crypto::ComputeSHA256 (const ByteCursor &input, ByteBuf &output, size_t truncateTo=0) noexcept |
bool AWS_CRT_CPP_API | Aws::Crt::Crypto::ComputeMD5 (Allocator *allocator, const ByteCursor &input, ByteBuf &output, size_t truncateTo=0) noexcept |
bool AWS_CRT_CPP_API | Aws::Crt::Crypto::ComputeMD5 (const ByteCursor &input, ByteBuf &output, size_t truncateTo=0) noexcept |
+Variables | |
static const size_t | Aws::Crt::Crypto::SHA256_DIGEST_SIZE = 32 |
static const size_t | Aws::Crt::Crypto::MD5_DIGEST_SIZE = 16 |
+ aws-crt-cpp
+
+ C++ wrapper around the aws-c-* libraries. Provides Cross-Platform Transport Protocols and SSL/TLS implementations for C++.
+ |
+
+ aws-crt-cpp
+
+ C++ wrapper around the aws-c-* libraries. Provides Cross-Platform Transport Protocols and SSL/TLS implementations for C++.
+ |
+
#include <aws/crt/io/HostResolver.h>
#include <aws/crt/io/EventLoopGroup.h>
#include <aws/common/string.h>
#include <aws/crt/Api.h>
+Namespaces | |
Aws | |
Aws::Crt | |
Aws::Crt::Io | |
+ aws-crt-cpp
+
+ C++ wrapper around the aws-c-* libraries. Provides Cross-Platform Transport Protocols and SSL/TLS implementations for C++.
+ |
+
Go to the source code of this file.
++Classes | |
class | Aws::Crt::Io::HostResolver |
class | Aws::Crt::Io::DefaultHostResolver |
+Namespaces | |
Aws | |
Aws::Crt | |
Aws::Crt::Io | |
+Typedefs | |
using | Aws::Crt::Io::HostAddress = aws_host_address |
using | Aws::Crt::Io::OnHostResolved = std::function< void(HostResolver &resolver, const Vector< HostAddress > &addresses, int errorCode)> |
+ aws-crt-cpp
+
+ C++ wrapper around the aws-c-* libraries. Provides Cross-Platform Transport Protocols and SSL/TLS implementations for C++.
+ |
+
+ aws-crt-cpp
+
+ C++ wrapper around the aws-c-* libraries. Provides Cross-Platform Transport Protocols and SSL/TLS implementations for C++.
+ |
+
#include <aws/crt/Api.h>
#include <aws/crt/http/HttpConnection.h>
#include <aws/crt/http/HttpProxyStrategy.h>
#include <aws/crt/http/HttpRequestResponse.h>
#include <aws/crt/io/Bootstrap.h>
+Classes | |
struct | Aws::Crt::Http::ConnectionCallbackData |
class | Aws::Crt::Http::UnmanagedConnection |
+Namespaces | |
Aws | |
Aws::Crt | |
Aws::Crt::Http | |
+ aws-crt-cpp
+
+ C++ wrapper around the aws-c-* libraries. Provides Cross-Platform Transport Protocols and SSL/TLS implementations for C++.
+ |
+
#include <aws/http/connection.h>
#include <aws/http/proxy.h>
#include <aws/http/request_response.h>
#include <aws/crt/Types.h>
#include <aws/crt/io/Bootstrap.h>
#include <aws/crt/io/SocketOptions.h>
#include <aws/crt/io/TlsOptions.h>
#include <functional>
#include <memory>
Go to the source code of this file.
++Classes | |
struct | Aws::Crt::Http::HttpRequestOptions |
class | Aws::Crt::Http::HttpStream |
struct | Aws::Crt::Http::ClientStreamCallbackData |
class | Aws::Crt::Http::HttpClientStream |
class | Aws::Crt::Http::HttpClientConnectionProxyOptions |
class | Aws::Crt::Http::HttpClientConnectionOptions |
class | Aws::Crt::Http::HttpClientConnection |
+Namespaces | |
Aws | |
Aws::Crt | |
Aws::Crt::Io | |
Aws::Crt::Http | |
+Typedefs | |
using | Aws::Crt::Http::HttpHeader = aws_http_header |
using | Aws::Crt::Http::OnConnectionSetup = std::function< void(const std::shared_ptr< HttpClientConnection > &connection, int errorCode)> |
using | Aws::Crt::Http::OnConnectionShutdown = std::function< void(HttpClientConnection &connection, int errorCode)> |
using | Aws::Crt::Http::OnIncomingHeaders = std::function< void(HttpStream &stream, enum aws_http_header_block headerBlock, const HttpHeader *headersArray, std::size_t headersCount)> |
using | Aws::Crt::Http::OnIncomingHeadersBlockDone = std::function< void(HttpStream &stream, enum aws_http_header_block block)> |
using | Aws::Crt::Http::OnIncomingBody = std::function< void(HttpStream &stream, const ByteCursor &data)> |
using | Aws::Crt::Http::OnStreamComplete = std::function< void(HttpStream &stream, int errorCode)> |
+Enumerations | |
enum class | Aws::Crt::Http::AwsHttpProxyAuthenticationType { Aws::Crt::Http::None +, Aws::Crt::Http::Basic + } |
enum class | Aws::Crt::Http::AwsHttpProxyConnectionType { Aws::Crt::Http::Legacy = AWS_HPCT_HTTP_LEGACY +, Aws::Crt::Http::Forwarding = AWS_HPCT_HTTP_FORWARD +, Aws::Crt::Http::Tunneling = AWS_HPCT_HTTP_TUNNEL + } |
enum class | Aws::Crt::Http::HttpVersion { Aws::Crt::Http::Unknown = AWS_HTTP_VERSION_UNKNOWN +, Aws::Crt::Http::Http1_0 = AWS_HTTP_VERSION_1_0 +, Aws::Crt::Http::Http1_1 = AWS_HTTP_VERSION_1_1 +, Aws::Crt::Http::Http2 = AWS_HTTP_VERSION_2 + } |
+ aws-crt-cpp
+
+ C++ wrapper around the aws-c-* libraries. Provides Cross-Platform Transport Protocols and SSL/TLS implementations for C++.
+ |
+
+ aws-crt-cpp
+
+ C++ wrapper around the aws-c-* libraries. Provides Cross-Platform Transport Protocols and SSL/TLS implementations for C++.
+ |
+
#include <aws/crt/Api.h>
#include <aws/crt/http/HttpConnectionManager.h>
#include <aws/crt/http/HttpProxyStrategy.h>
#include <algorithm>
#include <aws/http/connection_manager.h>
+Classes | |
struct | Aws::Crt::Http::ConnectionManagerCallbackArgs |
class | Aws::Crt::Http::ManagedConnection |
+Namespaces | |
Aws | |
Aws::Crt | |
Aws::Crt::Http | |
+ aws-crt-cpp
+
+ C++ wrapper around the aws-c-* libraries. Provides Cross-Platform Transport Protocols and SSL/TLS implementations for C++.
+ |
+
#include <aws/crt/http/HttpConnection.h>
#include <atomic>
#include <condition_variable>
#include <future>
#include <mutex>
Go to the source code of this file.
++Classes | |
class | Aws::Crt::Http::HttpClientConnectionManagerOptions |
class | Aws::Crt::Http::HttpClientConnectionManager |
+Namespaces | |
Aws | |
Aws::Crt | |
Aws::Crt::Http | |
+Typedefs | |
using | Aws::Crt::Http::OnClientConnectionAvailable = std::function< void(std::shared_ptr< HttpClientConnection >, int errorCode)> |
+ aws-crt-cpp
+
+ C++ wrapper around the aws-c-* libraries. Provides Cross-Platform Transport Protocols and SSL/TLS implementations for C++.
+ |
+
+ aws-crt-cpp
+
+ C++ wrapper around the aws-c-* libraries. Provides Cross-Platform Transport Protocols and SSL/TLS implementations for C++.
+ |
+
#include <aws/crt/http/HttpProxyStrategy.h>
#include <aws/common/string.h>
#include <aws/crt/http/HttpConnection.h>
#include <aws/http/proxy.h>
+Classes | |
class | Aws::Crt::Http::AdaptiveHttpProxyStrategy |
+Namespaces | |
Aws | |
Aws::Crt | |
Aws::Crt::Http | |
+ aws-crt-cpp
+
+ C++ wrapper around the aws-c-* libraries. Provides Cross-Platform Transport Protocols and SSL/TLS implementations for C++.
+ |
+
Go to the source code of this file.
++Classes | |
struct | Aws::Crt::Http::HttpProxyStrategyBasicAuthConfig |
struct | Aws::Crt::Http::HttpProxyStrategyAdaptiveConfig |
class | Aws::Crt::Http::HttpProxyStrategy |
+Namespaces | |
Aws | |
Aws::Crt | |
Aws::Crt::Http | |
+Typedefs | |
using | Aws::Crt::Http::KerberosGetTokenFunction = std::function< bool(String &)> |
using | Aws::Crt::Http::NtlmGetTokenFunction = std::function< bool(const String &, String &)> |
+ aws-crt-cpp
+
+ C++ wrapper around the aws-c-* libraries. Provides Cross-Platform Transport Protocols and SSL/TLS implementations for C++.
+ |
+
+ aws-crt-cpp
+
+ C++ wrapper around the aws-c-* libraries. Provides Cross-Platform Transport Protocols and SSL/TLS implementations for C++.
+ |
+
#include <aws/crt/http/HttpRequestResponse.h>
#include <aws/crt/io/Stream.h>
#include <aws/http/request_response.h>
#include <aws/io/stream.h>
+Namespaces | |
Aws | |
Aws::Crt | |
Aws::Crt::Http | |
+ aws-crt-cpp
+
+ C++ wrapper around the aws-c-* libraries. Provides Cross-Platform Transport Protocols and SSL/TLS implementations for C++.
+ |
+
Go to the source code of this file.
++Classes | |
class | Aws::Crt::Http::HttpMessage |
class | Aws::Crt::Http::HttpRequest |
class | Aws::Crt::Http::HttpResponse |
+Namespaces | |
Aws | |
Aws::Crt | |
Aws::Crt::Mqtt | |
Aws::Crt::Mqtt5 | |
Aws::Crt::Http | |
+ aws-crt-cpp
+
+ C++ wrapper around the aws-c-* libraries. Provides Cross-Platform Transport Protocols and SSL/TLS implementations for C++.
+ |
+
+ aws-crt-cpp
+
+ C++ wrapper around the aws-c-* libraries. Provides Cross-Platform Transport Protocols and SSL/TLS implementations for C++.
+ |
+
#include <aws/auth/aws_imds_client.h>
#include <aws/auth/credentials.h>
#include <aws/crt/Api.h>
#include <aws/crt/ImdsClient.h>
#include <aws/crt/auth/Credentials.h>
#include <aws/crt/http/HttpConnection.h>
#include <aws/crt/io/Bootstrap.h>
+Classes | |
struct | Aws::Crt::Imds::WrappedCallbackArgs< T > |
+Namespaces | |
Aws | |
Aws::Crt | |
Aws::Crt::Imds | |
+ aws-crt-cpp
+
+ C++ wrapper around the aws-c-* libraries. Provides Cross-Platform Transport Protocols and SSL/TLS implementations for C++.
+ |
+
#include <aws/crt/DateTime.h>
#include <aws/crt/Exports.h>
#include <aws/crt/Types.h>
#include <functional>
Go to the source code of this file.
++Classes | |
struct | Aws::Crt::Imds::ImdsClientConfig |
struct | Aws::Crt::Imds::IamProfileView |
struct | Aws::Crt::Imds::IamProfile |
struct | Aws::Crt::Imds::InstanceInfoView |
struct | Aws::Crt::Imds::InstanceInfo |
class | Aws::Crt::Imds::ImdsClient |
+Namespaces | |
Aws | |
Aws::Crt | |
Aws::Crt::Io | |
Aws::Crt::Auth | |
Aws::Crt::Imds | |
+Typedefs | |
using | Aws::Crt::Imds::OnResourceAcquired = std::function< void(const StringView &resource, int errorCode, void *userData)> |
using | Aws::Crt::Imds::OnVectorResourceAcquired = std::function< void(const Vector< StringView > &resource, int errorCode, void *userData)> |
using | Aws::Crt::Imds::OnCredentialsAcquired = std::function< void(const Auth::Credentials &credentials, int errorCode, void *userData)> |
using | Aws::Crt::Imds::OnIamProfileAcquired = std::function< void(const IamProfileView &iamProfile, int errorCode, void *userData)> |
using | Aws::Crt::Imds::OnInstanceInfoAcquired = std::function< void(const InstanceInfoView &instanceInfo, int errorCode, void *userData)> |
+ aws-crt-cpp
+
+ C++ wrapper around the aws-c-* libraries. Provides Cross-Platform Transport Protocols and SSL/TLS implementations for C++.
+ |
+
+ aws-crt-cpp
+
+ C++ wrapper around the aws-c-* libraries. Provides Cross-Platform Transport Protocols and SSL/TLS implementations for C++.
+ |
+
#include <aws/crt/JsonObject.h>
#include <aws/common/json.h>
#include <algorithm>
#include <iterator>
+Namespaces | |
Aws | |
Aws::Crt | |
+ aws-crt-cpp
+
+ C++ wrapper around the aws-c-* libraries. Provides Cross-Platform Transport Protocols and SSL/TLS implementations for C++.
+ |
+
Go to the source code of this file.
++Classes | |
class | Aws::Crt::JsonObject |
class | Aws::Crt::JsonView |
+Namespaces | |
Aws | |
Aws::Crt | |
+ aws-crt-cpp
+
+ C++ wrapper around the aws-c-* libraries. Provides Cross-Platform Transport Protocols and SSL/TLS implementations for C++.
+ |
+
+ aws-crt-cpp
+
+ C++ wrapper around the aws-c-* libraries. Provides Cross-Platform Transport Protocols and SSL/TLS implementations for C++.
+ |
+
+ aws-crt-cpp
+
+ C++ wrapper around the aws-c-* libraries. Provides Cross-Platform Transport Protocols and SSL/TLS implementations for C++.
+ |
+
+ aws-crt-cpp
+
+ C++ wrapper around the aws-c-* libraries. Provides Cross-Platform Transport Protocols and SSL/TLS implementations for C++.
+ |
+
+ aws-crt-cpp
+
+ C++ wrapper around the aws-c-* libraries. Provides Cross-Platform Transport Protocols and SSL/TLS implementations for C++.
+ |
+
+Namespaces | |
Aws | |
Aws::Crt | |
Aws::Crt::Mqtt5 | |
+Functions | |
template<typename T > | |
void | Aws::Crt::Mqtt5::setPacketVector (Vector< T > &vector, const T *values, size_t length) |
template<typename T > | |
void | Aws::Crt::Mqtt5::setPacketOptional (Optional< T > &optional, const T *value) |
void | Aws::Crt::Mqtt5::setPacketStringOptional (Optional< aws_byte_cursor > &optional, Crt::String &optionalStorage, const aws_byte_cursor *value) |
void | Aws::Crt::Mqtt5::setPacketStringOptional (Optional< Crt::String > &optional, const aws_byte_cursor *value) |
void | Aws::Crt::Mqtt5::setPacketStringOptional (Optional< Crt::String > &optional, Crt::String &&toMove) |
void | Aws::Crt::Mqtt5::setPacketByteBufOptional (Optional< aws_byte_cursor > &optional, ByteBuf &optionalStorage, Allocator *allocator, const aws_byte_cursor *value) |
void | Aws::Crt::Mqtt5::setUserProperties (Vector< UserProperty > &userProperties, const struct aws_mqtt5_user_property *properties, size_t propertyCount) |
template<typename T > | |
void | Aws::Crt::Mqtt5::setNullableFromOptional (const T *&nullable, const Optional< T > &optional) |
void | Aws::Crt::Mqtt5::s_AllocateUnderlyingUserProperties (aws_mqtt5_user_property *&dst, const Crt::Vector< UserProperty > &userProperties, Allocator *allocator) |
void | Aws::Crt::Mqtt5::s_AllocateStringVector (aws_array_list &dst, const Crt::Vector< String > &stringVector, Allocator *allocator) |
void | Aws::Crt::Mqtt5::s_AllocateUnderlyingSubscription (aws_mqtt5_subscription_view *&dst, const Crt::Vector< Subscription > &subscriptions, Allocator *allocator) |
+ aws-crt-cpp
+
+ C++ wrapper around the aws-c-* libraries. Provides Cross-Platform Transport Protocols and SSL/TLS implementations for C++.
+ |
+
#include <aws/crt/mqtt/Mqtt5Client.h>
#include <aws/crt/mqtt/Mqtt5Packets.h>
#include <aws/crt/mqtt/Mqtt5Types.h>
Go to the source code of this file.
++Classes | |
class | Aws::Crt::Mqtt5::UserProperty |
class | Aws::Crt::Mqtt5::IPacket |
class | Aws::Crt::Mqtt5::PublishPacket |
class | Aws::Crt::Mqtt5::NegotiatedSettings |
class | Aws::Crt::Mqtt5::ConnectPacket |
class | Aws::Crt::Mqtt5::ConnAckPacket |
class | Aws::Crt::Mqtt5::DisconnectPacket |
class | Aws::Crt::Mqtt5::PubAckPacket |
class | Aws::Crt::Mqtt5::PublishResult |
class | Aws::Crt::Mqtt5::Subscription |
class | Aws::Crt::Mqtt5::SubscribePacket |
class | Aws::Crt::Mqtt5::SubAckPacket |
class | Aws::Crt::Mqtt5::UnsubscribePacket |
class | Aws::Crt::Mqtt5::UnSubAckPacket |
+Namespaces | |
Aws | |
Aws::Crt | |
Aws::Crt::Mqtt5 | |
+ aws-crt-cpp
+
+ C++ wrapper around the aws-c-* libraries. Provides Cross-Platform Transport Protocols and SSL/TLS implementations for C++.
+ |
+
+ aws-crt-cpp
+
+ C++ wrapper around the aws-c-* libraries. Provides Cross-Platform Transport Protocols and SSL/TLS implementations for C++.
+ |
+
#include <aws/mqtt/v5/mqtt5_client.h>
#include <aws/mqtt/v5/mqtt5_types.h>
Go to the source code of this file.
++Namespaces | |
Aws | |
Aws::Crt | |
Aws::Crt::Mqtt5 | |
+Typedefs | |
using | Aws::Crt::Mqtt5::QOS = aws_mqtt5_qos |
using | Aws::Crt::Mqtt5::ConnectReasonCode = aws_mqtt5_connect_reason_code |
using | Aws::Crt::Mqtt5::DisconnectReasonCode = aws_mqtt5_disconnect_reason_code |
using | Aws::Crt::Mqtt5::PubAckReasonCode = aws_mqtt5_puback_reason_code |
using | Aws::Crt::Mqtt5::SubAckReasonCode = aws_mqtt5_suback_reason_code |
using | Aws::Crt::Mqtt5::UnSubAckReasonCode = aws_mqtt5_unsuback_reason_code |
using | Aws::Crt::Mqtt5::ClientSessionBehaviorType = aws_mqtt5_client_session_behavior_type |
using | Aws::Crt::Mqtt5::ClientExtendedValidationAndFlowControl = aws_mqtt5_extended_validation_and_flow_control_options |
using | Aws::Crt::Mqtt5::ClientOperationQueueBehaviorType = aws_mqtt5_client_operation_queue_behavior_type |
using | Aws::Crt::Mqtt5::ExponentialBackoffJitterMode = aws_exponential_backoff_jitter_mode |
using | Aws::Crt::Mqtt5::JitterMode = ExponentialBackoffJitterMode |
using | Aws::Crt::Mqtt5::PayloadFormatIndicator = aws_mqtt5_payload_format_indicator |
using | Aws::Crt::Mqtt5::RetainHandlingType = aws_mqtt5_retain_handling_type |
using | Aws::Crt::Mqtt5::PacketType = aws_mqtt5_packet_type |
+ aws-crt-cpp
+
+ C++ wrapper around the aws-c-* libraries. Provides Cross-Platform Transport Protocols and SSL/TLS implementations for C++.
+ |
+
+ aws-crt-cpp
+
+ C++ wrapper around the aws-c-* libraries. Provides Cross-Platform Transport Protocols and SSL/TLS implementations for C++.
+ |
+
#include <aws/iot/MqttClient.h>
#include <aws/crt/Api.h>
#include <aws/crt/auth/Credentials.h>
#include <aws/crt/auth/Sigv4Signing.h>
#include <aws/crt/http/HttpRequestResponse.h>
+Namespaces | |
Aws | |
Aws::Iot | |
+ aws-crt-cpp
+
+ C++ wrapper around the aws-c-* libraries. Provides Cross-Platform Transport Protocols and SSL/TLS implementations for C++.
+ |
+
#include <aws/crt/Config.h>
#include <aws/crt/Exports.h>
#include <aws/crt/auth/Sigv4Signing.h>
#include <aws/crt/mqtt/MqttClient.h>
Go to the source code of this file.
++Classes | |
struct | Aws::Iot::WebsocketConfig |
struct | Aws::Iot::Pkcs12Options |
+Namespaces | |
Aws | |
Aws::Iot | |
+Typedefs | |
using | Aws::Iot::CreateSigningConfig = std::function< std::shared_ptr< Crt::Auth::ISigningConfig >(void)> |
+ aws-crt-cpp
+
+ C++ wrapper around the aws-c-* libraries. Provides Cross-Platform Transport Protocols and SSL/TLS implementations for C++.
+ |
+
+ aws-crt-cpp
+
+ C++ wrapper around the aws-c-* libraries. Provides Cross-Platform Transport Protocols and SSL/TLS implementations for C++.
+ |
+
#include <aws/crt/mqtt/MqttConnection.h>
#include <aws/crt/mqtt/Mqtt5Client.h>
#include <aws/crt/mqtt/private/Mqtt5ClientCore.h>
#include <aws/crt/mqtt/private/MqttConnectionCore.h>
+Namespaces | |
Aws | |
Aws::Crt | |
Aws::Crt::Mqtt | |
+ aws-crt-cpp
+
+ C++ wrapper around the aws-c-* libraries. Provides Cross-Platform Transport Protocols and SSL/TLS implementations for C++.
+ |
+
#include <aws/crt/Exports.h>
#include <aws/crt/StlAllocator.h>
#include <aws/crt/Types.h>
#include <aws/crt/http/HttpConnection.h>
#include <aws/crt/io/SocketOptions.h>
#include <aws/crt/io/TlsOptions.h>
#include <aws/crt/mqtt/MqttTypes.h>
#include <aws/mqtt/client.h>
#include <aws/mqtt/v5/mqtt5_client.h>
#include <functional>
#include <memory>
Go to the source code of this file.
++Classes | |
struct | Aws::Crt::Mqtt::OnConnectionClosedData |
struct | Aws::Crt::Mqtt::OnConnectionSuccessData |
struct | Aws::Crt::Mqtt::OnConnectionFailureData |
class | Aws::Crt::Mqtt::MqttConnection |
+Namespaces | |
Aws | |
Aws::Crt | |
Aws::Crt::Http | |
Aws::Crt::Mqtt5 | |
Aws::Crt::Mqtt | |
+Typedefs | |
using | Aws::Crt::Mqtt::OnConnectionInterruptedHandler = std::function< void(MqttConnection &connection, int error)> |
using | Aws::Crt::Mqtt::OnConnectionResumedHandler = std::function< void(MqttConnection &connection, ReturnCode connectCode, bool sessionPresent)> |
using | Aws::Crt::Mqtt::OnConnectionCompletedHandler = std::function< void(MqttConnection &connection, int errorCode, ReturnCode returnCode, bool sessionPresent)> |
using | Aws::Crt::Mqtt::OnConnectionClosedHandler = std::function< void(MqttConnection &connection, OnConnectionClosedData *callbackData)> |
using | Aws::Crt::Mqtt::OnConnectionSuccessHandler = std::function< void(MqttConnection &connection, OnConnectionSuccessData *callbackData)> |
using | Aws::Crt::Mqtt::OnConnectionFailureHandler = std::function< void(MqttConnection &connection, OnConnectionFailureData *callbackData)> |
using | Aws::Crt::Mqtt::OnDisconnectHandler = std::function< void(MqttConnection &connection)> |
using | Aws::Crt::Mqtt::OnPublishReceivedHandler = std::function< void(MqttConnection &connection, const String &topic, const ByteBuf &payload)> |
using | Aws::Crt::Mqtt::OnWebSocketHandshakeInterceptComplete = std::function< void(const std::shared_ptr< Http::HttpRequest > &, int errorCode)> |
using | Aws::Crt::Mqtt::OnWebSocketHandshakeIntercept = std::function< void(std::shared_ptr< Http::HttpRequest > req, const OnWebSocketHandshakeInterceptComplete &onComplete)> |
+ aws-crt-cpp
+
+ C++ wrapper around the aws-c-* libraries. Provides Cross-Platform Transport Protocols and SSL/TLS implementations for C++.
+ |
+
+ aws-crt-cpp
+
+ C++ wrapper around the aws-c-* libraries. Provides Cross-Platform Transport Protocols and SSL/TLS implementations for C++.
+ |
+
+ aws-crt-cpp
+
+ C++ wrapper around the aws-c-* libraries. Provides Cross-Platform Transport Protocols and SSL/TLS implementations for C++.
+ |
+
+ aws-crt-cpp
+
+ C++ wrapper around the aws-c-* libraries. Provides Cross-Platform Transport Protocols and SSL/TLS implementations for C++.
+ |
+
+ aws-crt-cpp
+
+ C++ wrapper around the aws-c-* libraries. Provides Cross-Platform Transport Protocols and SSL/TLS implementations for C++.
+ |
+
#include <aws/crt/Types.h>
#include <aws/crt/io/SocketOptions.h>
#include <aws/crt/io/TlsOptions.h>
#include <aws/mqtt/client.h>
#include <aws/mqtt/v5/mqtt5_client.h>
#include <functional>
Go to the source code of this file.
++Classes | |
struct | Aws::Crt::Mqtt::MqttConnectionOptions |
struct | Aws::Crt::Mqtt::MqttConnectionOperationStatistics |
+Namespaces | |
Aws | |
Aws::Crt | |
Aws::Crt::Mqtt | |
+Typedefs | |
using | Aws::Crt::Mqtt::OnMessageReceivedHandler = std::function< void(MqttConnection &connection, const String &topic, const ByteBuf &payload, bool dup, QOS qos, bool retain)> |
using | Aws::Crt::Mqtt::OnSubAckHandler = std::function< void(MqttConnection &connection, uint16_t packetId, const String &topic, QOS qos, int errorCode)> |
using | Aws::Crt::Mqtt::OnMultiSubAckHandler = std::function< void(MqttConnection &connection, uint16_t packetId, const Vector< String > &topics, QOS qos, int errorCode)> |
using | Aws::Crt::Mqtt::OnOperationCompleteHandler = std::function< void(MqttConnection &connection, uint16_t packetId, int errorCode)> |
+ aws-crt-cpp
+
+ C++ wrapper around the aws-c-* libraries. Provides Cross-Platform Transport Protocols and SSL/TLS implementations for C++.
+ |
+
+ aws-crt-cpp
+
+ C++ wrapper around the aws-c-* libraries. Provides Cross-Platform Transport Protocols and SSL/TLS implementations for C++.
+ |
+
#include <utility>
Go to the source code of this file.
++Classes | |
class | Aws::Crt::Optional< T > |
+Namespaces | |
Aws | |
Aws::Crt | |
+ aws-crt-cpp
+
+ C++ wrapper around the aws-c-* libraries. Provides Cross-Platform Transport Protocols and SSL/TLS implementations for C++.
+ |
+
+ aws-crt-cpp
+
+ C++ wrapper around the aws-c-* libraries. Provides Cross-Platform Transport Protocols and SSL/TLS implementations for C++.
+ |
+
+Namespaces | |
Aws | |
Aws::Crt | |
Aws::Crt::Io | |
+ aws-crt-cpp
+
+ C++ wrapper around the aws-c-* libraries. Provides Cross-Platform Transport Protocols and SSL/TLS implementations for C++.
+ |
+
#include <aws/crt/Types.h>
Go to the source code of this file.
++Classes | |
class | Aws::Crt::Io::Pkcs11Lib |
+Namespaces | |
Aws | |
Aws::Crt | |
Aws::Crt::Io | |
+ aws-crt-cpp
+
+ C++ wrapper around the aws-c-* libraries. Provides Cross-Platform Transport Protocols and SSL/TLS implementations for C++.
+ |
+
+ aws-crt-cpp
+
+ C++ wrapper around the aws-c-* libraries. Provides Cross-Platform Transport Protocols and SSL/TLS implementations for C++.
+ |
+
#include <aws/common/assert.h>
#include <memory>
#include <mutex>
Go to the source code of this file.
++Classes | |
class | Aws::Crt::RefCounted< T > |
+Namespaces | |
Aws | |
Aws::Crt | |
+ aws-crt-cpp
+
+ C++ wrapper around the aws-c-* libraries. Provides Cross-Platform Transport Protocols and SSL/TLS implementations for C++.
+ |
+
+ aws-crt-cpp
+
+ C++ wrapper around the aws-c-* libraries. Provides Cross-Platform Transport Protocols and SSL/TLS implementations for C++.
+ |
+
#include <aws/common/string.h>
#include <aws/crt/Api.h>
#include <aws/crt/endpoints/RuleEngine.h>
#include <aws/sdkutils/endpoints_rule_engine.h>
#include <aws/sdkutils/partitions.h>
+Namespaces | |
Aws | |
Aws::Crt | |
Aws::Crt::Endpoints | |
+Functions | |
StringView | Aws::Crt::Endpoints::CrtStringToStringView (const aws_string *s) |
+ aws-crt-cpp
+
+ C++ wrapper around the aws-c-* libraries. Provides Cross-Platform Transport Protocols and SSL/TLS implementations for C++.
+ |
+
#include <aws/crt/Types.h>
Go to the source code of this file.
++Classes | |
class | Aws::Crt::Endpoints::RequestContext |
class | Aws::Crt::Endpoints::ResolutionOutcome |
class | Aws::Crt::Endpoints::RuleEngine |
+Namespaces | |
Aws | |
Aws::Crt | |
Aws::Crt::Endpoints | |
+ aws-crt-cpp
+
+ C++ wrapper around the aws-c-* libraries. Provides Cross-Platform Transport Protocols and SSL/TLS implementations for C++.
+ |
+
+ aws-crt-cpp
+
+ C++ wrapper around the aws-c-* libraries. Provides Cross-Platform Transport Protocols and SSL/TLS implementations for C++.
+ |
+
#include <aws/crt/Exports.h>
#include <aws/auth/signing_config.h>
#include <functional>
#include <memory>
Go to the source code of this file.
++Classes | |
class | Aws::Crt::Auth::ISigningConfig |
class | Aws::Crt::Auth::IHttpRequestSigner |
+Namespaces | |
Aws | |
Aws::Crt | |
Aws::Crt::Http | |
Aws::Crt::Auth | |
+Typedefs | |
using | Aws::Crt::Auth::OnHttpRequestSigningComplete = std::function< void(const std::shared_ptr< Aws::Crt::Http::HttpRequest > &, int)> |
+Enumerations | |
enum class | Aws::Crt::Auth::SigningConfigType { Aws::Crt::Auth::Aws = AWS_SIGNING_CONFIG_AWS + } |
+ aws-crt-cpp
+
+ C++ wrapper around the aws-c-* libraries. Provides Cross-Platform Transport Protocols and SSL/TLS implementations for C++.
+ |
+
+ aws-crt-cpp
+
+ C++ wrapper around the aws-c-* libraries. Provides Cross-Platform Transport Protocols and SSL/TLS implementations for C++.
+ |
+
#include <aws/crt/auth/Sigv4Signing.h>
#include <aws/crt/auth/Credentials.h>
#include <aws/crt/http/HttpRequestResponse.h>
#include <aws/auth/signable.h>
#include <aws/auth/signing.h>
#include <aws/auth/signing_result.h>
+Classes | |
struct | Aws::Crt::Auth::HttpSignerCallbackData |
+Namespaces | |
Aws | |
Aws::Crt | |
Aws::Crt::Auth | |
Aws::Crt::Auth::SignedBodyValue | |
+Functions | |
AWS_CRT_CPP_API const char * | Aws::Crt::Auth::SignedBodyValue::EmptySha256Str () |
AWS_CRT_CPP_API const char * | Aws::Crt::Auth::SignedBodyValue::UnsignedPayloadStr () |
AWS_CRT_CPP_API const char * | Aws::Crt::Auth::SignedBodyValue::StreamingAws4HmacSha256PayloadStr () |
AWS_CRT_CPP_API const char * | Aws::Crt::Auth::SignedBodyValue::StreamingAws4HmacSha256EventsStr () |
static void | Aws::Crt::Auth::s_http_signing_complete_fn (struct aws_signing_result *result, int errorCode, void *userdata) |
+ aws-crt-cpp
+
+ C++ wrapper around the aws-c-* libraries. Provides Cross-Platform Transport Protocols and SSL/TLS implementations for C++.
+ |
+
#include <aws/crt/Exports.h>
#include <aws/crt/DateTime.h>
#include <aws/crt/Types.h>
#include <aws/crt/auth/Signing.h>
Go to the source code of this file.
++Classes | |
class | Aws::Crt::Auth::AwsSigningConfig |
class | Aws::Crt::Auth::Sigv4HttpRequestSigner |
+Namespaces | |
Aws | |
Aws::Crt | |
Aws::Crt::Auth | |
Aws::Crt::Auth::SignedBodyValue | |
+Typedefs | |
using | Aws::Crt::Auth::ShouldSignHeaderCb = bool(*)(const Crt::ByteCursor *, void *) |
+Enumerations | |
enum class | Aws::Crt::Auth::SigningAlgorithm { Aws::Crt::Auth::SigV4 = AWS_SIGNING_ALGORITHM_V4 +, Aws::Crt::Auth::SigV4A = AWS_SIGNING_ALGORITHM_V4_ASYMMETRIC + } |
enum class | Aws::Crt::Auth::SignatureType { Aws::Crt::Auth::HttpRequestViaHeaders = AWS_ST_HTTP_REQUEST_HEADERS +, Aws::Crt::Auth::HttpRequestViaQueryParams = AWS_ST_HTTP_REQUEST_QUERY_PARAMS +, Aws::Crt::Auth::HttpRequestChunk = AWS_ST_HTTP_REQUEST_CHUNK +, Aws::Crt::Auth::HttpRequestEvent = AWS_ST_HTTP_REQUEST_EVENT + } |
enum class | Aws::Crt::Auth::SignedBodyHeaderType { Aws::Crt::Auth::None = AWS_SBHT_NONE +, Aws::Crt::Auth::XAmzContentSha256 = AWS_SBHT_X_AMZ_CONTENT_SHA256 + } |
+Functions | |
AWS_CRT_CPP_API const char * | Aws::Crt::Auth::SignedBodyValue::EmptySha256Str () |
AWS_CRT_CPP_API const char * | Aws::Crt::Auth::SignedBodyValue::UnsignedPayloadStr () |
AWS_CRT_CPP_API const char * | Aws::Crt::Auth::SignedBodyValue::StreamingAws4HmacSha256PayloadStr () |
AWS_CRT_CPP_API const char * | Aws::Crt::Auth::SignedBodyValue::StreamingAws4HmacSha256EventsStr () |
+Variables | |
AWS_CRT_CPP_API const char * | Aws::Crt::Auth::SignedBodyValue::UnsignedPayload = "UNSIGNED-PAYLOAD" |
AWS_CRT_CPP_API const char * | Aws::Crt::Auth::SignedBodyValue::EmptySha256 = "e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855" |
AWS_CRT_CPP_API const char * | Aws::Crt::Auth::SignedBodyValue::StreamingAws4HmacSha256Payload = "STREAMING-AWS4-HMAC-SHA256-PAYLOAD" |
AWS_CRT_CPP_API const char * | Aws::Crt::Auth::SignedBodyValue::StreamingAws4HmacSha256Events = "STREAMING-AWS4-HMAC-SHA256-EVENTS" |
+ aws-crt-cpp
+
+ C++ wrapper around the aws-c-* libraries. Provides Cross-Platform Transport Protocols and SSL/TLS implementations for C++.
+ |
+
+ aws-crt-cpp
+
+ C++ wrapper around the aws-c-* libraries. Provides Cross-Platform Transport Protocols and SSL/TLS implementations for C++.
+ |
+
#include <aws/crt/io/SocketOptions.h>
+Namespaces | |
Aws | |
Aws::Crt | |
Aws::Crt::Io | |
+Variables | |
static const uint32_t | Aws::Crt::Io::DEFAULT_SOCKET_TIME_MSEC = 3000 |
+ aws-crt-cpp
+
+ C++ wrapper around the aws-c-* libraries. Provides Cross-Platform Transport Protocols and SSL/TLS implementations for C++.
+ |
+
Go to the source code of this file.
++Classes | |
class | Aws::Crt::Io::SocketOptions |
+Namespaces | |
Aws | |
Aws::Crt | |
Aws::Crt::Io | |
+Enumerations | |
enum class | Aws::Crt::Io::SocketType { Aws::Crt::Io::Stream = AWS_SOCKET_STREAM +, Aws::Crt::Io::Dgram = AWS_SOCKET_DGRAM + } |
enum class | Aws::Crt::Io::SocketDomain { Aws::Crt::Io::IPv4 = AWS_SOCKET_IPV4 +, Aws::Crt::Io::IPv6 = AWS_SOCKET_IPV6 +, Aws::Crt::Io::Local = AWS_SOCKET_LOCAL + } |
+ aws-crt-cpp
+
+ C++ wrapper around the aws-c-* libraries. Provides Cross-Platform Transport Protocols and SSL/TLS implementations for C++.
+ |
+
+ aws-crt-cpp
+
+ C++ wrapper around the aws-c-* libraries. Provides Cross-Platform Transport Protocols and SSL/TLS implementations for C++.
+ |
+
Go to the source code of this file.
++Classes | |
class | Aws::Crt::StlAllocator< T > |
struct | Aws::Crt::StlAllocator< T >::rebind< U > |
+Namespaces | |
Aws | |
Aws::Crt | |
+ aws-crt-cpp
+
+ C++ wrapper around the aws-c-* libraries. Provides Cross-Platform Transport Protocols and SSL/TLS implementations for C++.
+ |
+
+ aws-crt-cpp
+
+ C++ wrapper around the aws-c-* libraries. Provides Cross-Platform Transport Protocols and SSL/TLS implementations for C++.
+ |
+
+Namespaces | |
Aws | |
Aws::Crt | |
Aws::Crt::Io | |
+ aws-crt-cpp
+
+ C++ wrapper around the aws-c-* libraries. Provides Cross-Platform Transport Protocols and SSL/TLS implementations for C++.
+ |
+
#include <aws/crt/Exports.h>
#include <aws/crt/RefCounted.h>
#include <aws/crt/Types.h>
#include <aws/io/stream.h>
Go to the source code of this file.
++Classes | |
class | Aws::Crt::Io::InputStream |
class | Aws::Crt::Io::StdIOStreamInputStream |
+Namespaces | |
Aws | |
Aws::Crt | |
Aws::Crt::Io | |
+Typedefs | |
using | Aws::Crt::Io::StreamStatus = aws_stream_status |
using | Aws::Crt::Io::OffsetType = aws_off_t |
+Enumerations | |
enum class | Aws::Crt::Io::StreamSeekBasis { Aws::Crt::Io::Begin = AWS_SSB_BEGIN +, Aws::Crt::Io::End = AWS_SSB_END + } |
+ aws-crt-cpp
+
+ C++ wrapper around the aws-c-* libraries. Provides Cross-Platform Transport Protocols and SSL/TLS implementations for C++.
+ |
+
+ aws-crt-cpp
+
+ C++ wrapper around the aws-c-* libraries. Provides Cross-Platform Transport Protocols and SSL/TLS implementations for C++.
+ |
+
+Namespaces | |
Aws | |
Aws::Crt | |
+Functions | |
size_t AWS_CRT_CPP_API | Aws::Crt::HashString (const char *str) noexcept |
+ aws-crt-cpp
+
+ C++ wrapper around the aws-c-* libraries. Provides Cross-Platform Transport Protocols and SSL/TLS implementations for C++.
+ |
+
Go to the source code of this file.
++Namespaces | |
Aws | |
Aws::Crt | |
+Functions | |
size_t AWS_CRT_CPP_API | Aws::Crt::HashString (const char *str) noexcept |
+ aws-crt-cpp
+
+ C++ wrapper around the aws-c-* libraries. Provides Cross-Platform Transport Protocols and SSL/TLS implementations for C++.
+ |
+
+ aws-crt-cpp
+
+ C++ wrapper around the aws-c-* libraries. Provides Cross-Platform Transport Protocols and SSL/TLS implementations for C++.
+ |
+
#include <algorithm>
#include <cassert>
#include <iterator>
#include <limits>
#include <stddef.h>
#include <type_traits>
Go to the source code of this file.
++Classes | |
class | Aws::Crt::basic_string_view< CharT, Traits > |
struct | std::hash< Aws::Crt::basic_string_view< CharT, Traits > > |
+Namespaces | |
Aws | |
Aws::Crt | |
Aws::Crt::literals | |
Aws::Crt::literals::string_view_literals | |
std | |
+Typedefs | |
typedef basic_string_view< char > | Aws::Crt::string_view |
typedef basic_string_view< char16_t > | Aws::Crt::u16string_view |
typedef basic_string_view< char32_t > | Aws::Crt::u32string_view |
typedef basic_string_view< wchar_t > | Aws::Crt::wstring_view |
using | Aws::Crt::StringView = string_view |
+Functions | |
template<class CharT , class Traits > | |
bool | Aws::Crt::operator== (const basic_string_view< CharT, Traits > &lhs, const basic_string_view< CharT, Traits > &rhs) noexcept |
template<class CharT , class Traits > | |
bool | Aws::Crt::operator== (const basic_string_view< CharT, Traits > &lhs, typename std::common_type< basic_string_view< CharT, Traits >>::type &rhs) noexcept |
template<class CharT , class Traits > | |
bool | Aws::Crt::operator== (typename std::common_type< basic_string_view< CharT, Traits >>::type &lhs, const basic_string_view< CharT, Traits > &rhs) noexcept |
template<class CharT , class Traits > | |
bool | Aws::Crt::operator!= (const basic_string_view< CharT, Traits > &lhs, const basic_string_view< CharT, Traits > &rhs) noexcept |
template<class CharT , class Traits > | |
bool | Aws::Crt::operator!= (const basic_string_view< CharT, Traits > &lhs, typename std::common_type< basic_string_view< CharT, Traits >>::type &rhs) noexcept |
template<class CharT , class Traits > | |
bool | Aws::Crt::operator!= (typename std::common_type< basic_string_view< CharT, Traits >>::type &lhs, const basic_string_view< CharT, Traits > &rhs) noexcept |
template<class CharT , class Traits > | |
bool | Aws::Crt::operator< (const basic_string_view< CharT, Traits > &lhs, const basic_string_view< CharT, Traits > &rhs) noexcept |
template<class CharT , class Traits > | |
constexpr bool | Aws::Crt::operator< (const basic_string_view< CharT, Traits > &lhs, typename std::common_type< basic_string_view< CharT, Traits >>::type &rhs) noexcept |
template<class CharT , class Traits > | |
constexpr bool | Aws::Crt::operator< (typename std::common_type< basic_string_view< CharT, Traits >>::type &lhs, const basic_string_view< CharT, Traits > &rhs) noexcept |
template<class CharT , class Traits > | |
constexpr bool | Aws::Crt::operator> (const basic_string_view< CharT, Traits > &lhs, const basic_string_view< CharT, Traits > &rhs) noexcept |
template<class CharT , class Traits > | |
constexpr bool | Aws::Crt::operator> (const basic_string_view< CharT, Traits > &lhs, typename std::common_type< basic_string_view< CharT, Traits >>::type &rhs) noexcept |
template<class CharT , class Traits > | |
constexpr bool | Aws::Crt::operator> (typename std::common_type< basic_string_view< CharT, Traits >>::type &lhs, const basic_string_view< CharT, Traits > &rhs) noexcept |
template<class CharT , class Traits > | |
constexpr bool | Aws::Crt::operator<= (const basic_string_view< CharT, Traits > &lhs, const basic_string_view< CharT, Traits > &rhs) noexcept |
template<class CharT , class Traits > | |
constexpr bool | Aws::Crt::operator<= (const basic_string_view< CharT, Traits > &lhs, typename std::common_type< basic_string_view< CharT, Traits >>::type &rhs) noexcept |
template<class CharT , class Traits > | |
constexpr bool | Aws::Crt::operator<= (typename std::common_type< basic_string_view< CharT, Traits >>::type &lhs, const basic_string_view< CharT, Traits > &rhs) noexcept |
template<class CharT , class Traits > | |
constexpr bool | Aws::Crt::operator>= (const basic_string_view< CharT, Traits > &lhs, const basic_string_view< CharT, Traits > &rhs) noexcept |
template<class CharT , class Traits > | |
constexpr bool | Aws::Crt::operator>= (const basic_string_view< CharT, Traits > &lhs, typename std::common_type< basic_string_view< CharT, Traits >>::type &rhs) noexcept |
template<class CharT , class Traits > | |
constexpr bool | Aws::Crt::operator>= (typename std::common_type< basic_string_view< CharT, Traits >>::type &lhs, const basic_string_view< CharT, Traits > &rhs) noexcept |
basic_string_view< char > | Aws::Crt::literals::string_view_literals::operator""_sv (const char *s, size_t length) noexcept |
basic_string_view< wchar_t > | Aws::Crt::literals::string_view_literals::operator""_sv (const wchar_t *s, size_t length) noexcept |
basic_string_view< char16_t > | Aws::Crt::literals::string_view_literals::operator""_sv (const char16_t *s, size_t length) noexcept |
basic_string_view< char32_t > | Aws::Crt::literals::string_view_literals::operator""_sv (const char32_t *s, size_t length) noexcept |
+ aws-crt-cpp
+
+ C++ wrapper around the aws-c-* libraries. Provides Cross-Platform Transport Protocols and SSL/TLS implementations for C++.
+ |
+
+ aws-crt-cpp
+
+ C++ wrapper around the aws-c-* libraries. Provides Cross-Platform Transport Protocols and SSL/TLS implementations for C++.
+ |
+
#include <aws/crt/io/TlsOptions.h>
#include <aws/crt/io/Pkcs11.h>
#include <aws/crt/Api.h>
#include <aws/io/logging.h>
#include <aws/io/tls_channel_handler.h>
+Namespaces | |
Aws | |
Aws::Crt | |
Aws::Crt::Io | |
+ aws-crt-cpp
+
+ C++ wrapper around the aws-c-* libraries. Provides Cross-Platform Transport Protocols and SSL/TLS implementations for C++.
+ |
+
#include <aws/crt/Types.h>
#include <aws/crt/io/ChannelHandler.h>
#include <aws/io/tls_channel_handler.h>
#include <functional>
#include <memory>
Go to the source code of this file.
++Classes | |
class | Aws::Crt::Io::TlsContextOptions |
class | Aws::Crt::Io::TlsContextPkcs11Options |
class | Aws::Crt::Io::TlsConnectionOptions |
class | Aws::Crt::Io::TlsContext |
class | Aws::Crt::Io::TlsChannelHandler |
class | Aws::Crt::Io::ClientTlsChannelHandler |
+Namespaces | |
Aws | |
Aws::Crt | |
Aws::Crt::Io | |
+Typedefs | |
using | Aws::Crt::Io::NewTlsContextImplCallback = std::function< void *(TlsContextOptions &, TlsMode, Allocator *)> |
using | Aws::Crt::Io::DeleteTlsContextImplCallback = std::function< void(void *)> |
using | Aws::Crt::Io::IsTlsAlpnSupportedCallback = std::function< bool()> |
using | Aws::Crt::Io::NewClientTlsHandlerCallback = std::function< std::shared_ptr< ClientTlsChannelHandler >(struct aws_channel_slot *slot, const struct aws_tls_connection_options &options, Allocator *allocator)> |
+Enumerations | |
enum class | Aws::Crt::Io::TlsMode { Aws::Crt::Io::CLIENT +, Aws::Crt::Io::SERVER + } |
+ aws-crt-cpp
+
+ C++ wrapper around the aws-c-* libraries. Provides Cross-Platform Transport Protocols and SSL/TLS implementations for C++.
+ |
+
+ aws-crt-cpp
+
+ C++ wrapper around the aws-c-* libraries. Provides Cross-Platform Transport Protocols and SSL/TLS implementations for C++.
+ |
+
+Namespaces | |
Aws | |
Aws::Crt | |
+Functions | |
AWS_CRT_CPP_API ByteBuf | Aws::Crt::ByteBufFromCString (const char *str) noexcept |
AWS_CRT_CPP_API ByteBuf | Aws::Crt::ByteBufFromEmptyArray (const uint8_t *array, size_t len) noexcept |
AWS_CRT_CPP_API ByteBuf | Aws::Crt::ByteBufFromArray (const uint8_t *array, size_t capacity) noexcept |
AWS_CRT_CPP_API ByteBuf | Aws::Crt::ByteBufNewCopy (Allocator *alloc, const uint8_t *array, size_t len) |
AWS_CRT_CPP_API void | Aws::Crt::ByteBufDelete (ByteBuf &) |
AWS_CRT_CPP_API ByteCursor | Aws::Crt::ByteCursorFromCString (const char *str) noexcept |
AWS_CRT_CPP_API ByteCursor | Aws::Crt::ByteCursorFromString (const Crt::String &str) noexcept |
AWS_CRT_CPP_API ByteCursor | Aws::Crt::ByteCursorFromStringView (const Crt::StringView &str) noexcept |
AWS_CRT_CPP_API ByteCursor | Aws::Crt::ByteCursorFromByteBuf (const ByteBuf &) noexcept |
AWS_CRT_CPP_API ByteCursor | Aws::Crt::ByteCursorFromArray (const uint8_t *array, size_t len) noexcept |
AWS_CRT_CPP_API Vector< uint8_t > | Aws::Crt::Base64Decode (const String &decode) |
AWS_CRT_CPP_API String | Aws::Crt::Base64Encode (const Vector< uint8_t > &encode) |
+ aws-crt-cpp
+
+ C++ wrapper around the aws-c-* libraries. Provides Cross-Platform Transport Protocols and SSL/TLS implementations for C++.
+ |
+
#include <aws/common/common.h>
#include <aws/crt/Exports.h>
#include <aws/crt/Optional.h>
#include <aws/crt/StlAllocator.h>
#include <aws/crt/StringView.h>
#include <aws/io/socket.h>
#include <aws/mqtt/mqtt.h>
#include <functional>
#include <list>
#include <map>
#include <sstream>
#include <string>
#include <unordered_map>
#include <utility>
#include <vector>
Go to the source code of this file.
++Namespaces | |
Aws | |
Aws::Crt | |
Aws::Crt::Io | |
Aws::Crt::Mqtt | |
+Typedefs | |
using | Aws::Crt::ByteBuf = aws_byte_buf |
using | Aws::Crt::ByteCursor = aws_byte_cursor |
using | Aws::Crt::Io::IStream = std::basic_istream< char, std::char_traits< char > > |
using | Aws::Crt::Mqtt::QOS = aws_mqtt_qos |
using | Aws::Crt::Mqtt::ReturnCode = aws_mqtt_connect_return_code |
using | Aws::Crt::String = std::basic_string< char, std::char_traits< char >, StlAllocator< char > > |
using | Aws::Crt::StringStream = std::basic_stringstream< char, std::char_traits< char >, StlAllocator< char > > |
template<typename K , typename V > | |
using | Aws::Crt::Map = std::map< K, V, std::less< K >, StlAllocator< std::pair< const K, V > >> |
template<typename K , typename V > | |
using | Aws::Crt::UnorderedMap = std::unordered_map< K, V, std::hash< K >, std::equal_to< K >, StlAllocator< std::pair< const K, V > >> |
template<typename K , typename V > | |
using | Aws::Crt::MultiMap = std::multimap< K, V, std::less< K >, StlAllocator< std::pair< const K, V > >> |
template<typename T > | |
using | Aws::Crt::Vector = std::vector< T, StlAllocator< T > > |
template<typename T > | |
using | Aws::Crt::List = std::list< T, StlAllocator< T > > |
template<typename RawType , typename TargetType > | |
using | Aws::Crt::TypeConvertor = std::function< TargetType(RawType)> |
template<typename T > | |
using | Aws::Crt::ScopedResource = std::unique_ptr< T, std::function< void(T *)> > |
+Functions | |
AWS_CRT_CPP_API ByteBuf | Aws::Crt::ByteBufFromCString (const char *str) noexcept |
AWS_CRT_CPP_API ByteBuf | Aws::Crt::ByteBufFromEmptyArray (const uint8_t *array, size_t len) noexcept |
AWS_CRT_CPP_API ByteBuf | Aws::Crt::ByteBufFromArray (const uint8_t *array, size_t capacity) noexcept |
AWS_CRT_CPP_API ByteBuf | Aws::Crt::ByteBufNewCopy (Allocator *alloc, const uint8_t *array, size_t len) |
AWS_CRT_CPP_API void | Aws::Crt::ByteBufDelete (ByteBuf &) |
AWS_CRT_CPP_API ByteCursor | Aws::Crt::ByteCursorFromCString (const char *str) noexcept |
AWS_CRT_CPP_API ByteCursor | Aws::Crt::ByteCursorFromString (const Crt::String &str) noexcept |
AWS_CRT_CPP_API ByteCursor | Aws::Crt::ByteCursorFromStringView (const Crt::StringView &str) noexcept |
AWS_CRT_CPP_API ByteCursor | Aws::Crt::ByteCursorFromByteBuf (const ByteBuf &) noexcept |
AWS_CRT_CPP_API ByteCursor | Aws::Crt::ByteCursorFromArray (const uint8_t *array, size_t len) noexcept |
AWS_CRT_CPP_API Vector< uint8_t > | Aws::Crt::Base64Decode (const String &decode) |
AWS_CRT_CPP_API String | Aws::Crt::Base64Encode (const Vector< uint8_t > &encode) |
template<typename RawType , typename TargetType > | |
Vector< TargetType > | Aws::Crt::ArrayListToVector (const aws_array_list *array, TypeConvertor< RawType, TargetType > conv) |
template<typename RawType , typename TargetType > | |
Vector< TargetType > | Aws::Crt::ArrayListToVector (const aws_array_list *array) |
template<typename Type > | |
Vector< Type > | Aws::Crt::ArrayListToVector (const aws_array_list *array) |
AWS_CRT_CPP_API StringView | Aws::Crt::ByteCursorToStringView (const ByteCursor &bc) |
AWS_CRT_CPP_API ByteCursor | Aws::Crt::StringViewToByteCursor (const StringView &sv) |
template<typename T > | |
void | Aws::Crt::Delete (T *t, Allocator *allocator) |
template<typename T , typename... Args> | |
T * | Aws::Crt::New (Allocator *allocator, Args &&...args) |
template<typename T , typename... Args> | |
std::shared_ptr< T > | Aws::Crt::MakeShared (Allocator *allocator, Args &&...args) |
+ aws-crt-cpp
+
+ C++ wrapper around the aws-c-* libraries. Provides Cross-Platform Transport Protocols and SSL/TLS implementations for C++.
+ |
+
+ aws-crt-cpp
+
+ C++ wrapper around the aws-c-* libraries. Provides Cross-Platform Transport Protocols and SSL/TLS implementations for C++.
+ |
+
#include <aws/crt/UUID.h>
+Namespaces | |
Aws | |
Aws::Crt | |
+ aws-crt-cpp
+
+ C++ wrapper around the aws-c-* libraries. Provides Cross-Platform Transport Protocols and SSL/TLS implementations for C++.
+ |
+
Go to the source code of this file.
++Classes | |
class | Aws::Crt::UUID |
+Namespaces | |
Aws | |
Aws::Crt | |
+ aws-crt-cpp
+
+ C++ wrapper around the aws-c-* libraries. Provides Cross-Platform Transport Protocols and SSL/TLS implementations for C++.
+ |
+
+ aws-crt-cpp
+
+ C++ wrapper around the aws-c-* libraries. Provides Cross-Platform Transport Protocols and SSL/TLS implementations for C++.
+ |
+
#include <aws/crt/io/Uri.h>
+Namespaces | |
Aws | |
Aws::Crt | |
Aws::Crt::Io | |
+Functions | |
AWS_CRT_CPP_API Aws::Crt::String | Aws::Crt::Io::EncodeQueryParameterValue (ByteCursor paramValue) |
+ aws-crt-cpp
+
+ C++ wrapper around the aws-c-* libraries. Provides Cross-Platform Transport Protocols and SSL/TLS implementations for C++.
+ |
+
Go to the source code of this file.
++Classes | |
class | Aws::Crt::Io::Uri |
+Namespaces | |
Aws | |
Aws::Crt | |
Aws::Crt::Io | |
+Functions | |
AWS_CRT_CPP_API Aws::Crt::String | Aws::Crt::Io::EncodeQueryParameterValue (ByteCursor paramValue) |
+ aws-crt-cpp
+
+ C++ wrapper around the aws-c-* libraries. Provides Cross-Platform Transport Protocols and SSL/TLS implementations for C++.
+ |
+
+ aws-crt-cpp
+
+ C++ wrapper around the aws-c-* libraries. Provides Cross-Platform Transport Protocols and SSL/TLS implementations for C++.
+ |
+
▼NAws | |
▼NCrt | |
►NAuth | |
►NCrypto | |
►NEndpoints | |
►NHttp | |
►NImds | |
►NIo | |
►NMqtt | |
►NMqtt5 | |
►CApiHandle | |
CDateTime | |
CJsonObject | |
CJsonView | |
COptional | |
CRefCounted | |
►CStlAllocator | |
Cbasic_string_view | |
CUUID | |
▼NIot | |
CMqtt5CustomAuthConfig | |
CMqtt5ClientBuilder | |
CMqttClientConnectionConfig | |
CMqttClientConnectionConfigBuilder | |
CMqttClient | |
CWebsocketConfig | |
CPkcs12Options | |
▼Nstd | |
Chash< Aws::Crt::basic_string_view< CharT, Traits > > |
+ aws-crt-cpp
+
+ C++ wrapper around the aws-c-* libraries. Provides Cross-Platform Transport Protocols and SSL/TLS implementations for C++.
+ |
+
This is the complete list of members for Aws::Crt::ApiHandle, including all inherited members.
+
+ aws-crt-cpp
+
+ C++ wrapper around the aws-c-* libraries. Provides Cross-Platform Transport Protocols and SSL/TLS implementations for C++.
+ |
+
#include <Api.h>
+Classes | |
struct | Version |
+Static Public Member Functions | |
static Io::ClientBootstrap * | GetOrCreateStaticDefaultClientBootstrap () |
static Io::EventLoopGroup * | GetOrCreateStaticDefaultEventLoopGroup () |
static Io::HostResolver * | GetOrCreateStaticDefaultHostResolver () |
A singleton object representing the init/cleanup state of the entire CRT. It's invalid to have more than one active simultaneously and it's also invalid to use CRT functionality without one active.
+
+
|
+ +noexcept | +
Customize the ApiAllocator(), which is be used by any objects constructed without an explicit allocator.
+ +
+
|
+ +noexcept | +
Aws::Crt::ApiHandle::~ApiHandle | +( | +) | ++ |
+
|
+ +delete | +
+
|
+ +delete | +
ApiHandle::Version Aws::Crt::ApiHandle::GetCrtVersion | +( | +) | +const | +
Gets the version of the AWS-CRT-CPP library
+
|
+ +static | +
Gets the static default ClientBootstrap, creating it if necessary.
+This default will be used when a ClientBootstrap is not explicitly passed but is needed to allow the process to function. An example of this would be in the MQTT connection creation workflow. The default ClientBootstrap will use the default EventLoopGroup and HostResolver, creating them if necessary.
+The default ClientBootstrap will be automatically managed and released by the API handle when it's resources are being freed, not requiring any manual memory management.
+
+
|
+ +static | +
Gets the static default EventLoopGroup, creating it if necessary.
+This default will be used when a EventLoopGroup is not explicitly passed but is needed to allow the process to function. An example of this would be in the MQTT connection creation workflow.
+The EventLoopGroup will automatically pick a default number of threads based on the system. You can manually adjust the number of threads being used by creating a EventLoopGroup and passing it through the SetDefaultEventLoopGroup function.
+The default EventLoopGroup will be automatically managed and released by the API handle when it's resources are being freed, not requiring any manual memory management.
+
+
|
+ +static | +
Gets the static default HostResolver, creating it if necessary.
+This default will be used when a HostResolver is not explicitly passed but is needed to allow the process to function. An example of this would be in the MQTT connection creation workflow.
+The HostResolver will be set to have a maximum of 8 entries by default. You can manually adjust the maximum number of entries being used by creating a HostResolver and passing it through the SetDefaultEventLoopGroup function.
+The default HostResolver will be automatically managed and released by the API handle when it's resources are being freed, not requiring any manual memory management.
+void Aws::Crt::ApiHandle::InitializeLogging | +( | +LogLevel | +level, | +
+ | + | const char * | +filename | +
+ | ) | ++ |
Initialize logging in awscrt.
level | Display messages of this importance and higher. LogLevel.NoLogs will disable logging. |
filename | Logging destination, a file path from the disk. |
void Aws::Crt::ApiHandle::InitializeLogging | +( | +LogLevel | +level, | +
+ | + | FILE * | +fp | +
+ | ) | ++ |
Initialize logging in awscrt.
level | Display messages of this importance and higher. LogLevel.NoLogs will disable logging. |
fp | The FILE object for logging destination. |
+
|
+ +delete | +
+
|
+ +delete | +
void Aws::Crt::ApiHandle::SetBYOCryptoClientTlsCallback | +( | +Io::NewClientTlsHandlerCallback && | +callback | ) | ++ |
BYO_CRYPTO: set callback for creating a ClientTlsChannelHandler. If using BYO_CRYPTO, you must call this prior to creating any client channels in the application.
+ +void Aws::Crt::ApiHandle::SetBYOCryptoNewMD5Callback | +( | +Crypto::CreateHashCallback && | +callback | ) | ++ |
BYO_CRYPTO: set callback for creating MD5 hashes. If using BYO_CRYPTO, you must call this.
+ +void Aws::Crt::ApiHandle::SetBYOCryptoNewSHA256Callback | +( | +Crypto::CreateHashCallback && | +callback | ) | ++ |
BYO_CRYPTO: set callback for creating SHA256 hashes. If using BYO_CRYPTO, you must call this.
+ +void Aws::Crt::ApiHandle::SetBYOCryptoNewSHA256HMACCallback | +( | +Crypto::CreateHMACCallback && | +callback | ) | ++ |
BYO_CRYPTO: set callback for creating Streaming SHA256 HMAC objects. If using BYO_CRYPTO, you must call this.
+ +void Aws::Crt::ApiHandle::SetBYOCryptoTlsContextCallbacks | +( | +Io::NewTlsContextImplCallback && | +newCallback, | +
+ | + | Io::DeleteTlsContextImplCallback && | +deleteCallback, | +
+ | + | Io::IsTlsAlpnSupportedCallback && | +alpnCallback | +
+ | ) | ++ |
BYO_CRYPTO: set callbacks for the TlsContext. If using BYO_CRYPTO, you need to call this function prior to creating a TlsContext.
+newCallback | Create custom implementation object, to be stored inside TlsContext. Return nullptr if failure occurs. |
deleteCallback | Destroy object that was created by newCallback. |
alpnCallback | Return whether ALPN is supported. |
void Aws::Crt::ApiHandle::SetShutdownBehavior | +( | +ApiHandleShutdownBehavior | +behavior | ) | ++ |
Configures the shutdown behavior of the api handle instance
behavior | desired shutdown behavior |
+ aws-crt-cpp
+
+ C++ wrapper around the aws-c-* libraries. Provides Cross-Platform Transport Protocols and SSL/TLS implementations for C++.
+ |
+
This is the complete list of members for Aws::Crt::Auth::AwsSigningConfig, including all inherited members.
+
+ aws-crt-cpp
+
+ C++ wrapper around the aws-c-* libraries. Provides Cross-Platform Transport Protocols and SSL/TLS implementations for C++.
+ |
+
#include <Sigv4Signing.h>
+Public Member Functions | |
AwsSigningConfig (Allocator *allocator=ApiAllocator()) | |
virtual | ~AwsSigningConfig () |
virtual SigningConfigType | GetType () const noexcept override |
SigningAlgorithm | GetSigningAlgorithm () const noexcept |
void | SetSigningAlgorithm (SigningAlgorithm algorithm) noexcept |
SignatureType | GetSignatureType () const noexcept |
void | SetSignatureType (SignatureType signatureType) noexcept |
const Crt::String & | GetRegion () const noexcept |
void | SetRegion (const Crt::String ®ion) noexcept |
const Crt::String & | GetService () const noexcept |
void | SetService (const Crt::String &service) noexcept |
DateTime | GetSigningTimepoint () const noexcept |
void | SetSigningTimepoint (const DateTime &date) noexcept |
bool | GetUseDoubleUriEncode () const noexcept |
void | SetUseDoubleUriEncode (bool useDoubleUriEncode) noexcept |
bool | GetShouldNormalizeUriPath () const noexcept |
void | SetShouldNormalizeUriPath (bool shouldNormalizeUriPath) noexcept |
bool | GetOmitSessionToken () const noexcept |
void | SetOmitSessionToken (bool omitSessionToken) noexcept |
ShouldSignHeaderCb | GetShouldSignHeaderCallback () const noexcept |
void | SetShouldSignHeaderCallback (ShouldSignHeaderCb shouldSignHeaderCb) noexcept |
void * | GetShouldSignHeaderUserData () const noexcept |
void | SetShouldSignHeaderUserData (void *userData) noexcept |
const Crt::String & | GetSignedBodyValue () const noexcept |
void | SetSignedBodyValue (const Crt::String &signedBodyValue) noexcept |
SignedBodyHeaderType | GetSignedBodyHeader () const noexcept |
void | SetSignedBodyHeader (SignedBodyHeaderType signedBodyHeader) noexcept |
uint64_t | GetExpirationInSeconds () const noexcept |
void | SetExpirationInSeconds (uint64_t expirationInSeconds) noexcept |
const std::shared_ptr< ICredentialsProvider > & | GetCredentialsProvider () const noexcept |
void | SetCredentialsProvider (const std::shared_ptr< ICredentialsProvider > &credsProvider) noexcept |
const std::shared_ptr< Credentials > & | GetCredentials () const noexcept |
void | SetCredentials (const std::shared_ptr< Credentials > &credentials) noexcept |
Public Member Functions inherited from Aws::Crt::Auth::ISigningConfig | |
ISigningConfig ()=default | |
ISigningConfig (const ISigningConfig &)=delete | |
ISigningConfig (ISigningConfig &&)=delete | |
ISigningConfig & | operator= (const ISigningConfig &)=delete |
ISigningConfig & | operator= (ISigningConfig &&)=delete |
virtual | ~ISigningConfig ()=default |
Wrapper around the configuration structure specific to the AWS Sigv4 signing process
+Aws::Crt::Auth::AwsSigningConfig::AwsSigningConfig | +( | +Allocator * | +allocator = ApiAllocator() | ) | ++ |
+
|
+ +virtual | +
+
|
+ +noexcept | +
+
|
+ +noexcept | +
+
|
+ +noexcept | +
+
|
+ +noexcept | +
+
|
+ +noexcept | +
+
|
+ +noexcept | +
+
|
+ +noexcept | +
+
|
+ +noexcept | +
+
|
+ +noexcept | +
+
|
+ +noexcept | +
+
|
+ +noexcept | +
+
|
+ +noexcept | +
+
|
+ +noexcept | +
+
|
+ +noexcept | +
+
|
+ +inlineoverridevirtualnoexcept | +
RTTI query for the SigningConfig hierarchy
Implements Aws::Crt::Auth::ISigningConfig.
+ +
+
|
+ +noexcept | +
+
|
+ +noexcept | +
Set the credentials to use for signing.
+ +
+
|
+ +noexcept | +
Set the credentials provider to use for signing.
+ +
+
|
+ +noexcept | +
(Query param signing only) Sets the amount of time, in seconds, the (pre)signed URI will be good for
+ +
+
|
+ +noexcept | +
Sets whether or not to omit the session token during signing. Only set to true when performing a websocket handshake with IoT Core.
+ +
+
|
+ +noexcept | +
Sets the AWS region to sign against
+ +
+
|
+ +noexcept | +
Sets the (signing) name of the AWS service to sign a request for
+ +
+
|
+ +noexcept | +
Sets whether or not the uri paths should be normalized when building the canonical request
+ +
+
|
+ +noexcept | +
Sets a callback invoked during the signing process for white-listing headers that can be signed. If you do not set this, all headers will be signed.
+ +
+
|
+ +noexcept | +
Sets the userData you could get from the ShouldSignHeaderCb callback function.
+ +
+
|
+ +noexcept | +
Sets the type of signature we want to calculate
+ +
+
|
+ +noexcept | +
Sets the name of the header to add that stores the signed body value
+ +
+
|
+ +noexcept | +
Sets the string to use as the canonical request's body value. If an empty string is set (the default), a value will be calculated from the payload during signing. Typically, this is the SHA-256 of the (request/chunk/event) payload, written as lowercase hex. If this has been precalculated, it can be set here. Special values used by certain services can also be set (see Aws::Crt::Auth::SignedBodyValue).
+ +
+
|
+ +noexcept | +
Sets the signing process we want to invoke
+ +
+
|
+ +noexcept | +
Sets the timestamp to use during the signing process.
+ +
+
|
+ +noexcept | +
Sets whether or not the signing process should perform a uri encode step before creating the canonical request.
+ +
+ aws-crt-cpp
+
+ C++ wrapper around the aws-c-* libraries. Provides Cross-Platform Transport Protocols and SSL/TLS implementations for C++.
+ |
+
This is the complete list of members for Aws::Crt::Auth::Credentials, including all inherited members.
+
+ aws-crt-cpp
+
+ C++ wrapper around the aws-c-* libraries. Provides Cross-Platform Transport Protocols and SSL/TLS implementations for C++.
+ |
+
#include <Credentials.h>
+Public Member Functions | |
Credentials (const aws_credentials *credentials) noexcept | |
Credentials (ByteCursor access_key_id, ByteCursor secret_access_key, ByteCursor session_token, uint64_t expiration_timepoint_in_seconds, Allocator *allocator=ApiAllocator()) noexcept | |
Credentials (Allocator *allocator=ApiAllocator()) noexcept | |
~Credentials () | |
Credentials (const Credentials &)=delete | |
Credentials (Credentials &&)=delete | |
Credentials & | operator= (const Credentials &)=delete |
Credentials & | operator= (Credentials &&)=delete |
ByteCursor | GetAccessKeyId () const noexcept |
ByteCursor | GetSecretAccessKey () const noexcept |
ByteCursor | GetSessionToken () const noexcept |
uint64_t | GetExpirationTimepointInSeconds () const noexcept |
operator bool () const noexcept | |
const aws_credentials * | GetUnderlyingHandle () const noexcept |
A class to hold the basic components necessary for various AWS authentication protocols.
+
+
|
+ +noexcept | +
+
|
+ +noexcept | +
+
|
+ +noexcept | +
Create new anonymous Credentials. Use anonymous Credentials when you want to skip signing.
allocator |
Aws::Crt::Auth::Credentials::~Credentials | +( | +) | ++ |
+
|
+ +delete | +
+
|
+ +delete | +
+
|
+ +noexcept | +
Gets the value of the access key component of aws credentials
+ +
+
|
+ +noexcept | +
Gets the expiration timestamp for the credentials, or UINT64_MAX if no expiration
+ +
+
|
+ +noexcept | +
Gets the value of the secret access key component of aws credentials
+ +
+
|
+ +noexcept | +
Gets the value of the session token of aws credentials
+ +
+
|
+ +inlinenoexcept | +
Returns the underlying credentials implementation.
+ +
+
|
+ +explicitnoexcept | +
Validity check - returns true if the instance is valid, false otherwise
+ +
+
|
+ +delete | +
+
|
+ +delete | +
+ aws-crt-cpp
+
+ C++ wrapper around the aws-c-* libraries. Provides Cross-Platform Transport Protocols and SSL/TLS implementations for C++.
+ |
+
This is the complete list of members for Aws::Crt::Auth::CredentialsProvider, including all inherited members.
+CreateCredentialsProviderAnonymous(Allocator *allocator=ApiAllocator()) | Aws::Crt::Auth::CredentialsProvider | static |
CreateCredentialsProviderCached(const CredentialsProviderCachedConfig &config, Allocator *allocator=ApiAllocator()) | Aws::Crt::Auth::CredentialsProvider | static |
CreateCredentialsProviderChain(const CredentialsProviderChainConfig &config, Allocator *allocator=ApiAllocator()) | Aws::Crt::Auth::CredentialsProvider | static |
CreateCredentialsProviderChainDefault(const CredentialsProviderChainDefaultConfig &config, Allocator *allocator=ApiAllocator()) | Aws::Crt::Auth::CredentialsProvider | static |
CreateCredentialsProviderCognito(const CredentialsProviderCognitoConfig &config, Allocator *allocator=ApiAllocator()) | Aws::Crt::Auth::CredentialsProvider | static |
CreateCredentialsProviderDelegate(const CredentialsProviderDelegateConfig &config, Allocator *allocator=ApiAllocator()) | Aws::Crt::Auth::CredentialsProvider | static |
CreateCredentialsProviderEnvironment(Allocator *allocator=ApiAllocator()) | Aws::Crt::Auth::CredentialsProvider | static |
CreateCredentialsProviderImds(const CredentialsProviderImdsConfig &config, Allocator *allocator=ApiAllocator()) | Aws::Crt::Auth::CredentialsProvider | static |
CreateCredentialsProviderProfile(const CredentialsProviderProfileConfig &config, Allocator *allocator=ApiAllocator()) | Aws::Crt::Auth::CredentialsProvider | static |
CreateCredentialsProviderStatic(const CredentialsProviderStaticConfig &config, Allocator *allocator=ApiAllocator()) | Aws::Crt::Auth::CredentialsProvider | static |
CreateCredentialsProviderSTS(const CredentialsProviderSTSConfig &config, Allocator *allocator=ApiAllocator()) | Aws::Crt::Auth::CredentialsProvider | static |
CreateCredentialsProviderX509(const CredentialsProviderX509Config &config, Allocator *allocator=ApiAllocator()) | Aws::Crt::Auth::CredentialsProvider | static |
CredentialsProvider(aws_credentials_provider *provider, Allocator *allocator=ApiAllocator()) noexcept | Aws::Crt::Auth::CredentialsProvider | |
CredentialsProvider(const CredentialsProvider &)=delete | Aws::Crt::Auth::CredentialsProvider | |
CredentialsProvider(CredentialsProvider &&)=delete | Aws::Crt::Auth::CredentialsProvider | |
GetCredentials(const OnCredentialsResolved &onCredentialsResolved) const override | Aws::Crt::Auth::CredentialsProvider | virtual |
GetUnderlyingHandle() const noexcept override | Aws::Crt::Auth::CredentialsProvider | inlinevirtual |
IsValid() const noexcept override | Aws::Crt::Auth::CredentialsProvider | inlinevirtual |
operator=(const CredentialsProvider &)=delete | Aws::Crt::Auth::CredentialsProvider | |
operator=(CredentialsProvider &&)=delete | Aws::Crt::Auth::CredentialsProvider | |
~CredentialsProvider() | Aws::Crt::Auth::CredentialsProvider | virtual |
~ICredentialsProvider()=default | Aws::Crt::Auth::ICredentialsProvider | virtual |
+ aws-crt-cpp
+
+ C++ wrapper around the aws-c-* libraries. Provides Cross-Platform Transport Protocols and SSL/TLS implementations for C++.
+ |
+
#include <Credentials.h>
+Public Member Functions | |
CredentialsProvider (aws_credentials_provider *provider, Allocator *allocator=ApiAllocator()) noexcept | |
virtual | ~CredentialsProvider () |
CredentialsProvider (const CredentialsProvider &)=delete | |
CredentialsProvider (CredentialsProvider &&)=delete | |
CredentialsProvider & | operator= (const CredentialsProvider &)=delete |
CredentialsProvider & | operator= (CredentialsProvider &&)=delete |
virtual bool | GetCredentials (const OnCredentialsResolved &onCredentialsResolved) const override |
virtual aws_credentials_provider * | GetUnderlyingHandle () const noexcept override |
virtual bool | IsValid () const noexcept override |
Public Member Functions inherited from Aws::Crt::Auth::ICredentialsProvider | |
virtual | ~ICredentialsProvider ()=default |
Simple credentials provider implementation that wraps one of the internal C-based implementations.
+Contains a set of static factory methods for building each supported provider, as well as one for the default provider chain.
+
+
|
+ +noexcept | +
+
|
+ +virtual | +
+
|
+ +delete | +
+
|
+ +delete | +
+
|
+ +static | +
Creates an anonymous provider that have anonymous credentials Use anonymous credentials when you want to skip signing
+ +
+
|
+ +static | +
+
|
+ +static | +
Creates a provider that sources credentials by querying a series of providers and returning the first valid credential set encountered
+ +
+
|
+ +static | +
Creates the SDK-standard default credentials provider which is a cache-fronted chain of:
+Environment -> Profile -> IMDS/ECS
+ +
+
|
+ +static | +
Creates a provider that sources credentials from the Cognito Identity service
+ +
+
|
+ +static | +
Creates a provider that sources credentials from the provided function.
+ +
+
|
+ +static | +
Creates a provider that returns credentials sourced from environment variables
+ +
+
|
+ +static | +
Creates a provider that returns credentials sourced from Ec2 instance metadata service
+ +
+
|
+ +static | +
Creates a provider that returns credentials sourced from config files
+ +
+
|
+ +static | +
Creates a provider that returns a fixed set of credentials
+ +
+
|
+ +static | +
Creates a provider that sources credentials from STS
+ +
+
|
+ +static | +
Creates a provider that sources credentials from the IoT X509 provider service
+ +
+
|
+ +overridevirtual | +
Asynchronous method to query for AWS credentials based on the internal provider implementation.
+ +Implements Aws::Crt::Auth::ICredentialsProvider.
+ +
+
|
+ +inlineoverridevirtualnoexcept | +
Returns the underlying credentials provider implementation.
+ +Implements Aws::Crt::Auth::ICredentialsProvider.
+ +
+
|
+ +inlineoverridevirtualnoexcept | +
Validity check method
+ +Implements Aws::Crt::Auth::ICredentialsProvider.
+ +
+
|
+ +delete | +
+
|
+ +delete | +
+ aws-crt-cpp
+
+ C++ wrapper around the aws-c-* libraries. Provides Cross-Platform Transport Protocols and SSL/TLS implementations for C++.
+ |
+
This is the complete list of members for Aws::Crt::Auth::ICredentialsProvider, including all inherited members.
+GetCredentials(const OnCredentialsResolved &onCredentialsResolved) const =0 | Aws::Crt::Auth::ICredentialsProvider | pure virtual |
GetUnderlyingHandle() const noexcept=0 | Aws::Crt::Auth::ICredentialsProvider | pure virtual |
IsValid() const noexcept=0 | Aws::Crt::Auth::ICredentialsProvider | pure virtual |
~ICredentialsProvider()=default | Aws::Crt::Auth::ICredentialsProvider | virtual |
+ aws-crt-cpp
+
+ C++ wrapper around the aws-c-* libraries. Provides Cross-Platform Transport Protocols and SSL/TLS implementations for C++.
+ |
+
#include <Credentials.h>
+Public Member Functions | |
virtual | ~ICredentialsProvider ()=default |
virtual bool | GetCredentials (const OnCredentialsResolved &onCredentialsResolved) const =0 |
virtual aws_credentials_provider * | GetUnderlyingHandle () const noexcept=0 |
virtual bool | IsValid () const noexcept=0 |
Base interface for all credentials providers. Credentials providers are objects that retrieve AWS credentials from some source.
+
+
|
+ +virtualdefault | +
+
|
+ +pure virtual | +
Asynchronous method to query for AWS credentials based on the internal provider implementation.
+ +Implemented in Aws::Crt::Auth::CredentialsProvider.
+ +
+
|
+ +pure virtualnoexcept | +
Returns the underlying credentials provider implementation. Support for credentials providers not based on a C implementation is theoretically possible, but requires some re-implementation to support provider chains and caching (whose implementations rely on links to C implementation providers)
+ +Implemented in Aws::Crt::Auth::CredentialsProvider.
+ +
+
|
+ +pure virtualnoexcept | +
Validity check method
+ +Implemented in Aws::Crt::Auth::CredentialsProvider.
+ +
+ aws-crt-cpp
+
+ C++ wrapper around the aws-c-* libraries. Provides Cross-Platform Transport Protocols and SSL/TLS implementations for C++.
+ |
+
This is the complete list of members for Aws::Crt::Auth::IHttpRequestSigner, including all inherited members.
+IHttpRequestSigner()=default | Aws::Crt::Auth::IHttpRequestSigner | |
IHttpRequestSigner(const IHttpRequestSigner &)=delete | Aws::Crt::Auth::IHttpRequestSigner | |
IHttpRequestSigner(IHttpRequestSigner &&)=delete | Aws::Crt::Auth::IHttpRequestSigner | |
IsValid() const =0 | Aws::Crt::Auth::IHttpRequestSigner | pure virtual |
operator=(const IHttpRequestSigner &)=delete | Aws::Crt::Auth::IHttpRequestSigner | |
operator=(IHttpRequestSigner &&)=delete | Aws::Crt::Auth::IHttpRequestSigner | |
SignRequest(const std::shared_ptr< Aws::Crt::Http::HttpRequest > &request, const ISigningConfig &config, const OnHttpRequestSigningComplete &completionCallback)=0 | Aws::Crt::Auth::IHttpRequestSigner | pure virtual |
~IHttpRequestSigner()=default | Aws::Crt::Auth::IHttpRequestSigner | virtual |
+ aws-crt-cpp
+
+ C++ wrapper around the aws-c-* libraries. Provides Cross-Platform Transport Protocols and SSL/TLS implementations for C++.
+ |
+
#include <Signing.h>
+Public Member Functions | |
IHttpRequestSigner ()=default | |
IHttpRequestSigner (const IHttpRequestSigner &)=delete | |
IHttpRequestSigner (IHttpRequestSigner &&)=delete | |
IHttpRequestSigner & | operator= (const IHttpRequestSigner &)=delete |
IHttpRequestSigner & | operator= (IHttpRequestSigner &&)=delete |
virtual | ~IHttpRequestSigner ()=default |
virtual bool | SignRequest (const std::shared_ptr< Aws::Crt::Http::HttpRequest > &request, const ISigningConfig &config, const OnHttpRequestSigningComplete &completionCallback)=0 |
virtual bool | IsValid () const =0 |
Abstract base for all http request signers. Asynchronous interface. Intended to be a tight wrapper around aws-c-* signer implementations.
+
+
|
+ +default | +
+
|
+ +delete | +
+
|
+ +delete | +
+
|
+ +virtualdefault | +
+
|
+ +pure virtual | +
Implemented in Aws::Crt::Auth::Sigv4HttpRequestSigner.
+ +
+
|
+ +delete | +
+
|
+ +delete | +
+
|
+ +pure virtual | +
Signs an http request based on the signing implementation and supplied configuration
request | http request to sign |
config | base signing configuration. Actual type should match the configuration expected by the signer implementation |
completionCallback | completion function to invoke when signing has completed or failed |
Implemented in Aws::Crt::Auth::Sigv4HttpRequestSigner.
+ +
+ aws-crt-cpp
+
+ C++ wrapper around the aws-c-* libraries. Provides Cross-Platform Transport Protocols and SSL/TLS implementations for C++.
+ |
+
This is the complete list of members for Aws::Crt::Auth::ISigningConfig, including all inherited members.
+GetType(void) const =0 | Aws::Crt::Auth::ISigningConfig | pure virtual |
ISigningConfig()=default | Aws::Crt::Auth::ISigningConfig | |
ISigningConfig(const ISigningConfig &)=delete | Aws::Crt::Auth::ISigningConfig | |
ISigningConfig(ISigningConfig &&)=delete | Aws::Crt::Auth::ISigningConfig | |
operator=(const ISigningConfig &)=delete | Aws::Crt::Auth::ISigningConfig | |
operator=(ISigningConfig &&)=delete | Aws::Crt::Auth::ISigningConfig | |
~ISigningConfig()=default | Aws::Crt::Auth::ISigningConfig | virtual |
+ aws-crt-cpp
+
+ C++ wrapper around the aws-c-* libraries. Provides Cross-Platform Transport Protocols and SSL/TLS implementations for C++.
+ |
+
#include <Signing.h>
+Public Member Functions | |
ISigningConfig ()=default | |
ISigningConfig (const ISigningConfig &)=delete | |
ISigningConfig (ISigningConfig &&)=delete | |
ISigningConfig & | operator= (const ISigningConfig &)=delete |
ISigningConfig & | operator= (ISigningConfig &&)=delete |
virtual | ~ISigningConfig ()=default |
virtual SigningConfigType | GetType (void) const =0 |
Base class for all different signing configurations. Type functions as a primitive RTTI for downcasting.
+
+
|
+ +default | +
+
|
+ +delete | +
+
|
+ +delete | +
+
|
+ +virtualdefault | +
+
|
+ +pure virtual | +
RTTI query for the SigningConfig hierarchy
Implemented in Aws::Crt::Auth::AwsSigningConfig.
+ +
+
|
+ +delete | +
+
|
+ +delete | +
+ aws-crt-cpp
+
+ C++ wrapper around the aws-c-* libraries. Provides Cross-Platform Transport Protocols and SSL/TLS implementations for C++.
+ |
+
This is the complete list of members for Aws::Crt::Auth::Sigv4HttpRequestSigner, including all inherited members.
+IHttpRequestSigner()=default | Aws::Crt::Auth::IHttpRequestSigner | |
IHttpRequestSigner(const IHttpRequestSigner &)=delete | Aws::Crt::Auth::IHttpRequestSigner | |
IHttpRequestSigner(IHttpRequestSigner &&)=delete | Aws::Crt::Auth::IHttpRequestSigner | |
IsValid() const override | Aws::Crt::Auth::Sigv4HttpRequestSigner | inlinevirtual |
operator=(const IHttpRequestSigner &)=delete | Aws::Crt::Auth::IHttpRequestSigner | |
operator=(IHttpRequestSigner &&)=delete | Aws::Crt::Auth::IHttpRequestSigner | |
SignRequest(const std::shared_ptr< Aws::Crt::Http::HttpRequest > &request, const ISigningConfig &config, const OnHttpRequestSigningComplete &completionCallback) override | Aws::Crt::Auth::Sigv4HttpRequestSigner | virtual |
Sigv4HttpRequestSigner(Allocator *allocator=ApiAllocator()) | Aws::Crt::Auth::Sigv4HttpRequestSigner | |
~IHttpRequestSigner()=default | Aws::Crt::Auth::IHttpRequestSigner | virtual |
~Sigv4HttpRequestSigner()=default | Aws::Crt::Auth::Sigv4HttpRequestSigner | virtual |
+ aws-crt-cpp
+
+ C++ wrapper around the aws-c-* libraries. Provides Cross-Platform Transport Protocols and SSL/TLS implementations for C++.
+ |
+
#include <Sigv4Signing.h>
+Public Member Functions | |
Sigv4HttpRequestSigner (Allocator *allocator=ApiAllocator()) | |
virtual | ~Sigv4HttpRequestSigner ()=default |
bool | IsValid () const override |
virtual bool | SignRequest (const std::shared_ptr< Aws::Crt::Http::HttpRequest > &request, const ISigningConfig &config, const OnHttpRequestSigningComplete &completionCallback) override |
Public Member Functions inherited from Aws::Crt::Auth::IHttpRequestSigner | |
IHttpRequestSigner ()=default | |
IHttpRequestSigner (const IHttpRequestSigner &)=delete | |
IHttpRequestSigner (IHttpRequestSigner &&)=delete | |
IHttpRequestSigner & | operator= (const IHttpRequestSigner &)=delete |
IHttpRequestSigner & | operator= (IHttpRequestSigner &&)=delete |
virtual | ~IHttpRequestSigner ()=default |
Http request signer that performs Aws Sigv4 signing. Expects the signing configuration to be and instance of AwsSigningConfig
+Aws::Crt::Auth::Sigv4HttpRequestSigner::Sigv4HttpRequestSigner | +( | +Allocator * | +allocator = ApiAllocator() | ) | ++ |
+
|
+ +virtualdefault | +
+
|
+ +inlineoverridevirtual | +
Implements Aws::Crt::Auth::IHttpRequestSigner.
+ +
+
|
+ +overridevirtual | +
Signs an http request with AWS-auth sigv4. OnCompletionCallback will be invoked upon completion.
+ +Implements Aws::Crt::Auth::IHttpRequestSigner.
+ +
+ aws-crt-cpp
+
+ C++ wrapper around the aws-c-* libraries. Provides Cross-Platform Transport Protocols and SSL/TLS implementations for C++.
+ |
+
This is the complete list of members for Aws::Crt::Crypto::ByoHMAC, including all inherited members.
+ByoHMAC(size_t digestSize, const ByteCursor &secret, Allocator *allocator=ApiAllocator()) | Aws::Crt::Crypto::ByoHMAC | protected |
DigestInternal(ByteBuf &output, size_t truncateTo=0) noexcept=0 | Aws::Crt::Crypto::ByoHMAC | protectedpure virtual |
UpdateInternal(const ByteCursor &toHash) noexcept=0 | Aws::Crt::Crypto::ByoHMAC | protectedpure virtual |
~ByoHMAC()=default | Aws::Crt::Crypto::ByoHMAC | virtual |
+ aws-crt-cpp
+
+ C++ wrapper around the aws-c-* libraries. Provides Cross-Platform Transport Protocols and SSL/TLS implementations for C++.
+ |
+
#include <HMAC.h>
+Public Member Functions | |
virtual | ~ByoHMAC ()=default |
+Protected Member Functions | |
ByoHMAC (size_t digestSize, const ByteCursor &secret, Allocator *allocator=ApiAllocator()) | |
virtual bool | UpdateInternal (const ByteCursor &toHash) noexcept=0 |
virtual bool | DigestInternal (ByteBuf &output, size_t truncateTo=0) noexcept=0 |
BYO_CRYPTO: Base class for custom HMAC implementations.
+If using BYO_CRYPTO, you must define concrete implementations for the required HMAC algorithms and set their creation callbacks via functions like ApiHandle.SetBYOCryptoNewSHA256HMACCallback().
+
+
|
+ +virtualdefault | +
+
|
+ +protected | +
+
|
+ +protectedpure virtualnoexcept | +
Complete the HMAC computation and write the final digest to output. This cannote be called more than once. If truncate_to is something other than 0, the output must be truncated to that number of bytes. Raise an AWS error and return false to indicate failure.
+ +
+
|
+ +protectedpure virtualnoexcept | +
Updates the running HMAC with to_hash. This can be called multiple times. Raise an AWS error and return false to indicate failure.
+ +
+ aws-crt-cpp
+
+ C++ wrapper around the aws-c-* libraries. Provides Cross-Platform Transport Protocols and SSL/TLS implementations for C++.
+ |
+
This is the complete list of members for Aws::Crt::Crypto::ByoHash, including all inherited members.
+ByoHash(size_t digestSize, Allocator *allocator=ApiAllocator()) | Aws::Crt::Crypto::ByoHash | protected |
DigestInternal(ByteBuf &output, size_t truncateTo=0) noexcept=0 | Aws::Crt::Crypto::ByoHash | protectedpure virtual |
UpdateInternal(const ByteCursor &toHash) noexcept=0 | Aws::Crt::Crypto::ByoHash | protectedpure virtual |
~ByoHash() | Aws::Crt::Crypto::ByoHash | virtual |
+ aws-crt-cpp
+
+ C++ wrapper around the aws-c-* libraries. Provides Cross-Platform Transport Protocols and SSL/TLS implementations for C++.
+ |
+
#include <Hash.h>
+Public Member Functions | |
virtual | ~ByoHash () |
+Protected Member Functions | |
ByoHash (size_t digestSize, Allocator *allocator=ApiAllocator()) | |
virtual bool | UpdateInternal (const ByteCursor &toHash) noexcept=0 |
virtual bool | DigestInternal (ByteBuf &output, size_t truncateTo=0) noexcept=0 |
BYO_CRYPTO: Base class for custom hash implementations.
+If using BYO_CRYPTO, you must define concrete implementations for the required hash algorithms and set their creation callbacks via functions like ApiHandle.SetBYOCryptoNewMD5Callback().
+
+
|
+ +virtual | +
+
|
+ +protected | +
+
|
+ +protectedpure virtualnoexcept | +
Complete the hash computation and write the final digest to output. This cannote be called more than once. If truncate_to is something other than 0, the output must be truncated to that number of bytes. Raise an AWS error and return false to indicate failure.
+ +
+
|
+ +protectedpure virtualnoexcept | +
Update the running hash with to_hash. This can be called multiple times. Raise an AWS error and return false to indicate failure.
+ +
+ aws-crt-cpp
+
+ C++ wrapper around the aws-c-* libraries. Provides Cross-Platform Transport Protocols and SSL/TLS implementations for C++.
+ |
+
This is the complete list of members for Aws::Crt::Crypto::HMAC, including all inherited members.
+CreateSHA256HMAC(Allocator *allocator, const ByteCursor &secret) noexcept | Aws::Crt::Crypto::HMAC | static |
CreateSHA256HMAC(const ByteCursor &secret) noexcept | Aws::Crt::Crypto::HMAC | static |
Digest(ByteBuf &output, size_t truncateTo=0) noexcept | Aws::Crt::Crypto::HMAC | |
HMAC(const HMAC &)=delete | Aws::Crt::Crypto::HMAC | |
HMAC(HMAC &&toMove) | Aws::Crt::Crypto::HMAC | |
LastError() const noexcept | Aws::Crt::Crypto::HMAC | inline |
operator bool() const noexcept | Aws::Crt::Crypto::HMAC | inline |
operator=(const HMAC &)=delete | Aws::Crt::Crypto::HMAC | |
operator=(HMAC &&toMove) | Aws::Crt::Crypto::HMAC | |
Update(const ByteCursor &toHMAC) noexcept | Aws::Crt::Crypto::HMAC | |
~HMAC() | Aws::Crt::Crypto::HMAC |
+ aws-crt-cpp
+
+ C++ wrapper around the aws-c-* libraries. Provides Cross-Platform Transport Protocols and SSL/TLS implementations for C++.
+ |
+
#include <HMAC.h>
+Public Member Functions | |
~HMAC () | |
HMAC (const HMAC &)=delete | |
HMAC & | operator= (const HMAC &)=delete |
HMAC (HMAC &&toMove) | |
HMAC & | operator= (HMAC &&toMove) |
operator bool () const noexcept | |
int | LastError () const noexcept |
bool | Update (const ByteCursor &toHMAC) noexcept |
bool | Digest (ByteBuf &output, size_t truncateTo=0) noexcept |
+Static Public Member Functions | |
static HMAC | CreateSHA256HMAC (Allocator *allocator, const ByteCursor &secret) noexcept |
static HMAC | CreateSHA256HMAC (const ByteCursor &secret) noexcept |
Streaming HMAC object. The typical use case is for computing the HMAC of an object that is too large to load into memory. You can call Update() multiple times as you load chunks of data into memory. When you're finished simply call Digest(). After Digest() is called, this object is no longer usable.
+Aws::Crt::Crypto::HMAC::~HMAC | +( | +) | ++ |
+
|
+ +delete | +
Aws::Crt::Crypto::HMAC::HMAC | +( | +HMAC && | +toMove | ) | ++ |
+
|
+ +staticnoexcept | +
Creates an instance of a Streaming SHA256 HMAC.
+ +
+
|
+ +staticnoexcept | +
Creates an instance of a Streaming SHA256 HMAC using the Default Allocator.
+ +
+
|
+ +noexcept | +
Finishes the running HMAC operation and writes the digest into output. The available capacity of output must be large enough for the digest. See: SHA256_DIGEST_SIZE and MD5_DIGEST_SIZE for size hints. 'truncateTo' is for if you want truncated output (e.g. you only want the first 16 bytes of a SHA256 digest. Returns true on success. Call LastError() for the reason this call failed.
+ +
+
|
+ +inlinenoexcept | +
Returns the value of the last aws error encountered by operations on this instance.
+ +
+
|
+ +inlinenoexcept | +
Returns true if the instance is in a valid state, false otherwise.
+ +
+
|
+ +noexcept | +
Updates the running HMAC object with data in toHMAC. Returns true on success. Call LastError() for the reason this call failed.
+ +
+ aws-crt-cpp
+
+ C++ wrapper around the aws-c-* libraries. Provides Cross-Platform Transport Protocols and SSL/TLS implementations for C++.
+ |
+
This is the complete list of members for Aws::Crt::Crypto::Hash, including all inherited members.
+CreateMD5(Allocator *allocator=ApiAllocator()) noexcept | Aws::Crt::Crypto::Hash | static |
CreateSHA256(Allocator *allocator=ApiAllocator()) noexcept | Aws::Crt::Crypto::Hash | static |
Digest(ByteBuf &output, size_t truncateTo=0) noexcept | Aws::Crt::Crypto::Hash | |
Hash(const Hash &)=delete | Aws::Crt::Crypto::Hash | |
Hash(Hash &&toMove) | Aws::Crt::Crypto::Hash | |
LastError() const noexcept | Aws::Crt::Crypto::Hash | inline |
operator bool() const noexcept | Aws::Crt::Crypto::Hash | inline |
operator=(const Hash &)=delete | Aws::Crt::Crypto::Hash | |
operator=(Hash &&toMove) | Aws::Crt::Crypto::Hash | |
Update(const ByteCursor &toHash) noexcept | Aws::Crt::Crypto::Hash | |
~Hash() | Aws::Crt::Crypto::Hash |
+ aws-crt-cpp
+
+ C++ wrapper around the aws-c-* libraries. Provides Cross-Platform Transport Protocols and SSL/TLS implementations for C++.
+ |
+
#include <Hash.h>
+Public Member Functions | |
~Hash () | |
Hash (const Hash &)=delete | |
Hash & | operator= (const Hash &)=delete |
Hash (Hash &&toMove) | |
Hash & | operator= (Hash &&toMove) |
operator bool () const noexcept | |
int | LastError () const noexcept |
bool | Update (const ByteCursor &toHash) noexcept |
bool | Digest (ByteBuf &output, size_t truncateTo=0) noexcept |
+Static Public Member Functions | |
static Hash | CreateSHA256 (Allocator *allocator=ApiAllocator()) noexcept |
static Hash | CreateMD5 (Allocator *allocator=ApiAllocator()) noexcept |
Streaming Hash object. The typical use case is for computing the hash of an object that is too large to load into memory. You can call Update() multiple times as you load chunks of data into memory. When you're finished simply call Digest(). After Digest() is called, this object is no longer usable.
+Aws::Crt::Crypto::Hash::~Hash | +( | +) | ++ |
+
|
+ +delete | +
Aws::Crt::Crypto::Hash::Hash | +( | +Hash && | +toMove | ) | ++ |
+
|
+ +staticnoexcept | +
Creates an instance of a Streaming MD5 Hash.
+ +
+
|
+ +staticnoexcept | +
Creates an instance of a Streaming SHA256 Hash.
+ +
+
|
+ +noexcept | +
Finishes the running hash operation and writes the digest into output. The available capacity of output must be large enough for the digest. See: SHA256_DIGEST_SIZE and MD5_DIGEST_SIZE for size hints. 'truncateTo' is for if you want truncated output (e.g. you only want the first 16 bytes of a SHA256 digest. Returns true on success. Call LastError() for the reason this call failed.
+ +
+
|
+ +inlinenoexcept | +
Returns the value of the last aws error encountered by operations on this instance.
+ +
+
|
+ +inlinenoexcept | +
Returns true if the instance is in a valid state, false otherwise.
+ +
+
|
+ +noexcept | +
Updates the running hash object with data in toHash. Returns true on success. Call LastError() for the reason this call failed.
+ +
+ aws-crt-cpp
+
+ C++ wrapper around the aws-c-* libraries. Provides Cross-Platform Transport Protocols and SSL/TLS implementations for C++.
+ |
+
This is the complete list of members for Aws::Crt::DateTime, including all inherited members.
+DateTime() noexcept | Aws::Crt::DateTime | |
DateTime(const std::chrono::system_clock::time_point &timepointToAssign) noexcept | Aws::Crt::DateTime | |
DateTime(uint64_t millisSinceEpoch) noexcept | Aws::Crt::DateTime | |
DateTime(double epoch_millis) noexcept | Aws::Crt::DateTime | |
DateTime(const char *timestamp, DateFormat format) noexcept | Aws::Crt::DateTime | |
GetDay(bool localTime=false) const noexcept | Aws::Crt::DateTime | |
GetDayOfWeek(bool localTime=false) const noexcept | Aws::Crt::DateTime | |
GetHour(bool localTime=false) const noexcept | Aws::Crt::DateTime | |
GetLastError() const noexcept | Aws::Crt::DateTime | |
GetMinute(bool localTime=false) const noexcept | Aws::Crt::DateTime | |
GetMonth(bool localTime=false) const noexcept | Aws::Crt::DateTime | |
GetSecond(bool localTime=false) const noexcept | Aws::Crt::DateTime | |
GetYear(bool localTime=false) const noexcept | Aws::Crt::DateTime | |
IsDST(bool localTime=false) const noexcept | Aws::Crt::DateTime | |
Millis() const noexcept | Aws::Crt::DateTime | |
Now() noexcept | Aws::Crt::DateTime | static |
operator bool() const noexcept | Aws::Crt::DateTime | explicit |
operator!=(const DateTime &other) const noexcept | Aws::Crt::DateTime | |
operator+(const std::chrono::milliseconds &a) const noexcept | Aws::Crt::DateTime | |
operator-(const std::chrono::milliseconds &a) const noexcept | Aws::Crt::DateTime | |
operator-(const DateTime &other) const noexcept | Aws::Crt::DateTime | |
operator<(const DateTime &other) const noexcept | Aws::Crt::DateTime | |
operator<=(const DateTime &other) const noexcept | Aws::Crt::DateTime | |
operator=(double secondsSinceEpoch) noexcept | Aws::Crt::DateTime | |
operator=(uint64_t millisSinceEpoch) noexcept | Aws::Crt::DateTime | |
operator=(const std::chrono::system_clock::time_point &timepointToAssign) noexcept | Aws::Crt::DateTime | |
operator=(const char *timestamp) noexcept | Aws::Crt::DateTime | |
operator==(const DateTime &other) const noexcept | Aws::Crt::DateTime | |
operator>(const DateTime &other) const noexcept | Aws::Crt::DateTime | |
operator>=(const DateTime &other) const noexcept | Aws::Crt::DateTime | |
SecondsWithMSPrecision() const noexcept | Aws::Crt::DateTime | |
ToGmtString(DateFormat format, ByteBuf &outputBuf) const noexcept | Aws::Crt::DateTime | |
ToLocalTimeString(DateFormat format, ByteBuf &outputBuf) const noexcept | Aws::Crt::DateTime | |
UnderlyingTimestamp() const noexcept | Aws::Crt::DateTime |
+ aws-crt-cpp
+
+ C++ wrapper around the aws-c-* libraries. Provides Cross-Platform Transport Protocols and SSL/TLS implementations for C++.
+ |
+
#include <DateTime.h>
+Public Member Functions | |
DateTime () noexcept | |
DateTime (const std::chrono::system_clock::time_point &timepointToAssign) noexcept | |
DateTime (uint64_t millisSinceEpoch) noexcept | |
DateTime (double epoch_millis) noexcept | |
DateTime (const char *timestamp, DateFormat format) noexcept | |
bool | operator== (const DateTime &other) const noexcept |
bool | operator< (const DateTime &other) const noexcept |
bool | operator> (const DateTime &other) const noexcept |
bool | operator!= (const DateTime &other) const noexcept |
bool | operator<= (const DateTime &other) const noexcept |
bool | operator>= (const DateTime &other) const noexcept |
DateTime | operator+ (const std::chrono::milliseconds &a) const noexcept |
DateTime | operator- (const std::chrono::milliseconds &a) const noexcept |
DateTime & | operator= (double secondsSinceEpoch) noexcept |
DateTime & | operator= (uint64_t millisSinceEpoch) noexcept |
DateTime & | operator= (const std::chrono::system_clock::time_point &timepointToAssign) noexcept |
DateTime & | operator= (const char *timestamp) noexcept |
operator bool () const noexcept | |
int | GetLastError () const noexcept |
bool | ToLocalTimeString (DateFormat format, ByteBuf &outputBuf) const noexcept |
bool | ToGmtString (DateFormat format, ByteBuf &outputBuf) const noexcept |
double | SecondsWithMSPrecision () const noexcept |
uint64_t | Millis () const noexcept |
std::chrono::system_clock::time_point | UnderlyingTimestamp () const noexcept |
uint16_t | GetYear (bool localTime=false) const noexcept |
Month | GetMonth (bool localTime=false) const noexcept |
uint8_t | GetDay (bool localTime=false) const noexcept |
DayOfWeek | GetDayOfWeek (bool localTime=false) const noexcept |
uint8_t | GetHour (bool localTime=false) const noexcept |
uint8_t | GetMinute (bool localTime=false) const noexcept |
uint8_t | GetSecond (bool localTime=false) const noexcept |
bool | IsDST (bool localTime=false) const noexcept |
std::chrono::milliseconds | operator- (const DateTime &other) const noexcept |
+Static Public Member Functions | |
static DateTime | Now () noexcept |
+
|
+ +noexcept | +
Initializes time point to epoch
+ +
+
|
+ +noexcept | +
Initializes time point to any other arbitrary timepoint
+ +
+
|
+ +noexcept | +
Initializes time point to millis Since epoch
+ +
+
|
+ +noexcept | +
Initializes time point to epoch time in seconds.millis
+ +
+
|
+ +noexcept | +
Initializes time point to value represented by timestamp and format.
+ +
+
|
+ +noexcept | +
Get the Day of the Month portion of this dateTime. localTime if true, return local time, otherwise return UTC
+ +
+
|
+ +noexcept | +
Get the Day of the Week portion of this dateTime. localTime if true, return local time, otherwise return UTC
+ +
+
|
+ +noexcept | +
Get the Hour portion of this dateTime. localTime if true, return local time, otherwise return UTC
+ +
+
|
+ +noexcept | +
+
|
+ +noexcept | +
Get the Minute portion of this dateTime. localTime if true, return local time, otherwise return UTC
+ +
+
|
+ +noexcept | +
Get the Month portion of this dateTime. localTime if true, return local time, otherwise return UTC
+ +
+
|
+ +noexcept | +
Get the Second portion of this dateTime. localTime if true, return local time, otherwise return UTC
+ +
+
|
+ +noexcept | +
Get the Year portion of this dateTime. localTime if true, return local time, otherwise return UTC
+ +
+
|
+ +noexcept | +
Get whether or not this dateTime is in Daylight savings time. localTime if true, return local time, otherwise return UTC
+ +
+
|
+ +noexcept | +
Milliseconds since epoch of this datetime.
+ +
+
|
+ +staticnoexcept | +
Get an instance of DateTime representing this very instant.
+ +
+
|
+ +explicitnoexcept | +
+
|
+ +noexcept | +
+
|
+ +noexcept | +
+
|
+ +noexcept | +
Computes the difference between two DateTime instances and returns the difference in milliseconds.
+ +
+
|
+ +noexcept | +
+
|
+ +noexcept | +
+
|
+ +noexcept | +
+
|
+ +noexcept | +
Assign from an ISO8601 or RFC822 formatted string
+ +
+
|
+ +noexcept | +
Assign from another time_point
+ +
+
|
+ +noexcept | +
Assign from seconds.millis since epoch.
+ +
+
|
+ +noexcept | +
Assign from millis since epoch.
+ +
+
|
+ +noexcept | +
+
|
+ +noexcept | +
+
|
+ +noexcept | +
+
|
+ +noexcept | +
Get the representation of this datetime as seconds.milliseconds since epoch
+ +
+
|
+ +noexcept | +
Convert dateTime to GMT time string using predefined format.
+ +
+
|
+ +noexcept | +
Convert dateTime to local time string using predefined format.
+ +
+
|
+ +noexcept | +
In the likely case this class doesn't do everything you need to do, here's a copy of the time_point structure. Have fun.
+ +
+ aws-crt-cpp
+
+ C++ wrapper around the aws-c-* libraries. Provides Cross-Platform Transport Protocols and SSL/TLS implementations for C++.
+ |
+
This is the complete list of members for Aws::Crt::Endpoints::RequestContext, including all inherited members.
+AddBoolean(const ByteCursor &name, bool value) | Aws::Crt::Endpoints::RequestContext | |
AddString(const ByteCursor &name, const ByteCursor &value) | Aws::Crt::Endpoints::RequestContext | |
operator bool() const noexcept | Aws::Crt::Endpoints::RequestContext | inline |
operator=(const RequestContext &)=delete | Aws::Crt::Endpoints::RequestContext | |
operator=(RequestContext &&)=delete | Aws::Crt::Endpoints::RequestContext | |
RequestContext(Allocator *allocator=ApiAllocator()) noexcept | Aws::Crt::Endpoints::RequestContext | |
RequestContext(const RequestContext &)=delete | Aws::Crt::Endpoints::RequestContext | |
RequestContext(RequestContext &&)=delete | Aws::Crt::Endpoints::RequestContext | |
~RequestContext() | Aws::Crt::Endpoints::RequestContext |
+ aws-crt-cpp
+
+ C++ wrapper around the aws-c-* libraries. Provides Cross-Platform Transport Protocols and SSL/TLS implementations for C++.
+ |
+
#include <RuleEngine.h>
+Public Member Functions | |
RequestContext (Allocator *allocator=ApiAllocator()) noexcept | |
~RequestContext () | |
RequestContext (const RequestContext &)=delete | |
RequestContext & | operator= (const RequestContext &)=delete |
RequestContext (RequestContext &&)=delete | |
RequestContext & | operator= (RequestContext &&)=delete |
operator bool () const noexcept | |
bool | AddString (const ByteCursor &name, const ByteCursor &value) |
bool | AddBoolean (const ByteCursor &name, bool value) |
+
|
+ +noexcept | +
Aws::Crt::Endpoints::RequestContext::~RequestContext | +( | +) | ++ |
+
|
+ +delete | +
+
|
+ +delete | +
bool Aws::Crt::Endpoints::RequestContext::AddBoolean | +( | +const ByteCursor & | +name, | +
+ | + | bool | +value | +
+ | ) | ++ |
bool Aws::Crt::Endpoints::RequestContext::AddString | +( | +const ByteCursor & | +name, | +
+ | + | const ByteCursor & | +value | +
+ | ) | ++ |
+
|
+ +inlinenoexcept | +
+
|
+ +delete | +
+
|
+ +delete | +
+ aws-crt-cpp
+
+ C++ wrapper around the aws-c-* libraries. Provides Cross-Platform Transport Protocols and SSL/TLS implementations for C++.
+ |
+
This is the complete list of members for Aws::Crt::Endpoints::ResolutionOutcome, including all inherited members.
+GetError() const | Aws::Crt::Endpoints::ResolutionOutcome | |
GetHeaders() const | Aws::Crt::Endpoints::ResolutionOutcome | |
GetProperties() const | Aws::Crt::Endpoints::ResolutionOutcome | |
GetUrl() const | Aws::Crt::Endpoints::ResolutionOutcome | |
IsEndpoint() const noexcept | Aws::Crt::Endpoints::ResolutionOutcome | |
IsError() const noexcept | Aws::Crt::Endpoints::ResolutionOutcome | |
operator bool() const noexcept | Aws::Crt::Endpoints::ResolutionOutcome | inline |
operator=(const ResolutionOutcome &)=delete | Aws::Crt::Endpoints::ResolutionOutcome | |
operator=(ResolutionOutcome &&) | Aws::Crt::Endpoints::ResolutionOutcome | |
ResolutionOutcome(const ResolutionOutcome &)=delete | Aws::Crt::Endpoints::ResolutionOutcome | |
ResolutionOutcome(ResolutionOutcome &&toMove) noexcept | Aws::Crt::Endpoints::ResolutionOutcome | |
~ResolutionOutcome() | Aws::Crt::Endpoints::ResolutionOutcome |
+ aws-crt-cpp
+
+ C++ wrapper around the aws-c-* libraries. Provides Cross-Platform Transport Protocols and SSL/TLS implementations for C++.
+ |
+
#include <RuleEngine.h>
+Public Member Functions | |
~ResolutionOutcome () | |
ResolutionOutcome (const ResolutionOutcome &)=delete | |
ResolutionOutcome & | operator= (const ResolutionOutcome &)=delete |
ResolutionOutcome (ResolutionOutcome &&toMove) noexcept | |
ResolutionOutcome & | operator= (ResolutionOutcome &&) |
bool | IsEndpoint () const noexcept |
bool | IsError () const noexcept |
Optional< StringView > | GetUrl () const |
Optional< StringView > | GetProperties () const |
Optional< UnorderedMap< StringView, Vector< StringView > > > | GetHeaders () const |
Optional< StringView > | GetError () const |
operator bool () const noexcept | |
Aws::Crt::Endpoints::ResolutionOutcome::~ResolutionOutcome | +( | +) | ++ |
+
|
+ +delete | +
+
|
+ +noexcept | +
Optional< StringView > Aws::Crt::Endpoints::ResolutionOutcome::GetError | +( | +) | +const | +
Optional< UnorderedMap< StringView, Vector< StringView > > > Aws::Crt::Endpoints::ResolutionOutcome::GetHeaders | +( | +) | +const | +
Optional< StringView > Aws::Crt::Endpoints::ResolutionOutcome::GetProperties | +( | +) | +const | +
Optional< StringView > Aws::Crt::Endpoints::ResolutionOutcome::GetUrl | +( | +) | +const | +
+
|
+ +noexcept | +
+
|
+ +noexcept | +
+
|
+ +inlinenoexcept | +
+
|
+ +delete | +
ResolutionOutcome & Aws::Crt::Endpoints::ResolutionOutcome::operator= | +( | +ResolutionOutcome && | +toMove | ) | ++ |
+ aws-crt-cpp
+
+ C++ wrapper around the aws-c-* libraries. Provides Cross-Platform Transport Protocols and SSL/TLS implementations for C++.
+ |
+
This is the complete list of members for Aws::Crt::Endpoints::RuleEngine, including all inherited members.
+operator bool() const noexcept | Aws::Crt::Endpoints::RuleEngine | inline |
operator=(const RuleEngine &)=delete | Aws::Crt::Endpoints::RuleEngine | |
operator=(RuleEngine &&)=delete | Aws::Crt::Endpoints::RuleEngine | |
Resolve(const RequestContext &context) const | Aws::Crt::Endpoints::RuleEngine | |
RuleEngine(const ByteCursor &rulesetCursor, const ByteCursor &partitionsCursor, Allocator *allocator=ApiAllocator()) noexcept | Aws::Crt::Endpoints::RuleEngine | |
RuleEngine(const RuleEngine &)=delete | Aws::Crt::Endpoints::RuleEngine | |
RuleEngine(RuleEngine &&)=delete | Aws::Crt::Endpoints::RuleEngine | |
~RuleEngine() | Aws::Crt::Endpoints::RuleEngine |
+ aws-crt-cpp
+
+ C++ wrapper around the aws-c-* libraries. Provides Cross-Platform Transport Protocols and SSL/TLS implementations for C++.
+ |
+
#include <RuleEngine.h>
+Public Member Functions | |
RuleEngine (const ByteCursor &rulesetCursor, const ByteCursor &partitionsCursor, Allocator *allocator=ApiAllocator()) noexcept | |
~RuleEngine () | |
RuleEngine (const RuleEngine &)=delete | |
RuleEngine & | operator= (const RuleEngine &)=delete |
RuleEngine (RuleEngine &&)=delete | |
RuleEngine & | operator= (RuleEngine &&)=delete |
operator bool () const noexcept | |
Optional< ResolutionOutcome > | Resolve (const RequestContext &context) const |
Endpoints Rule Engine.
+
+
|
+ +noexcept | +
Aws::Crt::Endpoints::RuleEngine::~RuleEngine | +( | +) | ++ |
+
|
+ +delete | +
+
|
+ +delete | +
+
|
+ +inlinenoexcept | +
+
|
+ +delete | +
+
|
+ +delete | +
Optional< ResolutionOutcome > Aws::Crt::Endpoints::RuleEngine::Resolve | +( | +const RequestContext & | +context | ) | +const | +
+ aws-crt-cpp
+
+ C++ wrapper around the aws-c-* libraries. Provides Cross-Platform Transport Protocols and SSL/TLS implementations for C++.
+ |
+
This is the complete list of members for Aws::Crt::Http::AdaptiveHttpProxyStrategy, including all inherited members.
+AdaptiveHttpProxyStrategy(Allocator *allocator, const KerberosGetTokenFunction &kerberosGetToken, const KerberosGetTokenFunction &ntlmGetCredential, const NtlmGetTokenFunction &ntlmGetToken) | Aws::Crt::Http::AdaptiveHttpProxyStrategy | inline |
CreateAdaptiveHttpProxyStrategy(const HttpProxyStrategyAdaptiveConfig &config, Allocator *allocator=ApiAllocator()) | Aws::Crt::Http::HttpProxyStrategy | static |
CreateBasicHttpProxyStrategy(const HttpProxyStrategyBasicAuthConfig &config, Allocator *allocator=ApiAllocator()) | Aws::Crt::Http::HttpProxyStrategy | static |
HttpProxyStrategy(struct aws_http_proxy_strategy *strategy) | Aws::Crt::Http::HttpProxyStrategy | |
KerberosGetToken(void *user_data, int *error_code) | Aws::Crt::Http::AdaptiveHttpProxyStrategy | inlinestatic |
m_strategy | Aws::Crt::Http::HttpProxyStrategy | protected |
NtlmGetCredential(void *user_data, int *error_code) | Aws::Crt::Http::AdaptiveHttpProxyStrategy | inlinestatic |
NtlmGetToken(void *user_data, const struct aws_byte_cursor *challenge_cursor, int *error_code) | Aws::Crt::Http::AdaptiveHttpProxyStrategy | inlinestatic |
SetStrategy(struct aws_http_proxy_strategy *strategy) | Aws::Crt::Http::AdaptiveHttpProxyStrategy | inline |
~HttpProxyStrategy() | Aws::Crt::Http::HttpProxyStrategy | virtual |
+ aws-crt-cpp
+
+ C++ wrapper around the aws-c-* libraries. Provides Cross-Platform Transport Protocols and SSL/TLS implementations for C++.
+ |
+
+Public Member Functions | |
AdaptiveHttpProxyStrategy (Allocator *allocator, const KerberosGetTokenFunction &kerberosGetToken, const KerberosGetTokenFunction &ntlmGetCredential, const NtlmGetTokenFunction &ntlmGetToken) | |
void | SetStrategy (struct aws_http_proxy_strategy *strategy) |
Public Member Functions inherited from Aws::Crt::Http::HttpProxyStrategy | |
HttpProxyStrategy (struct aws_http_proxy_strategy *strategy) | |
virtual | ~HttpProxyStrategy () |
+Static Public Member Functions | |
static struct aws_string * | NtlmGetCredential (void *user_data, int *error_code) |
static struct aws_string * | KerberosGetToken (void *user_data, int *error_code) |
static struct aws_string * | NtlmGetToken (void *user_data, const struct aws_byte_cursor *challenge_cursor, int *error_code) |
Static Public Member Functions inherited from Aws::Crt::Http::HttpProxyStrategy | |
static std::shared_ptr< HttpProxyStrategy > | CreateBasicHttpProxyStrategy (const HttpProxyStrategyBasicAuthConfig &config, Allocator *allocator=ApiAllocator()) |
static std::shared_ptr< HttpProxyStrategy > | CreateAdaptiveHttpProxyStrategy (const HttpProxyStrategyAdaptiveConfig &config, Allocator *allocator=ApiAllocator()) |
+Additional Inherited Members | |
Protected Attributes inherited from Aws::Crt::Http::HttpProxyStrategy | |
struct aws_http_proxy_strategy * | m_strategy |
+
|
+ +inline | +
+
|
+ +inlinestatic | +
+
|
+ +inlinestatic | +
+
|
+ +inlinestatic | +
+
|
+ +inline | +
+ aws-crt-cpp
+
+ C++ wrapper around the aws-c-* libraries. Provides Cross-Platform Transport Protocols and SSL/TLS implementations for C++.
+ |
+
This is the complete list of members for Aws::Crt::Http::HttpClientConnection, including all inherited members.
+
+ aws-crt-cpp
+
+ C++ wrapper around the aws-c-* libraries. Provides Cross-Platform Transport Protocols and SSL/TLS implementations for C++.
+ |
+
#include <HttpConnection.h>
+Public Member Functions | |
virtual | ~HttpClientConnection ()=default |
HttpClientConnection (const HttpClientConnection &)=delete | |
HttpClientConnection (HttpClientConnection &&)=delete | |
HttpClientConnection & | operator= (const HttpClientConnection &)=delete |
HttpClientConnection & | operator= (HttpClientConnection &&)=delete |
std::shared_ptr< HttpClientStream > | NewClientStream (const HttpRequestOptions &requestOptions) noexcept |
bool | IsOpen () const noexcept |
void | Close () noexcept |
HttpVersion | GetVersion () noexcept |
int | LastError () const noexcept |
+Static Public Member Functions | |
static bool | CreateConnection (const HttpClientConnectionOptions &connectionOptions, Allocator *allocator) noexcept |
+Protected Member Functions | |
HttpClientConnection (aws_http_connection *m_connection, Allocator *allocator) noexcept | |
+Protected Attributes | |
aws_http_connection * | m_connection |
Represents a connection from a Http Client to a Server.
+
+
|
+ +virtualdefault | +
+
|
+ +delete | +
+
|
+ +delete | +
+
|
+ +protectednoexcept | +
+
|
+ +noexcept | +
Initiate a shutdown of the connection. Sometimes, connections are persistent and you want to close them before shutting down your application or whatever is consuming this interface.
+Assuming OnConnectionShutdown
has not already been invoked, it will be invoked as a result of this call.
+
|
+ +staticnoexcept | +
Create a new Https Connection to hostName:port, using socketOptions
for tcp options and tlsConnOptions
for TLS/SSL options. If tlsConnOptions
is null http (plain-text) will be used.
returns true on success, and false on failure. If false is returned, onConnectionSetup
will not be invoked. On success, onConnectionSetup
will be called, either with a connection, or an errorCode.
+
|
+ +noexcept | +
+
|
+ +noexcept | +
+
|
+ +inlinenoexcept | +
+
|
+ +noexcept | +
Make a new client initiated request on this connection.
+If you take a reference to the return value, the memory and resources for the connection and stream will not be cleaned up until you release it. You can however, release the reference as soon as you don't need it anymore. The internal reference count ensures the resources will not be freed until the stream is completed.
+Returns an instance of HttpStream upon success and nullptr on failure.
+You must call HttpClientStream::Activate() to begin outgoing processing of the stream.
+ +
+
|
+ +delete | +
+
|
+ +delete | +
+
|
+ +protected | +
+ aws-crt-cpp
+
+ C++ wrapper around the aws-c-* libraries. Provides Cross-Platform Transport Protocols and SSL/TLS implementations for C++.
+ |
+
This is the complete list of members for Aws::Crt::Http::HttpClientConnectionManager, including all inherited members.
+AcquireConnection(const OnClientConnectionAvailable &onClientConnectionAvailable) noexcept | Aws::Crt::Http::HttpClientConnectionManager | |
InitiateShutdown() noexcept | Aws::Crt::Http::HttpClientConnectionManager | |
ManagedConnection class | Aws::Crt::Http::HttpClientConnectionManager | friend |
NewClientConnectionManager(const HttpClientConnectionManagerOptions &connectionManagerOptions, Allocator *allocator=ApiAllocator()) noexcept | Aws::Crt::Http::HttpClientConnectionManager | static |
~HttpClientConnectionManager() | Aws::Crt::Http::HttpClientConnectionManager |
+ aws-crt-cpp
+
+ C++ wrapper around the aws-c-* libraries. Provides Cross-Platform Transport Protocols and SSL/TLS implementations for C++.
+ |
+
#include <HttpConnectionManager.h>
+Public Member Functions | |
~HttpClientConnectionManager () | |
bool | AcquireConnection (const OnClientConnectionAvailable &onClientConnectionAvailable) noexcept |
std::future< void > | InitiateShutdown () noexcept |
+Static Public Member Functions | |
static std::shared_ptr< HttpClientConnectionManager > | NewClientConnectionManager (const HttpClientConnectionManagerOptions &connectionManagerOptions, Allocator *allocator=ApiAllocator()) noexcept |
+Friends | |
class | ManagedConnection |
Manages a pool of connections to a specific endpoint using the same socket and tls options.
+Aws::Crt::Http::HttpClientConnectionManager::~HttpClientConnectionManager | +( | +) | ++ |
+
|
+ +noexcept | +
Acquires a connection from the pool. onClientConnectionAvailable will be invoked upon an available connection. Returns true if the connection request was successfully queued, returns false if it failed. On failure, onClientConnectionAvailable will not be invoked. After receiving a connection, it will automatically be cleaned up when your last reference to the shared_ptr is released.
+onClientConnectionAvailable | callback to invoke when a connection becomes available or the acquisition attempt terminates |
+
|
+ +noexcept | +
Starts shutdown of the connection manager. Returns a future to the connection manager's shutdown process. If EnableBlockingDestruct was enabled on the connection manager options, calling get() on the returned future will block until the last connection is released. If the option is not set, get() will immediately return.
+
|
+ +staticnoexcept | +
Factory function for connection managers
+connectionManagerOptions | connection manager configuration data |
allocator | allocator to use |
+
|
+ +friend | +
+ aws-crt-cpp
+
+ C++ wrapper around the aws-c-* libraries. Provides Cross-Platform Transport Protocols and SSL/TLS implementations for C++.
+ |
+
This is the complete list of members for Aws::Crt::Http::HttpClientConnectionManagerOptions, including all inherited members.
+ConnectionOptions | Aws::Crt::Http::HttpClientConnectionManagerOptions | |
EnableBlockingShutdown | Aws::Crt::Http::HttpClientConnectionManagerOptions | |
HttpClientConnectionManagerOptions() noexcept | Aws::Crt::Http::HttpClientConnectionManagerOptions | |
HttpClientConnectionManagerOptions(const HttpClientConnectionManagerOptions &rhs)=default | Aws::Crt::Http::HttpClientConnectionManagerOptions | |
HttpClientConnectionManagerOptions(HttpClientConnectionManagerOptions &&rhs)=default | Aws::Crt::Http::HttpClientConnectionManagerOptions | |
MaxConnections | Aws::Crt::Http::HttpClientConnectionManagerOptions | |
operator=(const HttpClientConnectionManagerOptions &rhs)=default | Aws::Crt::Http::HttpClientConnectionManagerOptions | |
operator=(HttpClientConnectionManagerOptions &&rhs)=default | Aws::Crt::Http::HttpClientConnectionManagerOptions |
+ aws-crt-cpp
+
+ C++ wrapper around the aws-c-* libraries. Provides Cross-Platform Transport Protocols and SSL/TLS implementations for C++.
+ |
+
#include <HttpConnectionManager.h>
+Public Member Functions | |
HttpClientConnectionManagerOptions () noexcept | |
HttpClientConnectionManagerOptions (const HttpClientConnectionManagerOptions &rhs)=default | |
HttpClientConnectionManagerOptions (HttpClientConnectionManagerOptions &&rhs)=default | |
HttpClientConnectionManagerOptions & | operator= (const HttpClientConnectionManagerOptions &rhs)=default |
HttpClientConnectionManagerOptions & | operator= (HttpClientConnectionManagerOptions &&rhs)=default |
+Public Attributes | |
HttpClientConnectionOptions | ConnectionOptions |
size_t | MaxConnections |
bool | EnableBlockingShutdown |
Configuration struct containing all options related to connection manager behavior
+
+
|
+ +noexcept | +
+
|
+ +default | +
+
|
+ +default | +
+
|
+ +default | +
+
|
+ +default | +
HttpClientConnectionOptions Aws::Crt::Http::HttpClientConnectionManagerOptions::ConnectionOptions | +
The http connection options to use for each connection created by the manager
+ +bool Aws::Crt::Http::HttpClientConnectionManagerOptions::EnableBlockingShutdown | +
If set, initiate shutdown will return a future that will allow a user to block until the connection manager has completely released all resources. This isn't necessary during the normal flow of an application, but it is useful for scenarios, such as tests, that need deterministic shutdown ordering. Be aware, if you use this anywhere other than the main thread, you will most likely cause a deadlock. If this is set, you MUST call InitiateShutdown() before releasing your last reference to the connection manager.
+ +size_t Aws::Crt::Http::HttpClientConnectionManagerOptions::MaxConnections | +
The maximum number of connections the manager is allowed to create/manage
+ +
+ aws-crt-cpp
+
+ C++ wrapper around the aws-c-* libraries. Provides Cross-Platform Transport Protocols and SSL/TLS implementations for C++.
+ |
+
This is the complete list of members for Aws::Crt::Http::HttpClientConnectionOptions, including all inherited members.
+
+ aws-crt-cpp
+
+ C++ wrapper around the aws-c-* libraries. Provides Cross-Platform Transport Protocols and SSL/TLS implementations for C++.
+ |
+
#include <HttpConnection.h>
+Public Member Functions | |
HttpClientConnectionOptions () | |
HttpClientConnectionOptions (const HttpClientConnectionOptions &rhs)=default | |
HttpClientConnectionOptions (HttpClientConnectionOptions &&rhs)=default | |
~HttpClientConnectionOptions ()=default | |
HttpClientConnectionOptions & | operator= (const HttpClientConnectionOptions &rhs)=default |
HttpClientConnectionOptions & | operator= (HttpClientConnectionOptions &&rhs)=default |
+Public Attributes | |
Io::ClientBootstrap * | Bootstrap |
size_t | InitialWindowSize |
OnConnectionSetup | OnConnectionSetupCallback |
OnConnectionShutdown | OnConnectionShutdownCallback |
String | HostName |
uint32_t | Port |
Io::SocketOptions | SocketOptions |
Optional< Io::TlsConnectionOptions > | TlsOptions |
Optional< HttpClientConnectionProxyOptions > | ProxyOptions |
bool | ManualWindowManagement |
Configuration structure holding all options relating to http connection establishment
+Aws::Crt::Http::HttpClientConnectionOptions::HttpClientConnectionOptions | +( | +) | ++ |
+
|
+ +default | +
+
|
+ +default | +
+
|
+ +default | +
+
|
+ +default | +
+
|
+ +default | +
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.
+ +
+ aws-crt-cpp
+
+ C++ wrapper around the aws-c-* libraries. Provides Cross-Platform Transport Protocols and SSL/TLS implementations for C++.
+ |
+
This is the complete list of members for Aws::Crt::Http::HttpClientConnectionProxyOptions, including all inherited members.
+
+ aws-crt-cpp
+
+ C++ wrapper around the aws-c-* libraries. Provides Cross-Platform Transport Protocols and SSL/TLS implementations for C++.
+ |
+
#include <HttpConnection.h>
+Public Member Functions | |
HttpClientConnectionProxyOptions () | |
HttpClientConnectionProxyOptions (const HttpClientConnectionProxyOptions &rhs)=default | |
HttpClientConnectionProxyOptions (HttpClientConnectionProxyOptions &&rhs)=default | |
HttpClientConnectionProxyOptions & | operator= (const HttpClientConnectionProxyOptions &rhs)=default |
HttpClientConnectionProxyOptions & | operator= (HttpClientConnectionProxyOptions &&rhs)=default |
~HttpClientConnectionProxyOptions ()=default | |
void | InitializeRawProxyOptions (struct aws_http_proxy_options &raw_options) const |
+Public Attributes | |
String | HostName |
uint32_t | Port |
Optional< Io::TlsConnectionOptions > | TlsOptions |
AwsHttpProxyConnectionType | ProxyConnectionType |
std::shared_ptr< HttpProxyStrategy > | ProxyStrategy |
AwsHttpProxyAuthenticationType | AuthType |
String | BasicAuthUsername |
String | BasicAuthPassword |
Configuration structure that holds all proxy-related http connection options
+Aws::Crt::Http::HttpClientConnectionProxyOptions::HttpClientConnectionProxyOptions | +( | +) | ++ |
+
|
+ +default | +
+
|
+ +default | +
+
|
+ +default | +
void Aws::Crt::Http::HttpClientConnectionProxyOptions::InitializeRawProxyOptions | +( | +struct aws_http_proxy_options & | +raw_options | ) | +const | +
Intended for internal use only. Initializes the C proxy configuration structure, aws_http_proxy_options, from an HttpClientConnectionProxyOptions instance.
+raw_options | - output parameter containing low level proxy options to be passed to the C interface |
+
|
+ +default | +
+
|
+ +default | +
AwsHttpProxyAuthenticationType Aws::Crt::Http::HttpClientConnectionProxyOptions::AuthType | +
Backwards compatibility achieved by invoking CreateBasicHttpProxyStrategy if (1) ProxyStrategy is null (2) AuthType is AwsHttpProxyAuthenticationType::Basic
+ +String Aws::Crt::Http::HttpClientConnectionProxyOptions::BasicAuthPassword | +
String Aws::Crt::Http::HttpClientConnectionProxyOptions::BasicAuthUsername | +
String Aws::Crt::Http::HttpClientConnectionProxyOptions::HostName | +
The name of the proxy server to connect through. Required.
+ +uint32_t Aws::Crt::Http::HttpClientConnectionProxyOptions::Port | +
The port of the proxy server to connect to. Required.
+ +AwsHttpProxyConnectionType Aws::Crt::Http::HttpClientConnectionProxyOptions::ProxyConnectionType | +
What kind of proxy connection to make
+ +std::shared_ptr<HttpProxyStrategy> Aws::Crt::Http::HttpClientConnectionProxyOptions::ProxyStrategy | +
Proxy strategy to use while negotiating the connection. Use null for no additional steps.
+ +Optional<Io::TlsConnectionOptions> Aws::Crt::Http::HttpClientConnectionProxyOptions::TlsOptions | +
Sets the TLS options for the connection to the proxy. Optional.
+ +
+ aws-crt-cpp
+
+ C++ wrapper around the aws-c-* libraries. Provides Cross-Platform Transport Protocols and SSL/TLS implementations for C++.
+ |
+
This is the complete list of members for Aws::Crt::Http::HttpClientStream, including all inherited members.
+
+ aws-crt-cpp
+
+ C++ wrapper around the aws-c-* libraries. Provides Cross-Platform Transport Protocols and SSL/TLS implementations for C++.
+ |
+
#include <HttpConnection.h>
+Public Member Functions | |
~HttpClientStream () | |
HttpClientStream (const HttpClientStream &)=delete | |
HttpClientStream (HttpClientStream &&)=delete | |
HttpClientStream & | operator= (const HttpClientStream &)=delete |
HttpClientStream & | operator= (HttpClientStream &&)=delete |
virtual int | GetResponseStatusCode () const noexcept override |
bool | Activate () noexcept |
Public Member Functions inherited from Aws::Crt::Http::HttpStream | |
virtual | ~HttpStream () |
HttpStream (const HttpStream &)=delete | |
HttpStream (HttpStream &&)=delete | |
HttpStream & | operator= (const HttpStream &)=delete |
HttpStream & | operator= (HttpStream &&)=delete |
HttpClientConnection & | GetConnection () const noexcept |
void | UpdateWindow (std::size_t incrementSize) noexcept |
+Friends | |
class | HttpClientConnection |
+Additional Inherited Members | |
Protected Member Functions inherited from Aws::Crt::Http::HttpStream | |
HttpStream (const std::shared_ptr< HttpClientConnection > &connection) noexcept | |
Protected Attributes inherited from Aws::Crt::Http::HttpStream | |
aws_http_stream * | m_stream |
std::shared_ptr< HttpClientConnection > | m_connection |
Subclass that represents an http client's view of an HttpStream.
+Aws::Crt::Http::HttpClientStream::~HttpClientStream | +( | +) | ++ |
+
|
+ +delete | +
+
|
+ +delete | +
+
|
+ +noexcept | +
Activates the request's outgoing stream processing.
+Returns true on success, false otherwise.
+ +
+
|
+ +overridevirtualnoexcept | +
If this stream was initiated as a request, assuming the headers of the response has been received, this value contains the Http Response Code. *
+ +Implements Aws::Crt::Http::HttpStream.
+ +
+
|
+ +delete | +
+
|
+ +delete | +
+
|
+ +friend | +
+ aws-crt-cpp
+
+ C++ wrapper around the aws-c-* libraries. Provides Cross-Platform Transport Protocols and SSL/TLS implementations for C++.
+ |
+
This is the complete list of members for Aws::Crt::Http::HttpMessage, including all inherited members.
+
+ aws-crt-cpp
+
+ C++ wrapper around the aws-c-* libraries. Provides Cross-Platform Transport Protocols and SSL/TLS implementations for C++.
+ |
+
#include <HttpRequestResponse.h>
+Public Member Functions | |
virtual | ~HttpMessage () |
HttpMessage (const HttpMessage &)=delete | |
HttpMessage (HttpMessage &&)=delete | |
HttpMessage & | operator= (const HttpMessage &)=delete |
HttpMessage & | operator= (HttpMessage &&)=delete |
std::shared_ptr< Aws::Crt::Io::InputStream > | GetBody () const noexcept |
bool | SetBody (const std::shared_ptr< Aws::Crt::Io::IStream > &body) noexcept |
bool | SetBody (const std::shared_ptr< Aws::Crt::Io::InputStream > &body) noexcept |
size_t | GetHeaderCount () const noexcept |
Optional< HttpHeader > | GetHeader (size_t index) const noexcept |
bool | AddHeader (const HttpHeader &header) noexcept |
bool | EraseHeader (size_t index) noexcept |
operator bool () const noexcept | |
+Protected Member Functions | |
HttpMessage (Allocator *allocator, struct aws_http_message *message) noexcept | |
+Protected Attributes | |
Allocator * | m_allocator |
struct aws_http_message * | m_message |
std::shared_ptr< Aws::Crt::Io::InputStream > | m_bodyStream |
Base class representing a mutable http request or response.
+
+
|
+ +virtual | +
+
|
+ +delete | +
+
|
+ +delete | +
+
|
+ +protectednoexcept | +
+
|
+ +noexcept | +
Adds a header to the request
header | header to add |
+
|
+ +noexcept | +
Removes a header from the request
index | index of the header to remove |
+
|
+ +noexcept | +
Gets the input stream representing the message body
+ +
+
|
+ +noexcept | +
Gets a particular header in the request
index | index of the header to fetch |
+
|
+ +noexcept | +
Gets the number of headers contained in this request
+
|
+ +inlinenoexcept | +
+
|
+ +delete | +
+
|
+ +delete | +
+
|
+ +noexcept | +
Sets the input stream representing the message body
body | the input stream representing the message body |
+
|
+ +noexcept | +
Sets the input stream representing the message body
body | the input stream representing the message body |
+
|
+ +protected | +
+
|
+ +protected | +
+
|
+ +protected | +
+ aws-crt-cpp
+
+ C++ wrapper around the aws-c-* libraries. Provides Cross-Platform Transport Protocols and SSL/TLS implementations for C++.
+ |
+
This is the complete list of members for Aws::Crt::Http::HttpProxyStrategy, including all inherited members.
+CreateAdaptiveHttpProxyStrategy(const HttpProxyStrategyAdaptiveConfig &config, Allocator *allocator=ApiAllocator()) | Aws::Crt::Http::HttpProxyStrategy | static |
CreateBasicHttpProxyStrategy(const HttpProxyStrategyBasicAuthConfig &config, Allocator *allocator=ApiAllocator()) | Aws::Crt::Http::HttpProxyStrategy | static |
HttpProxyStrategy(struct aws_http_proxy_strategy *strategy) | Aws::Crt::Http::HttpProxyStrategy | |
m_strategy | Aws::Crt::Http::HttpProxyStrategy | protected |
~HttpProxyStrategy() | Aws::Crt::Http::HttpProxyStrategy | virtual |
+ aws-crt-cpp
+
+ C++ wrapper around the aws-c-* libraries. Provides Cross-Platform Transport Protocols and SSL/TLS implementations for C++.
+ |
+
#include <HttpProxyStrategy.h>
+Public Member Functions | |
HttpProxyStrategy (struct aws_http_proxy_strategy *strategy) | |
virtual | ~HttpProxyStrategy () |
+Static Public Member Functions | |
static std::shared_ptr< HttpProxyStrategy > | CreateBasicHttpProxyStrategy (const HttpProxyStrategyBasicAuthConfig &config, Allocator *allocator=ApiAllocator()) |
static std::shared_ptr< HttpProxyStrategy > | CreateAdaptiveHttpProxyStrategy (const HttpProxyStrategyAdaptiveConfig &config, Allocator *allocator=ApiAllocator()) |
+Protected Attributes | |
struct aws_http_proxy_strategy * | m_strategy |
Wrapper class for a C-level proxy strategy - an object that allows the user to transform or modify the authentication logic when connecting to a proxy.
+Aws::Crt::Http::HttpProxyStrategy::HttpProxyStrategy | +( | +struct aws_http_proxy_strategy * | +strategy | ) | ++ |
+
|
+ +virtual | +
+
|
+ +static | +
Creates a proxy strategy that, depending on configuration, can attempt kerberos and/or ntlm authentication when connecting to the proxy
config | the adaptive strategy configuration options |
allocator | allocator to use |
+
|
+ +static | +
Creates a proxy strategy that performs basic authentication
config | basic authentication configuration options |
allocator | allocator to use |
+
|
+ +protected | +
+ aws-crt-cpp
+
+ C++ wrapper around the aws-c-* libraries. Provides Cross-Platform Transport Protocols and SSL/TLS implementations for C++.
+ |
+
This is the complete list of members for Aws::Crt::Http::HttpRequest, including all inherited members.
+
+ aws-crt-cpp
+
+ C++ wrapper around the aws-c-* libraries. Provides Cross-Platform Transport Protocols and SSL/TLS implementations for C++.
+ |
+
#include <HttpRequestResponse.h>
+Public Member Functions | |
HttpRequest (Allocator *allocator=ApiAllocator()) | |
Optional< ByteCursor > | GetMethod () const noexcept |
bool | SetMethod (ByteCursor method) noexcept |
Optional< ByteCursor > | GetPath () const noexcept |
bool | SetPath (ByteCursor path) noexcept |
+Protected Member Functions | |
HttpRequest (Allocator *allocator, struct aws_http_message *message) | |
+Friends | |
class | Mqtt::MqttConnectionCore |
class | Mqtt5::Mqtt5ClientCore |
+Additional Inherited Members |
Class representing a mutable http request.
+Aws::Crt::Http::HttpRequest::HttpRequest | +( | +Allocator * | +allocator = ApiAllocator() | ) | ++ |
+
|
+ +protected | +
+
|
+ +noexcept | +
+
|
+ +noexcept | +
+
|
+ +noexcept | +
Sets the value of the Http method associated with this request
+ +
+
|
+ +noexcept | +
Sets the value of the URI-path associated with this request
+ +
+
|
+ +friend | +
+
|
+ +friend | +
+ aws-crt-cpp
+
+ C++ wrapper around the aws-c-* libraries. Provides Cross-Platform Transport Protocols and SSL/TLS implementations for C++.
+ |
+
This is the complete list of members for Aws::Crt::Http::HttpResponse, including all inherited members.
+
+ aws-crt-cpp
+
+ C++ wrapper around the aws-c-* libraries. Provides Cross-Platform Transport Protocols and SSL/TLS implementations for C++.
+ |
+
#include <HttpRequestResponse.h>
+Public Member Functions | |
HttpResponse (Allocator *allocator=ApiAllocator()) | |
Optional< int > | GetResponseCode () const noexcept |
bool | SetResponseCode (int response) noexcept |
+Additional Inherited Members |
Class representing a mutable http response.
+Aws::Crt::Http::HttpResponse::HttpResponse | +( | +Allocator * | +allocator = ApiAllocator() | ) | ++ |
+
|
+ +noexcept | +
+
|
+ +noexcept | +
Sets the integral Http response code associated with this response
+ +
+ aws-crt-cpp
+
+ C++ wrapper around the aws-c-* libraries. Provides Cross-Platform Transport Protocols and SSL/TLS implementations for C++.
+ |
+
This is the complete list of members for Aws::Crt::Http::HttpStream, including all inherited members.
+GetConnection() const noexcept | Aws::Crt::Http::HttpStream | |
GetResponseStatusCode() const noexcept=0 | Aws::Crt::Http::HttpStream | pure virtual |
HttpClientConnection class | Aws::Crt::Http::HttpStream | friend |
HttpStream(const HttpStream &)=delete | Aws::Crt::Http::HttpStream | |
HttpStream(HttpStream &&)=delete | Aws::Crt::Http::HttpStream | |
HttpStream(const std::shared_ptr< HttpClientConnection > &connection) noexcept | Aws::Crt::Http::HttpStream | protected |
m_connection | Aws::Crt::Http::HttpStream | protected |
m_stream | Aws::Crt::Http::HttpStream | protected |
operator=(const HttpStream &)=delete | Aws::Crt::Http::HttpStream | |
operator=(HttpStream &&)=delete | Aws::Crt::Http::HttpStream | |
UpdateWindow(std::size_t incrementSize) noexcept | Aws::Crt::Http::HttpStream | |
~HttpStream() | Aws::Crt::Http::HttpStream | virtual |
+ aws-crt-cpp
+
+ C++ wrapper around the aws-c-* libraries. Provides Cross-Platform Transport Protocols and SSL/TLS implementations for C++.
+ |
+
#include <HttpConnection.h>
+Public Member Functions | |
virtual | ~HttpStream () |
HttpStream (const HttpStream &)=delete | |
HttpStream (HttpStream &&)=delete | |
HttpStream & | operator= (const HttpStream &)=delete |
HttpStream & | operator= (HttpStream &&)=delete |
HttpClientConnection & | GetConnection () const noexcept |
virtual int | GetResponseStatusCode () const noexcept=0 |
void | UpdateWindow (std::size_t incrementSize) noexcept |
+Protected Member Functions | |
HttpStream (const std::shared_ptr< HttpClientConnection > &connection) noexcept | |
+Protected Attributes | |
aws_http_stream * | m_stream |
std::shared_ptr< HttpClientConnection > | m_connection |
+Friends | |
class | HttpClientConnection |
Represents a single http message exchange (request/response) or in H2, it can also represent a PUSH_PROMISE followed by the accompanying Response.
+
+
|
+ +virtual | +
+
|
+ +delete | +
+
|
+ +delete | +
+
|
+ +protectednoexcept | +
+
|
+ +noexcept | +
Get the underlying connection for the stream.
+ +
+
|
+ +pure virtualnoexcept | +
Implemented in Aws::Crt::Http::HttpClientStream.
+ +
+
|
+ +delete | +
+
|
+ +delete | +
+
|
+ +noexcept | +
Updates the read window on the connection. In Http 1.1 this relieves TCP back pressure, in H2 this will trigger two WINDOW_UPDATE frames, one for the connection and one for the stream.
+You do not need to call this unless you utilized the outWindowUpdateSize
in OnIncomingBody
. See OnIncomingBody
for more information.
incrementSize
is the amount to update the read window by.
+
|
+ +friend | +
+
|
+ +protected | +
+
|
+ +protected | +
+ aws-crt-cpp
+
+ C++ wrapper around the aws-c-* libraries. Provides Cross-Platform Transport Protocols and SSL/TLS implementations for C++.
+ |
+
This is the complete list of members for Aws::Crt::Http::ManagedConnection, including all inherited members.
+
+ aws-crt-cpp
+
+ C++ wrapper around the aws-c-* libraries. Provides Cross-Platform Transport Protocols and SSL/TLS implementations for C++.
+ |
+
+Public Member Functions | |
ManagedConnection (aws_http_connection *connection, std::shared_ptr< HttpClientConnectionManager > connectionManager) | |
~ManagedConnection () override | |
Public Member Functions inherited from Aws::Crt::Http::HttpClientConnection | |
virtual | ~HttpClientConnection ()=default |
HttpClientConnection (const HttpClientConnection &)=delete | |
HttpClientConnection (HttpClientConnection &&)=delete | |
HttpClientConnection & | operator= (const HttpClientConnection &)=delete |
HttpClientConnection & | operator= (HttpClientConnection &&)=delete |
std::shared_ptr< HttpClientStream > | NewClientStream (const HttpRequestOptions &requestOptions) noexcept |
bool | IsOpen () const noexcept |
void | Close () noexcept |
HttpVersion | GetVersion () noexcept |
int | LastError () const noexcept |
+Additional Inherited Members | |
Static Public Member Functions inherited from Aws::Crt::Http::HttpClientConnection | |
static bool | CreateConnection (const HttpClientConnectionOptions &connectionOptions, Allocator *allocator) noexcept |
Protected Member Functions inherited from Aws::Crt::Http::HttpClientConnection | |
HttpClientConnection (aws_http_connection *m_connection, Allocator *allocator) noexcept | |
Protected Attributes inherited from Aws::Crt::Http::HttpClientConnection | |
aws_http_connection * | m_connection |
+
|
+ +inline | +
+
|
+ +inlineoverride | +
+ aws-crt-cpp
+
+ C++ wrapper around the aws-c-* libraries. Provides Cross-Platform Transport Protocols and SSL/TLS implementations for C++.
+ |
+
This is the complete list of members for Aws::Crt::Http::UnmanagedConnection, including all inherited members.
+
+ aws-crt-cpp
+
+ C++ wrapper around the aws-c-* libraries. Provides Cross-Platform Transport Protocols and SSL/TLS implementations for C++.
+ |
+
+Public Member Functions | |
UnmanagedConnection (aws_http_connection *connection, Aws::Crt::Allocator *allocator) | |
~UnmanagedConnection () override | |
Public Member Functions inherited from Aws::Crt::Http::HttpClientConnection | |
virtual | ~HttpClientConnection ()=default |
HttpClientConnection (const HttpClientConnection &)=delete | |
HttpClientConnection (HttpClientConnection &&)=delete | |
HttpClientConnection & | operator= (const HttpClientConnection &)=delete |
HttpClientConnection & | operator= (HttpClientConnection &&)=delete |
std::shared_ptr< HttpClientStream > | NewClientStream (const HttpRequestOptions &requestOptions) noexcept |
bool | IsOpen () const noexcept |
void | Close () noexcept |
HttpVersion | GetVersion () noexcept |
int | LastError () const noexcept |
+Additional Inherited Members | |
Static Public Member Functions inherited from Aws::Crt::Http::HttpClientConnection | |
static bool | CreateConnection (const HttpClientConnectionOptions &connectionOptions, Allocator *allocator) noexcept |
Protected Member Functions inherited from Aws::Crt::Http::HttpClientConnection | |
HttpClientConnection (aws_http_connection *m_connection, Allocator *allocator) noexcept | |
Protected Attributes inherited from Aws::Crt::Http::HttpClientConnection | |
aws_http_connection * | m_connection |
+
|
+ +inline | +
+
|
+ +inlineoverride | +
+ aws-crt-cpp
+
+ C++ wrapper around the aws-c-* libraries. Provides Cross-Platform Transport Protocols and SSL/TLS implementations for C++.
+ |
+
This is the complete list of members for Aws::Crt::Imds::ImdsClient, including all inherited members.
+GetAmiId(OnResourceAcquired callback, void *userData) | Aws::Crt::Imds::ImdsClient | |
GetAmiLaunchIndex(OnResourceAcquired callback, void *userData) | Aws::Crt::Imds::ImdsClient | |
GetAmiManifestPath(OnResourceAcquired callback, void *userData) | Aws::Crt::Imds::ImdsClient | |
GetAncestorAmiIds(OnVectorResourceAcquired callback, void *userData) | Aws::Crt::Imds::ImdsClient | |
GetAttachedIamRole(OnResourceAcquired callback, void *userData) | Aws::Crt::Imds::ImdsClient | |
GetAvailabilityZone(OnResourceAcquired callback, void *userData) | Aws::Crt::Imds::ImdsClient | |
GetBlockDeviceMapping(OnVectorResourceAcquired callback, void *userData) | Aws::Crt::Imds::ImdsClient | |
GetCredentials(const StringView &iamRoleName, OnCredentialsAcquired callback, void *userData) | Aws::Crt::Imds::ImdsClient | |
GetIamProfile(OnIamProfileAcquired callback, void *userData) | Aws::Crt::Imds::ImdsClient | |
GetInstanceAction(OnResourceAcquired callback, void *userData) | Aws::Crt::Imds::ImdsClient | |
GetInstanceId(OnResourceAcquired callback, void *userData) | Aws::Crt::Imds::ImdsClient | |
GetInstanceInfo(OnInstanceInfoAcquired callback, void *userData) | Aws::Crt::Imds::ImdsClient | |
GetInstanceSignature(OnResourceAcquired callback, void *userData) | Aws::Crt::Imds::ImdsClient | |
GetInstanceType(OnResourceAcquired callback, void *userData) | Aws::Crt::Imds::ImdsClient | |
GetMacAddress(OnResourceAcquired callback, void *userData) | Aws::Crt::Imds::ImdsClient | |
GetPrivateIpAddress(OnResourceAcquired callback, void *userData) | Aws::Crt::Imds::ImdsClient | |
GetProductCodes(OnResourceAcquired callback, void *userData) | Aws::Crt::Imds::ImdsClient | |
GetPublicKey(OnResourceAcquired callback, void *userData) | Aws::Crt::Imds::ImdsClient | |
GetRamDiskId(OnResourceAcquired callback, void *userData) | Aws::Crt::Imds::ImdsClient | |
GetReservationId(OnResourceAcquired callback, void *userData) | Aws::Crt::Imds::ImdsClient | |
GetResource(const StringView &resourcePath, OnResourceAcquired callback, void *userData) | Aws::Crt::Imds::ImdsClient | |
GetSecurityGroups(OnVectorResourceAcquired callback, void *userData) | Aws::Crt::Imds::ImdsClient | |
GetUnderlyingHandle() | Aws::Crt::Imds::ImdsClient | inline |
GetUserData(OnResourceAcquired callback, void *userData) | Aws::Crt::Imds::ImdsClient | |
ImdsClient(const ImdsClientConfig &config, Allocator *allocator=ApiAllocator()) noexcept | Aws::Crt::Imds::ImdsClient | |
ImdsClient(const ImdsClient &)=delete | Aws::Crt::Imds::ImdsClient | |
ImdsClient(ImdsClient &&)=delete | Aws::Crt::Imds::ImdsClient | |
operator=(const ImdsClient &)=delete | Aws::Crt::Imds::ImdsClient | |
operator=(ImdsClient &&)=delete | Aws::Crt::Imds::ImdsClient | |
~ImdsClient() | Aws::Crt::Imds::ImdsClient |
+ aws-crt-cpp
+
+ C++ wrapper around the aws-c-* libraries. Provides Cross-Platform Transport Protocols and SSL/TLS implementations for C++.
+ |
+
#include <ImdsClient.h>
+Public Member Functions | |
ImdsClient (const ImdsClientConfig &config, Allocator *allocator=ApiAllocator()) noexcept | |
~ImdsClient () | |
ImdsClient (const ImdsClient &)=delete | |
ImdsClient (ImdsClient &&)=delete | |
ImdsClient & | operator= (const ImdsClient &)=delete |
ImdsClient & | operator= (ImdsClient &&)=delete |
aws_imds_client * | GetUnderlyingHandle () |
int | GetResource (const StringView &resourcePath, OnResourceAcquired callback, void *userData) |
int | GetAmiId (OnResourceAcquired callback, void *userData) |
int | GetAmiLaunchIndex (OnResourceAcquired callback, void *userData) |
int | GetAmiManifestPath (OnResourceAcquired callback, void *userData) |
int | GetAncestorAmiIds (OnVectorResourceAcquired callback, void *userData) |
int | GetInstanceAction (OnResourceAcquired callback, void *userData) |
int | GetInstanceId (OnResourceAcquired callback, void *userData) |
int | GetInstanceType (OnResourceAcquired callback, void *userData) |
int | GetMacAddress (OnResourceAcquired callback, void *userData) |
int | GetPrivateIpAddress (OnResourceAcquired callback, void *userData) |
int | GetAvailabilityZone (OnResourceAcquired callback, void *userData) |
int | GetProductCodes (OnResourceAcquired callback, void *userData) |
int | GetPublicKey (OnResourceAcquired callback, void *userData) |
int | GetRamDiskId (OnResourceAcquired callback, void *userData) |
int | GetReservationId (OnResourceAcquired callback, void *userData) |
int | GetSecurityGroups (OnVectorResourceAcquired callback, void *userData) |
int | GetBlockDeviceMapping (OnVectorResourceAcquired callback, void *userData) |
int | GetAttachedIamRole (OnResourceAcquired callback, void *userData) |
int | GetCredentials (const StringView &iamRoleName, OnCredentialsAcquired callback, void *userData) |
int | GetIamProfile (OnIamProfileAcquired callback, void *userData) |
int | GetUserData (OnResourceAcquired callback, void *userData) |
int | GetInstanceSignature (OnResourceAcquired callback, void *userData) |
int | GetInstanceInfo (OnInstanceInfoAcquired callback, void *userData) |
+
|
+ +noexcept | +
Aws::Crt::Imds::ImdsClient::~ImdsClient | +( | +) | ++ |
+
|
+ +delete | +
+
|
+ +delete | +
int Aws::Crt::Imds::ImdsClient::GetAmiId | +( | +OnResourceAcquired | +callback, | +
+ | + | void * | +userData | +
+ | ) | ++ |
Gets the ami id of the ec2 instance from the instance metadata document
+callback | callback function to invoke on query success or failure |
userData | opaque data to invoke the completion callback with |
int Aws::Crt::Imds::ImdsClient::GetAmiLaunchIndex | +( | +OnResourceAcquired | +callback, | +
+ | + | void * | +userData | +
+ | ) | ++ |
Gets the ami launch index of the ec2 instance from the instance metadata document
+callback | callback function to invoke on query success or failure |
userData | opaque data to invoke the completion callback with |
int Aws::Crt::Imds::ImdsClient::GetAmiManifestPath | +( | +OnResourceAcquired | +callback, | +
+ | + | void * | +userData | +
+ | ) | ++ |
Gets the ami manifest path of the ec2 instance from the instance metadata document
+callback | callback function to invoke on query success or failure |
userData | opaque data to invoke the completion callback with |
int Aws::Crt::Imds::ImdsClient::GetAncestorAmiIds | +( | +OnVectorResourceAcquired | +callback, | +
+ | + | void * | +userData | +
+ | ) | ++ |
Gets the list of ancestor ami ids of the ec2 instance from the instance metadata document
+callback | callback function to invoke on query success or failure |
userData | opaque data to invoke the completion callback with |
int Aws::Crt::Imds::ImdsClient::GetAttachedIamRole | +( | +OnResourceAcquired | +callback, | +
+ | + | void * | +userData | +
+ | ) | ++ |
Gets the attached iam role of the ec2 instance from the instance metadata document
+callback | callback function to invoke on query success or failure |
userData | opaque data to invoke the completion callback with |
int Aws::Crt::Imds::ImdsClient::GetAvailabilityZone | +( | +OnResourceAcquired | +callback, | +
+ | + | void * | +userData | +
+ | ) | ++ |
Gets the availability zone of the ec2 instance from the instance metadata document
+callback | callback function to invoke on query success or failure |
userData | opaque data to invoke the completion callback with |
int Aws::Crt::Imds::ImdsClient::GetBlockDeviceMapping | +( | +OnVectorResourceAcquired | +callback, | +
+ | + | void * | +userData | +
+ | ) | ++ |
Gets the list of block device mappings of the ec2 instance from the instance metadata document
+callback | callback function to invoke on query success or failure |
userData | opaque data to invoke the completion callback with |
int Aws::Crt::Imds::ImdsClient::GetCredentials | +( | +const StringView & | +iamRoleName, | +
+ | + | OnCredentialsAcquired | +callback, | +
+ | + | void * | +userData | +
+ | ) | ++ |
Gets temporary credentials based on the attached iam role of the ec2 instance
+iamRoleName | iam role name to get temporary credentials through |
callback | callback function to invoke on query success or failure |
userData | opaque data to invoke the completion callback with |
int Aws::Crt::Imds::ImdsClient::GetIamProfile | +( | +OnIamProfileAcquired | +callback, | +
+ | + | void * | +userData | +
+ | ) | ++ |
Gets the iam profile information of the ec2 instance from the instance metadata document
+callback | callback function to invoke on query success or failure |
userData | opaque data to invoke the completion callback with |
int Aws::Crt::Imds::ImdsClient::GetInstanceAction | +( | +OnResourceAcquired | +callback, | +
+ | + | void * | +userData | +
+ | ) | ++ |
Gets the instance-action of the ec2 instance from the instance metadata document
+callback | callback function to invoke on query success or failure |
userData | opaque data to invoke the completion callback with |
int Aws::Crt::Imds::ImdsClient::GetInstanceId | +( | +OnResourceAcquired | +callback, | +
+ | + | void * | +userData | +
+ | ) | ++ |
Gets the instance id of the ec2 instance from the instance metadata document
+callback | callback function to invoke on query success or failure |
userData | opaque data to invoke the completion callback with |
int Aws::Crt::Imds::ImdsClient::GetInstanceInfo | +( | +OnInstanceInfoAcquired | +callback, | +
+ | + | void * | +userData | +
+ | ) | ++ |
Gets the instance information data block of the ec2 instance from the instance metadata document
+callback | callback function to invoke on query success or failure |
userData | opaque data to invoke the completion callback with |
int Aws::Crt::Imds::ImdsClient::GetInstanceSignature | +( | +OnResourceAcquired | +callback, | +
+ | + | void * | +userData | +
+ | ) | ++ |
Gets the signature of the ec2 instance from the instance metadata document
+callback | callback function to invoke on query success or failure |
userData | opaque data to invoke the completion callback with |
int Aws::Crt::Imds::ImdsClient::GetInstanceType | +( | +OnResourceAcquired | +callback, | +
+ | + | void * | +userData | +
+ | ) | ++ |
Gets the instance type of the ec2 instance from the instance metadata document
+callback | callback function to invoke on query success or failure |
userData | opaque data to invoke the completion callback with |
int Aws::Crt::Imds::ImdsClient::GetMacAddress | +( | +OnResourceAcquired | +callback, | +
+ | + | void * | +userData | +
+ | ) | ++ |
Gets the mac address of the ec2 instance from the instance metadata document
+callback | callback function to invoke on query success or failure |
userData | opaque data to invoke the completion callback with |
int Aws::Crt::Imds::ImdsClient::GetPrivateIpAddress | +( | +OnResourceAcquired | +callback, | +
+ | + | void * | +userData | +
+ | ) | ++ |
Gets the private ip address of the ec2 instance from the instance metadata document
+callback | callback function to invoke on query success or failure |
userData | opaque data to invoke the completion callback with |
int Aws::Crt::Imds::ImdsClient::GetProductCodes | +( | +OnResourceAcquired | +callback, | +
+ | + | void * | +userData | +
+ | ) | ++ |
Gets the product codes of the ec2 instance from the instance metadata document
+callback | callback function to invoke on query success or failure |
userData | opaque data to invoke the completion callback with |
int Aws::Crt::Imds::ImdsClient::GetPublicKey | +( | +OnResourceAcquired | +callback, | +
+ | + | void * | +userData | +
+ | ) | ++ |
Gets the public key of the ec2 instance from the instance metadata document
+callback | callback function to invoke on query success or failure |
userData | opaque data to invoke the completion callback with |
int Aws::Crt::Imds::ImdsClient::GetRamDiskId | +( | +OnResourceAcquired | +callback, | +
+ | + | void * | +userData | +
+ | ) | ++ |
Gets the ramdisk id of the ec2 instance from the instance metadata document
+callback | callback function to invoke on query success or failure |
userData | opaque data to invoke the completion callback with |
int Aws::Crt::Imds::ImdsClient::GetReservationId | +( | +OnResourceAcquired | +callback, | +
+ | + | void * | +userData | +
+ | ) | ++ |
Gets the reservation id of the ec2 instance from the instance metadata document
+callback | callback function to invoke on query success or failure |
userData | opaque data to invoke the completion callback with |
int Aws::Crt::Imds::ImdsClient::GetResource | +( | +const StringView & | +resourcePath, | +
+ | + | OnResourceAcquired | +callback, | +
+ | + | void * | +userData | +
+ | ) | ++ |
Queries a generic resource (string) from the ec2 instance metadata document
+resourcePath | path of the resource to query |
callback | callback function to invoke on query success or failure |
userData | opaque data to invoke the completion callback with |
int Aws::Crt::Imds::ImdsClient::GetSecurityGroups | +( | +OnVectorResourceAcquired | +callback, | +
+ | + | void * | +userData | +
+ | ) | ++ |
Gets the list of the security groups of the ec2 instance from the instance metadata document
+callback | callback function to invoke on query success or failure |
userData | opaque data to invoke the completion callback with |
+
|
+ +inline | +
int Aws::Crt::Imds::ImdsClient::GetUserData | +( | +OnResourceAcquired | +callback, | +
+ | + | void * | +userData | +
+ | ) | ++ |
Gets the user data of the ec2 instance from the instance metadata document
+callback | callback function to invoke on query success or failure |
userData | opaque data to invoke the completion callback with |
+
|
+ +delete | +
+
|
+ +delete | +
+ aws-crt-cpp
+
+ C++ wrapper around the aws-c-* libraries. Provides Cross-Platform Transport Protocols and SSL/TLS implementations for C++.
+ |
+
This is the complete list of members for Aws::Crt::Io::ChannelHandler, including all inherited members.
+
+ aws-crt-cpp
+
+ C++ wrapper around the aws-c-* libraries. Provides Cross-Platform Transport Protocols and SSL/TLS implementations for C++.
+ |
+
#include <ChannelHandler.h>
+Public Member Functions | |
virtual | ~ChannelHandler ()=default |
ChannelHandler (const ChannelHandler &)=delete | |
ChannelHandler & | operator= (const ChannelHandler &)=delete |
bool | ChannelsThreadIsCallersThread () const |
void | ShutDownChannel (int errorCode) |
void | ScheduleTask (std::function< void(TaskStatus)> &&task) |
void | ScheduleTask (std::function< void(TaskStatus)> &&task, std::chrono::nanoseconds run_in) |
+Public Attributes | |
s_ProcessReadMessage | |
s_ProcessWriteMessage | |
s_IncrementReadWindow | |
s_ProcessShutdown | |
s_InitialWindowSize | |
s_MessageOverhead | |
s_ResetStatistics | |
s_GatherStatistics | |
+Protected Member Functions | |
virtual int | ProcessReadMessage (struct aws_io_message *message)=0 |
virtual int | ProcessWriteMessage (struct aws_io_message *message)=0 |
virtual int | IncrementReadWindow (size_t size)=0 |
virtual void | ProcessShutdown (ChannelDirection dir, int errorCode, bool freeScarceResourcesImmediately)=0 |
virtual size_t | InitialWindowSize ()=0 |
virtual size_t | MessageOverhead ()=0 |
virtual void | ResetStatistics () |
virtual void | GatherStatistics (struct aws_array_list *) |
ChannelHandler (Allocator *allocator=ApiAllocator()) | |
struct aws_io_message * | AcquireMessageFromPool (MessageType messageType, size_t sizeHint) |
struct aws_io_message * | AcquireMaxSizeMessageForWrite () |
bool | SendMessage (struct aws_io_message *message, ChannelDirection direction) |
bool | IncrementUpstreamReadWindow (size_t windowUpdateSize) |
void | OnShutdownComplete (ChannelDirection direction, int errorCode, bool freeScarceResourcesImmediately) |
size_t | DownstreamReadWindow () const |
size_t | UpstreamMessageOverhead () const |
struct aws_channel_slot * | GetSlot () const |
+Protected Attributes | |
struct aws_channel_handler | m_handler |
Allocator * | m_allocator |
Wrapper for aws-c-io channel handlers. The semantics are identical as the functions on aws_channel_handler.
+All virtual calls are made from the same thread (the channel's thread).
+
+
|
+ +virtualdefault | +
+
|
+ +delete | +
+
|
+ +protected | +
+
|
+ +protected | +
Convenience function that invokes AcquireMessageFromPool(), asking for the largest reasonable DATA message that can be sent in the write direction, with upstream overhead accounted for.
+ +
+
|
+ +protected | +
Acquire an aws_io_message from the channel's pool.
+ +bool Aws::Crt::Io::ChannelHandler::ChannelsThreadIsCallersThread | +( | +) | +const | +
Return whether the caller is on the same thread as the handler's channel.
+ +
+
|
+ +protected | +
Fetches the downstream read window. This gives you the information necessary to honor the read window. If you call send_message() and it exceeds this window, the message will be rejected.
+ +
+
|
+ +inlineprotectedvirtual | +
Adds a pointer to the handler's internal statistics (if they exist) to a list of statistics structures associated with the channel's handler chain.
+ +
+
|
+ +protected | +
+
|
+ +protectedpure virtual | +
Called by the channel when a downstream handler has issued a window increment. You'll want to update your internal state and likely propagate a window increment message of your own by calling IncrementUpstreamReadWindow()
+
+
|
+ +protected | +
Issue a window update notification upstream. Returns true if successful.
+ +
+
|
+ +protectedpure virtual | +
Called by the channel when the handler is added to a slot, to get the initial window size.
+ +
+
|
+ +protectedpure virtual | +
Called by the channel anytime a handler is added or removed, provides a hint for downstream handlers to avoid message fragmentation due to message overhead.
+ +
+
|
+ +protected | +
Must be called by a handler once they have finished their shutdown in the 'dir' direction. Propagates the shutdown process to the next handler in the channel.
+ +
+
|
+ +delete | +
+
|
+ +protectedpure virtual | +
Called by the channel when a message is available for processing in the read direction. It is your responsibility to call aws_mem_release(message->allocator, message); on message when you are finished with it.
+Also keep in mind that your slot's internal window has been decremented. You'll want to call aws_channel_slot_increment_read_window() at some point in the future if you want to keep receiving data.
+
+
|
+ +protectedpure virtual | +
The channel calls shutdown on all handlers twice, once to shut down reading, and once to shut down writing. Shutdown always begins with the left-most handler, and proceeds to the right with dir set to ChannelDirection::Read. Then shutdown is called on handlers from right to left with dir set to ChannelDirection::Write.
+The shutdown process does not need to complete immediately and may rely on scheduled tasks. The handler MUST call OnShutdownComplete() when it is finished, which propagates shutdown to the next handler. If 'freeScarceResourcesImmediately' is true, then resources vulnerable to denial-of-service attacks (such as sockets and file handles) must be closed immediately before the shutdown process complete.
+ +
+
|
+ +protectedpure virtual | +
Called by the channel when a message is available for processing in the write direction. It is your responsibility to call aws_mem_release(message->allocator, message); on message when you are finished with it.
+
+
|
+ +inlineprotectedvirtual | +
Directs the channel handler to reset all of the internal statistics it tracks about itself.
+ +void Aws::Crt::Io::ChannelHandler::ScheduleTask | +( | +std::function< void(TaskStatus)> && | +task | ) | ++ |
Schedule a task to run on the next "tick" of the event loop. If the channel is completely shut down, the task will run with the 'Canceled' status.
+ +void Aws::Crt::Io::ChannelHandler::ScheduleTask | +( | +std::function< void(TaskStatus)> && | +task, | +
+ | + | std::chrono::nanoseconds | +run_in | +
+ | ) | ++ |
Schedule a task to run after a desired length of time has passed. The task will run with the 'Canceled' status if the channel completes shutdown before that length of time elapses.
+ +
+
|
+ +protected | +
Send a message in the read or write direction. Returns true if message successfully sent. If false is returned, you must release the message yourself.
+ +void Aws::Crt::Io::ChannelHandler::ShutDownChannel | +( | +int | +errorCode | ) | ++ |
Initiate a shutdown of the handler's channel.
+If the channel is already shutting down, this call has no effect.
+ +
+
|
+ +protected | +
Fetches the current overhead of upstream handlers. This provides a hint to avoid fragmentation if you care.
+ +
+
|
+ +protected | +
+
|
+ +protected | +
void Aws::Crt::Io::ChannelHandler::s_GatherStatistics | +
int Aws::Crt::Io::ChannelHandler::s_IncrementReadWindow | +
size_t Aws::Crt::Io::ChannelHandler::s_InitialWindowSize | +
size_t Aws::Crt::Io::ChannelHandler::s_MessageOverhead | +
int Aws::Crt::Io::ChannelHandler::s_ProcessReadMessage | +
int Aws::Crt::Io::ChannelHandler::s_ProcessShutdown | +
int Aws::Crt::Io::ChannelHandler::s_ProcessWriteMessage | +
void Aws::Crt::Io::ChannelHandler::s_ResetStatistics | +
+ aws-crt-cpp
+
+ C++ wrapper around the aws-c-* libraries. Provides Cross-Platform Transport Protocols and SSL/TLS implementations for C++.
+ |
+
This is the complete list of members for Aws::Crt::Io::ClientBootstrap, including all inherited members.
+ClientBootstrap(EventLoopGroup &elGroup, HostResolver &resolver, Allocator *allocator=ApiAllocator()) noexcept | Aws::Crt::Io::ClientBootstrap | |
ClientBootstrap(Allocator *allocator=ApiAllocator()) noexcept | Aws::Crt::Io::ClientBootstrap | |
ClientBootstrap(const ClientBootstrap &)=delete | Aws::Crt::Io::ClientBootstrap | |
ClientBootstrap(ClientBootstrap &&)=delete | Aws::Crt::Io::ClientBootstrap | |
EnableBlockingShutdown() noexcept | Aws::Crt::Io::ClientBootstrap | |
LastError() const noexcept | Aws::Crt::Io::ClientBootstrap | |
operator bool() const noexcept | Aws::Crt::Io::ClientBootstrap | |
operator=(const ClientBootstrap &)=delete | Aws::Crt::Io::ClientBootstrap | |
operator=(ClientBootstrap &&)=delete | Aws::Crt::Io::ClientBootstrap | |
SetShutdownCompleteCallback(OnClientBootstrapShutdownComplete callback) | Aws::Crt::Io::ClientBootstrap | |
~ClientBootstrap() | Aws::Crt::Io::ClientBootstrap |
+ aws-crt-cpp
+
+ C++ wrapper around the aws-c-* libraries. Provides Cross-Platform Transport Protocols and SSL/TLS implementations for C++.
+ |
+
#include <Bootstrap.h>
+Public Member Functions | |
ClientBootstrap (EventLoopGroup &elGroup, HostResolver &resolver, Allocator *allocator=ApiAllocator()) noexcept | |
ClientBootstrap (Allocator *allocator=ApiAllocator()) noexcept | |
~ClientBootstrap () | |
ClientBootstrap (const ClientBootstrap &)=delete | |
ClientBootstrap & | operator= (const ClientBootstrap &)=delete |
ClientBootstrap (ClientBootstrap &&)=delete | |
ClientBootstrap & | operator= (ClientBootstrap &&)=delete |
operator bool () const noexcept | |
int | LastError () const noexcept |
void | SetShutdownCompleteCallback (OnClientBootstrapShutdownComplete callback) |
void | EnableBlockingShutdown () noexcept |
A ClientBootstrap handles creation and setup of socket connections to specific endpoints.
+Note that ClientBootstrap may not clean up all its behind-the-scenes resources immediately upon destruction. If you need to know when behind-the-scenes shutdown is complete, use SetShutdownCompleteCallback() or EnableBlockingShutdown() (only safe on main thread).
+
+
|
+ +noexcept | +
elGroup | EventLoopGroup to use. |
resolver | DNS host resolver to use. |
allocator | memory allocator to use |
+
|
+ +noexcept | +
Uses the default EventLoopGroup and HostResolver. See Aws::Crt::ApiHandle::GetOrCreateStaticDefaultEventLoopGroup and Aws::Crt::ApiHandle::GetOrCreateStaticDefaultHostResolver
+ +Aws::Crt::Io::ClientBootstrap::~ClientBootstrap | +( | +) | ++ |
+
|
+ +delete | +
+
|
+ +delete | +
+
|
+ +noexcept | +
Force the ClientBootstrap's destructor to block until all behind-the-scenes resources finish shutting down.
+This isn't necessary during the normal flow of an application, but it is useful for scenarios, such as tests, that need deterministic shutdown ordering. Be aware, if you use this anywhere other than the main thread, YOU WILL MOST LIKELY CAUSE A DEADLOCK.
+Use SetShutdownCompleteCallback() for a thread-safe way to know when shutdown is complete.
+ +
+
|
+ +noexcept | +
+
|
+ +noexcept | +
+
|
+ +delete | +
+
|
+ +delete | +
void Aws::Crt::Io::ClientBootstrap::SetShutdownCompleteCallback | +( | +OnClientBootstrapShutdownComplete | +callback | ) | ++ |
Set function to invoke when ClientBootstrap's behind-the-scenes resources finish shutting down. This function may be invoked on any thread. Shutdown begins when the ClientBootstrap's destructor runs.
+ +
+ aws-crt-cpp
+
+ C++ wrapper around the aws-c-* libraries. Provides Cross-Platform Transport Protocols and SSL/TLS implementations for C++.
+ |
+
This is the complete list of members for Aws::Crt::Io::ClientTlsChannelHandler, including all inherited members.
+
+ aws-crt-cpp
+
+ C++ wrapper around the aws-c-* libraries. Provides Cross-Platform Transport Protocols and SSL/TLS implementations for C++.
+ |
+
#include <TlsOptions.h>
+Public Member Functions | |
virtual void | StartNegotiation ()=0 |
Public Member Functions inherited from Aws::Crt::Io::TlsChannelHandler | |
virtual | ~TlsChannelHandler () |
virtual String | GetProtocol () const =0 |
Public Member Functions inherited from Aws::Crt::Io::ChannelHandler | |
virtual | ~ChannelHandler ()=default |
ChannelHandler (const ChannelHandler &)=delete | |
ChannelHandler & | operator= (const ChannelHandler &)=delete |
bool | ChannelsThreadIsCallersThread () const |
void | ShutDownChannel (int errorCode) |
void | ScheduleTask (std::function< void(TaskStatus)> &&task) |
void | ScheduleTask (std::function< void(TaskStatus)> &&task, std::chrono::nanoseconds run_in) |
+Protected Member Functions | |
ClientTlsChannelHandler (struct aws_channel_slot *slot, const struct aws_tls_connection_options &options, Allocator *allocator=ApiAllocator()) | |
Protected Member Functions inherited from Aws::Crt::Io::TlsChannelHandler | |
TlsChannelHandler (struct aws_channel_slot *slot, const struct aws_tls_connection_options &options, Allocator *allocator=ApiAllocator()) | |
void | CompleteTlsNegotiation (int errorCode) |
Protected Member Functions inherited from Aws::Crt::Io::ChannelHandler | |
virtual int | ProcessReadMessage (struct aws_io_message *message)=0 |
virtual int | ProcessWriteMessage (struct aws_io_message *message)=0 |
virtual int | IncrementReadWindow (size_t size)=0 |
virtual void | ProcessShutdown (ChannelDirection dir, int errorCode, bool freeScarceResourcesImmediately)=0 |
virtual size_t | InitialWindowSize ()=0 |
virtual size_t | MessageOverhead ()=0 |
virtual void | ResetStatistics () |
virtual void | GatherStatistics (struct aws_array_list *) |
ChannelHandler (Allocator *allocator=ApiAllocator()) | |
struct aws_io_message * | AcquireMessageFromPool (MessageType messageType, size_t sizeHint) |
struct aws_io_message * | AcquireMaxSizeMessageForWrite () |
bool | SendMessage (struct aws_io_message *message, ChannelDirection direction) |
bool | IncrementUpstreamReadWindow (size_t windowUpdateSize) |
void | OnShutdownComplete (ChannelDirection direction, int errorCode, bool freeScarceResourcesImmediately) |
size_t | DownstreamReadWindow () const |
size_t | UpstreamMessageOverhead () const |
struct aws_channel_slot * | GetSlot () const |
+Additional Inherited Members | |
Public Attributes inherited from Aws::Crt::Io::ChannelHandler | |
s_ProcessReadMessage | |
s_ProcessWriteMessage | |
s_IncrementReadWindow | |
s_ProcessShutdown | |
s_InitialWindowSize | |
s_MessageOverhead | |
s_ResetStatistics | |
s_GatherStatistics | |
Protected Attributes inherited from Aws::Crt::Io::ChannelHandler | |
struct aws_channel_handler | m_handler |
Allocator * | m_allocator |
BYO_CRYPTO: Client TLS channel-handler base class.
+If using BYO_CRYPTO, you must define a concrete implementation and set its creation callback via ApiHandle.SetBYOCryptoClientTlsCallback().
+
+
|
+ +protected | +
+
|
+ +pure virtual | +
Initiates the TLS session negotiation. This is called by the common runtime when it's time to start a new session.
+ +
+ aws-crt-cpp
+
+ C++ wrapper around the aws-c-* libraries. Provides Cross-Platform Transport Protocols and SSL/TLS implementations for C++.
+ |
+
This is the complete list of members for Aws::Crt::Io::DefaultHostResolver, including all inherited members.
+
+ aws-crt-cpp
+
+ C++ wrapper around the aws-c-* libraries. Provides Cross-Platform Transport Protocols and SSL/TLS implementations for C++.
+ |
+
#include <HostResolver.h>
+Public Member Functions | |
DefaultHostResolver (EventLoopGroup &elGroup, size_t maxHosts, size_t maxTTL, Allocator *allocator=ApiAllocator()) noexcept | |
DefaultHostResolver (size_t maxHosts, size_t maxTTL, Allocator *allocator=ApiAllocator()) noexcept | |
~DefaultHostResolver () | |
DefaultHostResolver (const DefaultHostResolver &)=delete | |
DefaultHostResolver & | operator= (const DefaultHostResolver &)=delete |
DefaultHostResolver (DefaultHostResolver &&)=delete | |
DefaultHostResolver & | operator= (DefaultHostResolver &&)=delete |
operator bool () const noexcept | |
int | LastError () const noexcept |
bool | ResolveHost (const String &host, const OnHostResolved &onResolved) noexcept override |
Public Member Functions inherited from Aws::Crt::Io::HostResolver | |
virtual | ~HostResolver () |
A wrapper around the CRT default host resolution system that uses getaddrinfo() farmed off to separate threads in order to resolve names.
+
+
|
+ +noexcept | +
Resolves DNS addresses.
+elGroup | EventLoopGroup to use. |
maxHosts | the number of unique hosts to maintain in the cache. |
maxTTL | how long to keep an address in the cache before evicting it. |
allocator | memory allocator to use. |
+
|
+ +noexcept | +
Resolves DNS addresses using the default EventLoopGroup.
+For more information on the default EventLoopGroup see Aws::Crt::ApiHandle::GetOrCreateStaticDefaultEventLoopGroup
+maxHosts | the number of unique hosts to maintain in the cache. |
maxTTL | how long to keep an address in the cache before evicting it. |
allocator | memory allocator to use. |
Aws::Crt::Io::DefaultHostResolver::~DefaultHostResolver | +( | +) | ++ |
+
|
+ +delete | +
+
|
+ +delete | +
+
|
+ +inlinenoexcept | +
+
|
+ +inlinenoexcept | +
+
|
+ +delete | +
+
|
+ +delete | +
+
|
+ +overridevirtualnoexcept | +
Kicks off an asynchronous resolution of host. onResolved will be invoked upon completion of the resolution.
Implements Aws::Crt::Io::HostResolver.
+ +
+ aws-crt-cpp
+
+ C++ wrapper around the aws-c-* libraries. Provides Cross-Platform Transport Protocols and SSL/TLS implementations for C++.
+ |
+
This is the complete list of members for Aws::Crt::Io::EventLoopGroup, including all inherited members.
+EventLoopGroup(uint16_t threadCount=0, Allocator *allocator=ApiAllocator()) noexcept | Aws::Crt::Io::EventLoopGroup | |
EventLoopGroup(uint16_t cpuGroup, uint16_t threadCount, Allocator *allocator=ApiAllocator()) noexcept | Aws::Crt::Io::EventLoopGroup | |
EventLoopGroup(const EventLoopGroup &)=delete | Aws::Crt::Io::EventLoopGroup | |
EventLoopGroup(EventLoopGroup &&) noexcept | Aws::Crt::Io::EventLoopGroup | |
LastError() const | Aws::Crt::Io::EventLoopGroup | |
operator bool() const | Aws::Crt::Io::EventLoopGroup | |
operator=(const EventLoopGroup &)=delete | Aws::Crt::Io::EventLoopGroup | |
operator=(EventLoopGroup &&) noexcept | Aws::Crt::Io::EventLoopGroup | |
~EventLoopGroup() | Aws::Crt::Io::EventLoopGroup |
+ aws-crt-cpp
+
+ C++ wrapper around the aws-c-* libraries. Provides Cross-Platform Transport Protocols and SSL/TLS implementations for C++.
+ |
+
#include <EventLoopGroup.h>
+Public Member Functions | |
EventLoopGroup (uint16_t threadCount=0, Allocator *allocator=ApiAllocator()) noexcept | |
EventLoopGroup (uint16_t cpuGroup, uint16_t threadCount, Allocator *allocator=ApiAllocator()) noexcept | |
~EventLoopGroup () | |
EventLoopGroup (const EventLoopGroup &)=delete | |
EventLoopGroup (EventLoopGroup &&) noexcept | |
EventLoopGroup & | operator= (const EventLoopGroup &)=delete |
EventLoopGroup & | operator= (EventLoopGroup &&) noexcept |
operator bool () const | |
int | LastError () const |
A collection of event loops.
+An event-loop is a thread for doing async work, such as I/O. Classes that need to do async work will ask the EventLoopGroup for an event-loop to use.
+The number of threads used depends on your use-case. IF you have a maximum of less than a few hundred connections 1 thread is the ideal threadCount.
+There should only be one instance of an EventLoopGroup per application and it should be passed to all network clients. One exception to this is if you want to peg different types of IO to different threads. In that case, you may want to have one event loop group dedicated to one IO activity and another dedicated to another type.
+
+
|
+ +noexcept | +
threadCount | The number of event-loops to create, default will be 0, which will create one for each processor on the machine. |
allocator | memory allocator to use. |
+
|
+ +noexcept | +
cpuGroup | The CPU group (e.g. NUMA nodes) that all hardware threads are pinned to. |
threadCount | The number of event-loops to create, default will be 0, which will create one for each processor on the machine. |
allocator | memory allocator to use. |
Aws::Crt::Io::EventLoopGroup::~EventLoopGroup | +( | +) | ++ |
+
|
+ +delete | +
+
|
+ +noexcept | +
int Aws::Crt::Io::EventLoopGroup::LastError | +( | +) | +const | +
Aws::Crt::Io::EventLoopGroup::operator bool | +( | +) | +const | +
+
|
+ +delete | +
+
|
+ +noexcept | +
+ aws-crt-cpp
+
+ C++ wrapper around the aws-c-* libraries. Provides Cross-Platform Transport Protocols and SSL/TLS implementations for C++.
+ |
+
This is the complete list of members for Aws::Crt::Io::HostResolver, including all inherited members.
+ResolveHost(const String &host, const OnHostResolved &onResolved) noexcept=0 | Aws::Crt::Io::HostResolver | pure virtual |
~HostResolver() | Aws::Crt::Io::HostResolver | virtual |
+ aws-crt-cpp
+
+ C++ wrapper around the aws-c-* libraries. Provides Cross-Platform Transport Protocols and SSL/TLS implementations for C++.
+ |
+
#include <HostResolver.h>
+Public Member Functions | |
virtual | ~HostResolver () |
virtual bool | ResolveHost (const String &host, const OnHostResolved &onResolved) noexcept=0 |
Simple interface for DNS name lookup implementations
+
+
|
+ +virtual | +
+
|
+ +pure virtualnoexcept | +
Implemented in Aws::Crt::Io::DefaultHostResolver.
+ +
+ aws-crt-cpp
+
+ C++ wrapper around the aws-c-* libraries. Provides Cross-Platform Transport Protocols and SSL/TLS implementations for C++.
+ |
+
This is the complete list of members for Aws::Crt::Io::InputStream, including all inherited members.
+
+ aws-crt-cpp
+
+ C++ wrapper around the aws-c-* libraries. Provides Cross-Platform Transport Protocols and SSL/TLS implementations for C++.
+ |
+
#include <Stream.h>
+Public Member Functions | |
virtual | ~InputStream () |
InputStream (const InputStream &)=delete | |
InputStream & | operator= (const InputStream &)=delete |
InputStream (InputStream &&)=delete | |
InputStream & | operator= (InputStream &&)=delete |
operator bool () const noexcept | |
virtual bool | IsValid () const noexcept=0 |
bool | Read (ByteBuf &dest) |
bool | Seek (int64_t offset, StreamSeekBasis seekBasis) |
bool | GetStatus (StreamStatus &status) |
bool | GetLength (int64_t &length) |
+Protected Member Functions | |
InputStream (Aws::Crt::Allocator *allocator=ApiAllocator()) | |
virtual bool | ReadImpl (ByteBuf &buffer) noexcept=0 |
virtual StreamStatus | GetStatusImpl () const noexcept=0 |
virtual int64_t | GetLengthImpl () const noexcept=0 |
virtual bool | SeekImpl (int64_t offset, StreamSeekBasis seekBasis) noexcept=0 |
Protected Member Functions inherited from Aws::Crt::RefCounted< InputStream > | |
RefCounted () | |
~RefCounted () | |
void | AcquireRef () |
void | ReleaseRef () |
+Protected Attributes | |
Allocator * | m_allocator |
aws_input_stream | m_underlying_stream |
+
|
+ +virtual | +
+
|
+ +delete | +
+
|
+ +delete | +
+
|
+ +protected | +
+
|
+ +inline | +
Gets the stream's length. Some streams may not be able to answer this.
length | output parameter for the length of the stream |
+
|
+ +protectedpure virtualnoexcept | +
Implemented in Aws::Crt::Io::StdIOStreamInputStream.
+ +
+
|
+ +inline | +
Gets the stream's current status
status | output parameter for the stream's status |
+
|
+ +protectedpure virtualnoexcept | +
Implemented in Aws::Crt::Io::StdIOStreamInputStream.
+ +
+
|
+ +pure virtualnoexcept | +
Implemented in Aws::Crt::Io::StdIOStreamInputStream.
+ +
+
|
+ +inlineexplicitnoexcept | +
+
|
+ +delete | +
+
|
+ +delete | +
+
|
+ +inline | +
Reads data from the stream into a buffer
dest | buffer to add the read data into |
+
|
+ +protectedpure virtualnoexcept | +
Implemented in Aws::Crt::Io::StdIOStreamInputStream.
+ +
+
|
+ +inline | +
Moves the head of the stream to a new location
offset | how far to move, in bytes |
seekBasis | what direction to move the head of stream |
+
|
+ +protectedpure virtualnoexcept | +
Seek's the stream to seekBasis based offset bytes.
+It is expected, that if seeking to the beginning of a stream, all error's are cleared if possible.
+
+
|
+ +protected | +
+
|
+ +protected | +
+ aws-crt-cpp
+
+ C++ wrapper around the aws-c-* libraries. Provides Cross-Platform Transport Protocols and SSL/TLS implementations for C++.
+ |
+
This is the complete list of members for Aws::Crt::Io::Pkcs11Lib, including all inherited members.
+Create(const String &filename, Allocator *allocator=ApiAllocator()) | Aws::Crt::Io::Pkcs11Lib | static |
Create(const String &filename, InitializeFinalizeBehavior initializeFinalizeBehavior, Allocator *allocator=ApiAllocator()) | Aws::Crt::Io::Pkcs11Lib | static |
InitializeFinalizeBehavior enum name | Aws::Crt::Io::Pkcs11Lib | |
~Pkcs11Lib() | Aws::Crt::Io::Pkcs11Lib |
+ aws-crt-cpp
+
+ C++ wrapper around the aws-c-* libraries. Provides Cross-Platform Transport Protocols and SSL/TLS implementations for C++.
+ |
+
#include <Pkcs11.h>
+Public Types | |
enum class | InitializeFinalizeBehavior { Default +, Omit +, Strict + } |
+Public Member Functions | |
~Pkcs11Lib () | |
+Static Public Member Functions | |
static std::shared_ptr< Pkcs11Lib > | Create (const String &filename, Allocator *allocator=ApiAllocator()) |
static std::shared_ptr< Pkcs11Lib > | Create (const String &filename, InitializeFinalizeBehavior initializeFinalizeBehavior, Allocator *allocator=ApiAllocator()) |
Handle to a loaded PKCS#11 library.
+For most use cases, a single instance of Pkcs11Lib should be used for the lifetime of your application.
+
+
|
+ +strong | +
Controls how Pkcs11Lib calls C_Initialize()
and C_Finalize()
on the PKCS#11 library.
Aws::Crt::Io::Pkcs11Lib::~Pkcs11Lib | +( | +) | ++ |
+
|
+ +static | +
Load and initialize a PKCS#11 library.
+C_Initialize()
and C_Finalize()
are called on the PKCS#11 library in the InitializeFinalizeBehavior::Default way.
filename | Name or path of PKCS#11 library file to load (UTF-8). Pass an empty string if your application already has PKCS#11 symbols linked in. |
allocator | Memory allocator to use. |
shared_ptr
containing the Pkcs11Lib is returned. If unsuccessful the shared_ptr
will be empty, and Aws::Crt::LastError() will contain the error that occurred.
+
|
+ +static | +
Load a PKCS#11 library, specifying how C_Initialize()
and C_Finalize()
will be called.
filename | Name or path of PKCS#11 library file to load (UTF-8). Pass an empty string if your application already has PKCS#11 symbols linked in. |
initializeFinalizeBehavior | Specifies how C_Initialize() and C_Finalize() will be called on the PKCS#11 library. |
allocator | Memory allocator to use. |
shared_ptr
containing the Pkcs11Lib is returned. If unsuccessful the shared_ptr
will be empty, and Aws::Crt::LastError() will contain the error that occurred.
+ aws-crt-cpp
+
+ C++ wrapper around the aws-c-* libraries. Provides Cross-Platform Transport Protocols and SSL/TLS implementations for C++.
+ |
+
This is the complete list of members for Aws::Crt::Io::SocketOptions, including all inherited members.
+
+ aws-crt-cpp
+
+ C++ wrapper around the aws-c-* libraries. Provides Cross-Platform Transport Protocols and SSL/TLS implementations for C++.
+ |
+
#include <SocketOptions.h>
+Public Member Functions | |
SocketOptions () | |
SocketOptions (const SocketOptions &rhs)=default | |
SocketOptions (SocketOptions &&rhs)=default | |
SocketOptions & | operator= (const SocketOptions &rhs)=default |
SocketOptions & | operator= (SocketOptions &&rhs)=default |
void | SetSocketType (SocketType type) |
SocketType | GetSocketType () const |
void | SetSocketDomain (SocketDomain domain) |
SocketDomain | GetSocketDomain () const |
void | SetConnectTimeoutMs (uint32_t timeout) |
uint32_t | GetConnectTimeoutMs () const |
void | SetKeepAliveIntervalSec (uint16_t keepAliveInterval) |
uint16_t | GetKeepAliveIntervalSec () const |
void | SetKeepAliveTimeoutSec (uint16_t keepAliveTimeout) |
uint16_t | GetKeepAliveTimeoutSec () const |
void | SetKeepAliveMaxFailedProbes (uint16_t maxProbes) |
uint16_t | GetKeepAliveMaxFailedProbes () const |
void | SetKeepAlive (bool keepAlive) |
bool | GetKeepAlive () const |
Socket configuration options
+Aws::Crt::Io::SocketOptions::SocketOptions | +( | +) | ++ |
+
|
+ +default | +
+
|
+ +default | +
+
|
+ +inline | +
+
|
+ +inline | +
+
|
+ +inline | +
+
|
+ +inline | +
+
|
+ +inline | +
+
|
+ +inline | +
+
|
+ +inline | +
+
|
+ +default | +
+
|
+ +default | +
+
|
+ +inline | +
Set connection timeout
timeout | connection timeout in milliseconds. |
+
|
+ +inline | +
Set keep alive option.
keepAlive | True, periodically transmit keepalive messages for detecting a disconnected peer. |
+
|
+ +inline | +
Set keep alive interval seconds.
keepAliveInterval | Duration, in seconds, between keepalive probes. If 0, then a default value is used. |
+
|
+ +inline | +
Set keep alive max failed probes.
maxProbes | The number of keepalive probes allowed to fail before a connection is considered lost. |
+
|
+ +inline | +
Set keep alive time out seconds.
keepAliveTimeout | interval, in seconds, that a connection must be idle for before keep alive probes begin to get sent out |
+
|
+ +inline | +
Set socket domain
domain | SocketDomain object. |
+
|
+ +inline | +
Set socket type
type | SocketType object. |
+ aws-crt-cpp
+
+ C++ wrapper around the aws-c-* libraries. Provides Cross-Platform Transport Protocols and SSL/TLS implementations for C++.
+ |
+
This is the complete list of members for Aws::Crt::Io::StdIOStreamInputStream, including all inherited members.
+
+ aws-crt-cpp
+
+ C++ wrapper around the aws-c-* libraries. Provides Cross-Platform Transport Protocols and SSL/TLS implementations for C++.
+ |
+
#include <Stream.h>
+Public Member Functions | |
StdIOStreamInputStream (std::shared_ptr< Aws::Crt::Io::IStream > stream, Aws::Crt::Allocator *allocator=ApiAllocator()) noexcept | |
bool | IsValid () const noexcept override |
Public Member Functions inherited from Aws::Crt::Io::InputStream | |
virtual | ~InputStream () |
InputStream (const InputStream &)=delete | |
InputStream & | operator= (const InputStream &)=delete |
InputStream (InputStream &&)=delete | |
InputStream & | operator= (InputStream &&)=delete |
operator bool () const noexcept | |
bool | Read (ByteBuf &dest) |
bool | Seek (int64_t offset, StreamSeekBasis seekBasis) |
bool | GetStatus (StreamStatus &status) |
bool | GetLength (int64_t &length) |
+Protected Member Functions | |
bool | ReadImpl (ByteBuf &buffer) noexcept override |
StreamStatus | GetStatusImpl () const noexcept override |
int64_t | GetLengthImpl () const noexcept override |
bool | SeekImpl (OffsetType offsetType, StreamSeekBasis seekBasis) noexcept override |
Protected Member Functions inherited from Aws::Crt::Io::InputStream | |
InputStream (Aws::Crt::Allocator *allocator=ApiAllocator()) | |
virtual bool | SeekImpl (int64_t offset, StreamSeekBasis seekBasis) noexcept=0 |
Protected Member Functions inherited from Aws::Crt::RefCounted< InputStream > | |
RefCounted () | |
~RefCounted () | |
void | AcquireRef () |
void | ReleaseRef () |
+Additional Inherited Members | |
Protected Attributes inherited from Aws::Crt::Io::InputStream | |
Allocator * | m_allocator |
aws_input_stream | m_underlying_stream |
+
|
+ +noexcept | +
+
|
+ +overrideprotectedvirtualnoexcept | +
Implements Aws::Crt::Io::InputStream.
+ +
+
|
+ +overrideprotectedvirtualnoexcept | +
Implements Aws::Crt::Io::InputStream.
+ +
+
|
+ +overridevirtualnoexcept | +
Implements Aws::Crt::Io::InputStream.
+ +
+
|
+ +overrideprotectedvirtualnoexcept | +
Implements Aws::Crt::Io::InputStream.
+ +
+
|
+ +overrideprotectednoexcept | +
+ aws-crt-cpp
+
+ C++ wrapper around the aws-c-* libraries. Provides Cross-Platform Transport Protocols and SSL/TLS implementations for C++.
+ |
+
This is the complete list of members for Aws::Crt::Io::TlsChannelHandler, including all inherited members.
+
+ aws-crt-cpp
+
+ C++ wrapper around the aws-c-* libraries. Provides Cross-Platform Transport Protocols and SSL/TLS implementations for C++.
+ |
+
#include <TlsOptions.h>
+Public Member Functions | |
virtual | ~TlsChannelHandler () |
virtual String | GetProtocol () const =0 |
Public Member Functions inherited from Aws::Crt::Io::ChannelHandler | |
virtual | ~ChannelHandler ()=default |
ChannelHandler (const ChannelHandler &)=delete | |
ChannelHandler & | operator= (const ChannelHandler &)=delete |
bool | ChannelsThreadIsCallersThread () const |
void | ShutDownChannel (int errorCode) |
void | ScheduleTask (std::function< void(TaskStatus)> &&task) |
void | ScheduleTask (std::function< void(TaskStatus)> &&task, std::chrono::nanoseconds run_in) |
+Protected Member Functions | |
TlsChannelHandler (struct aws_channel_slot *slot, const struct aws_tls_connection_options &options, Allocator *allocator=ApiAllocator()) | |
void | CompleteTlsNegotiation (int errorCode) |
Protected Member Functions inherited from Aws::Crt::Io::ChannelHandler | |
virtual int | ProcessReadMessage (struct aws_io_message *message)=0 |
virtual int | ProcessWriteMessage (struct aws_io_message *message)=0 |
virtual int | IncrementReadWindow (size_t size)=0 |
virtual void | ProcessShutdown (ChannelDirection dir, int errorCode, bool freeScarceResourcesImmediately)=0 |
virtual size_t | InitialWindowSize ()=0 |
virtual size_t | MessageOverhead ()=0 |
virtual void | ResetStatistics () |
virtual void | GatherStatistics (struct aws_array_list *) |
ChannelHandler (Allocator *allocator=ApiAllocator()) | |
struct aws_io_message * | AcquireMessageFromPool (MessageType messageType, size_t sizeHint) |
struct aws_io_message * | AcquireMaxSizeMessageForWrite () |
bool | SendMessage (struct aws_io_message *message, ChannelDirection direction) |
bool | IncrementUpstreamReadWindow (size_t windowUpdateSize) |
void | OnShutdownComplete (ChannelDirection direction, int errorCode, bool freeScarceResourcesImmediately) |
size_t | DownstreamReadWindow () const |
size_t | UpstreamMessageOverhead () const |
struct aws_channel_slot * | GetSlot () const |
+Friends | |
aws_byte_buf() | aws_tls_handler_protocol (aws_channel_handler *) |
+Additional Inherited Members | |
Public Attributes inherited from Aws::Crt::Io::ChannelHandler | |
s_ProcessReadMessage | |
s_ProcessWriteMessage | |
s_IncrementReadWindow | |
s_ProcessShutdown | |
s_InitialWindowSize | |
s_MessageOverhead | |
s_ResetStatistics | |
s_GatherStatistics | |
Protected Attributes inherited from Aws::Crt::Io::ChannelHandler | |
struct aws_channel_handler | m_handler |
Allocator * | m_allocator |
BYO_CRYPTO: TLS channel-handler base class.
+
+
|
+ +virtual | +
+
|
+ +protected | +
+
|
+ +protected | +
Invoke this function from inside your handler after TLS negotiation completes. errorCode == AWS_ERROR_SUCCESS or 0 means the session was successfully established and the connection should continue on.
+ +
+
|
+ +pure virtual | +
+
|
+ +friend | +
+ aws-crt-cpp
+
+ C++ wrapper around the aws-c-* libraries. Provides Cross-Platform Transport Protocols and SSL/TLS implementations for C++.
+ |
+
This is the complete list of members for Aws::Crt::Io::TlsConnectionOptions, including all inherited members.
+LastError() const noexcept | Aws::Crt::Io::TlsConnectionOptions | inline |
operator bool() const noexcept | Aws::Crt::Io::TlsConnectionOptions | inlineexplicit |
operator=(const TlsConnectionOptions &) noexcept | Aws::Crt::Io::TlsConnectionOptions | |
operator=(TlsConnectionOptions &&options) noexcept | Aws::Crt::Io::TlsConnectionOptions | |
SetAlpnList(const char *alpnList) noexcept | Aws::Crt::Io::TlsConnectionOptions | |
SetServerName(ByteCursor &serverName) noexcept | Aws::Crt::Io::TlsConnectionOptions | |
TlsConnectionOptions() noexcept | Aws::Crt::Io::TlsConnectionOptions | |
TlsConnectionOptions(const TlsConnectionOptions &) noexcept | Aws::Crt::Io::TlsConnectionOptions | |
TlsConnectionOptions(TlsConnectionOptions &&options) noexcept | Aws::Crt::Io::TlsConnectionOptions | |
TlsContext class | Aws::Crt::Io::TlsConnectionOptions | friend |
~TlsConnectionOptions() | Aws::Crt::Io::TlsConnectionOptions |
+ aws-crt-cpp
+
+ C++ wrapper around the aws-c-* libraries. Provides Cross-Platform Transport Protocols and SSL/TLS implementations for C++.
+ |
+
#include <TlsOptions.h>
+Public Member Functions | |
TlsConnectionOptions () noexcept | |
~TlsConnectionOptions () | |
TlsConnectionOptions (const TlsConnectionOptions &) noexcept | |
TlsConnectionOptions & | operator= (const TlsConnectionOptions &) noexcept |
TlsConnectionOptions (TlsConnectionOptions &&options) noexcept | |
TlsConnectionOptions & | operator= (TlsConnectionOptions &&options) noexcept |
bool | SetServerName (ByteCursor &serverName) noexcept |
bool | SetAlpnList (const char *alpnList) noexcept |
operator bool () const noexcept | |
int | LastError () const noexcept |
+Friends | |
class | TlsContext |
Options specific to a single connection.
+
+
|
+ +noexcept | +
Aws::Crt::Io::TlsConnectionOptions::~TlsConnectionOptions | +( | +) | ++ |
+
|
+ +noexcept | +
+
|
+ +noexcept | +
+
|
+ +inlinenoexcept | +
+
|
+ +inlineexplicitnoexcept | +
+
|
+ +noexcept | +
+
|
+ +noexcept | +
+
|
+ +noexcept | +
Sets list of protocols (semi-colon delimited in priority order) used for ALPN extension. alpnList is copied.
+
+
|
+ +noexcept | +
Sets SNI extension, and also the name used for X.509 validation. serverName is copied.
+
+
|
+ +friend | +
+ aws-crt-cpp
+
+ C++ wrapper around the aws-c-* libraries. Provides Cross-Platform Transport Protocols and SSL/TLS implementations for C++.
+ |
+
This is the complete list of members for Aws::Crt::Io::TlsContext, including all inherited members.
+GetInitializationError() const noexcept | Aws::Crt::Io::TlsContext | inline |
NewConnectionOptions() const noexcept | Aws::Crt::Io::TlsContext | |
operator bool() const noexcept | Aws::Crt::Io::TlsContext | inlineexplicit |
operator=(const TlsContext &) noexcept=default | Aws::Crt::Io::TlsContext | |
operator=(TlsContext &&) noexcept=default | Aws::Crt::Io::TlsContext | |
TlsContext() noexcept | Aws::Crt::Io::TlsContext | |
TlsContext(TlsContextOptions &options, TlsMode mode, Allocator *allocator=ApiAllocator()) noexcept | Aws::Crt::Io::TlsContext | |
TlsContext(const TlsContext &) noexcept=default | Aws::Crt::Io::TlsContext | |
TlsContext(TlsContext &&) noexcept=default | Aws::Crt::Io::TlsContext | |
~TlsContext()=default | Aws::Crt::Io::TlsContext |
+ aws-crt-cpp
+
+ C++ wrapper around the aws-c-* libraries. Provides Cross-Platform Transport Protocols and SSL/TLS implementations for C++.
+ |
+
#include <TlsOptions.h>
+Public Member Functions | |
TlsContext () noexcept | |
TlsContext (TlsContextOptions &options, TlsMode mode, Allocator *allocator=ApiAllocator()) noexcept | |
~TlsContext ()=default | |
TlsContext (const TlsContext &) noexcept=default | |
TlsContext & | operator= (const TlsContext &) noexcept=default |
TlsContext (TlsContext &&) noexcept=default | |
TlsContext & | operator= (TlsContext &&) noexcept=default |
TlsConnectionOptions | NewConnectionOptions () const noexcept |
operator bool () const noexcept | |
int | GetInitializationError () const noexcept |
Stateful context for TLS with a given configuration. Per-connection TLS "contexts" (TlsConnectionOptions) are instantiated from this as needed.
+
+
|
+ +noexcept | +
+
|
+ +noexcept | +
+
|
+ +default | +
+
|
+ +defaultnoexcept | +
+
|
+ +defaultnoexcept | +
+
|
+ +inlinenoexcept | +
+
|
+ +noexcept | +
+
|
+ +inlineexplicitnoexcept | +
+
|
+ +defaultnoexcept | +
+
|
+ +defaultnoexcept | +
+ aws-crt-cpp
+
+ C++ wrapper around the aws-c-* libraries. Provides Cross-Platform Transport Protocols and SSL/TLS implementations for C++.
+ |
+
This is the complete list of members for Aws::Crt::Io::TlsContextOptions, including all inherited members.
+
+ aws-crt-cpp
+
+ C++ wrapper around the aws-c-* libraries. Provides Cross-Platform Transport Protocols and SSL/TLS implementations for C++.
+ |
+
#include <TlsOptions.h>
+Public Member Functions | |
TlsContextOptions () noexcept | |
virtual | ~TlsContextOptions () |
TlsContextOptions (const TlsContextOptions &) noexcept=delete | |
TlsContextOptions & | operator= (const TlsContextOptions &) noexcept=delete |
TlsContextOptions (TlsContextOptions &&) noexcept | |
TlsContextOptions & | operator= (TlsContextOptions &&) noexcept |
operator bool () const noexcept | |
int | LastError () const noexcept |
bool | SetKeychainPath (ByteCursor &keychain_path) noexcept |
bool | SetAlpnList (const char *alpnList) noexcept |
void | SetVerifyPeer (bool verifyPeer) noexcept |
void | SetMinimumTlsVersion (aws_tls_versions minimumTlsVersion) |
void | SetTlsCipherPreference (aws_tls_cipher_pref cipher_pref) |
bool | OverrideDefaultTrustStore (const char *caPath, const char *caFile) noexcept |
bool | OverrideDefaultTrustStore (const ByteCursor &ca) noexcept |
+Static Public Member Functions | |
static TlsContextOptions | InitDefaultClient (Allocator *allocator=ApiAllocator()) noexcept |
static TlsContextOptions | InitClientWithMtls (const char *cert_path, const char *pkey_path, Allocator *allocator=ApiAllocator()) noexcept |
static TlsContextOptions | InitClientWithMtls (const ByteCursor &cert, const ByteCursor &pkey, Allocator *allocator=ApiAllocator()) noexcept |
static TlsContextOptions | InitClientWithMtlsPkcs11 (const TlsContextPkcs11Options &pkcs11Options, Allocator *allocator=ApiAllocator()) noexcept |
static TlsContextOptions | InitClientWithMtlsPkcs12 (const char *pkcs12_path, const char *pkcs12_pwd, Allocator *allocator=ApiAllocator()) noexcept |
static TlsContextOptions | InitClientWithMtlsSystemPath (const char *windowsCertStorePath, Allocator *allocator=ApiAllocator()) noexcept |
static bool | IsAlpnSupported () noexcept |
+Friends | |
class | TlsContext |
Top-level tls configuration options. These options are used to create a context from which per-connection TLS contexts can be created.
+
+
|
+ +noexcept | +
+
|
+ +virtual | +
+
|
+ +deletenoexcept | +
+
|
+ +noexcept | +
+
|
+ +staticnoexcept | +
Initializes TlsContextOptions for mutual TLS (mTLS), with client certificate and private key. These are in memory buffers. These buffers must be in the PEM format.
+NOTE: This is unsupported on iOS.
+cert | Certificate contents in memory. |
pkey | Private key contents in memory. |
allocator | Memory allocator to use. |
+
|
+ +staticnoexcept | +
Initializes TlsContextOptions for mutual TLS (mTLS), with client certificate and private key. These are paths to a file on disk. These files must be in the PEM format.
+NOTE: This is unsupported on iOS.
+cert_path | Path to certificate file. |
pkey_path | Path to private key file. |
allocator | Memory allocator to use. |
+
|
+ +staticnoexcept | +
Initializes TlsContextOptions for mutual TLS (mTLS), using a PKCS#11 library for private key operations.
+NOTE: This only works on Unix devices.
+pkcs11Options | PKCS#11 options |
allocator | Memory allocator to use. |
+
|
+ +staticnoexcept | +
Initializes TlsContextOptions for mutual TLS (mTLS), with client certificate and private key in the PKCS#12 format.
+NOTE: This only works on Apple devices.
+pkcs12_path | Path to PKCS #12 file. The file is loaded from disk and stored internally. It must remain in memory for the lifetime of the returned object. |
pkcs12_pwd | Password to PKCS #12 file. It must remain in memory for the lifetime of the returned object. |
allocator | Memory allocator to use. |
+
|
+ +staticnoexcept | +
Initializes TlsContextOptions for mutual TLS (mTLS), using a client certificate in a Windows certificate store.
+NOTE: This only works on Windows.
+windowsCertStorePath | Path to certificate in a Windows certificate store. The path must use backslashes and end with the certificate's thumbprint. Example: CurrentUser\MY\A11F8A9B5DF5B98BA3508FBCA575D09570E0D2C6 |
allocator | The memory allocator to use. |
+
|
+ +staticnoexcept | +
Initializes TlsContextOptions with secure by default options, with no client certificates.
+ +
+
|
+ +staticnoexcept | +
+
|
+ +noexcept | +
+
|
+ +inlineexplicitnoexcept | +
+
|
+ +deletenoexcept | +
+
|
+ +noexcept | +
+
|
+ +noexcept | +
Overrides the default system trust store.
ca | PEM armored chain of trusted CA certificates. |
+
|
+ +noexcept | +
Overrides the default system trust store.
caPath | Path to directory containing trusted certificates, which will overrides the default trust store. Only useful on Unix style systems where all anchors are stored in a directory (like /etc/ssl/certs). This string must remain in memory for the lifetime of this object. |
caFile | Path to file containing PEM armored chain of trusted CA certificates. This string must remain in memory for the lifetime of this object. |
+
|
+ +noexcept | +
Sets the list of alpn protocols.
alpnList | List of protocol names, delimited by ';'. This string must remain in memory for the lifetime of this object. |
+
|
+ +noexcept | +
By default the certificates and private keys are stored in the default keychain of the account of the process. If you instead wish to provide your own keychain for storing them, this makes the TlsContext to use that instead. NOTE: The password of your keychain must be empty.
+NOTE: This only works on MacOS.
+ +void Aws::Crt::Io::TlsContextOptions::SetMinimumTlsVersion | +( | +aws_tls_versions | +minimumTlsVersion | ) | ++ |
Sets the minimum TLS version allowed.
minimumTlsVersion | The minimum TLS version. |
void Aws::Crt::Io::TlsContextOptions::SetTlsCipherPreference | +( | +aws_tls_cipher_pref | +cipher_pref | ) | ++ |
Sets the preferred TLS Cipher List
cipher_pref | The preferred TLS cipher list. |
+
|
+ +noexcept | +
In client mode, this turns off x.509 validation. Don't do this unless you're testing. It's much better, to just override the default trust store and pass the self-signed certificate as the caFile argument.
+In server mode, this defaults to false. If you want to support mutual TLS from the server, you'll want to set this to true.
+ +
+
|
+ +friend | +
+ aws-crt-cpp
+
+ C++ wrapper around the aws-c-* libraries. Provides Cross-Platform Transport Protocols and SSL/TLS implementations for C++.
+ |
+
This is the complete list of members for Aws::Crt::Io::TlsContextPkcs11Options, including all inherited members.
+SetCertificateFileContents(const String &contents) noexcept | Aws::Crt::Io::TlsContextPkcs11Options | |
SetCertificateFilePath(const String &path) noexcept | Aws::Crt::Io::TlsContextPkcs11Options | |
SetPrivateKeyObjectLabel(const String &label) noexcept | Aws::Crt::Io::TlsContextPkcs11Options | |
SetSlotId(const uint64_t id) noexcept | Aws::Crt::Io::TlsContextPkcs11Options | |
SetTokenLabel(const String &label) noexcept | Aws::Crt::Io::TlsContextPkcs11Options | |
SetUserPin(const String &pin) noexcept | Aws::Crt::Io::TlsContextPkcs11Options | |
TlsContextPkcs11Options(const std::shared_ptr< Pkcs11Lib > &pkcs11Lib, Allocator *allocator=ApiAllocator()) noexcept | Aws::Crt::Io::TlsContextPkcs11Options |
+ aws-crt-cpp
+
+ C++ wrapper around the aws-c-* libraries. Provides Cross-Platform Transport Protocols and SSL/TLS implementations for C++.
+ |
+
#include <TlsOptions.h>
+Public Member Functions | |
TlsContextPkcs11Options (const std::shared_ptr< Pkcs11Lib > &pkcs11Lib, Allocator *allocator=ApiAllocator()) noexcept | |
void | SetUserPin (const String &pin) noexcept |
void | SetSlotId (const uint64_t id) noexcept |
void | SetTokenLabel (const String &label) noexcept |
void | SetPrivateKeyObjectLabel (const String &label) noexcept |
void | SetCertificateFilePath (const String &path) noexcept |
void | SetCertificateFileContents (const String &contents) noexcept |
Options for TLS, when using a PKCS#11 library for private key operations.
+ +
+
|
+ +noexcept | +
pkcs11Lib | use this PKCS#11 library |
allocator | Memory allocator to use. |
+
|
+ +noexcept | +
Use this X.509 certificate (contents in memory). The certificate may be specified by other means instead (ex: SetCertificateFilePath())
+contents | contents of PEM-formatted certificate file. |
+
|
+ +noexcept | +
Use this X.509 certificate (file on disk). The certificate may be specified by other means instead (ex: SetCertificateFileContents())
+path | path to PEM-formatted certificate file on disk. |
+
|
+ +noexcept | +
Specify the label of the private key object on the PKCS#11 token. If not specified, the key will be chosen based on other criteria (such as being the only available private key on the token).
+label | label of private key object |
+
|
+ +noexcept | +
Specify the slot ID containing a PKCS#11 token. If not specified, the token will be chosen based on other criteria (such as token label).
+id | slot ID |
+
|
+ +noexcept | +
Specify the label of the PKCS#11 token to use. If not specified, the token will be chosen based on other criteria (such as slot ID).
+label | label of token |
+
|
+ +noexcept | +
Use this PIN to log the user into the PKCS#11 token. Leave unspecified to log into a token with a "protected authentication path".
+pin | PIN |
+ aws-crt-cpp
+
+ C++ wrapper around the aws-c-* libraries. Provides Cross-Platform Transport Protocols and SSL/TLS implementations for C++.
+ |
+
This is the complete list of members for Aws::Crt::Io::Uri, including all inherited members.
+GetAuthority() const noexcept | Aws::Crt::Io::Uri | |
GetFullUri() const noexcept | Aws::Crt::Io::Uri | |
GetHostName() const noexcept | Aws::Crt::Io::Uri | |
GetPath() const noexcept | Aws::Crt::Io::Uri | |
GetPathAndQuery() const noexcept | Aws::Crt::Io::Uri | |
GetPort() const noexcept | Aws::Crt::Io::Uri | |
GetQueryString() const noexcept | Aws::Crt::Io::Uri | |
GetScheme() const noexcept | Aws::Crt::Io::Uri | |
LastError() const noexcept | Aws::Crt::Io::Uri | inline |
operator bool() const noexcept | Aws::Crt::Io::Uri | inline |
operator=(const Uri &) | Aws::Crt::Io::Uri | |
operator=(Uri &&) noexcept | Aws::Crt::Io::Uri | |
Uri() noexcept | Aws::Crt::Io::Uri | |
Uri(const ByteCursor &cursor, Allocator *allocator=ApiAllocator()) noexcept | Aws::Crt::Io::Uri | |
Uri(aws_uri_builder_options &builderOptions, Allocator *allocator=ApiAllocator()) noexcept | Aws::Crt::Io::Uri | |
Uri(const Uri &) | Aws::Crt::Io::Uri | |
Uri(Uri &&uri) noexcept | Aws::Crt::Io::Uri | |
~Uri() | Aws::Crt::Io::Uri |
+ aws-crt-cpp
+
+ C++ wrapper around the aws-c-* libraries. Provides Cross-Platform Transport Protocols and SSL/TLS implementations for C++.
+ |
+
#include <Uri.h>
+Public Member Functions | |
Uri () noexcept | |
~Uri () | |
Uri (const ByteCursor &cursor, Allocator *allocator=ApiAllocator()) noexcept | |
Uri (aws_uri_builder_options &builderOptions, Allocator *allocator=ApiAllocator()) noexcept | |
Uri (const Uri &) | |
Uri & | operator= (const Uri &) |
Uri (Uri &&uri) noexcept | |
Uri & | operator= (Uri &&) noexcept |
operator bool () const noexcept | |
int | LastError () const noexcept |
ByteCursor | GetScheme () const noexcept |
ByteCursor | GetAuthority () const noexcept |
ByteCursor | GetPath () const noexcept |
ByteCursor | GetQueryString () const noexcept |
ByteCursor | GetHostName () const noexcept |
uint32_t | GetPort () const noexcept |
ByteCursor | GetPathAndQuery () const noexcept |
ByteCursor | GetFullUri () const noexcept |
Contains a URI used for networking application protocols. This type is move-only.
+
+
|
+ +noexcept | +
Aws::Crt::Io::Uri::~Uri | +( | +) | ++ |
+
|
+ +noexcept | +
Parses cursor
as a URI. Upon failure the bool() operator will return false and LastError() will contain the errorCode.
+
|
+ +noexcept | +
Builds a URI from builderOptions
. Upon failure the bool() operator will return false and LastError() will contain the errorCode.
Aws::Crt::Io::Uri::Uri | +( | +const Uri & | +other | ) | ++ |
+
|
+ +noexcept | +
+
|
+ +noexcept | +
+
|
+ +noexcept | +
+
|
+ +noexcept | +
+
|
+ +noexcept | +
+
|
+ +noexcept | +
+
|
+ +noexcept | +
+
|
+ +noexcept | +
+
|
+ +noexcept | +
+
|
+ +inlinenoexcept | +
+
|
+ +inlinenoexcept | +
+ aws-crt-cpp
+
+ C++ wrapper around the aws-c-* libraries. Provides Cross-Platform Transport Protocols and SSL/TLS implementations for C++.
+ |
+
This is the complete list of members for Aws::Crt::JsonObject, including all inherited members.
+ApiHandle class | Aws::Crt::JsonObject | friend |
AsArray(const Vector< JsonObject > &array) | Aws::Crt::JsonObject | |
AsArray(Vector< JsonObject > &&array) | Aws::Crt::JsonObject | |
AsBool(bool value) | Aws::Crt::JsonObject | |
AsDouble(double value) | Aws::Crt::JsonObject | |
AsInt64(int64_t value) | Aws::Crt::JsonObject | |
AsInteger(int value) | Aws::Crt::JsonObject | |
AsNull() | Aws::Crt::JsonObject | |
AsObject(const JsonObject &value) | Aws::Crt::JsonObject | |
AsObject(JsonObject &&value) | Aws::Crt::JsonObject | |
AsString(const String &value) | Aws::Crt::JsonObject | |
GetErrorMessage() const | Aws::Crt::JsonObject | |
JsonObject() | Aws::Crt::JsonObject | |
JsonObject(const String &stringToParse) | Aws::Crt::JsonObject | |
JsonObject(const JsonObject &other) | Aws::Crt::JsonObject | |
JsonObject(JsonObject &&other) noexcept | Aws::Crt::JsonObject | |
JsonView class | Aws::Crt::JsonObject | friend |
operator!=(const JsonObject &other) const | Aws::Crt::JsonObject | |
operator=(const JsonObject &other) | Aws::Crt::JsonObject | |
operator=(JsonObject &&other) noexcept | Aws::Crt::JsonObject | |
operator==(const JsonObject &other) const | Aws::Crt::JsonObject | |
View() const | Aws::Crt::JsonObject | |
WasParseSuccessful() const | Aws::Crt::JsonObject | inline |
WithArray(const String &key, const Vector< String > &array) | Aws::Crt::JsonObject | |
WithArray(const char *key, const Vector< String > &array) | Aws::Crt::JsonObject | |
WithArray(const String &key, const Vector< JsonObject > &array) | Aws::Crt::JsonObject | |
WithArray(const String &key, Vector< JsonObject > &&array) | Aws::Crt::JsonObject | |
WithBool(const String &key, bool value) | Aws::Crt::JsonObject | |
WithBool(const char *key, bool value) | Aws::Crt::JsonObject | |
WithDouble(const String &key, double value) | Aws::Crt::JsonObject | |
WithDouble(const char *key, double value) | Aws::Crt::JsonObject | |
WithInt64(const String &key, int64_t value) | Aws::Crt::JsonObject | |
WithInt64(const char *key, int64_t value) | Aws::Crt::JsonObject | |
WithInteger(const String &key, int value) | Aws::Crt::JsonObject | |
WithInteger(const char *key, int value) | Aws::Crt::JsonObject | |
WithObject(const String &key, const JsonObject &value) | Aws::Crt::JsonObject | |
WithObject(const char *key, const JsonObject &value) | Aws::Crt::JsonObject | |
WithObject(const String &key, JsonObject &&value) | Aws::Crt::JsonObject | |
WithObject(const char *key, JsonObject &&value) | Aws::Crt::JsonObject | |
WithString(const String &key, const String &value) | Aws::Crt::JsonObject | |
WithString(const char *key, const String &value) | Aws::Crt::JsonObject | |
~JsonObject() | Aws::Crt::JsonObject |
+ aws-crt-cpp
+
+ C++ wrapper around the aws-c-* libraries. Provides Cross-Platform Transport Protocols and SSL/TLS implementations for C++.
+ |
+
#include <JsonObject.h>
+Public Member Functions | |
JsonObject () | |
JsonObject (const String &stringToParse) | |
JsonObject (const JsonObject &other) | |
JsonObject (JsonObject &&other) noexcept | |
~JsonObject () | |
JsonObject & | operator= (const JsonObject &other) |
JsonObject & | operator= (JsonObject &&other) noexcept |
bool | operator== (const JsonObject &other) const |
bool | operator!= (const JsonObject &other) const |
JsonObject & | WithString (const String &key, const String &value) |
JsonObject & | WithString (const char *key, const String &value) |
JsonObject & | AsString (const String &value) |
JsonObject & | WithBool (const String &key, bool value) |
JsonObject & | WithBool (const char *key, bool value) |
JsonObject & | AsBool (bool value) |
JsonObject & | WithInteger (const String &key, int value) |
JsonObject & | WithInteger (const char *key, int value) |
JsonObject & | AsInteger (int value) |
JsonObject & | WithInt64 (const String &key, int64_t value) |
JsonObject & | WithInt64 (const char *key, int64_t value) |
JsonObject & | AsInt64 (int64_t value) |
JsonObject & | WithDouble (const String &key, double value) |
JsonObject & | WithDouble (const char *key, double value) |
JsonObject & | AsDouble (double value) |
JsonObject & | WithArray (const String &key, const Vector< String > &array) |
JsonObject & | WithArray (const char *key, const Vector< String > &array) |
JsonObject & | WithArray (const String &key, const Vector< JsonObject > &array) |
JsonObject & | WithArray (const String &key, Vector< JsonObject > &&array) |
JsonObject & | AsArray (const Vector< JsonObject > &array) |
JsonObject & | AsArray (Vector< JsonObject > &&array) |
JsonObject & | AsNull () |
JsonObject & | WithObject (const String &key, const JsonObject &value) |
JsonObject & | WithObject (const char *key, const JsonObject &value) |
JsonObject & | WithObject (const String &key, JsonObject &&value) |
JsonObject & | WithObject (const char *key, JsonObject &&value) |
JsonObject & | AsObject (const JsonObject &value) |
JsonObject & | AsObject (JsonObject &&value) |
bool | WasParseSuccessful () const |
const String & | GetErrorMessage () const |
JsonView | View () const |
+Friends | |
class | JsonView |
class | ApiHandle |
JSON DOM manipulation class. To read or serialize use View function.
+Aws::Crt::JsonObject::JsonObject | +( | +) | ++ |
Constructs empty JSON DOM.
+ +Aws::Crt::JsonObject::JsonObject | +( | +const String & | +stringToParse | ) | ++ |
Constructs a JSON DOM by parsing the input string. Call WasParseSuccessful() on new object to determine if parse was successful.
+ +Aws::Crt::JsonObject::JsonObject | +( | +const JsonObject & | +other | ) | ++ |
Construct a deep copy. Prefer using a JsonView if copying is not needed.
+ +
+
|
+ +noexcept | +
Move constructor. No copying is performed.
+ +Aws::Crt::JsonObject::~JsonObject | +( | +) | ++ |
JsonObject & Aws::Crt::JsonObject::AsArray | +( | +const Vector< JsonObject > & | +array | ) | ++ |
Converts the current JSON node to an array whose values are deep-copied from the array parameter.
+ +JsonObject & Aws::Crt::JsonObject::AsArray | +( | +Vector< JsonObject > && | +array | ) | ++ |
Converts the current JSON node to an array whose values are moved from the array parameter.
+ +JsonObject & Aws::Crt::JsonObject::AsBool | +( | +bool | +value | ) | ++ |
Converts the current JSON node to a bool.
+ +JsonObject & Aws::Crt::JsonObject::AsDouble | +( | +double | +value | ) | ++ |
Converts the current JSON node to a number.
+ +JsonObject & Aws::Crt::JsonObject::AsInt64 | +( | +int64_t | +value | ) | ++ |
Converts the current JSON node to a number. Precision may be lost.
+ +JsonObject & Aws::Crt::JsonObject::AsInteger | +( | +int | +value | ) | ++ |
Converts the current JSON node to a number. Precision may be lost.
+ +JsonObject & Aws::Crt::JsonObject::AsNull | +( | +) | ++ |
Sets the current JSON node as null.
+ +JsonObject & Aws::Crt::JsonObject::AsObject | +( | +const JsonObject & | +value | ) | ++ |
Converts the current JSON node to a JSON object by deep-copying the parameter.
+ +JsonObject & Aws::Crt::JsonObject::AsObject | +( | +JsonObject && | +value | ) | ++ |
Converts the current JSON node to a JSON object by moving from the parameter.
+ +JsonObject & Aws::Crt::JsonObject::AsString | +( | +const String & | +value | ) | ++ |
Converts the current JSON node to a string.
+ +const String & Aws::Crt::JsonObject::GetErrorMessage | +( | +) | +const | +
bool Aws::Crt::JsonObject::operator!= | +( | +const JsonObject & | +other | ) | +const | +
JsonObject & Aws::Crt::JsonObject::operator= | +( | +const JsonObject & | +other | ) | ++ |
Performs a deep copy.
+ +
+
|
+ +noexcept | +
Moves the ownership of the internal JSON DOM of the parameter to the current object. No copying is performed. A DOM currently owned by the object will be freed prior to copying.
bool Aws::Crt::JsonObject::operator== | +( | +const JsonObject & | +other | ) | +const | +
JsonView Aws::Crt::JsonObject::View | +( | +) | +const | +
Creates a view of this JSON node.
+ +
+
|
+ +inline | +
Returns true if the last parse request was successful.
+ +JsonObject & Aws::Crt::JsonObject::WithArray | +( | +const char * | +key, | +
+ | + | const Vector< String > & | +array | +
+ | ) | ++ |
JsonObject & Aws::Crt::JsonObject::WithArray | +( | +const String & | +key, | +
+ | + | const Vector< JsonObject > & | +array | +
+ | ) | ++ |
Adds an array of arbitrary JSON objects to the top level of this node at key. The values in the array parameter will be deep-copied.
+ +JsonObject & Aws::Crt::JsonObject::WithArray | +( | +const String & | +key, | +
+ | + | const Vector< String > & | +array | +
+ | ) | ++ |
Adds an array of strings to the top level of this node at key.
+ +JsonObject & Aws::Crt::JsonObject::WithArray | +( | +const String & | +key, | +
+ | + | Vector< JsonObject > && | +array | +
+ | ) | ++ |
Adds an array of arbitrary JSON objects to the top level of this node at key. The values in the array parameter will be moved-from.
+ +JsonObject & Aws::Crt::JsonObject::WithBool | +( | +const char * | +key, | +
+ | + | bool | +value | +
+ | ) | ++ |
JsonObject & Aws::Crt::JsonObject::WithBool | +( | +const String & | +key, | +
+ | + | bool | +value | +
+ | ) | ++ |
Adds a bool value with key to the top level of this node.
+ +JsonObject & Aws::Crt::JsonObject::WithDouble | +( | +const char * | +key, | +
+ | + | double | +value | +
+ | ) | ++ |
JsonObject & Aws::Crt::JsonObject::WithDouble | +( | +const String & | +key, | +
+ | + | double | +value | +
+ | ) | ++ |
Adds a number value at key at the top level of this node.
+ +JsonObject & Aws::Crt::JsonObject::WithInt64 | +( | +const char * | +key, | +
+ | + | int64_t | +value | +
+ | ) | ++ |
JsonObject & Aws::Crt::JsonObject::WithInt64 | +( | +const String & | +key, | +
+ | + | int64_t | +value | +
+ | ) | ++ |
Adds a number value at key to the top level of this node. Precision may be lost.
+ +JsonObject & Aws::Crt::JsonObject::WithInteger | +( | +const char * | +key, | +
+ | + | int | +value | +
+ | ) | ++ |
JsonObject & Aws::Crt::JsonObject::WithInteger | +( | +const String & | +key, | +
+ | + | int | +value | +
+ | ) | ++ |
Adds a number value at key at the top level of this node. Precision may be lost.
+ +JsonObject & Aws::Crt::JsonObject::WithObject | +( | +const char * | +key, | +
+ | + | const JsonObject & | +value | +
+ | ) | ++ |
JsonObject & Aws::Crt::JsonObject::WithObject | +( | +const char * | +key, | +
+ | + | JsonObject && | +value | +
+ | ) | ++ |
JsonObject & Aws::Crt::JsonObject::WithObject | +( | +const String & | +key, | +
+ | + | const JsonObject & | +value | +
+ | ) | ++ |
Adds a JSON object to the top level of this node at key. The object parameter is deep-copied.
+ +JsonObject & Aws::Crt::JsonObject::WithObject | +( | +const String & | +key, | +
+ | + | JsonObject && | +value | +
+ | ) | ++ |
Adds a JSON object to the top level of this node at key.
+ +JsonObject & Aws::Crt::JsonObject::WithString | +( | +const char * | +key, | +
+ | + | const String & | +value | +
+ | ) | ++ |
JsonObject & Aws::Crt::JsonObject::WithString | +( | +const String & | +key, | +
+ | + | const String & | +value | +
+ | ) | ++ |
Adds a string to the top level of this node with key.
+ +
+
|
+ +friend | +
+
|
+ +friend | +
+ aws-crt-cpp
+
+ C++ wrapper around the aws-c-* libraries. Provides Cross-Platform Transport Protocols and SSL/TLS implementations for C++.
+ |
+
This is the complete list of members for Aws::Crt::JsonView, including all inherited members.
+
+ aws-crt-cpp
+
+ C++ wrapper around the aws-c-* libraries. Provides Cross-Platform Transport Protocols and SSL/TLS implementations for C++.
+ |
+
#include <JsonObject.h>
+Public Member Functions | |
JsonView () | |
JsonView (const JsonObject &val) | |
JsonView & | operator= (const JsonObject &val) |
String | GetString (const String &key) const |
String | GetString (const char *key) const |
String | AsString () const |
bool | GetBool (const String &key) const |
bool | GetBool (const char *key) const |
bool | AsBool () const |
int | GetInteger (const String &key) const |
int | GetInteger (const char *key) const |
int | AsInteger () const |
int64_t | GetInt64 (const String &key) const |
int64_t | GetInt64 (const char *key) const |
int64_t | AsInt64 () const |
double | GetDouble (const String &key) const |
double | GetDouble (const char *key) const |
double | AsDouble () const |
Vector< JsonView > | GetArray (const String &key) const |
Vector< JsonView > | GetArray (const char *key) const |
Vector< JsonView > | AsArray () const |
JsonView | GetJsonObject (const String &key) const |
JsonView | GetJsonObject (const char *key) const |
JsonObject | GetJsonObjectCopy (const String &key) const |
JsonObject | GetJsonObjectCopy (const char *key) const |
JsonView | AsObject () const |
Map< String, JsonView > | GetAllObjects () const |
bool | ValueExists (const String &key) const |
bool | ValueExists (const char *key) const |
bool | KeyExists (const String &key) const |
bool | KeyExists (const char *key) const |
bool | IsObject () const |
bool | IsBool () const |
bool | IsString () const |
bool | IsNumber () const |
bool | IsIntegerType () const |
bool | IsFloatingPointType () const |
bool | IsListType () const |
bool | IsNull () const |
String | WriteCompact (bool treatAsObject=true) const |
String | WriteReadable (bool treatAsObject=true) const |
JsonObject | Materialize () const |
Provides read-only view to an existing JsonObject. This allows lightweight copying without making deep copies of the JsonObject. Note: This class does not extend the lifetime of the given JsonObject. It's your responsibility to ensure the lifetime of the JsonObject is extended beyond the lifetime of its view.
+Aws::Crt::JsonView::JsonView | +( | +) | ++ |
Aws::Crt::JsonView::JsonView | +( | +const JsonObject & | +val | ) | ++ |
Returns the value of this node as an array of JsonView objects.
+ +bool Aws::Crt::JsonView::AsBool | +( | +) | +const | +
Returns the value of this node as a boolean.
+ +double Aws::Crt::JsonView::AsDouble | +( | +) | +const | +
Returns the value of this node as a double precision floating-point.
+ +int64_t Aws::Crt::JsonView::AsInt64 | +( | +) | +const | +
Returns the value of this node as 64-bit integer.
+ +int Aws::Crt::JsonView::AsInteger | +( | +) | +const | +
Returns the value of this node as an int.
+ +JsonView Aws::Crt::JsonView::AsObject | +( | +) | +const | +
Returns the value of this node as a JsonView object.
+ +String Aws::Crt::JsonView::AsString | +( | +) | +const | +
Returns the value of this node as a string. The behavior is undefined if the node is not of type string.
+ +Reads all json objects at the top level of this node (does not traverse the tree any further) along with their keys.
+ +Gets an array of JsonView objects from this node by its key.
+ +Gets an array of JsonView objects from this node by its key.
+ +bool Aws::Crt::JsonView::GetBool | +( | +const char * | +key | ) | +const | +
Gets a boolean value from this node by its key.
+ +bool Aws::Crt::JsonView::GetBool | +( | +const String & | +key | ) | +const | +
Gets a boolean value from this node by its key.
+ +double Aws::Crt::JsonView::GetDouble | +( | +const char * | +key | ) | +const | +
Gets a double precision floating-point value from this node by its key.
+ +double Aws::Crt::JsonView::GetDouble | +( | +const String & | +key | ) | +const | +
Gets a double precision floating-point value from this node by its key.
+ +int64_t Aws::Crt::JsonView::GetInt64 | +( | +const char * | +key | ) | +const | +
Gets a 64-bit integer value from this node by its key. The value is 64-bit regardless of the platform/machine.
+ +int64_t Aws::Crt::JsonView::GetInt64 | +( | +const String & | +key | ) | +const | +
Gets a 64-bit integer value from this node by its key. The value is 64-bit regardless of the platform/machine.
+ +int Aws::Crt::JsonView::GetInteger | +( | +const char * | +key | ) | +const | +
Gets an integer value from this node by its key. The integer is of the same size as an int on the machine.
+ +int Aws::Crt::JsonView::GetInteger | +( | +const String & | +key | ) | +const | +
Gets an integer value from this node by its key. The integer is of the same size as an int on the machine.
+ +JsonView Aws::Crt::JsonView::GetJsonObject | +( | +const char * | +key | ) | +const | +
Gets a JsonView object from this node by its key.
+ +Gets a JsonView object from this node by its key.
+ +JsonObject Aws::Crt::JsonView::GetJsonObjectCopy | +( | +const char * | +key | ) | +const | +
JsonObject Aws::Crt::JsonView::GetJsonObjectCopy | +( | +const String & | +key | ) | +const | +
String Aws::Crt::JsonView::GetString | +( | +const char * | +key | ) | +const | +
Gets a string from this node by its key.
+ +Gets a string from this node by its key.
+ +bool Aws::Crt::JsonView::IsBool | +( | +) | +const | +
Tests whether the current value is a boolean.
+ +bool Aws::Crt::JsonView::IsFloatingPointType | +( | +) | +const | +
Tests whether the current value is a number that will lose precision if converted to an int64_t.
+ +bool Aws::Crt::JsonView::IsIntegerType | +( | +) | +const | +
Tests whether the current value is a number that can convert to an int64_t without losing precision.
+ +bool Aws::Crt::JsonView::IsListType | +( | +) | +const | +
Tests whether the current value is a JSON array.
+ +bool Aws::Crt::JsonView::IsNull | +( | +) | +const | +
Tests whether the current value is a JSON null.
+ +bool Aws::Crt::JsonView::IsNumber | +( | +) | +const | +
Tests whether the current value is a number.
+ +bool Aws::Crt::JsonView::IsObject | +( | +) | +const | +
Tests whether the current value is a JSON object.
+ +bool Aws::Crt::JsonView::IsString | +( | +) | +const | +
Tests whether the current value is a string.
+ +bool Aws::Crt::JsonView::KeyExists | +( | +const char * | +key | ) | +const | +
Tests whether a key exists at the current node level.
+ +bool Aws::Crt::JsonView::KeyExists | +( | +const String & | +key | ) | +const | +
Tests whether a key exists at the current node level.
+ +JsonObject Aws::Crt::JsonView::Materialize | +( | +) | +const | +
Creates a deep copy of the JSON value rooted in the current JSON view.
+ +JsonView & Aws::Crt::JsonView::operator= | +( | +const JsonObject & | +val | ) | ++ |
bool Aws::Crt::JsonView::ValueExists | +( | +const char * | +key | ) | +const | +
Tests whether a value exists at the current node level for the given key. Returns true if a value has been found and its value is not null, false otherwise.
+ +bool Aws::Crt::JsonView::ValueExists | +( | +const String & | +key | ) | +const | +
Tests whether a value exists at the current node level for the given key. Returns true if a value has been found and its value is not null, false otherwise.
+ +String Aws::Crt::JsonView::WriteCompact | +( | +bool | +treatAsObject = true | ) | +const | +
Writes the current JSON view without whitespace characters starting at the current level to a string.
treatAsObject | if the current value is empty, writes out '{}' rather than an empty string. |
String Aws::Crt::JsonView::WriteReadable | +( | +bool | +treatAsObject = true | ) | +const | +
Writes the current JSON view to a string in a human friendly format.
treatAsObject | if the current value is empty, writes out '{}' rather than an empty string. |
+ aws-crt-cpp
+
+ C++ wrapper around the aws-c-* libraries. Provides Cross-Platform Transport Protocols and SSL/TLS implementations for C++.
+ |
+
This is the complete list of members for Aws::Crt::Mqtt5::ConnAckPacket, including all inherited members.
+
+ aws-crt-cpp
+
+ C++ wrapper around the aws-c-* libraries. Provides Cross-Platform Transport Protocols and SSL/TLS implementations for C++.
+ |
+
#include <Mqtt5Packets.h>
+Public Member Functions | |
ConnAckPacket (const aws_mqtt5_packet_connack_view &packet, Allocator *allocator=ApiAllocator()) noexcept | |
PacketType | getType () override |
bool | getSessionPresent () const noexcept |
ConnectReasonCode | getReasonCode () const noexcept |
const Crt::Optional< uint32_t > & | getSessionExpiryIntervalSec () const noexcept |
const Crt::Optional< uint32_t > & | getSessionExpiryInterval () const noexcept |
const Crt::Optional< uint16_t > & | getReceiveMaximum () const noexcept |
const Crt::Optional< QOS > & | getMaximumQOS () const noexcept |
const Crt::Optional< bool > & | getRetainAvailable () const noexcept |
const Crt::Optional< uint32_t > & | getMaximumPacketSize () const noexcept |
const Crt::Optional< String > & | getAssignedClientIdentifier () const noexcept |
const Crt::Optional< uint16_t > | getTopicAliasMaximum () const noexcept |
const Crt::Optional< String > & | getReasonString () const noexcept |
const Vector< UserProperty > & | getUserProperty () const noexcept |
const Crt::Optional< bool > & | getWildcardSubscriptionsAvailable () const noexcept |
const Crt::Optional< bool > & | getSubscriptionIdentifiersAvailable () const noexcept |
const Crt::Optional< bool > & | getSharedSubscriptionsAvailable () const noexcept |
const Crt::Optional< uint16_t > & | getServerKeepAliveSec () const noexcept |
const Crt::Optional< uint16_t > & | getServerKeepAlive () const noexcept |
const Crt::Optional< String > & | getResponseInformation () const noexcept |
const Crt::Optional< String > & | getServerReference () const noexcept |
virtual | ~ConnAckPacket () |
ConnAckPacket (const ConnAckPacket &)=delete | |
ConnAckPacket (ConnAckPacket &&) noexcept=delete | |
ConnAckPacket & | operator= (const ConnAckPacket &)=delete |
ConnAckPacket & | operator= (ConnAckPacket &&) noexcept=delete |
Data model of an MQTT5 CONNACK packet.
+
+
|
+ +noexcept | +
+
|
+ +inlinevirtual | +
+
|
+ +delete | +
+
|
+ +deletenoexcept | +
+
|
+ +noexcept | +
Specifies a client identifier assigned to this connection by the server. Only valid when the client id of the preceding CONNECT packet was left empty.
+See MQTT5 Assigned Client Identifier
+
+
|
+ +noexcept | +
Specifies the maximum packet size, in bytes, that the server is willing to accept. If null, there is no limit beyond what is imposed by the MQTT spec itself.
+ +
+
|
+ +noexcept | +
The maximum message delivery quality of service that the server will allow on this connection.
+ +
+
|
+ +noexcept | +
Indicates either success or the reason for failure for the connection attempt.
+ +
+
|
+ +noexcept | +
Additional diagnostic information about the result of the connection attempt.
+ +
+
|
+ +noexcept | +
The maximum amount of in-flight QoS 1 or 2 messages that the server is willing to handle at once. If omitted or null, the limit is based on the valid MQTT packet id space (65535).
+ +
+
|
+ +noexcept | +
A value that can be used in the creation of a response topic associated with this connection. MQTT5-based request/response is outside the purview of the MQTT5 spec and this client.
+See MQTT5 Response Information
+
+
|
+ +noexcept | +
Indicates whether the server supports retained messages. If null, retained messages are supported.
+ +
+
|
+ +noexcept | +
ConnAckPacket::getServerKeepAliveSec()
. Server-requested override of the keep alive interval, in seconds. If null, the keep alive value sent by the client should be used.
+
|
+ +noexcept | +
Server-requested override of the keep alive interval, in seconds. If null, the keep alive value sent by the client should be used.
+ +
+
|
+ +noexcept | +
Property indicating an alternate server that the client may temporarily or permanently attempt to connect to instead of the configured endpoint. Will only be set if the reason code indicates another server may be used (ServerMoved, UseAnotherServer).
+ +
+
|
+ +noexcept | +
ConnAckPacket::getSessionExpiryIntervalSec()
.A time interval, in seconds, that the server will persist this connection's MQTT session state for. If present, this value overrides any session expiry specified in the preceding CONNECT packet.
+See MQTT5 Session Expiry Interval
+
+
|
+ +noexcept | +
A time interval, in seconds, that the server will persist this connection's MQTT session state for. If present, this value overrides any session expiry specified in the preceding CONNECT packet.
+See MQTT5 Session Expiry Interval
+
+
|
+ +noexcept | +
True if the client rejoined an existing session on the server, false otherwise.
+ +
+
|
+ +noexcept | +
Indicates whether the server supports shared subscription topic filters. If null, shared subscriptions are supported.
+See MQTT5 Shared Subscriptions Available
+
+
|
+ +noexcept | +
Indicates whether the server supports subscription identifiers. If null, subscription identifiers are supported.
+See MQTT5 Subscription Identifiers Available
+
+
|
+ +noexcept | +
Specifies the maximum topic alias value that the server will accept from the client.
+ +
+
|
+ +inlineoverridevirtual | +
Implements Aws::Crt::Mqtt5::IPacket.
+ +
+
|
+ +noexcept | +
List of MQTT5 user properties included with the packet.
+ +
+
|
+ +noexcept | +
Indicates whether the server supports wildcard subscriptions. If null, wildcard subscriptions are supported.
+See MQTT5 Wildcard Subscriptions Available
+
+
|
+ +deletenoexcept | +
+
|
+ +delete | +
+ aws-crt-cpp
+
+ C++ wrapper around the aws-c-* libraries. Provides Cross-Platform Transport Protocols and SSL/TLS implementations for C++.
+ |
+
This is the complete list of members for Aws::Crt::Mqtt5::ConnectPacket, including all inherited members.
+
+ aws-crt-cpp
+
+ C++ wrapper around the aws-c-* libraries. Provides Cross-Platform Transport Protocols and SSL/TLS implementations for C++.
+ |
+
#include <Mqtt5Packets.h>
+Public Member Functions | |
ConnectPacket (Allocator *allocator=ApiAllocator()) noexcept | |
PacketType | getType () override |
ConnectPacket & | WithKeepAliveIntervalSec (uint16_t keepAliveInteralSeconds) noexcept |
ConnectPacket & | WithClientId (Crt::String clientId) noexcept |
ConnectPacket & | WithUserName (Crt::String username) noexcept |
ConnectPacket & | WithPassword (ByteCursor password) noexcept |
ConnectPacket & | WithSessionExpiryIntervalSec (uint32_t sessionExpiryIntervalSeconds) noexcept |
ConnectPacket & | WithRequestResponseInformation (bool requestResponseInformation) noexcept |
ConnectPacket & | WithRequestProblemInformation (bool requestProblemInformation) noexcept |
ConnectPacket & | WithReceiveMaximum (uint16_t receiveMaximum) noexcept |
ConnectPacket & | WithMaximumPacketSizeBytes (uint32_t maximumPacketSizeBytes) noexcept |
ConnectPacket & | WithWillDelayIntervalSec (uint32_t willDelayIntervalSeconds) noexcept |
ConnectPacket & | WithWill (std::shared_ptr< PublishPacket > will) noexcept |
ConnectPacket & | WithUserProperties (const Vector< UserProperty > &userProperties) noexcept |
ConnectPacket & | WithUserProperties (Vector< UserProperty > &&userProperties) noexcept |
ConnectPacket & | WithUserProperty (UserProperty &&property) noexcept |
uint16_t | getKeepAliveIntervalSec () const noexcept |
const Crt::String & | getClientId () const noexcept |
const Crt::Optional< Crt::String > & | getUsername () const noexcept |
const Crt::Optional< Crt::ByteCursor > & | getPassword () const noexcept |
const Crt::Optional< uint32_t > & | getSessionExpiryIntervalSec () const noexcept |
const Crt::Optional< bool > & | getRequestResponseInformation () const noexcept |
const Crt::Optional< bool > & | getRequestProblemInformation () const noexcept |
const Crt::Optional< uint16_t > & | getReceiveMaximum () const noexcept |
const Crt::Optional< uint32_t > & | getMaximumPacketSizeBytes () const noexcept |
const Crt::Optional< uint32_t > & | getMaximumPacketSizeToServer () const noexcept |
const Crt::Optional< uint32_t > & | getWillDelayIntervalSec () const noexcept |
const Crt::Optional< std::shared_ptr< PublishPacket > > & | getWill () const noexcept |
const Crt::Vector< UserProperty > & | getUserProperties () const noexcept |
bool | initializeRawOptions (aws_mqtt5_packet_connect_view &raw_options, Allocator *allocator) noexcept |
virtual | ~ConnectPacket () |
ConnectPacket (const ConnectPacket &)=delete | |
ConnectPacket (ConnectPacket &&) noexcept=delete | |
ConnectPacket & | operator= (const ConnectPacket &)=delete |
ConnectPacket & | operator= (ConnectPacket &&) noexcept=delete |
Data model of an MQTT5 CONNECT packet.
+
+
|
+ +noexcept | +
+
|
+ +virtual | +
+
|
+ +delete | +
+
|
+ +deletenoexcept | +
+
|
+ +noexcept | +
A unique string identifying the client to the server. Used to restore session state between connections.
+If left empty, the broker will auto-assign a unique client id. When reconnecting, the mqtt5 client will always use the auto-assigned client id.
+ +
+
|
+ +noexcept | +
The maximum time interval, in seconds, that is permitted to elapse between the point at which the client finishes transmitting one MQTT packet and the point it starts sending the next. The client will use PINGREQ packets to maintain this property.
+If the responding CONNACK contains a keep alive property value, then that is the negotiated keep alive value. Otherwise, the keep alive sent by the client is the negotiated value.
+See MQTT5 Keep Alive
+
+
|
+ +noexcept | +
ConnectPacket::getMaximumPacketSizeToServer()
Notifies the server of the maximum packet size the client is willing to handle. If omitted or null, then no limit beyond the natural limits of MQTT packet size is requested.
+ +
+
|
+ +noexcept | +
Notifies the server of the maximum packet size the client is willing to handle. If omitted or null, then no limit beyond the natural limits of MQTT packet size is requested.
+ +
+
|
+ +noexcept | +
Opaque binary data that the server may use for client authentication and authorization.
+See MQTT5 Password
+
+
|
+ +noexcept | +
Notifies the server of the maximum number of in-flight QoS 1 and 2 messages the client is willing to handle. If omitted or null, then no limit is requested.
+ +
+
|
+ +noexcept | +
If true, requests that the server send additional diagnostic information (via response string or user properties) in DISCONNECT or CONNACK packets from the server.
+See MQTT5 Request Problem Information
+
+
|
+ +noexcept | +
If true, requests that the server send response information in the subsequent CONNACK. This response information may be used to set up request-response implementations over MQTT, but doing so is outside the scope of the MQTT5 spec and client.
+See MQTT5 Request Response Information
+
+
|
+ +noexcept | +
A time interval, in seconds, that the client requests the server to persist this connection's MQTT session state for. Has no meaning if the client has not been configured to rejoin sessions. Must be non-zero in order to successfully rejoin a session.
+If the responding CONNACK contains a session expiry property value, then that is the negotiated session expiry value. Otherwise, the session expiry sent by the client is the negotiated value.
+See MQTT5 Session Expiry Interval
+
+
|
+ +inlineoverridevirtual | +
Implements Aws::Crt::Mqtt5::IPacket.
+ +
+
|
+ +noexcept | +
A string value that the server may use for client authentication and authorization.
+See MQTT5 User Name
+
+
|
+ +noexcept | +
List of MQTT5 user properties included with the packet.
+ +
+
|
+ +noexcept | +
The definition of a message to be published when the connection's session is destroyed by the server or when the will delay interval has elapsed, whichever comes first. If null, then nothing will be sent.
+See MQTT5 Will
+
+
|
+ +noexcept | +
A time interval, in seconds, that the server should wait (for a session reconnection) before sending the will message associated with the connection's session. If omitted or null, the server will send the will when the associated session is destroyed. If the session is destroyed before a will delay interval has elapsed, then the will must be sent at the time of session destruction.
+ +
+
|
+ +noexcept | +
Intended for internal use only. Initializes the C aws_mqtt5_packet_connack_view from PacketConnect
+raw_options | - output parameter containing low level client options to be passed to the C |
allocator | - memory Allocator |
+
|
+ +deletenoexcept | +
+
|
+ +delete | +
+
|
+ +noexcept | +
Sets the unique string identifying the client to the server. Used to restore session state between connections.
+If left empty, the broker will auto-assign a unique client id. When reconnecting, the mqtt5 client will always use the auto-assigned client id.
+ +clientId | A unique string identifying the client to the server. |
+
|
+ +noexcept | +
Sets the maximum time interval, in seconds, that is permitted to elapse between the point at which the client finishes transmitting one MQTT packet and the point it starts sending the next. The client will use PINGREQ packets to maintain this property.
+If the responding CONNACK contains a keep alive property value, then that is the negotiated keep alive value. Otherwise, the keep alive sent by the client is the negotiated value.
+See MQTT5 Keep Alive
+NOTE: The keepAliveIntervalSeconds HAS to be larger than the pingTimeoutMs time set in the Mqtt5ClientOptions.
+keepAliveInteralSeconds | the maximum time interval, in seconds, that is permitted to elapse between the point at which the client finishes transmitting one MQTT packet and the point it starts sending the next. |
+
|
+ +noexcept | +
Sets the maximum packet size the client is willing to handle. If omitted, then no limit beyond the natural limits of MQTT packet size is requested.
+ +maximumPacketSizeBytes | The maximum packet size the client is willing to handle |
+
|
+ +noexcept | +
Sets the opaque binary data that the server may use for client authentication and authorization.
+See MQTT5 Password
+password | Opaque binary data that the server may use for client authentication and authorization. |
+
|
+ +noexcept | +
Sets the maximum number of in-flight QoS 1 and 2 messages the client is willing to handle. If omitted, then no limit is requested.
+ +receiveMaximum | The maximum number of in-flight QoS 1 and 2 messages the client is willing to handle. |
+
|
+ +noexcept | +
Sets whether requests that the server send additional diagnostic information (via response string or user properties) in DISCONNECT or CONNACK packets from the server.
+See MQTT5 Request Problem Information
+requestProblemInformation | If true, requests that the server send additional diagnostic information (via response string or user properties) in DISCONNECT or CONNACK packets from the server. |
+
|
+ +noexcept | +
Sets whether requests that the server send response information in the subsequent CONNACK. This response information may be used to set up request-response implementations over MQTT, but doing so is outside the scope of the MQTT5 spec and client.
+See MQTT5 Request Response Information
+requestResponseInformation | If true, requests that the server send response information in the subsequent CONNACK. |
+
|
+ +noexcept | +
Sets the time interval, in seconds, that the client requests the server to persist this connection's MQTT session state for. Has no meaning if the client has not been configured to rejoin sessions. Must be non-zero in order to successfully rejoin a session.
+If the responding CONNACK contains a session expiry property value, then that is the negotiated session expiry value. Otherwise, the session expiry sent by the client is the negotiated value.
+See MQTT5 Session Expiry Interval
+sessionExpiryIntervalSeconds | A time interval, in seconds, that the client requests the server to persist this connection's MQTT session state for. |
+
|
+ +noexcept | +
Sets the string value that the server may use for client authentication and authorization.
+See MQTT5 User Name
+username | The string value that the server may use for client authentication and authorization. |
+
|
+ +noexcept | +
Sets the list of MQTT5 user properties included with the packet.
+ +userProperties | List of MQTT5 user properties included with the packet. |
+
|
+ +noexcept | +
Sets the list of MQTT5 user properties included with the packet.
+ +userProperties | List of MQTT5 user properties included with the packet. |
+
|
+ +noexcept | +
Put a MQTT5 user property to the back of the packet user property vector/list
+ +property | set of userProperty of MQTT5 user properties included with the packet. |
+
|
+ +noexcept | +
Sets the definition of a message to be published when the connection's session is destroyed by the server or when the will delay interval has elapsed, whichever comes first. If null, then nothing will be sent.
+See MQTT5 Will
+will | The message to be published when the connection's session is destroyed by the server or when the will delay interval has elapsed, whichever comes first. |
+
|
+ +noexcept | +
Sets the time interval, in seconds, that the server should wait (for a session reconnection) before sending the will message associated with the connection's session. If omitted, the server will send the will when the associated session is destroyed. If the session is destroyed before a will delay interval has elapsed, then the will must be sent at the time of session destruction.
+ +willDelayIntervalSeconds | A time interval, in seconds, that the server should wait (for a session reconnection) before sending the will message associated with the connection's session. |
+ aws-crt-cpp
+
+ C++ wrapper around the aws-c-* libraries. Provides Cross-Platform Transport Protocols and SSL/TLS implementations for C++.
+ |
+
This is the complete list of members for Aws::Crt::Mqtt5::DisconnectPacket, including all inherited members.
+
+ aws-crt-cpp
+
+ C++ wrapper around the aws-c-* libraries. Provides Cross-Platform Transport Protocols and SSL/TLS implementations for C++.
+ |
+
#include <Mqtt5Packets.h>
Data model of an MQTT5 DISCONNECT packet.
+
+
|
+ +noexcept | +
+
|
+ +noexcept | +
+
|
+ +virtual | +
+
|
+ +delete | +
+
|
+ +deletenoexcept | +
+
|
+ +noexcept | +
Value indicating the reason that the sender is closing the connection
+See MQTT5 Disconnect Reason Code
+
+
|
+ +noexcept | +
Additional diagnostic information about the reason that the sender is closing the connection
+ +
+
|
+ +noexcept | +
Property indicating an alternate server that the client may temporarily or permanently attempt to connect to instead of the configured endpoint. Will only be set if the reason code indicates another server may be used (ServerMoved, UseAnotherServer).
+ +
+
|
+ +noexcept | +
A change to the session expiry interval negotiated at connection time as part of the disconnect. Only valid for DISCONNECT packets sent from client to server. It is not valid to attempt to change session expiry from zero to a non-zero value.
+See MQTT5 Session Expiry Interval
+
+
|
+ +inlineoverridevirtual | +
Implements Aws::Crt::Mqtt5::IPacket.
+ +
+
|
+ +noexcept | +
List of MQTT5 user properties included with the packet.
+ +
+
|
+ +noexcept | +
+
|
+ +delete | +
+
|
+ +deletenoexcept | +
+
|
+ +noexcept | +
Sets the value indicating the reason that the sender is closing the connection
+See MQTT5 Disconnect Reason Code
+reasonCode | Value indicating the reason that the sender is closing the connection |
+
|
+ +noexcept | +
Sets the additional diagnostic information about the reason that the sender is closing the connection
+ +reasonString | Additional diagnostic information about the reason that the sender is closing the connection |
+
|
+ +noexcept | +
Sets the property indicating an alternate server that the client may temporarily or permanently attempt to connect to instead of the configured endpoint. Will only be set if the reason code indicates another server may be used (ServerMoved, UseAnotherServer).
+ +serverReference | Property indicating an alternate server that the client may temporarily or permanently attempt to connect to instead of the configured endpoint. |
+
|
+ +noexcept | +
Sets the change to the session expiry interval negotiated at connection time as part of the disconnect. Only valid for DISCONNECT packets sent from client to server. It is not valid to attempt to change session expiry from zero to a non-zero value.
+See MQTT5 Session Expiry Interval
+sessionExpiryIntervalSeconds |
+
|
+ +noexcept | +
Sets the list of MQTT5 user properties included with the packet.
+ +userProperties | List of MQTT5 user properties included with the packet. |
+
|
+ +noexcept | +
Sets the list of MQTT5 user properties included with the packet.
+ +userProperties | List of MQTT5 user properties included with the packet. |
+
|
+ +noexcept | +
Put a MQTT5 user property to the back of the packet user property vector/list
+ +property | set of userProperty of MQTT5 user properties included with the packet. |
+ aws-crt-cpp
+
+ C++ wrapper around the aws-c-* libraries. Provides Cross-Platform Transport Protocols and SSL/TLS implementations for C++.
+ |
+
This is the complete list of members for Aws::Crt::Mqtt5::IPacket, including all inherited members.
+getType()=0 | Aws::Crt::Mqtt5::IPacket | pure virtual |
+ aws-crt-cpp
+
+ C++ wrapper around the aws-c-* libraries. Provides Cross-Platform Transport Protocols and SSL/TLS implementations for C++.
+ |
+
#include <Mqtt5Packets.h>
+Public Member Functions | |
virtual PacketType | getType ()=0 |
+
|
+ +pure virtual | +
Implemented in Aws::Crt::Mqtt5::UnSubAckPacket, Aws::Crt::Mqtt5::UnsubscribePacket, Aws::Crt::Mqtt5::SubAckPacket, Aws::Crt::Mqtt5::SubscribePacket, Aws::Crt::Mqtt5::PubAckPacket, Aws::Crt::Mqtt5::DisconnectPacket, Aws::Crt::Mqtt5::ConnAckPacket, Aws::Crt::Mqtt5::ConnectPacket, and Aws::Crt::Mqtt5::PublishPacket.
+ +
+ aws-crt-cpp
+
+ C++ wrapper around the aws-c-* libraries. Provides Cross-Platform Transport Protocols and SSL/TLS implementations for C++.
+ |
+
This is the complete list of members for Aws::Crt::Mqtt5::Mqtt5Client, including all inherited members.
+GetOperationStatistics() noexcept | Aws::Crt::Mqtt5::Mqtt5Client | |
getptr() | Aws::Crt::Mqtt5::Mqtt5Client | inline |
LastError() const noexcept | Aws::Crt::Mqtt5::Mqtt5Client | |
Mqtt::MqttConnection class | Aws::Crt::Mqtt5::Mqtt5Client | friend |
NewMqtt5Client(const Mqtt5ClientOptions &options, Allocator *allocator=ApiAllocator()) noexcept | Aws::Crt::Mqtt5::Mqtt5Client | static |
operator bool() const noexcept | Aws::Crt::Mqtt5::Mqtt5Client | |
Publish(std::shared_ptr< PublishPacket > publishPacket, OnPublishCompletionHandler onPublishCompletionCallback=NULL) noexcept | Aws::Crt::Mqtt5::Mqtt5Client | |
Start() const noexcept | Aws::Crt::Mqtt5::Mqtt5Client | |
Stop() noexcept | Aws::Crt::Mqtt5::Mqtt5Client | |
Stop(std::shared_ptr< DisconnectPacket > disconnectPacket) noexcept | Aws::Crt::Mqtt5::Mqtt5Client | |
Subscribe(std::shared_ptr< SubscribePacket > subscribePacket, OnSubscribeCompletionHandler onSubscribeCompletionCallback=NULL) noexcept | Aws::Crt::Mqtt5::Mqtt5Client | |
Unsubscribe(std::shared_ptr< UnsubscribePacket > unsubscribePacket, OnUnsubscribeCompletionHandler onUnsubscribeCompletionCallback=NULL) noexcept | Aws::Crt::Mqtt5::Mqtt5Client | |
~Mqtt5Client() | Aws::Crt::Mqtt5::Mqtt5Client | virtual |
+ aws-crt-cpp
+
+ C++ wrapper around the aws-c-* libraries. Provides Cross-Platform Transport Protocols and SSL/TLS implementations for C++.
+ |
+
#include <Mqtt5Client.h>
+Public Member Functions | |
std::shared_ptr< Mqtt5Client > | getptr () |
operator bool () const noexcept | |
int | LastError () const noexcept |
bool | Start () const noexcept |
bool | Stop () noexcept |
bool | Stop (std::shared_ptr< DisconnectPacket > disconnectPacket) noexcept |
bool | Publish (std::shared_ptr< PublishPacket > publishPacket, OnPublishCompletionHandler onPublishCompletionCallback=NULL) noexcept |
bool | Subscribe (std::shared_ptr< SubscribePacket > subscribePacket, OnSubscribeCompletionHandler onSubscribeCompletionCallback=NULL) noexcept |
bool | Unsubscribe (std::shared_ptr< UnsubscribePacket > unsubscribePacket, OnUnsubscribeCompletionHandler onUnsubscribeCompletionCallback=NULL) noexcept |
const Mqtt5ClientOperationStatistics & | GetOperationStatistics () noexcept |
virtual | ~Mqtt5Client () |
+Static Public Member Functions | |
static std::shared_ptr< Mqtt5Client > | NewMqtt5Client (const Mqtt5ClientOptions &options, Allocator *allocator=ApiAllocator()) noexcept |
+Friends | |
class | Mqtt::MqttConnection |
An MQTT5 client. This is a move-only type. Unless otherwise specified, all function arguments need only to live through the duration of the function call.
+
+
|
+ +virtual | +
+
|
+ +noexcept | +
Get the statistics about the current state of the client's queue of operations
+ + +
+
|
+ +inline | +
Get shared poitner of the Mqtt5Client. Mqtt5Client is inherited to enable_shared_from_this to help with memory safety.
+
+
|
+ +noexcept | +
+
|
+ +staticnoexcept | +
Factory function for mqtt5 client
+options | Mqtt5 Client Options |
allocator | allocator to use |
+
|
+ +noexcept | +
+
|
+ +noexcept | +
Tells the client to attempt to send a PUBLISH packet
+publishPacket | packet PUBLISH to send to the server |
onPublishCompletionCallback | callback on publish complete, default to NULL |
+
|
+ +noexcept | +
Notifies the MQTT5 client that you want it to attempt to connect to the configured endpoint. The client will attempt to stay connected using the properties of the reconnect-related parameters from the client configuration.
+
+
|
+ +noexcept | +
Notifies the MQTT5 client that you want it to transition to the stopped state, disconnecting any existing connection and stopping subsequent reconnect attempts.
+
+
|
+ +noexcept | +
Notifies the MQTT5 client that you want it to transition to the stopped state, disconnecting any existing connection and stopping subsequent reconnect attempts.
+disconnectPacket | (optional) properties of a DISCONNECT packet to send as part of the shutdown process |
+
|
+ +noexcept | +
Tells the client to attempt to subscribe to one or more topic filters.
+subscribePacket | SUBSCRIBE packet to send to the server |
onSubscribeCompletionCallback | callback on subscribe complete, default to NULL |
+
|
+ +noexcept | +
Tells the client to attempt to unsubscribe to one or more topic filters.
+unsubscribePacket | UNSUBSCRIBE packet to send to the server |
onUnsubscribeCompletionCallback | callback on unsubscribe complete, default to NULL |
+
|
+ +friend | +
+ aws-crt-cpp
+
+ C++ wrapper around the aws-c-* libraries. Provides Cross-Platform Transport Protocols and SSL/TLS implementations for C++.
+ |
+
This is the complete list of members for Aws::Crt::Mqtt5::Mqtt5ClientOptions, including all inherited members.
+
+ aws-crt-cpp
+
+ C++ wrapper around the aws-c-* libraries. Provides Cross-Platform Transport Protocols and SSL/TLS implementations for C++.
+ |
+
#include <Mqtt5Client.h>
+Friends | |
class | Mqtt5ClientCore |
class | Mqtt5to3AdapterOptions |
Configuration interface for mqtt5 clients
+
+
|
+ +noexcept | +
Default constructior of Mqtt5ClientOptions
+ + +
+
|
+ +virtual | +
+
|
+ +delete | +
+
|
+ +delete | +
+
|
+ +noexcept | +
Initializes the C aws_mqtt5_client_options from Mqtt5ClientOptions. For internal use
+raw_options | - output parameter containing low level client options to be passed to the C interface |
+
|
+ +delete | +
+
|
+ +delete | +
+
|
+ +noexcept | +
Sets Operation Timeout(Seconds). Time interval to wait for an ack after sending a QoS 1+ PUBLISH, SUBSCRIBE, or UNSUBSCRIBE before failing the operation.
+ackTimeoutSec |
+
|
+ +noexcept | +
Mqtt5ClientOptions::WithAckTimeoutSec(uint32_t)
Sets Operation Timeout(Seconds). Time interval to wait for an ack after sending a QoS 1+ PUBLISH, SUBSCRIBE, or UNSUBSCRIBE before failing the operation.
+ackTimeoutSec |
+
|
+ +noexcept | +
Set booststrap for mqtt5 client
+bootStrap | bootstrap used for mqtt5 client. The default ClientBootstrap see Aws::Crt::ApiHandle::GetOrCreateStaticDefaultClientBootstrap. |
+
|
+ +noexcept | +
Sets callback trigged when client begins an attempt to connect to the remote endpoint.
+callback |
+
|
+ +noexcept | +
Sets callback trigged when client fails to establish an MQTT connection
+callback |
+
|
+ +noexcept | +
Sets callback trigged when client successfully establishes an MQTT connection
+callback |
+
|
+ +noexcept | +
Sets callback trigged when client's current MQTT connection is closed
+callback |
+
|
+ +noexcept | +
Sets client extended validation and flow control, additional controls for client behavior with respect to operation validation and flow control; these checks go beyond the base MQTT5 spec to respect limits of specific MQTT brokers.
+clientExtendedValidationAndFlowControl |
+
|
+ +noexcept | +
Sets callback trigged when client reaches the "Stopped" state
+callback |
+
|
+ +noexcept | +
Sets Connack Timeout (ms). Time interval to wait after sending a CONNECT request for a CONNACK to arrive. If one does not arrive, the connection will be shut down.
+connackTimeoutMs |
+
|
+ +noexcept | +
Sets mqtt5 connection options
+connectPacket | package connection options |
Mqtt5ClientOptions & Aws::Crt::Mqtt5::Mqtt5ClientOptions::WithHostName | +( | +Crt::String | +hostname | ) | ++ |
Sets host to connect to.
+hostname | endpoint to connect to |
+
|
+ +noexcept | +
Sets http proxy options.
+proxyOptions | http proxy configuration for connection establishment |
+
|
+ +noexcept | +
Sets OfflineQueueBehavior, controls how disconnects affect the queued and in-progress operations tracked by the client. Also controls how new operations are handled while the client is not connected. In particular, if the client is not connected, then any operation that would be failed on disconnect (according to these rules) will also be rejected.
+offlineQueueBehavior |
+
|
+ +noexcept | +
Sets ping timeout (ms). Time interval to wait after sending a PINGREQ for a PINGRESP to arrive. If one does not arrive, the client will close the current connection.
+pingTimeoutMs |
+
|
+ +noexcept | +
Set port to connect to
+port | port to connect to |
+
|
+ +noexcept | +
Sets callback trigged when a PUBLISH packet is received by the client
+callback |
+
|
+ +noexcept | +
Sets ReconnectOptions. Reconnect options, includes retryJitterMode, min reconnect delay time and max reconnect delay time and reset reconnect delay time
+reconnectOptions |
+
|
+ +noexcept | +
Sets session behavior. Overrides how the MQTT5 client should behave with respect to MQTT sessions.
+sessionBehavior |
+
|
+ +noexcept | +
Sets the aws socket options
+socketOptions | Io::SocketOptions used to setup socket |
+
|
+ +noexcept | +
Sets the tls connection options
+tslOptions | Io::TlsConnectionOptions |
+
|
+ +noexcept | +
Sets the topic aliasing behavior for the client.
+topicAliasingOptions | topic aliasing behavior options to use |
+
|
+ +noexcept | +
Sets callback for transform HTTP request. This callback allows a custom transformation of the HTTP request that acts as the websocket handshake. Websockets will be used if this is set to a valid transformation callback. To use websockets but not perform a transformation, just set this as a trivial completion callback. If undefined, the connection will be made with direct MQTT.
+callback |
+
|
+ +friend | +
+
|
+ +friend | +
+ aws-crt-cpp
+
+ C++ wrapper around the aws-c-* libraries. Provides Cross-Platform Transport Protocols and SSL/TLS implementations for C++.
+ |
+
This is the complete list of members for Aws::Crt::Mqtt5::NegotiatedSettings, including all inherited members.
+
+ aws-crt-cpp
+
+ C++ wrapper around the aws-c-* libraries. Provides Cross-Platform Transport Protocols and SSL/TLS implementations for C++.
+ |
+
#include <Mqtt5Packets.h>
+Public Member Functions | |
NegotiatedSettings (const aws_mqtt5_negotiated_settings &negotiated_settings, Allocator *allocator=ApiAllocator()) noexcept | |
Mqtt5::QOS | getMaximumQOS () const noexcept |
uint32_t | getSessionExpiryIntervalSec () const noexcept |
uint16_t | getReceiveMaximumFromServer () const noexcept |
uint32_t | getMaximumPacketSizeBytes () const noexcept |
uint32_t | getMaximumPacketSizeToServer () const noexcept |
uint16_t | getTopicAliasMaximumToServer () const noexcept |
uint16_t | getTopicAliasMaximumToClient () const noexcept |
uint16_t | getServerKeepAliveSec () const noexcept |
uint16_t | getServerKeepAlive () const noexcept |
bool | getRetainAvailable () const noexcept |
bool | getWildcardSubscriptionsAvailable () const noexcept |
bool | getSubscriptionIdentifiersAvailable () const noexcept |
bool | getSharedSubscriptionsAvailable () const noexcept |
bool | getRejoinedSession () const noexcept |
const Crt::String & | getClientId () const noexcept |
virtual | ~NegotiatedSettings () |
NegotiatedSettings (const NegotiatedSettings &)=delete | |
NegotiatedSettings (NegotiatedSettings &&) noexcept=delete | |
NegotiatedSettings & | operator= (const NegotiatedSettings &)=delete |
NegotiatedSettings & | operator= (NegotiatedSettings &&) noexcept=delete |
Mqtt behavior settings that are dynamically negotiated as part of the CONNECT/CONNACK exchange.
+While you can infer all of these values from a combination of (1) defaults as specified in the mqtt5 spec (2) your CONNECT settings (3) the CONNACK from the broker
+the client instead does the combining for you and emits a NegotiatedSettings object with final, authoritative values.
+Negotiated settings are communicated with every successful connection establishment.
+
+
|
+ +noexcept | +
+
|
+ +inlinevirtual | +
+
|
+ +delete | +
+
|
+ +deletenoexcept | +
+
|
+ +noexcept | +
The final client id in use by the newly-established connection. This will be the configured client id if one was given in the configuration, otherwise, if no client id was specified, this will be the client id assigned by the server. Reconnection attempts will always use the auto-assigned client id, allowing for auto-assigned session resumption.
+
+
|
+ +noexcept | +
NegotiatedSettings::getMaximumPacketSizeToServer()
+
|
+ +noexcept | +
+
|
+ +noexcept | +
+
|
+ +noexcept | +
+
|
+ +noexcept | +
+
|
+ +noexcept | +
+
|
+ +noexcept | +
NegotiatedSettings::getServerKeepAliveSec()
The maximum amount of time in seconds between client packets. The client should use PINGREQs to ensure this limit is not breached. The server will disconnect the client for inactivity if no MQTT packet is received in a time interval equal to 1.5 x this value.
+
+
|
+ +noexcept | +
The maximum amount of time in seconds between client packets. The client should use PINGREQs to ensure this limit is not breached. The server will disconnect the client for inactivity if no MQTT packet is received in a time interval equal to 1.5 x this value.
+
+
|
+ +noexcept | +
+
|
+ +noexcept | +
+
|
+ +noexcept | +
+
|
+ +noexcept | +
+
|
+ +noexcept | +
+
|
+ +noexcept | +
+
|
+ +delete | +
+
|
+ +deletenoexcept | +
+ aws-crt-cpp
+
+ C++ wrapper around the aws-c-* libraries. Provides Cross-Platform Transport Protocols and SSL/TLS implementations for C++.
+ |
+
This is the complete list of members for Aws::Crt::Mqtt5::PubAckPacket, including all inherited members.
+getReasonCode() const noexcept | Aws::Crt::Mqtt5::PubAckPacket | |
getReasonString() const noexcept | Aws::Crt::Mqtt5::PubAckPacket | |
getType() override | Aws::Crt::Mqtt5::PubAckPacket | inlinevirtual |
getUserProperties() const noexcept | Aws::Crt::Mqtt5::PubAckPacket | |
operator=(const PubAckPacket &toCopy) noexcept=delete | Aws::Crt::Mqtt5::PubAckPacket | |
operator=(PubAckPacket &&toMove) noexcept=delete | Aws::Crt::Mqtt5::PubAckPacket | |
PubAckPacket(const aws_mqtt5_packet_puback_view &packet, Allocator *allocator=ApiAllocator()) noexcept | Aws::Crt::Mqtt5::PubAckPacket | |
PubAckPacket(const PubAckPacket &toCopy) noexcept=delete | Aws::Crt::Mqtt5::PubAckPacket | |
PubAckPacket(PubAckPacket &&toMove) noexcept=delete | Aws::Crt::Mqtt5::PubAckPacket | |
~PubAckPacket() | Aws::Crt::Mqtt5::PubAckPacket | inlinevirtual |
+ aws-crt-cpp
+
+ C++ wrapper around the aws-c-* libraries. Provides Cross-Platform Transport Protocols and SSL/TLS implementations for C++.
+ |
+
#include <Mqtt5Packets.h>
+Public Member Functions | |
PubAckPacket (const aws_mqtt5_packet_puback_view &packet, Allocator *allocator=ApiAllocator()) noexcept | |
PacketType | getType () override |
PubAckReasonCode | getReasonCode () const noexcept |
const Crt::Optional< Crt::String > & | getReasonString () const noexcept |
const Crt::Vector< UserProperty > & | getUserProperties () const noexcept |
virtual | ~PubAckPacket () |
PubAckPacket (const PubAckPacket &toCopy) noexcept=delete | |
PubAckPacket (PubAckPacket &&toMove) noexcept=delete | |
PubAckPacket & | operator= (const PubAckPacket &toCopy) noexcept=delete |
PubAckPacket & | operator= (PubAckPacket &&toMove) noexcept=delete |
Data model of an MQTT5 PUBACK packet
+
+
|
+ +noexcept | +
+
|
+ +inlinevirtual | +
+
|
+ +deletenoexcept | +
+
|
+ +deletenoexcept | +
+
|
+ +noexcept | +
Success indicator or failure reason for the associated PUBLISH packet.
+ +
+
|
+ +noexcept | +
Additional diagnostic information about the result of the PUBLISH attempt.
+ +
+
|
+ +inlineoverridevirtual | +
Implements Aws::Crt::Mqtt5::IPacket.
+ +
+
|
+ +noexcept | +
List of MQTT5 user properties included with the packet.
+ +
+
|
+ +deletenoexcept | +
+
|
+ +deletenoexcept | +
+ aws-crt-cpp
+
+ C++ wrapper around the aws-c-* libraries. Provides Cross-Platform Transport Protocols and SSL/TLS implementations for C++.
+ |
+
This is the complete list of members for Aws::Crt::Mqtt5::PublishPacket, including all inherited members.
+
+ aws-crt-cpp
+
+ C++ wrapper around the aws-c-* libraries. Provides Cross-Platform Transport Protocols and SSL/TLS implementations for C++.
+ |
+
#include <Mqtt5Packets.h>
+Public Member Functions | |
PublishPacket (const aws_mqtt5_packet_publish_view &raw_options, Allocator *allocator=ApiAllocator()) noexcept | |
PublishPacket (Allocator *allocator=ApiAllocator()) noexcept | |
PublishPacket (Crt::String topic, ByteCursor payload, Mqtt5::QOS qos, Allocator *allocator=ApiAllocator()) noexcept | |
PacketType | getType () override |
PublishPacket & | WithPayload (ByteCursor payload) noexcept |
PublishPacket & | WithQOS (Mqtt5::QOS packetQOS) noexcept |
PublishPacket & | WithRetain (bool retain) noexcept |
PublishPacket & | WithTopic (Crt::String topic) noexcept |
PublishPacket & | WithPayloadFormatIndicator (PayloadFormatIndicator payloadFormat) noexcept |
PublishPacket & | WithMessageExpiryIntervalSec (uint32_t second) noexcept |
PublishPacket & | WithTopicAlias (uint16_t topicAlias) noexcept |
PublishPacket & | WithResponseTopic (ByteCursor responseTopic) noexcept |
PublishPacket & | WithCorrelationData (ByteCursor correlationData) noexcept |
PublishPacket & | WithUserProperties (const Vector< UserProperty > &userProperties) noexcept |
PublishPacket & | WithUserProperties (Vector< UserProperty > &&userProperties) noexcept |
PublishPacket & | WithUserProperty (UserProperty &&property) noexcept |
bool | initializeRawOptions (aws_mqtt5_packet_publish_view &raw_options) noexcept |
const ByteCursor & | getPayload () const noexcept |
Mqtt5::QOS | getQOS () const noexcept |
bool | getRetain () const noexcept |
const Crt::String & | getTopic () const noexcept |
const Crt::Optional< PayloadFormatIndicator > & | getPayloadFormatIndicator () const noexcept |
const Crt::Optional< uint32_t > & | getMessageExpiryIntervalSec () const noexcept |
const Crt::Optional< uint16_t > & | getTopicAlias () const noexcept |
const Crt::Optional< ByteCursor > & | getResponseTopic () const noexcept |
const Crt::Optional< ByteCursor > & | getCorrelationData () const noexcept |
const Crt::Vector< uint32_t > & | getSubscriptionIdentifiers () const noexcept |
const Crt::Optional< ByteCursor > & | getContentType () const noexcept |
const Crt::Vector< UserProperty > & | getUserProperties () const noexcept |
virtual | ~PublishPacket () |
PublishPacket (const PublishPacket &)=delete | |
PublishPacket (PublishPacket &&) noexcept=delete | |
PublishPacket & | operator= (const PublishPacket &)=delete |
PublishPacket & | operator= (PublishPacket &&) noexcept=delete |
Data model of an MQTT5 PUBLISH packet
+
+
|
+ +noexcept | +
+
|
+ +noexcept | +
+
|
+ +noexcept | +
+
|
+ +virtual | +
+
|
+ +delete | +
+
|
+ +deletenoexcept | +
+
|
+ +noexcept | +
Property specifying the content type of the payload. Not internally meaningful to MQTT5.
+ +
+
|
+ +noexcept | +
Opaque binary data used to correlate between publish messages, as a potential method for request-response implementation. Not internally meaningful to MQTT5.
+ +
+
|
+ +noexcept | +
Sent publishes - indicates the maximum amount of time allowed to elapse for message delivery before the server should instead delete the message (relative to a recipient).
+Received publishes - indicates the remaining amount of time (from the server's perspective) before the message would have been deleted relative to the subscribing client.
+If left null, indicates no expiration timeout.
+See MQTT5 Message Expiry Interval
+
+
|
+ +noexcept | +
The payload of the publish message.
+ +
+
|
+ +noexcept | +
Property specifying the format of the payload data. The mqtt5 client does not enforce or use this value in a meaningful way.
+See MQTT5 Payload Format Indicator
+
+
|
+ +noexcept | +
Sent publishes - The MQTT quality of service level this message should be delivered with.
+Received publishes - The MQTT quality of service level this message was delivered at.
+See MQTT5 QoS
+
+
|
+ +noexcept | +
Opaque topic string intended to assist with request/response implementations. Not internally meaningful to MQTT5 or this client.
+ +
+
|
+ +noexcept | +
True if this is a retained message, false otherwise.
+Always set on received publishes.
+See MQTT5 Retain
+
+
|
+ +noexcept | +
Sent publishes - ignored
+Received publishes - the subscription identifiers of all the subscriptions this message matched.
+See MQTT5 Subscription Identifier
+
+
|
+ +noexcept | +
Sent publishes - The topic this message should be published to.
+Received publishes - The topic this message was published to.
+See MQTT5 Topic Name
+
|
+ +noexcept | +
Sent publishes - Topic alias to use, if possible, when encoding this packet. Only used if the client's outbound topic aliasing mode is set to Manual.
+Received publishes - topic alias used by the server when transmitting the publish to the client.
+ +
+
|
+ +inlineoverridevirtual | +
Implements Aws::Crt::Mqtt5::IPacket.
+ +
+
|
+ +noexcept | +
List of MQTT5 user properties included with the packet.
+ +
+
|
+ +noexcept | +
+
|
+ +delete | +
+
|
+ +deletenoexcept | +
+
|
+ +noexcept | +
Sets the opaque binary data used to correlate between publish messages, as a potential method for request-response implementation. Not internally meaningful to MQTT5.
+ +correlationData | Opaque binary data used to correlate between publish messages |
+
|
+ +noexcept | +
Sets the maximum amount of time allowed to elapse for message delivery before the server should instead delete the message (relative to a recipient).
+See MQTT5 Message Expiry Interval
+second | The maximum amount of time allowed to elapse for message delivery before the server should instead delete the message (relative to a recipient). |
+
|
+ +noexcept | +
Sets the payload for the publish message.
+ +payload | The payload for the publish message. |
+
|
+ +noexcept | +
Sets the property specifying the format of the payload data. The mqtt5 client does not enforce or use this value in a meaningful way.
+See MQTT5 Payload Format Indicator
+payloadFormat | Property specifying the format of the payload data |
+
|
+ +noexcept | +
Sets the MQTT quality of service level the message should be delivered with.
+See MQTT5 QoS
+packetQOS | The MQTT quality of service level the message should be delivered with. |
+
|
+ +noexcept | +
Sets the opaque topic string intended to assist with request/response implementations. Not internally meaningful to MQTT5 or this client.
+responseTopic |
+
|
+ +noexcept | +
Sets if this should be a retained message.
+See MQTT5 Retain
+retain | if this is a retained message. |
+
|
+ +noexcept | +
Sets the topic this message should be published to. See MQTT5 Topic Name
+topic | The topic this message should be published to. |
+
|
+ +noexcept | +
Sets the opic alias to use, if possible, when encoding this packet. Only used if the client's outbound topic aliasing mode is set to Manual.
+ + +
+
|
+ +noexcept | +
Sets the list of MQTT5 user properties included with the packet.
+ +userProperties | List of MQTT5 user properties included with the packet. |
+
|
+ +noexcept | +
Sets the list of MQTT5 user properties included with the packet.
+ +userProperties | List of MQTT5 user properties included with the packet. |
+
|
+ +noexcept | +
Put a MQTT5 user property to the back of the packet user property vector/list
+ +property | set of userProperty of MQTT5 user properties included with the packet. |
+ aws-crt-cpp
+
+ C++ wrapper around the aws-c-* libraries. Provides Cross-Platform Transport Protocols and SSL/TLS implementations for C++.
+ |
+
This is the complete list of members for Aws::Crt::Mqtt5::PublishResult, including all inherited members.
+getAck() const | Aws::Crt::Mqtt5::PublishResult | inline |
getErrorCode() const | Aws::Crt::Mqtt5::PublishResult | inline |
operator=(const PublishResult &toCopy) noexcept=delete | Aws::Crt::Mqtt5::PublishResult | |
operator=(PublishResult &&toMove) noexcept=delete | Aws::Crt::Mqtt5::PublishResult | |
PublishResult() | Aws::Crt::Mqtt5::PublishResult | |
PublishResult(std::shared_ptr< PubAckPacket > puback) | Aws::Crt::Mqtt5::PublishResult | |
PublishResult(int errorCode) | Aws::Crt::Mqtt5::PublishResult | |
PublishResult(const PublishResult &toCopy) noexcept=delete | Aws::Crt::Mqtt5::PublishResult | |
PublishResult(PublishResult &&toMove) noexcept=delete | Aws::Crt::Mqtt5::PublishResult | |
wasSuccessful() const | Aws::Crt::Mqtt5::PublishResult | inline |
~PublishResult() noexcept | Aws::Crt::Mqtt5::PublishResult |
+ aws-crt-cpp
+
+ C++ wrapper around the aws-c-* libraries. Provides Cross-Platform Transport Protocols and SSL/TLS implementations for C++.
+ |
+
#include <Mqtt5Packets.h>
+Public Member Functions | |
PublishResult () | |
PublishResult (std::shared_ptr< PubAckPacket > puback) | |
PublishResult (int errorCode) | |
bool | wasSuccessful () const |
int | getErrorCode () const |
std::shared_ptr< IPacket > | getAck () const |
~PublishResult () noexcept | |
PublishResult (const PublishResult &toCopy) noexcept=delete | |
PublishResult (PublishResult &&toMove) noexcept=delete | |
PublishResult & | operator= (const PublishResult &toCopy) noexcept=delete |
PublishResult & | operator= (PublishResult &&toMove) noexcept=delete |
PublishResult returned with onPublishCompletionCallback after Publish get called
+Publish with QoS0: Ack will be nullptr QoS1: Ack will contains a PubAckPacket
+Aws::Crt::Mqtt5::PublishResult::PublishResult | +( | +) | ++ |
Aws::Crt::Mqtt5::PublishResult::PublishResult | +( | +std::shared_ptr< PubAckPacket > | +puback | ) | ++ |
Aws::Crt::Mqtt5::PublishResult::PublishResult | +( | +int | +errorCode | ) | ++ |
+
|
+ +noexcept | +
+
|
+ +deletenoexcept | +
+
|
+ +deletenoexcept | +
+
|
+ +inline | +
Get Publish ack packet
+
+
|
+ +inline | +
Get the error code value
+
+
|
+ +deletenoexcept | +
+
|
+ +deletenoexcept | +
+
|
+ +inline | +
Get if the publish succeed or not
+
+ aws-crt-cpp
+
+ C++ wrapper around the aws-c-* libraries. Provides Cross-Platform Transport Protocols and SSL/TLS implementations for C++.
+ |
+
This is the complete list of members for Aws::Crt::Mqtt5::SubAckPacket, including all inherited members.
+getReasonCodes() const noexcept | Aws::Crt::Mqtt5::SubAckPacket | |
getReasonString() const noexcept | Aws::Crt::Mqtt5::SubAckPacket | |
getType() override | Aws::Crt::Mqtt5::SubAckPacket | inlinevirtual |
getUserProperties() const noexcept | Aws::Crt::Mqtt5::SubAckPacket | |
operator=(const SubAckPacket &) noexcept=delete | Aws::Crt::Mqtt5::SubAckPacket | |
operator=(SubAckPacket &&) noexcept=delete | Aws::Crt::Mqtt5::SubAckPacket | |
SubAckPacket(const aws_mqtt5_packet_suback_view &packet, Allocator *allocator=ApiAllocator()) noexcept | Aws::Crt::Mqtt5::SubAckPacket | |
SubAckPacket(const SubAckPacket &) noexcept=delete | Aws::Crt::Mqtt5::SubAckPacket | |
SubAckPacket(SubAckPacket &&) noexcept=delete | Aws::Crt::Mqtt5::SubAckPacket | |
~SubAckPacket() | Aws::Crt::Mqtt5::SubAckPacket | inlinevirtual |
+ aws-crt-cpp
+
+ C++ wrapper around the aws-c-* libraries. Provides Cross-Platform Transport Protocols and SSL/TLS implementations for C++.
+ |
+
#include <Mqtt5Packets.h>
+Public Member Functions | |
SubAckPacket (const aws_mqtt5_packet_suback_view &packet, Allocator *allocator=ApiAllocator()) noexcept | |
PacketType | getType () override |
const Crt::Optional< Crt::String > & | getReasonString () const noexcept |
const Crt::Vector< UserProperty > & | getUserProperties () const noexcept |
const Crt::Vector< SubAckReasonCode > & | getReasonCodes () const noexcept |
virtual | ~SubAckPacket () |
SubAckPacket (const SubAckPacket &) noexcept=delete | |
SubAckPacket (SubAckPacket &&) noexcept=delete | |
SubAckPacket & | operator= (const SubAckPacket &) noexcept=delete |
SubAckPacket & | operator= (SubAckPacket &&) noexcept=delete |
Data model of an MQTT5 SUBACK packet.
+
+
|
+ +noexcept | +
+
|
+ +inlinevirtual | +
+
|
+ +deletenoexcept | +
+
|
+ +deletenoexcept | +
+
|
+ +noexcept | +
Returns list of reason codes indicating the result of each individual subscription entry in the associated SUBSCRIBE packet.
+ +
+
|
+ +noexcept | +
Returns additional diagnostic information about the result of the SUBSCRIBE attempt.
+ +
+
|
+ +inlineoverridevirtual | +
Implements Aws::Crt::Mqtt5::IPacket.
+ +
+
|
+ +noexcept | +
Returns list of MQTT5 user properties included with the packet.
+ +
+
|
+ +deletenoexcept | +
+
|
+ +deletenoexcept | +
+ aws-crt-cpp
+
+ C++ wrapper around the aws-c-* libraries. Provides Cross-Platform Transport Protocols and SSL/TLS implementations for C++.
+ |
+
This is the complete list of members for Aws::Crt::Mqtt5::SubscribePacket, including all inherited members.
+
+ aws-crt-cpp
+
+ C++ wrapper around the aws-c-* libraries. Provides Cross-Platform Transport Protocols and SSL/TLS implementations for C++.
+ |
+
#include <Mqtt5Packets.h>
Data model of an MQTT5 SUBSCRIBE packet.
+
+
|
+ +noexcept | +
+
|
+ +virtual | +
+
|
+ +deletenoexcept | +
+
|
+ +deletenoexcept | +
+
|
+ +inlineoverridevirtual | +
Implements Aws::Crt::Mqtt5::IPacket.
+ +
+
|
+ +noexcept | +
+
|
+ +deletenoexcept | +
+
|
+ +deletenoexcept | +
+
|
+ +noexcept | +
Sets a single subscription within the SUBSCRIBE packet.
+subscription | The subscription to add within the SUBSCRIBE packet. |
+
|
+ +noexcept | +
Sets the value to associate with all subscriptions in this request. Publish packets that match a subscription in this request should include this identifier in the resulting message.
+See MQTT5 Subscription Identifier
+subscriptionIdentifier | A positive long to associate with all subscriptions in this request. |
+
|
+ +noexcept | +
Sets a list of subscriptions within the SUBSCRIBE packet.
+subscriptions | vector of subscriptions to add within the SUBSCRIBE packet. |
+
|
+ +noexcept | +
Sets a list of subscriptions within the SUBSCRIBE packet.
+subscriptions | vector of subscriptions to add within the SUBSCRIBE packet. |
+
|
+ +noexcept | +
Sets the list of MQTT5 user properties included with the packet.
+ +userProperties | List of MQTT5 user properties included with the packet. |
+
|
+ +noexcept | +
Sets the list of MQTT5 user properties included with the packet.
+ +userProperties | List of MQTT5 user properties included with the packet. |
+
|
+ +noexcept | +
Put a MQTT5 user property to the back of the packet user property vector/list
+ +property | userProperty of MQTT5 user properties included with the packet. |
+ aws-crt-cpp
+
+ C++ wrapper around the aws-c-* libraries. Provides Cross-Platform Transport Protocols and SSL/TLS implementations for C++.
+ |
+
This is the complete list of members for Aws::Crt::Mqtt5::Subscription, including all inherited members.
+
+ aws-crt-cpp
+
+ C++ wrapper around the aws-c-* libraries. Provides Cross-Platform Transport Protocols and SSL/TLS implementations for C++.
+ |
+
#include <Mqtt5Packets.h>
+Public Member Functions | |
Subscription (Allocator *allocator=ApiAllocator()) | |
Subscription (Crt::String topicFilter, Mqtt5::QOS qos, Allocator *allocator=ApiAllocator()) | |
Subscription & | WithTopicFilter (Crt::String topicFilter) noexcept |
Subscription & | WithQOS (Mqtt5::QOS QOS) noexcept |
Subscription & | WithNoLocal (bool noLocal) noexcept |
Subscription & | WithRetainAsPublished (bool retain) noexcept |
Subscription & | WithRetain (bool retain) noexcept |
Subscription & | WithRetainHandlingType (RetainHandlingType retainHandlingType) noexcept |
bool | initializeRawOptions (aws_mqtt5_subscription_view &raw_options) const noexcept |
virtual | ~Subscription () |
Subscription (const Subscription &) noexcept | |
Subscription (Subscription &&) noexcept | |
Subscription & | operator= (const Subscription &) noexcept |
Subscription & | operator= (Subscription &&) noexcept |
Configures a single subscription within a Subscribe operation
+ +Aws::Crt::Mqtt5::Subscription::Subscription | +( | +Allocator * | +allocator = ApiAllocator() | ) | ++ |
Aws::Crt::Mqtt5::Subscription::Subscription | +( | +Crt::String | +topicFilter, | +
+ | + | Mqtt5::QOS | +qos, | +
+ | + | Allocator * | +allocator = ApiAllocator() |
+
+ | ) | ++ |
+
|
+ +inlinevirtual | +
+
|
+ +noexcept | +
+
|
+ +noexcept | +
+
|
+ +noexcept | +
+
|
+ +noexcept | +
+
|
+ +noexcept | +
+
|
+ +noexcept | +
Sets should the server not send publishes to a client when that client was the one who sent the publish? The value will be default to false.
+See MQTT5 Subscription Options
+noLocal | bool |
+
|
+ +noexcept | +
Sets Maximum QoS on which the subscriber will accept publish messages. Negotiated QoS may be different.
+See MQTT5 Subscription Options
+QOS |
+
|
+ +noexcept | +
Subscription::WithRetainAsPublished(bool)
.Sets should the server not send publishes to a client when that client was the one who sent the publish? The value will be default to false.
+See MQTT5 Subscription Options
+retain | bool |
+
|
+ +noexcept | +
Sets should the server not send publishes to a client when that client was the one who sent the publish? The value will be default to false.
+See MQTT5 Subscription Options
+retain | bool |
+
|
+ +noexcept | +
Sets should messages sent due to this subscription keep the retain flag preserved on the message? The value will be default to false.
+See MQTT5 Subscription Options
+retainHandlingType |
+
|
+ +noexcept | +
Sets topic filter to subscribe to
+See MQTT5 Subscription Options
+topicFilter | string |
+ aws-crt-cpp
+
+ C++ wrapper around the aws-c-* libraries. Provides Cross-Platform Transport Protocols and SSL/TLS implementations for C++.
+ |
+
This is the complete list of members for Aws::Crt::Mqtt5::UnSubAckPacket, including all inherited members.
+getReasonCodes() const noexcept | Aws::Crt::Mqtt5::UnSubAckPacket | |
getReasonString() const noexcept | Aws::Crt::Mqtt5::UnSubAckPacket | |
getType() override | Aws::Crt::Mqtt5::UnSubAckPacket | inlinevirtual |
getUserProperties() const noexcept | Aws::Crt::Mqtt5::UnSubAckPacket | |
operator=(const UnSubAckPacket &) noexcept=delete | Aws::Crt::Mqtt5::UnSubAckPacket | |
operator=(UnSubAckPacket &&) noexcept=delete | Aws::Crt::Mqtt5::UnSubAckPacket | |
UnSubAckPacket(const aws_mqtt5_packet_unsuback_view &packet, Allocator *allocator=ApiAllocator()) noexcept | Aws::Crt::Mqtt5::UnSubAckPacket | |
UnSubAckPacket(const UnSubAckPacket &) noexcept=delete | Aws::Crt::Mqtt5::UnSubAckPacket | |
UnSubAckPacket(UnSubAckPacket &&) noexcept=delete | Aws::Crt::Mqtt5::UnSubAckPacket | |
~UnSubAckPacket() | Aws::Crt::Mqtt5::UnSubAckPacket | inlinevirtual |
+ aws-crt-cpp
+
+ C++ wrapper around the aws-c-* libraries. Provides Cross-Platform Transport Protocols and SSL/TLS implementations for C++.
+ |
+
#include <Mqtt5Packets.h>
+Public Member Functions | |
UnSubAckPacket (const aws_mqtt5_packet_unsuback_view &packet, Allocator *allocator=ApiAllocator()) noexcept | |
PacketType | getType () override |
const Crt::Optional< Crt::String > & | getReasonString () const noexcept |
const Crt::Vector< UserProperty > & | getUserProperties () const noexcept |
const Crt::Vector< UnSubAckReasonCode > & | getReasonCodes () const noexcept |
virtual | ~UnSubAckPacket () |
UnSubAckPacket (const UnSubAckPacket &) noexcept=delete | |
UnSubAckPacket (UnSubAckPacket &&) noexcept=delete | |
UnSubAckPacket & | operator= (const UnSubAckPacket &) noexcept=delete |
UnSubAckPacket & | operator= (UnSubAckPacket &&) noexcept=delete |
Data model of an MQTT5 UNSUBACK packet.
+
+
|
+ +noexcept | +
+
|
+ +inlinevirtual | +
+
|
+ +deletenoexcept | +
+
|
+ +deletenoexcept | +
+
|
+ +noexcept | +
Returns a list of reason codes indicating the result of unsubscribing from each individual topic filter entry in the associated UNSUBSCRIBE packet.
+ +
+
|
+ +noexcept | +
Returns additional diagnostic information about the result of the UNSUBSCRIBE attempt.
+ +
+
|
+ +inlineoverridevirtual | +
Implements Aws::Crt::Mqtt5::IPacket.
+ +
+
|
+ +noexcept | +
Returns list of MQTT5 user properties included with the packet.
+ +
+
|
+ +deletenoexcept | +
+
|
+ +deletenoexcept | +
+ aws-crt-cpp
+
+ C++ wrapper around the aws-c-* libraries. Provides Cross-Platform Transport Protocols and SSL/TLS implementations for C++.
+ |
+
This is the complete list of members for Aws::Crt::Mqtt5::UnsubscribePacket, including all inherited members.
+
+ aws-crt-cpp
+
+ C++ wrapper around the aws-c-* libraries. Provides Cross-Platform Transport Protocols and SSL/TLS implementations for C++.
+ |
+
#include <Mqtt5Packets.h>
+Public Member Functions | |
UnsubscribePacket (Allocator *allocator=ApiAllocator()) noexcept | |
PacketType | getType () override |
UnsubscribePacket & | WithTopicFilter (Crt::String topicFilter) noexcept |
UnsubscribePacket & | WithTopicFilters (Crt::Vector< String > topicFilters) noexcept |
UnsubscribePacket & | WithUserProperties (const Vector< UserProperty > &userProperties) noexcept |
UnsubscribePacket & | WithUserProperties (Vector< UserProperty > &&userProperties) noexcept |
UnsubscribePacket & | WithUserProperty (UserProperty &&property) noexcept |
bool | initializeRawOptions (aws_mqtt5_packet_unsubscribe_view &raw_options) noexcept |
virtual | ~UnsubscribePacket () |
UnsubscribePacket (const UnsubscribePacket &) noexcept=delete | |
UnsubscribePacket (UnsubscribePacket &&) noexcept=delete | |
UnsubscribePacket & | operator= (const UnsubscribePacket &) noexcept=delete |
UnsubscribePacket & | operator= (UnsubscribePacket &&) noexcept=delete |
Data model of an MQTT5 UNSUBSCRIBE packet.
+
+
|
+ +noexcept | +
+
|
+ +virtual | +
+
|
+ +deletenoexcept | +
+
|
+ +deletenoexcept | +
+
|
+ +inlineoverridevirtual | +
Implements Aws::Crt::Mqtt5::IPacket.
+ +
+
|
+ +noexcept | +
+
|
+ +deletenoexcept | +
+
|
+ +deletenoexcept | +
+
|
+ +noexcept | +
Push back a topic filter that the client wishes to unsubscribe from.
+topicFilter | that the client wishes to unsubscribe from |
+
|
+ +noexcept | +
Sets list of topic filter that the client wishes to unsubscribe from.
+topicFilters | vector of subscription topic filters that the client wishes to unsubscribe from |
+
|
+ +noexcept | +
Sets the list of MQTT5 user properties included with the packet.
+ +userProperties | List of MQTT5 user properties included with the packet. |
+
|
+ +noexcept | +
Sets the list of MQTT5 user properties included with the packet.
+ +userProperties | List of MQTT5 user properties included with the packet. |
+
|
+ +noexcept | +
Put a MQTT5 user property to the back of the packet user property vector/list
+ +property | set of userProperty of MQTT5 user properties included with the packet. |
+ aws-crt-cpp
+
+ C++ wrapper around the aws-c-* libraries. Provides Cross-Platform Transport Protocols and SSL/TLS implementations for C++.
+ |
+
This is the complete list of members for Aws::Crt::Mqtt5::UserProperty, including all inherited members.
+getName() const noexcept | Aws::Crt::Mqtt5::UserProperty | inline |
getValue() const noexcept | Aws::Crt::Mqtt5::UserProperty | inline |
operator=(const UserProperty &toCopy) noexcept | Aws::Crt::Mqtt5::UserProperty | |
operator=(UserProperty &&toMove) noexcept | Aws::Crt::Mqtt5::UserProperty | |
UserProperty(Crt::String key, Crt::String value) noexcept | Aws::Crt::Mqtt5::UserProperty | |
UserProperty(const UserProperty &toCopy) noexcept | Aws::Crt::Mqtt5::UserProperty | |
UserProperty(UserProperty &&toMove) noexcept | Aws::Crt::Mqtt5::UserProperty | |
~UserProperty() noexcept | Aws::Crt::Mqtt5::UserProperty |
+ aws-crt-cpp
+
+ C++ wrapper around the aws-c-* libraries. Provides Cross-Platform Transport Protocols and SSL/TLS implementations for C++.
+ |
+
#include <Mqtt5Packets.h>
+Public Member Functions | |
UserProperty (Crt::String key, Crt::String value) noexcept | |
const Crt::String & | getName () const noexcept |
const Crt::String & | getValue () const noexcept |
~UserProperty () noexcept | |
UserProperty (const UserProperty &toCopy) noexcept | |
UserProperty (UserProperty &&toMove) noexcept | |
UserProperty & | operator= (const UserProperty &toCopy) noexcept |
UserProperty & | operator= (UserProperty &&toMove) noexcept |
Data model for MQTT5 user properties.
+A user property is a name-value pair of utf-8 strings that can be added to mqtt5 packets.
+
+
|
+ +noexcept | +
+
|
+ +noexcept | +
+
|
+ +noexcept | +
+
|
+ +noexcept | +
+
|
+ +inlinenoexcept | +
+
|
+ +inlinenoexcept | +
+
|
+ +noexcept | +
+
|
+ +noexcept | +
+ aws-crt-cpp
+
+ C++ wrapper around the aws-c-* libraries. Provides Cross-Platform Transport Protocols and SSL/TLS implementations for C++.
+ |
+
This is the complete list of members for Aws::Crt::Mqtt::MqttClient, including all inherited members.
+LastError() const noexcept | Aws::Crt::Mqtt::MqttClient | |
MqttClient(Io::ClientBootstrap &bootstrap, Allocator *allocator=ApiAllocator()) noexcept | Aws::Crt::Mqtt::MqttClient | |
MqttClient(Allocator *allocator=ApiAllocator()) noexcept | Aws::Crt::Mqtt::MqttClient | |
MqttClient(const MqttClient &)=delete | Aws::Crt::Mqtt::MqttClient | |
MqttClient(MqttClient &&) noexcept | Aws::Crt::Mqtt::MqttClient | |
NewConnection(const char *hostName, uint32_t port, const Io::SocketOptions &socketOptions, const Crt::Io::TlsContext &tlsContext, bool useWebsocket=false) noexcept | Aws::Crt::Mqtt::MqttClient | |
NewConnection(const char *hostName, uint32_t port, const Io::SocketOptions &socketOptions, bool useWebsocket=false) noexcept | Aws::Crt::Mqtt::MqttClient | |
operator bool() const noexcept | Aws::Crt::Mqtt::MqttClient | |
operator=(const MqttClient &)=delete | Aws::Crt::Mqtt::MqttClient | |
operator=(MqttClient &&) noexcept | Aws::Crt::Mqtt::MqttClient | |
~MqttClient() | Aws::Crt::Mqtt::MqttClient |
+ aws-crt-cpp
+
+ C++ wrapper around the aws-c-* libraries. Provides Cross-Platform Transport Protocols and SSL/TLS implementations for C++.
+ |
+
#include <MqttClient.h>
+Public Member Functions | |
MqttClient (Io::ClientBootstrap &bootstrap, Allocator *allocator=ApiAllocator()) noexcept | |
MqttClient (Allocator *allocator=ApiAllocator()) noexcept | |
~MqttClient () | |
MqttClient (const MqttClient &)=delete | |
MqttClient (MqttClient &&) noexcept | |
MqttClient & | operator= (const MqttClient &)=delete |
MqttClient & | operator= (MqttClient &&) noexcept |
operator bool () const noexcept | |
int | LastError () const noexcept |
std::shared_ptr< MqttConnection > | NewConnection (const char *hostName, uint32_t port, const Io::SocketOptions &socketOptions, const Crt::Io::TlsContext &tlsContext, bool useWebsocket=false) noexcept |
std::shared_ptr< MqttConnection > | NewConnection (const char *hostName, uint32_t port, const Io::SocketOptions &socketOptions, bool useWebsocket=false) noexcept |
An MQTT client. This is a move-only type. Unless otherwise specified, all function arguments need only to live through the duration of the function call.
+
+
|
+ +noexcept | +
Initialize an MqttClient using bootstrap and allocator
+ +
+
|
+ +noexcept | +
Initialize an MqttClient using a allocator and the default ClientBootstrap
+For more information on the default ClientBootstrap see Aws::Crt::ApiHandle::GetOrCreateStaticDefaultClientBootstrap
+ +Aws::Crt::Mqtt::MqttClient::~MqttClient | +( | +) | ++ |
+
|
+ +delete | +
+
|
+ +noexcept | +
+
|
+ +noexcept | +
+
|
+ +noexcept | +
Create a new connection object over plain text from the client. The client must outlive all of its connection instances.
hostName | endpoint to connect to |
port | port to connect to |
socketOptions | socket options to use when establishing the connection |
useWebsocket | should the connection use websockets or should it use direct mqtt? |
+
|
+ +noexcept | +
Create a new connection object using TLS from the client. The client must outlive all of its connection instances.
+hostName | endpoint to connect to |
port | port to connect to |
socketOptions | socket options to use when establishing the connection |
tlsContext | tls context to use with the connection |
useWebsocket | should the connection use websockets or should it use direct mqtt? |
+
|
+ +noexcept | +
+
|
+ +delete | +
+
|
+ +noexcept | +
+ aws-crt-cpp
+
+ C++ wrapper around the aws-c-* libraries. Provides Cross-Platform Transport Protocols and SSL/TLS implementations for C++.
+ |
+
This is the complete list of members for Aws::Crt::Mqtt::MqttConnection, including all inherited members.
+Connect(const char *clientId, bool cleanSession, uint16_t keepAliveTimeSecs=0, uint32_t pingTimeoutMs=0, uint32_t protocolOperationTimeoutMs=0) noexcept | Aws::Crt::Mqtt::MqttConnection | |
Disconnect() noexcept | Aws::Crt::Mqtt::MqttConnection | |
GetOperationStatistics() noexcept | Aws::Crt::Mqtt::MqttConnection | |
LastError() const noexcept | Aws::Crt::Mqtt::MqttConnection | |
Mqtt5::Mqtt5ClientCore class | Aws::Crt::Mqtt::MqttConnection | friend |
MqttClient class | Aws::Crt::Mqtt::MqttConnection | friend |
MqttConnection(const MqttConnection &)=delete | Aws::Crt::Mqtt::MqttConnection | |
MqttConnection(MqttConnection &&)=delete | Aws::Crt::Mqtt::MqttConnection | |
NewConnectionFromMqtt5Client(std::shared_ptr< Mqtt5::Mqtt5Client > mqtt5client) noexcept | Aws::Crt::Mqtt::MqttConnection | static |
OnConnectionClosed | Aws::Crt::Mqtt::MqttConnection | |
OnConnectionCompleted | Aws::Crt::Mqtt::MqttConnection | |
OnConnectionFailure | Aws::Crt::Mqtt::MqttConnection | |
OnConnectionInterrupted | Aws::Crt::Mqtt::MqttConnection | |
OnConnectionResumed | Aws::Crt::Mqtt::MqttConnection | |
OnConnectionSuccess | Aws::Crt::Mqtt::MqttConnection | |
OnDisconnect | Aws::Crt::Mqtt::MqttConnection | |
operator bool() const noexcept | Aws::Crt::Mqtt::MqttConnection | |
operator=(const MqttConnection &)=delete | Aws::Crt::Mqtt::MqttConnection | |
operator=(MqttConnection &&)=delete | Aws::Crt::Mqtt::MqttConnection | |
Publish(const char *topic, QOS qos, bool retain, const ByteBuf &payload, OnOperationCompleteHandler &&onOpComplete) noexcept | Aws::Crt::Mqtt::MqttConnection | |
SetHttpProxyOptions(const Http::HttpClientConnectionProxyOptions &proxyOptions) noexcept | Aws::Crt::Mqtt::MqttConnection | |
SetLogin(const char *username, const char *password) noexcept | Aws::Crt::Mqtt::MqttConnection | |
SetOnMessageHandler(OnMessageReceivedHandler &&onMessage) noexcept | Aws::Crt::Mqtt::MqttConnection | |
SetOnMessageHandler(OnPublishReceivedHandler &&onPublish) noexcept | Aws::Crt::Mqtt::MqttConnection | |
SetReconnectTimeout(uint64_t min_seconds, uint64_t max_seconds) noexcept | Aws::Crt::Mqtt::MqttConnection | |
SetWebsocketProxyOptions(const Http::HttpClientConnectionProxyOptions &proxyOptions) noexcept | Aws::Crt::Mqtt::MqttConnection | |
SetWill(const char *topic, QOS qos, bool retain, const ByteBuf &payload) noexcept | Aws::Crt::Mqtt::MqttConnection | |
Subscribe(const char *topicFilter, QOS qos, OnMessageReceivedHandler &&onMessage, OnSubAckHandler &&onSubAck) noexcept | Aws::Crt::Mqtt::MqttConnection | |
Subscribe(const char *topicFilter, QOS qos, OnPublishReceivedHandler &&onPublish, OnSubAckHandler &&onSubAck) noexcept | Aws::Crt::Mqtt::MqttConnection | |
Subscribe(const Vector< std::pair< const char *, OnMessageReceivedHandler >> &topicFilters, QOS qos, OnMultiSubAckHandler &&onOpComplete) noexcept | Aws::Crt::Mqtt::MqttConnection | |
Subscribe(const Vector< std::pair< const char *, OnPublishReceivedHandler >> &topicFilters, QOS qos, OnMultiSubAckHandler &&onOpComplete) noexcept | Aws::Crt::Mqtt::MqttConnection | |
Unsubscribe(const char *topicFilter, OnOperationCompleteHandler &&onOpComplete) noexcept | Aws::Crt::Mqtt::MqttConnection | |
WebsocketInterceptor | Aws::Crt::Mqtt::MqttConnection | |
~MqttConnection() | Aws::Crt::Mqtt::MqttConnection |
+ aws-crt-cpp
+
+ C++ wrapper around the aws-c-* libraries. Provides Cross-Platform Transport Protocols and SSL/TLS implementations for C++.
+ |
+
#include <MqttConnection.h>
+Public Member Functions | |
~MqttConnection () | |
MqttConnection (const MqttConnection &)=delete | |
MqttConnection (MqttConnection &&)=delete | |
MqttConnection & | operator= (const MqttConnection &)=delete |
MqttConnection & | operator= (MqttConnection &&)=delete |
operator bool () const noexcept | |
int | LastError () const noexcept |
bool | SetWill (const char *topic, QOS qos, bool retain, const ByteBuf &payload) noexcept |
bool | SetLogin (const char *username, const char *password) noexcept |
bool | SetWebsocketProxyOptions (const Http::HttpClientConnectionProxyOptions &proxyOptions) noexcept |
bool | SetHttpProxyOptions (const Http::HttpClientConnectionProxyOptions &proxyOptions) noexcept |
bool | SetReconnectTimeout (uint64_t min_seconds, uint64_t max_seconds) noexcept |
bool | Connect (const char *clientId, bool cleanSession, uint16_t keepAliveTimeSecs=0, uint32_t pingTimeoutMs=0, uint32_t protocolOperationTimeoutMs=0) noexcept |
bool | Disconnect () noexcept |
uint16_t | Subscribe (const char *topicFilter, QOS qos, OnMessageReceivedHandler &&onMessage, OnSubAckHandler &&onSubAck) noexcept |
uint16_t | Subscribe (const char *topicFilter, QOS qos, OnPublishReceivedHandler &&onPublish, OnSubAckHandler &&onSubAck) noexcept |
uint16_t | Subscribe (const Vector< std::pair< const char *, OnMessageReceivedHandler >> &topicFilters, QOS qos, OnMultiSubAckHandler &&onOpComplete) noexcept |
uint16_t | Subscribe (const Vector< std::pair< const char *, OnPublishReceivedHandler >> &topicFilters, QOS qos, OnMultiSubAckHandler &&onOpComplete) noexcept |
bool | SetOnMessageHandler (OnMessageReceivedHandler &&onMessage) noexcept |
bool | SetOnMessageHandler (OnPublishReceivedHandler &&onPublish) noexcept |
uint16_t | Unsubscribe (const char *topicFilter, OnOperationCompleteHandler &&onOpComplete) noexcept |
uint16_t | Publish (const char *topic, QOS qos, bool retain, const ByteBuf &payload, OnOperationCompleteHandler &&onOpComplete) noexcept |
const MqttConnectionOperationStatistics & | GetOperationStatistics () noexcept |
+Static Public Member Functions | |
static std::shared_ptr< Crt::Mqtt::MqttConnection > | NewConnectionFromMqtt5Client (std::shared_ptr< Mqtt5::Mqtt5Client > mqtt5client) noexcept |
+Friends | |
class | MqttClient |
class | Mqtt5::Mqtt5ClientCore |
Represents a persistent Mqtt Connection. The memory is owned by MqttClient or Mqtt5Client.
+To get a new instance of this class, use MqttClient::NewConnection or Mqtt5Client::NewConnection. Unless specified all function arguments need only to live through the duration of the function call.
+Aws::Crt::Mqtt::MqttConnection::~MqttConnection | +( | +) | ++ |
+
|
+ +delete | +
+
|
+ +delete | +
+
|
+ +noexcept | +
Initiates the connection, OnConnectionCompleted will be invoked in an event-loop thread.
+clientId | client identifier to use when establishing the mqtt connection |
cleanSession | false to attempt to rejoin an existing session for the client id, true to skip and start with a new session |
keepAliveTimeSecs | time interval to space mqtt pings apart by |
pingTimeoutMs | timeout in milliseconds before the keep alive ping is considered to have failed |
protocolOperationTimeoutMs | timeout in milliseconds to give up waiting for a response packet for an operation. Necessary due to throttling properties on certain server implementations that do not return an ACK for throttled operations. |
+
|
+ +noexcept | +
Initiates disconnect, OnDisconnectHandler will be invoked in an event-loop thread.
+
|
+ +noexcept | +
Get the statistics about the current state of the connection's queue of operations
+ + +
+
|
+ +noexcept | +
+
|
+ +staticnoexcept | +
Create a new MqttConnection object from the Mqtt5Client.
mqtt5client | The shared ptr of Mqtt5Client |
As we passed the std::shared_ptr<Mqtt5Client> by value, this function scope would keep a reference of the Mqtt5Client thus the underlying c client. Therefore we directly access the c client here. Other than that, we should never directly access the underlying c client without acquire the reference.
+ +
+
|
+ +noexcept | +
+
|
+ +delete | +
+
|
+ +delete | +
+
|
+ +noexcept | +
Publishes to a topic.
+topic | topic to publish to |
qos | QOS to publish the message with |
retain | should this message replace the current retained message of the topic? |
payload | payload of the message |
onOpComplete | completion callback to invoke when the operation is complete. If QoS is 0, then the callback is invoked when the message is passed to the tls handler, otherwise it's invoked on receipt of the final response from the server. |
+
|
+ +noexcept | +
Sets http proxy options. In order to use an http proxy with mqtt either (1) Websockets are used (2) Mqtt-over-tls is used and the ALPN list of the tls context contains a tag that resolves to mqtt
+proxyOptions | proxy configuration for making the mqtt connection |
+
|
+ +noexcept | +
Sets login credentials for the connection. The must get set before the Connect call if it is to be used.
username | user name to add to the MQTT CONNECT packet |
password | password to add to the MQTT CONNECT packet |
+
|
+ +noexcept | +
Installs a handler for all incoming publish messages, regardless of if Subscribe has been called on the topic.
+onMessage | callback to invoke for all received messages |
+
|
+ +noexcept | +
+
|
+ +noexcept | +
Customize time to wait between reconnect attempts. The time will start at min and multiply by 2 until max is reached. The time resets back to min after a successful connection. This function should only be called before Connect().
+min_seconds | minimum time to wait before attempting a reconnect |
max_seconds | maximum time to wait before attempting a reconnect |
+
|
+ +noexcept | +
+
|
+ +noexcept | +
Sets LastWill for the connection.
topic | topic the will message should be published to |
qos | QOS the will message should be published with |
retain | true if the will publish should be treated as a retained publish |
payload | payload of the will message |
+
|
+ +noexcept | +
Subscribes to topicFilter. OnMessageReceivedHandler will be invoked from an event-loop thread upon an incoming Publish message. OnSubAckHandler will be invoked upon receipt of a suback message.
+topicFilter | topic filter to subscribe to |
qos | maximum qos client is willing to receive matching messages on |
onMessage | callback to invoke when a message is received based on matching this filter |
onSubAck | callback to invoke with the server's response to the subscribe request |
+
|
+ +noexcept | +
+
|
+ +noexcept | +
Subscribes to multiple topicFilters. OnMessageReceivedHandler will be invoked from an event-loop thread upon an incoming Publish message. OnMultiSubAckHandler will be invoked upon receipt of a suback message.
+topicFilters | list of pairs of topic filters and message callbacks to invoke on a matching publish |
qos | maximum qos client is willing to receive matching messages on |
onOpComplete | callback to invoke with the server's response to the subscribe request |
+
|
+ +noexcept | +
+
|
+ +noexcept | +
Unsubscribes from topicFilter. OnOperationCompleteHandler will be invoked upon receipt of an unsuback message.
+topicFilter | topic filter to unsubscribe the session from |
onOpComplete | callback to invoke on receipt of the server's UNSUBACK message |
+
|
+ +friend | +
+
|
+ +friend | +
OnConnectionClosedHandler Aws::Crt::Mqtt::MqttConnection::OnConnectionClosed | +
Invoked when a connection is disconnected and shutdown successfully.
+OnConnectionCompletedHandler Aws::Crt::Mqtt::MqttConnection::OnConnectionCompleted | +
Invoked when a connack message is received, or an error occurred.
+ +OnConnectionFailureHandler Aws::Crt::Mqtt::MqttConnection::OnConnectionFailure | +
Invoked whenever the connection fails to connect.
+This callback is invoked for every failed connect and every failed reconnect.
+ +OnConnectionInterruptedHandler Aws::Crt::Mqtt::MqttConnection::OnConnectionInterrupted | +
A callback invoked every time the connections is interrupted.
+ +OnConnectionResumedHandler Aws::Crt::Mqtt::MqttConnection::OnConnectionResumed | +
A callback invoked every time the connection is resumed.
+ +OnConnectionSuccessHandler Aws::Crt::Mqtt::MqttConnection::OnConnectionSuccess | +
Invoked whenever the connection successfully connects.
+This callback is invoked for every successful connect and every successful reconnect.
+ +OnDisconnectHandler Aws::Crt::Mqtt::MqttConnection::OnDisconnect | +
A callback invoked on disconnect.
+ +OnWebSocketHandshakeIntercept Aws::Crt::Mqtt::MqttConnection::WebsocketInterceptor | +
Invoked during websocket handshake to give users opportunity to transform an http request for purposes such as signing/authorization etc... Returning from this function does not continue the websocket handshake since some work flows may be asynchronous. To accommodate that, onComplete must be invoked upon completion of the signing process.
+ +
+ aws-crt-cpp
+
+ C++ wrapper around the aws-c-* libraries. Provides Cross-Platform Transport Protocols and SSL/TLS implementations for C++.
+ |
+
This is the complete list of members for Aws::Crt::Optional< T >, including all inherited members.
+
+ aws-crt-cpp
+
+ C++ wrapper around the aws-c-* libraries. Provides Cross-Platform Transport Protocols and SSL/TLS implementations for C++.
+ |
+
#include <Optional.h>
+Public Member Functions | |
Optional () | |
Optional (const T &val) | |
Optional (T &&val) | |
~Optional () | |
template<typename U = T> | |
Optional & | operator= (U &&u) |
Optional (const Optional< T > &other) | |
Optional (Optional< T > &&other) | |
Optional & | operator= (const Optional &other) |
template<typename U = T> | |
Optional< T > & | operator= (const Optional< U > &other) |
template<typename U = T> | |
Optional< T > & | operator= (Optional< U > &&other) |
const T * | operator-> () const |
T * | operator-> () |
const T & | operator* () const & |
T & | operator* () & |
const T && | operator* () const && |
T && | operator* () && |
operator bool () const noexcept | |
bool | has_value () const noexcept |
T & | value () & |
const T & | value () const & |
T && | value () && |
const T && | value () const && |
void | reset () |
Custom implementation of an Option type. std::optional requires C++17
T | type of the optional value |
+
|
+ +inline | +
+
|
+ +inline | +
+
|
+ +inline | +
+
|
+ +inline | +
+
|
+ +inline | +
+
|
+ +inline | +
+
|
+ +inlinenoexcept | +
+
|
+ +inlineexplicitnoexcept | +
+
|
+ +inline | +
+
|
+ +inline | +
+
|
+ +inline | +
+
|
+ +inline | +
+
|
+ +inline | +
+
|
+ +inline | +
+
|
+ +inline | +
+
|
+ +inline | +
+
|
+ +inline | +
+
|
+ +inline | +
+
|
+ +inline | +
+
|
+ +inline | +
+
|
+ +inline | +
+
|
+ +inline | +
+
|
+ +inline | +
+ aws-crt-cpp
+
+ C++ wrapper around the aws-c-* libraries. Provides Cross-Platform Transport Protocols and SSL/TLS implementations for C++.
+ |
+
This is the complete list of members for Aws::Crt::RefCounted< T >, including all inherited members.
+AcquireRef() | Aws::Crt::RefCounted< T > | inlineprotected |
RefCounted() | Aws::Crt::RefCounted< T > | inlineprotected |
ReleaseRef() | Aws::Crt::RefCounted< T > | inlineprotected |
~RefCounted() | Aws::Crt::RefCounted< T > | inlineprotected |
+ aws-crt-cpp
+
+ C++ wrapper around the aws-c-* libraries. Provides Cross-Platform Transport Protocols and SSL/TLS implementations for C++.
+ |
+
#include <RefCounted.h>
+Protected Member Functions | |
RefCounted () | |
~RefCounted () | |
void | AcquireRef () |
void | ReleaseRef () |
Inherit from RefCounted to allow reference-counting from C code, which will keep your C++ object alive as long as the count is non-zero.
+A class must inherit from RefCounted and std::enable_shared_from_this. Your class must always be placed inside a shared_ptr (do not create on the stack, or keep on the heap as a raw pointer).
+Whenever the reference count goes from 0 to 1 a shared_ptr is created internally to keep this object alive. Whenever the reference count goes from 1 to 0 the internal shared_ptr is reset, allowing this object to be destroyed.
+
+
|
+ +inlineprotected | +
+
|
+ +inlineprotected | +
+
|
+ +inlineprotected | +
+
|
+ +inlineprotected | +
+ aws-crt-cpp
+
+ C++ wrapper around the aws-c-* libraries. Provides Cross-Platform Transport Protocols and SSL/TLS implementations for C++.
+ |
+
This is the complete list of members for Aws::Crt::StlAllocator< T >, including all inherited members.
+allocate(size_type n, const void *hint=nullptr) | Aws::Crt::StlAllocator< T > | inline |
Base typedef | Aws::Crt::StlAllocator< T > | |
deallocate(RawPointer p, size_type) | Aws::Crt::StlAllocator< T > | inline |
m_allocator | Aws::Crt::StlAllocator< T > | |
RawPointer typedef | Aws::Crt::StlAllocator< T > | |
size_type typedef | Aws::Crt::StlAllocator< T > | |
StlAllocator() noexcept | Aws::Crt::StlAllocator< T > | inline |
StlAllocator(Allocator *allocator) noexcept | Aws::Crt::StlAllocator< T > | inline |
StlAllocator(const StlAllocator< T > &a) noexcept | Aws::Crt::StlAllocator< T > | inline |
StlAllocator(const StlAllocator< U > &a) noexcept | Aws::Crt::StlAllocator< T > | inline |
~StlAllocator() | Aws::Crt::StlAllocator< T > | inline |
+ aws-crt-cpp
+
+ C++ wrapper around the aws-c-* libraries. Provides Cross-Platform Transport Protocols and SSL/TLS implementations for C++.
+ |
+
#include <StlAllocator.h>
+Classes | |
struct | rebind |
+Public Types | |
using | Base = std::allocator< T > |
using | size_type = std::size_t |
using | RawPointer = typename std::allocator_traits< std::allocator< T > >::pointer |
+Public Member Functions | |
StlAllocator () noexcept | |
StlAllocator (Allocator *allocator) noexcept | |
StlAllocator (const StlAllocator< T > &a) noexcept | |
template<class U > | |
StlAllocator (const StlAllocator< U > &a) noexcept | |
~StlAllocator () | |
RawPointer | allocate (size_type n, const void *hint=nullptr) |
void | deallocate (RawPointer p, size_type) |
+Public Attributes | |
Allocator * | m_allocator |
Stateful allocator variant that uses an underlying CRT allocator
T | type that allocator can allocate |
using Aws::Crt::StlAllocator< T >::Base = std::allocator<T> | +
using Aws::Crt::StlAllocator< T >::RawPointer = typename std::allocator_traits<std::allocator<T> >::pointer | +
using Aws::Crt::StlAllocator< T >::size_type = std::size_t | +
+
|
+ +inlinenoexcept | +
+
|
+ +inlinenoexcept | +
+
|
+ +inlinenoexcept | +
+
|
+ +inlinenoexcept | +
+
|
+ +inline | +
+
|
+ +inline | +
+
|
+ +inline | +
Allocator* Aws::Crt::StlAllocator< T >::m_allocator | +
+ aws-crt-cpp
+
+ C++ wrapper around the aws-c-* libraries. Provides Cross-Platform Transport Protocols and SSL/TLS implementations for C++.
+ |
+
This is the complete list of members for Aws::Crt::UUID, including all inherited members.
+GetLastError() const noexcept | Aws::Crt::UUID | |
operator bool() const noexcept | Aws::Crt::UUID | inline |
operator ByteBuf() const noexcept | Aws::Crt::UUID | |
operator String() const | Aws::Crt::UUID | |
operator!=(const UUID &other) noexcept | Aws::Crt::UUID | |
operator=(const String &str) noexcept | Aws::Crt::UUID | |
operator==(const UUID &other) noexcept | Aws::Crt::UUID | |
ToString() const | Aws::Crt::UUID | |
UUID() noexcept | Aws::Crt::UUID | |
UUID(const String &str) noexcept | Aws::Crt::UUID |
+ aws-crt-cpp
+
+ C++ wrapper around the aws-c-* libraries. Provides Cross-Platform Transport Protocols and SSL/TLS implementations for C++.
+ |
+
#include <UUID.h>
+Public Member Functions | |
UUID () noexcept | |
UUID (const String &str) noexcept | |
UUID & | operator= (const String &str) noexcept |
bool | operator== (const UUID &other) noexcept |
bool | operator!= (const UUID &other) noexcept |
operator String () const | |
operator ByteBuf () const noexcept | |
operator bool () const noexcept | |
int | GetLastError () const noexcept |
String | ToString () const |
Utility class for creating UUIDs and serializing them to a string
+
+
|
+ +noexcept | +
+
|
+ +noexcept | +
+
|
+ +noexcept | +
+
|
+ +inlinenoexcept | +
+
|
+ +noexcept | +
Aws::Crt::UUID::operator String | +( | +) | +const | +
+
|
+ +noexcept | +
+
|
+ +noexcept | +
String Aws::Crt::UUID::ToString | +( | +) | +const | +
+ aws-crt-cpp
+
+ C++ wrapper around the aws-c-* libraries. Provides Cross-Platform Transport Protocols and SSL/TLS implementations for C++.
+ |
+
This is the complete list of members for Aws::Crt::basic_string_view< CharT, Traits >, including all inherited members.
+
+ aws-crt-cpp
+
+ C++ wrapper around the aws-c-* libraries. Provides Cross-Platform Transport Protocols and SSL/TLS implementations for C++.
+ |
+
#include <StringView.h>
+Public Types | |
using | traits_type = Traits |
using | value_type = CharT |
using | pointer = value_type * |
using | const_pointer = const value_type * |
using | reference = value_type & |
using | const_reference = const value_type & |
using | const_iterator = const value_type * |
using | iterator = const_iterator |
using | const_reverse_iterator = std::reverse_iterator< const_iterator > |
using | reverse_iterator = const_reverse_iterator |
using | size_type = size_t |
using | difference_type = ptrdiff_t |
+Public Member Functions | |
constexpr | basic_string_view () noexcept |
constexpr | basic_string_view (const basic_string_view &) noexcept=default |
constexpr | basic_string_view (const CharT *s) noexcept |
constexpr | basic_string_view (const CharT *s, size_type count) noexcept |
basic_string_view & | operator= (const basic_string_view &) noexcept=default |
constexpr const_iterator | begin () const noexcept |
constexpr const_iterator | end () const noexcept |
constexpr const_iterator | cbegin () const noexcept |
constexpr const_iterator | cend () const noexcept |
constexpr const_reverse_iterator | rbegin () const noexcept |
constexpr const_reverse_iterator | rend () const noexcept |
constexpr const_reverse_iterator | crbegin () const noexcept |
constexpr const_reverse_iterator | crend () const noexcept |
constexpr size_type | size () const noexcept |
constexpr size_type | length () const noexcept |
constexpr size_type | max_size () const noexcept |
constexpr bool | empty () const noexcept |
const_reference | operator[] (size_type pos) const noexcept |
const_reference | at (size_type pos) const |
const_reference | front () const noexcept |
const_reference | back () const noexcept |
constexpr const_pointer | data () const noexcept |
void | remove_prefix (size_type n) noexcept |
void | remove_suffix (size_type n) noexcept |
void | swap (basic_string_view &other) noexcept |
size_type | copy (CharT *s, size_type n, size_type pos=0) const |
basic_string_view | substr (size_type pos=0, size_type n=npos) const noexcept(false) |
int | compare (const basic_string_view &s) const noexcept |
constexpr int | compare (size_type pos1, size_type n1, const basic_string_view &s) const |
constexpr int | compare (size_type pos1, size_type n1, const basic_string_view &s, size_type pos2, size_type n2) const |
constexpr int | compare (const CharT *s) const noexcept |
constexpr int | compare (size_type pos1, size_type n1, const CharT *s) const |
constexpr int | compare (size_type pos1, size_type n1, const CharT *s, size_type n2) const noexcept(false) |
constexpr bool | starts_with (const basic_string_view &other) const noexcept |
constexpr bool | starts_with (CharT c) const noexcept |
constexpr bool | starts_with (const CharT *s) const noexcept |
constexpr bool | ends_with (const basic_string_view &other) const noexcept |
constexpr bool | ends_with (CharT c) const noexcept |
constexpr bool | ends_with (const CharT *s) const noexcept |
constexpr size_type | find (const basic_string_view &s, size_type pos=0) const noexcept |
size_type | find (CharT c, size_type pos=0) const noexcept |
size_type | find (const CharT *s, size_type pos, size_type n) const noexcept |
constexpr size_type | find (const CharT *s, size_type pos=0) const noexcept |
size_type | rfind (basic_string_view s, size_type pos=npos) const noexcept |
size_type | rfind (CharT c, size_type pos=npos) const noexcept |
size_type | rfind (const CharT *s, size_type pos, size_type n) const noexcept |
constexpr size_type | rfind (const CharT *s, size_type pos=npos) const noexcept |
constexpr size_type | find_first_of (basic_string_view s, size_type pos=0) const noexcept |
constexpr size_type | find_first_of (CharT c, size_type pos=0) const noexcept |
size_type | find_first_of (const CharT *s, size_type pos, size_type n) const noexcept |
constexpr size_type | find_first_of (const CharT *s, size_type pos=0) const noexcept |
constexpr size_type | find_last_of (basic_string_view s, size_type pos=npos) const noexcept |
constexpr size_type | find_last_of (CharT c, size_type pos=npos) const noexcept |
size_type | find_last_of (const CharT *s, size_type pos, size_type n) const noexcept |
constexpr size_type | find_last_of (const CharT *s, size_type pos=npos) const noexcept |
size_type | find_first_not_of (basic_string_view s, size_type pos=0) const noexcept |
size_type | find_first_not_of (CharT c, size_type pos=0) const noexcept |
size_type | find_first_not_of (const CharT *s, size_type pos, size_type n) const noexcept |
constexpr size_type | find_first_not_of (const CharT *s, size_type pos=0) const noexcept |
size_type | find_last_not_of (basic_string_view s, size_type pos=npos) const noexcept |
size_type | find_last_not_of (CharT c, size_type pos=npos) const noexcept |
size_type | find_last_not_of (const CharT *s, size_type pos, size_type n) const noexcept |
constexpr size_type | find_last_not_of (const CharT *s, size_type pos=npos) const noexcept |
+Static Public Attributes | |
static constexpr size_type | npos = static_cast<size_type>(-1) |
Custom string view implementation in order to meet C++11 baseline
CharT | |
Traits |
using Aws::Crt::basic_string_view< CharT, Traits >::const_iterator = const value_type * | +
using Aws::Crt::basic_string_view< CharT, Traits >::const_pointer = const value_type * | +
using Aws::Crt::basic_string_view< CharT, Traits >::const_reference = const value_type & | +
using Aws::Crt::basic_string_view< CharT, Traits >::const_reverse_iterator = std::reverse_iterator<const_iterator> | +
using Aws::Crt::basic_string_view< CharT, Traits >::difference_type = ptrdiff_t | +
using Aws::Crt::basic_string_view< CharT, Traits >::iterator = const_iterator | +
using Aws::Crt::basic_string_view< CharT, Traits >::pointer = value_type * | +
using Aws::Crt::basic_string_view< CharT, Traits >::reference = value_type & | +
using Aws::Crt::basic_string_view< CharT, Traits >::reverse_iterator = const_reverse_iterator | +
using Aws::Crt::basic_string_view< CharT, Traits >::size_type = size_t | +
using Aws::Crt::basic_string_view< CharT, Traits >::traits_type = Traits | +
using Aws::Crt::basic_string_view< CharT, Traits >::value_type = CharT | +
+
|
+ +inlineconstexprnoexcept | +
+
|
+ +constexprdefaultnoexcept | +
+
|
+ +inlineconstexprnoexcept | +
+
|
+ +inlineconstexprnoexcept | +
+
|
+ +inline | +
+
|
+ +inlinenoexcept | +
+
|
+ +inlineconstexprnoexcept | +
+
|
+ +inlineconstexprnoexcept | +
+
|
+ +inlineconstexprnoexcept | +
+
|
+ +inlinenoexcept | +
+
|
+ +inlineconstexprnoexcept | +
+
|
+ +inlineconstexpr | +
+
|
+ +inlineconstexpr | +
+
|
+ +inlineconstexpr | +
+
|
+ +inlineconstexprnoexcept | +
+
|
+ +inline | +
+
|
+ +inlineconstexprnoexcept | +
+
|
+ +inlineconstexprnoexcept | +
+
|
+ +inlineconstexprnoexcept | +
+
|
+ +inlineconstexprnoexcept | +
+
|
+ +inlineconstexprnoexcept | +
+
|
+ +inlineconstexprnoexcept | +
+
|
+ +inlineconstexprnoexcept | +
+
|
+ +inlineconstexprnoexcept | +
+
|
+ +inlinenoexcept | +
+
|
+ +inlineconstexprnoexcept | +
+
|
+ +inlinenoexcept | +
+
|
+ +inlineconstexprnoexcept | +
+
|
+ +inlinenoexcept | +
+
|
+ +inlinenoexcept | +
+
|
+ +inlinenoexcept | +
+
|
+ +inlineconstexprnoexcept | +
+
|
+ +inlineconstexprnoexcept | +
+
|
+ +inlineconstexprnoexcept | +
+
|
+ +inlinenoexcept | +
+
|
+ +inlineconstexprnoexcept | +
+
|
+ +inlinenoexcept | +
+
|
+ +inlinenoexcept | +
+
|
+ +inlinenoexcept | +
+
|
+ +inlineconstexprnoexcept | +
+
|
+ +inlineconstexprnoexcept | +
+
|
+ +inlineconstexprnoexcept | +
+
|
+ +inlinenoexcept | +
+
|
+ +inlineconstexprnoexcept | +
+
|
+ +inlinenoexcept | +
+
|
+ +inlineconstexprnoexcept | +
+
|
+ +inlineconstexprnoexcept | +
+
|
+ +defaultnoexcept | +
+
|
+ +inlinenoexcept | +
+
|
+ +inlineconstexprnoexcept | +
+
|
+ +inlinenoexcept | +
+
|
+ +inlinenoexcept | +
+
|
+ +inlineconstexprnoexcept | +
+
|
+ +inlinenoexcept | +
+
|
+ +inlinenoexcept | +
+
|
+ +inlinenoexcept | +
+
|
+ +inlineconstexprnoexcept | +
+
|
+ +inlineconstexprnoexcept | +
+
|
+ +inlineconstexprnoexcept | +
+
|
+ +inlineconstexprnoexcept | +
+
|
+ +inlineconstexprnoexcept | +
+
|
+ +inlinenoexcept | +
+
|
+ +inlinenoexcept | +
+
|
+ +staticconstexpr | +
+ aws-crt-cpp
+
+ C++ wrapper around the aws-c-* libraries. Provides Cross-Platform Transport Protocols and SSL/TLS implementations for C++.
+ |
+
This is the complete list of members for Aws::Iot::Mqtt5ClientBuilder, including all inherited members.
+Build() noexcept | Aws::Iot::Mqtt5ClientBuilder | |
LastError() const noexcept | Aws::Iot::Mqtt5ClientBuilder | inline |
Mqtt5ClientBuilder(const Mqtt5ClientBuilder &)=delete | Aws::Iot::Mqtt5ClientBuilder | |
Mqtt5ClientBuilder(Mqtt5ClientBuilder &&)=delete | Aws::Iot::Mqtt5ClientBuilder | |
NewMqtt5ClientBuilderWithCustomAuthorizer(const Crt::String hostName, const Mqtt5CustomAuthConfig &customAuthConfig, Crt::Allocator *allocator) noexcept | Aws::Iot::Mqtt5ClientBuilder | static |
NewMqtt5ClientBuilderWithCustomAuthorizerWebsocket(const Crt::String hostName, const Mqtt5CustomAuthConfig &customAuthConfig, const WebsocketConfig &config, Crt::Allocator *allocator) noexcept | Aws::Iot::Mqtt5ClientBuilder | static |
NewMqtt5ClientBuilderWithMtlsFromMemory(const Crt::String hostName, const Crt::ByteCursor &certPath, const Crt::ByteCursor &pkeyPath, Crt::Allocator *allocator=Crt::ApiAllocator()) noexcept | Aws::Iot::Mqtt5ClientBuilder | static |
NewMqtt5ClientBuilderWithMtlsFromPath(const Crt::String hostName, const char *certPath, const char *pkeyPath, Crt::Allocator *allocator=Crt::ApiAllocator()) noexcept | Aws::Iot::Mqtt5ClientBuilder | static |
NewMqtt5ClientBuilderWithMtlsPkcs11(const Crt::String hostName, const Crt::Io::TlsContextPkcs11Options &pkcs11Options, Crt::Allocator *allocator=Crt::ApiAllocator()) noexcept | Aws::Iot::Mqtt5ClientBuilder | static |
NewMqtt5ClientBuilderWithMtlsPkcs12(const Crt::String hostName, const struct Pkcs12Options &options, Crt::Allocator *allocator=Crt::ApiAllocator()) noexcept | Aws::Iot::Mqtt5ClientBuilder | static |
NewMqtt5ClientBuilderWithWebsocket(const Crt::String hostName, const WebsocketConfig &config, Crt::Allocator *allocator=Crt::ApiAllocator()) noexcept | Aws::Iot::Mqtt5ClientBuilder | static |
NewMqtt5ClientBuilderWithWindowsCertStorePath(const Crt::String hostName, const char *windowsCertStorePath, Crt::Allocator *allocator=Crt::ApiAllocator()) noexcept | Aws::Iot::Mqtt5ClientBuilder | static |
operator bool() const noexcept | Aws::Iot::Mqtt5ClientBuilder | inlineexplicit |
operator=(const Mqtt5ClientBuilder &)=delete | Aws::Iot::Mqtt5ClientBuilder | |
operator=(Mqtt5ClientBuilder &&)=delete | Aws::Iot::Mqtt5ClientBuilder | |
WithAckTimeoutSec(uint32_t ackTimeoutSec) noexcept | Aws::Iot::Mqtt5ClientBuilder | |
WithAckTimeoutSeconds(uint32_t ackTimeoutSec) noexcept | Aws::Iot::Mqtt5ClientBuilder | |
WithBootstrap(Crt::Io::ClientBootstrap *bootStrap) noexcept | Aws::Iot::Mqtt5ClientBuilder | |
WithCertificateAuthority(const char *caPath) noexcept | Aws::Iot::Mqtt5ClientBuilder | |
WithCertificateAuthority(const Crt::ByteCursor &cert) noexcept | Aws::Iot::Mqtt5ClientBuilder | |
WithClientAttemptingConnectCallback(OnAttemptingConnectHandler callback) noexcept | Aws::Iot::Mqtt5ClientBuilder | |
WithClientConnectionFailureCallback(OnConnectionFailureHandler callback) noexcept | Aws::Iot::Mqtt5ClientBuilder | |
WithClientConnectionSuccessCallback(OnConnectionSuccessHandler callback) noexcept | Aws::Iot::Mqtt5ClientBuilder | |
WithClientDisconnectionCallback(OnDisconnectionHandler callback) noexcept | Aws::Iot::Mqtt5ClientBuilder | |
WithClientExtendedValidationAndFlowControl(ClientExtendedValidationAndFlowControl clientExtendedValidationAndFlowControl) noexcept | Aws::Iot::Mqtt5ClientBuilder | |
WithClientStoppedCallback(OnStoppedHandler callback) noexcept | Aws::Iot::Mqtt5ClientBuilder | |
WithConnackTimeoutMs(uint32_t connackTimeoutMs) noexcept | Aws::Iot::Mqtt5ClientBuilder | |
WithConnectOptions(std::shared_ptr< ConnectPacket > packetConnect) noexcept | Aws::Iot::Mqtt5ClientBuilder | |
WithCustomAuthorizer(const Iot::Mqtt5CustomAuthConfig &config) noexcept | Aws::Iot::Mqtt5ClientBuilder | |
WithHostName(Crt::String hostname) | Aws::Iot::Mqtt5ClientBuilder | |
WithHttpProxyOptions(const Crt::Http::HttpClientConnectionProxyOptions &proxyOptions) noexcept | Aws::Iot::Mqtt5ClientBuilder | |
WithMinConnectedTimeToResetReconnectDelayMs(uint64_t minConnectedTimeToResetReconnectDelayMs) noexcept | Aws::Iot::Mqtt5ClientBuilder | |
WithOfflineQueueBehavior(ClientOperationQueueBehaviorType offlineQueueBehavior) noexcept | Aws::Iot::Mqtt5ClientBuilder | |
WithPingTimeoutMs(uint32_t pingTimeoutMs) noexcept | Aws::Iot::Mqtt5ClientBuilder | |
WithPort(uint32_t port) noexcept | Aws::Iot::Mqtt5ClientBuilder | |
WithPublishReceivedCallback(OnPublishReceivedHandler callback) noexcept | Aws::Iot::Mqtt5ClientBuilder | |
WithReconnectOptions(ReconnectOptions reconnectOptions) noexcept | Aws::Iot::Mqtt5ClientBuilder | |
WithSdkName(const Crt::String &sdkName) | Aws::Iot::Mqtt5ClientBuilder | |
WithSdkVersion(const Crt::String &sdkVersion) | Aws::Iot::Mqtt5ClientBuilder | |
WithSessionBehavior(ClientSessionBehaviorType sessionBehavior) noexcept | Aws::Iot::Mqtt5ClientBuilder | |
WithTopicAliasingOptions(TopicAliasingOptions topicAliasingOptions) noexcept | Aws::Iot::Mqtt5ClientBuilder | |
~Mqtt5ClientBuilder() | Aws::Iot::Mqtt5ClientBuilder | inlinevirtual |
+ aws-crt-cpp
+
+ C++ wrapper around the aws-c-* libraries. Provides Cross-Platform Transport Protocols and SSL/TLS implementations for C++.
+ |
+
#include <Mqtt5Client.h>
Represents a unique configuration for mqtt5 client and connection. Helps to setup Mqtt5ClientOptionsBuilder for mqtt5 client.
+
+
|
+ +inlinevirtual | +
+
|
+ +delete | +
+
|
+ +delete | +
+
|
+ +noexcept | +
Builds a client configuration object from the set options.
+
+
|
+ +inlinenoexcept | +
+
|
+ +staticnoexcept | +
Sets the builder up for connection using authorization configuration.
+hostName | - AWS IoT endpoint to connect to |
customAuthConfig | custom authorization configuration information |
allocator | memory allocator to use |
+
|
+ +staticnoexcept | +
Sets the builder up for connection using authorization configuration using Websockets.
+hostName | - AWS IoT endpoint to connect to |
customAuthConfig | custom authorization configuration information |
config | websocket configuration information |
allocator | memory allocator to use |
+
|
+ +staticnoexcept | +
Sets the builder up for MTLS using cert and pkey. These are in-memory buffers and must be in the PEM format.
+hostName | - AWS IoT endpoint to connect to |
certPath | buffer containing the X509 certificate in a PEM format |
pkeyPath | buffer containing the private key in a PEM format |
allocator | memory allocator to use |
+
|
+ +staticnoexcept | +
Set the builder up for MTLS using certPath and pkeyPath. These are files on disk and must be in the PEM format.
+hostName | - AWS IoT endpoint to connect to |
certPath | path to the X509 certificate (pem file) to use |
pkeyPath | path to the private key (pem file) to use |
allocator | memory allocator to use |
+
|
+ +staticnoexcept | +
Sets the builder up for MTLS, using a PKCS#11 library for private key operations.
+NOTE: This only works on Unix devices.
+hostName | - AWS IoT endpoint to connect to |
pkcs11Options | PKCS#11 options |
allocator | memory allocator to use |
+
|
+ +staticnoexcept | +
Sets the builder up for MTLS, using a PKCS#12 file for private key operations.
+NOTE: This only works on MacOS devices.
+hostName | - AWS IoT endpoint to connect to |
options | The PKCS12 options to use. |
allocator | - memory allocator to use |
+
|
+ +staticnoexcept | +
Sets the builder up for Websocket connection.
+hostName | - AWS IoT endpoint to connect to |
config | websocket configuration information |
allocator | memory allocator to use |
+
|
+ +staticnoexcept | +
Sets the builder up for MTLS, using a certificate in a Windows certificate store.
+NOTE: This only works on Windows.
+hostName | - AWS IoT endpoint to connect to |
windowsCertStorePath | Path to certificate in a Windows certificate store. The path must use backslashes and end with the certificate's thumbprint. Example: CurrentUser\MY\A11F8A9B5DF5B98BA3508FBCA575D09570E0D2C6 |
allocator | memory allocator to use |
+
|
+ +inlineexplicitnoexcept | +
+
|
+ +delete | +
+
|
+ +delete | +
+
|
+ +noexcept | +
Sets Operation Timeout(Seconds). Time interval to wait for an ack after sending a QoS 1+ PUBLISH, SUBSCRIBE, or UNSUBSCRIBE before failing the operation.
+ackTimeoutSec |
+
|
+ +noexcept | +
Mqtt5ClientBuilder::WithAckTimeoutSec(uint32_t)
Sets Operation Timeout(Seconds). Time interval to wait for an ack after sending a QoS 1+ PUBLISH, SUBSCRIBE, or UNSUBSCRIBE before failing the operation.
+ackTimeoutSec |
+
|
+ +noexcept | +
Set booststrap for mqtt5 client
+bootStrap | bootstrap used for mqtt5 client. The default ClientBootstrap see Aws::Crt::ApiHandle::GetOrCreateStaticDefaultClientBootstrap. |
+
|
+ +noexcept | +
Sets the certificate authority for the endpoint you're connecting to. This is a path to a file on disk and must be in PEM format.
+caPath | path to the CA file in PEM format |
+
|
+ +noexcept | +
Sets the certificate authority for the endpoint you're connecting to. This is an in-memory buffer and must be in PEM format.
+cert | buffer containing the CA certificate in a PEM format |
+
|
+ +noexcept | +
Setup callback handler trigged when client begins an attempt to connect to the remote endpoint.
+callback |
+
|
+ +noexcept | +
Setup callback trigged when client fails to establish an MQTT connection
+callback |
+
|
+ +noexcept | +
Setup callback trigged when client successfully establishes an MQTT connection
+callback |
+
|
+ +noexcept | +
Setup callback handler trigged when client's current MQTT connection is closed
+callback |
+
|
+ +noexcept | +
Sets client extended validation and flow control, additional controls for client behavior with respect to operation validation and flow control; these checks go beyond the base MQTT5 spec to respect limits of specific MQTT brokers.
+clientExtendedValidationAndFlowControl |
+
|
+ +noexcept | +
Setup callback handler trigged when client reaches the "Stopped" state
+callback |
+
|
+ +noexcept | +
Sets Connack Timeout (ms). Time interval to wait after sending a CONNECT request for a CONNACK to arrive. If one does not arrive, the connection will be shut down.
+connackTimeoutMs |
+
|
+ +noexcept | +
Sets mqtt5 connection options
+packetConnect | package connection options |
+
|
+ +noexcept | +
Sets the custom authorizer settings. This function will modify the username, port, and TLS options.
+Mqtt5ClientBuilder & Aws::Iot::Mqtt5ClientBuilder::WithHostName | +( | +Crt::String | +hostname | ) | ++ |
Sets the host to connect to.
+hostname | endpoint to connect to |
+
|
+ +noexcept | +
Sets http proxy options.
+proxyOptions | http proxy configuration for connection establishment |
+
|
+ +noexcept | +
Sets minConnectedTimeToResetReconnectDelayMs, amount of time that must elapse with an established connection before the reconnect delay is reset to the minimum. This helps alleviate bandwidth-waste in fast reconnect cycles due to permission failures on operations.
+minConnectedTimeToResetReconnectDelayMs |
+
|
+ +noexcept | +
Sets OfflineQueueBehavior, controls how disconnects affect the queued and in-progress operations tracked by the client. Also controls how new operations are handled while the client is not connected. In particular, if the client is not connected, then any operation that would be failed on disconnect (according to these rules) will also be rejected.
+offlineQueueBehavior |
+
|
+ +noexcept | +
Sets ping timeout (ms). Time interval to wait after sending a PINGREQ for a PINGRESP to arrive. If one does not arrive, the client will close the current connection.
+pingTimeoutMs |
+
|
+ +noexcept | +
Set port to connect to
+port | port to connect to |
+
|
+ +noexcept | +
Setup callback handler trigged when an MQTT PUBLISH packet is received by the client
+callback |
+
|
+ +noexcept | +
Sets ReconnectOptions. Reconnect options includes retryJitterMode, min reconnect delay time and max reconnect delay time
+reconnectOptions |
Mqtt5ClientBuilder & Aws::Iot::Mqtt5ClientBuilder::WithSdkName | +( | +const Crt::String & | +sdkName | ) | ++ |
Overrides the default SDK Name to send as a metric in the MQTT CONNECT packet.
+sdkName | string to use as the SDK name parameter in the connection string |
Mqtt5ClientBuilder & Aws::Iot::Mqtt5ClientBuilder::WithSdkVersion | +( | +const Crt::String & | +sdkVersion | ) | ++ |
Overrides the default SDK Version to send as a metric in the MQTT CONNECT packet.
+sdkVersion | string to use as the SDK version parameter in the connection string |
+
|
+ +noexcept | +
Sets session behavior. Overrides how the MQTT5 client should behave with respect to MQTT sessions.
+sessionBehavior | how the MQTT5 client should behave with respect to MQTT sessions. |
+
|
+ +noexcept | +
Sets the topic aliasing behavior that the client should use.
+topicAliasingOptions | topic aliasing behavior options to use |
+ aws-crt-cpp
+
+ C++ wrapper around the aws-c-* libraries. Provides Cross-Platform Transport Protocols and SSL/TLS implementations for C++.
+ |
+
This is the complete list of members for Aws::Iot::Mqtt5CustomAuthConfig, including all inherited members.
+
+ aws-crt-cpp
+
+ C++ wrapper around the aws-c-* libraries. Provides Cross-Platform Transport Protocols and SSL/TLS implementations for C++.
+ |
+
#include <Mqtt5Client.h>
Class encapsulating configuration for establishing an Aws IoT Mqtt5 Connectin with custom authorizer
+
+
|
+ +noexcept | +
Create a custom authorizer configuration
+ +
+
|
+ +virtual | +
Aws::Iot::Mqtt5CustomAuthConfig::Mqtt5CustomAuthConfig | +( | +const Mqtt5CustomAuthConfig & | +rhs | ) | ++ |
+
|
+ +delete | +
const Crt::Optional< Crt::String > & Aws::Iot::Mqtt5CustomAuthConfig::GetAuthorizerName | +( | +) | ++ |
const Crt::Optional< Crt::ByteCursor > & Aws::Iot::Mqtt5CustomAuthConfig::GetPassword | +( | +) | ++ |
const Crt::Optional< Crt::String > & Aws::Iot::Mqtt5CustomAuthConfig::GetTokenKeyName | +( | +) | ++ |
const Crt::Optional< Crt::String > & Aws::Iot::Mqtt5CustomAuthConfig::GetTokenSignature | +( | +) | ++ |
const Crt::Optional< Crt::String > & Aws::Iot::Mqtt5CustomAuthConfig::GetTokenValue | +( | +) | ++ |
const Crt::Optional< Crt::String > & Aws::Iot::Mqtt5CustomAuthConfig::GetUsername | +( | +) | ++ |
Mqtt5CustomAuthConfig & Aws::Iot::Mqtt5CustomAuthConfig::operator= | +( | +const Mqtt5CustomAuthConfig & | +rhs | ) | ++ |
+
|
+ +delete | +
Mqtt5CustomAuthConfig & Aws::Iot::Mqtt5CustomAuthConfig::WithAuthorizerName | +( | +Crt::String | +authName | ) | ++ |
Mqtt5CustomAuthConfig & Aws::Iot::Mqtt5CustomAuthConfig::WithPassword | +( | +Crt::ByteCursor | +password | ) | ++ |
Mqtt5CustomAuthConfig & Aws::Iot::Mqtt5CustomAuthConfig::WithTokenKeyName | +( | +Crt::String | +tokenKeyName | ) | ++ |
Mqtt5CustomAuthConfig & Aws::Iot::Mqtt5CustomAuthConfig::WithTokenSignature | +( | +Crt::String | +tokenSignature | ) | ++ |
Mqtt5CustomAuthConfig & Aws::Iot::Mqtt5CustomAuthConfig::WithTokenValue | +( | +Crt::String | +tokenValue | ) | ++ |
Mqtt5CustomAuthConfig & Aws::Iot::Mqtt5CustomAuthConfig::WithUsername | +( | +Crt::String | +username | ) | ++ |
+ aws-crt-cpp
+
+ C++ wrapper around the aws-c-* libraries. Provides Cross-Platform Transport Protocols and SSL/TLS implementations for C++.
+ |
+
This is the complete list of members for Aws::Iot::MqttClient, including all inherited members.
+LastError() const noexcept | Aws::Iot::MqttClient | inline |
MqttClient(Crt::Io::ClientBootstrap &bootstrap, Crt::Allocator *allocator=Crt::ApiAllocator()) noexcept | Aws::Iot::MqttClient | |
MqttClient(Crt::Allocator *allocator=Crt::ApiAllocator()) noexcept | Aws::Iot::MqttClient | |
NewConnection(const MqttClientConnectionConfig &config) noexcept | Aws::Iot::MqttClient | |
operator bool() const noexcept | Aws::Iot::MqttClient | inlineexplicit |
+ aws-crt-cpp
+
+ C++ wrapper around the aws-c-* libraries. Provides Cross-Platform Transport Protocols and SSL/TLS implementations for C++.
+ |
+
#include <MqttClient.h>
+Public Member Functions | |
MqttClient (Crt::Io::ClientBootstrap &bootstrap, Crt::Allocator *allocator=Crt::ApiAllocator()) noexcept | |
MqttClient (Crt::Allocator *allocator=Crt::ApiAllocator()) noexcept | |
std::shared_ptr< Crt::Mqtt::MqttConnection > | NewConnection (const MqttClientConnectionConfig &config) noexcept |
int | LastError () const noexcept |
operator bool () const noexcept | |
AWS IOT specific Mqtt Client. Sets defaults for using the AWS IOT service. You'll need an instance of MqttClientConnectionConfig to use. Once NewConnection returns, you use it's return value identically to how you would use Aws::Crt::Mqtt::MqttConnection
+
+
|
+ +noexcept | +
+
|
+ +noexcept | +
Constructs a new Mqtt Client object using the static default ClientBootstrap.
+For more information on the default ClientBootstrap see Aws::Crt::ApiHandle::GetOrCreateDefaultClientBootstrap
+ +
+
|
+ +inlinenoexcept | +
+
|
+ +noexcept | +
Creates a new mqtt connection from a connection configuration object
config | mqtt connection configuration |
+
|
+ +inlineexplicitnoexcept | +
+ aws-crt-cpp
+
+ C++ wrapper around the aws-c-* libraries. Provides Cross-Platform Transport Protocols and SSL/TLS implementations for C++.
+ |
+
This is the complete list of members for Aws::Iot::MqttClientConnectionConfig, including all inherited members.
+CreateInvalid(int lastError) noexcept | Aws::Iot::MqttClientConnectionConfig | static |
LastError() const noexcept | Aws::Iot::MqttClientConnectionConfig | inline |
MqttClient class | Aws::Iot::MqttClientConnectionConfig | friend |
MqttClientConnectionConfig(const Crt::String &endpoint, uint32_t port, const Crt::Io::SocketOptions &socketOptions, Crt::Io::TlsContext &&tlsContext) | Aws::Iot::MqttClientConnectionConfig | |
MqttClientConnectionConfig(const Crt::String &endpoint, uint32_t port, const Crt::Io::SocketOptions &socketOptions, Crt::Io::TlsContext &&tlsContext, Crt::Mqtt::OnWebSocketHandshakeIntercept &&interceptor, const Crt::Optional< Crt::Http::HttpClientConnectionProxyOptions > &proxyOptions) | Aws::Iot::MqttClientConnectionConfig | |
MqttClientConnectionConfigBuilder class | Aws::Iot::MqttClientConnectionConfig | friend |
operator bool() const noexcept | Aws::Iot::MqttClientConnectionConfig | inlineexplicit |
+ aws-crt-cpp
+
+ C++ wrapper around the aws-c-* libraries. Provides Cross-Platform Transport Protocols and SSL/TLS implementations for C++.
+ |
+
#include <MqttClient.h>
+Public Member Functions | |
MqttClientConnectionConfig (const Crt::String &endpoint, uint32_t port, const Crt::Io::SocketOptions &socketOptions, Crt::Io::TlsContext &&tlsContext) | |
MqttClientConnectionConfig (const Crt::String &endpoint, uint32_t port, const Crt::Io::SocketOptions &socketOptions, Crt::Io::TlsContext &&tlsContext, Crt::Mqtt::OnWebSocketHandshakeIntercept &&interceptor, const Crt::Optional< Crt::Http::HttpClientConnectionProxyOptions > &proxyOptions) | |
operator bool () const noexcept | |
int | LastError () const noexcept |
+Static Public Member Functions | |
static MqttClientConnectionConfig | CreateInvalid (int lastError) noexcept |
+Friends | |
class | MqttClient |
class | MqttClientConnectionConfigBuilder |
Represents a unique configuration for connecting to a single AWS IoT endpoint. You can use a single instance of this class PER endpoint you want to connect to. This object must live through the lifetime of your connection.
+Aws::Iot::MqttClientConnectionConfig::MqttClientConnectionConfig | +( | +const Crt::String & | +endpoint, | +
+ | + | uint32_t | +port, | +
+ | + | const Crt::Io::SocketOptions & | +socketOptions, | +
+ | + | Crt::Io::TlsContext && | +tlsContext | +
+ | ) | ++ |
Creates a client configuration for use with making new AWS Iot specific MQTT Connections with MTLS.
+endpoint | endpoint to connect to |
port | port to connect to |
socketOptions | socket options to use when establishing the connection |
tlsContext | tls context that should be used for all connections sourced from this config |
Aws::Iot::MqttClientConnectionConfig::MqttClientConnectionConfig | +( | +const Crt::String & | +endpoint, | +
+ | + | uint32_t | +port, | +
+ | + | const Crt::Io::SocketOptions & | +socketOptions, | +
+ | + | Crt::Io::TlsContext && | +tlsContext, | +
+ | + | Crt::Mqtt::OnWebSocketHandshakeIntercept && | +interceptor, | +
+ | + | const Crt::Optional< Crt::Http::HttpClientConnectionProxyOptions > & | +proxyOptions | +
+ | ) | ++ |
Creates a client configuration for use with making new AWS Iot specific MQTT Connections with web sockets. interceptor: a callback invoked during web socket handshake giving you the opportunity to mutate the request for authorization/signing purposes. If not specified, it's assumed you don't need to sign the request. proxyOptions: optional, if you want to use a proxy with websockets, specify the configuration options here.
+If proxy options are used, the tlsContext is applied to the connection to the remote endpoint, NOT the proxy. To make a tls connection to the proxy itself, you'll want to specify tls options in proxyOptions.
+endpoint | endpoint to connect to |
port | port to connect to |
socketOptions | socket options to use when establishing the connection |
tlsContext | tls context that should be used for all connections sourced from this config |
interceptor | websocket upgrade handshake transformation function |
proxyOptions | proxy configuration options |
+
|
+ +staticnoexcept | +
+
|
+ +inlinenoexcept | +
+
|
+ +inlineexplicitnoexcept | +
+
|
+ +friend | +
+
|
+ +friend | +
+ aws-crt-cpp
+
+ C++ wrapper around the aws-c-* libraries. Provides Cross-Platform Transport Protocols and SSL/TLS implementations for C++.
+ |
+
This is the complete list of members for Aws::Iot::MqttClientConnectionConfigBuilder, including all inherited members.
+
+ aws-crt-cpp
+
+ C++ wrapper around the aws-c-* libraries. Provides Cross-Platform Transport Protocols and SSL/TLS implementations for C++.
+ |
+
#include <MqttClient.h>
+Static Public Member Functions | |
static MqttClientConnectionConfigBuilder | NewDefaultBuilder () noexcept |
Represents configuration parameters for building a MqttClientConnectionConfig object. You can use a single instance of this class PER MqttClientConnectionConfig you want to generate. If you want to generate a config for a different endpoint or port etc... you need a new instance of this class.
+Aws::Iot::MqttClientConnectionConfigBuilder::MqttClientConnectionConfigBuilder | +( | +) | ++ |
+
|
+ +noexcept | +
Sets the builder up for MTLS using certPath and pkeyPath. These are files on disk and must be in the PEM format.
+certPath | path to the X509 certificate (pem file) to use |
pkeyPath | path to the private key (pem file) to use |
allocator | memory allocator to use |
+
|
+ +noexcept | +
Sets the builder up for MTLS using cert and pkey. These are in-memory buffers and must be in the PEM format.
+cert | buffer containing the X509 certificate in a PEM format |
pkey | buffer containing the private key in a PEM format |
allocator | memory allocator to use |
+
|
+ +noexcept | +
Sets the builder up for MTLS, using a PKCS#11 library for private key operations.
+NOTE: This only works on Unix devices.
+pkcs11Options | PKCS#11 options |
allocator | memory allocator to use |
+
|
+ +noexcept | +
Sets the builder up for MTLS using a PKCS12 file and password. These are files on disk and must be in the PEM format.
+NOTE: This only works on MacOS devices.
+options | The PKCS12 options to use. Has to contain a PKCS12 filepath and password. |
allocator | memory allocator to use |
+
|
+ +noexcept | +
Sets the builder up for MTLS, using a certificate in a Windows certificate store.
+NOTE: This only works on Windows.
+windowsCertStorePath | Path to certificate in a Windows certificate store. The path must use backslashes and end with the certificate's thumbprint. Example: CurrentUser\MY\A11F8A9B5DF5B98BA3508FBCA575D09570E0D2C6 |
allocator | memory allocator to use |
+
|
+ +noexcept | +
Sets the builder up for Websocket connection.
+config | websocket configuration information |
allocator | memory allocator to use |
+
|
+ +noexcept | +
Builds a client configuration object from the set options.
+
+
|
+ +inlinenoexcept | +
+
|
+ +staticnoexcept | +
Creates a new builder with default Tls options. This requires setting the connection details manually.
+
+
|
+ +inlineexplicitnoexcept | +
+
|
+ +noexcept | +
Sets the certificate authority for the endpoint you're connecting to. This is a path to a file on disk and must be in PEM format.
+caPath | path to the CA file in PEM format |
+
|
+ +noexcept | +
Sets the certificate authority for the endpoint you're connecting to. This is an in-memory buffer and must be in PEM format.
+cert | buffer containing the CA certificate in a PEM format |
+
|
+ +noexcept | +
Sets the custom authorizer settings. This function will modify the username, port, and TLS options.
+username | The username to use with the custom authorizer. If an empty string is passed, it will check to see if a username has already been set (via WithUsername function). If no username is set then no username will be passed with the MQTT connection. |
authorizerName | The name of the custom authorizer. If an empty string is passed, then 'x-amz-customauthorizer-name' will not be added with the MQTT connection. |
authorizerSignature | The signature of the custom authorizer. NOTE: This will NOT work without the token key name and token value, which requires using the non-depreciated API. |
password | The password to use with the custom authorizer. If null is passed, then no password will be set. |
tokenKeyName
and tokenValue
. This version is left for backwards compatibility purposes.
+
|
+ +noexcept | +
Sets the custom authorizer settings. This function will modify the username, port, and TLS options.
+username | The username to use with the custom authorizer. If an empty string is passed, it will check to see if a username has already been set (via WithUsername function). If no username is set then no username will be passed with the MQTT connection. |
authorizerName | The name of the custom authorizer. If an empty string is passed, then 'x-amz-customauthorizer-name' will not be added with the MQTT connection. |
authorizerSignature | The signature of the custom authorizer. If an empty string is passed, then 'x-amz-customauthorizer-signature' will not be added with the MQTT connection. The signature must be based on the private key associated with the custom authorizer. The signature must be base64 encoded. |
password | The password to use with the custom authorizer. If null is passed, then no password will be set. |
tokenKeyName | Used to extract the custom authorizer token from MQTT username query-string properties. Required if the custom authorizer has signing enabled. It is strongly suggested to URL encode this value; the SDK will not do so for you. |
tokenValue | An opaque token value. Required if the custom authorizer has signing enabled. This value must be signed by the private key associated with the custom authorizer and the result placed in the authorizerSignature argument. |
MqttClientConnectionConfigBuilder & Aws::Iot::MqttClientConnectionConfigBuilder::WithEndpoint | +( | +const Crt::String & | +endpoint | ) | ++ |
Sets endpoint to connect to.
+endpoint | endpoint to connect to |
MqttClientConnectionConfigBuilder & Aws::Iot::MqttClientConnectionConfigBuilder::WithEndpoint | +( | +Crt::String && | +endpoint | ) | ++ |
Sets endpoint to connect to.
+endpoint | endpoint to connect to |
+
|
+ +noexcept | +
Sets http proxy options.
+proxyOptions | proxy configuration options for connection establishment |
MqttClientConnectionConfigBuilder & Aws::Iot::MqttClientConnectionConfigBuilder::WithMetricsCollection | +( | +bool | +enabled | ) | ++ |
Whether to send the SDK name and version number in the MQTT CONNECT packet. Default is True.
+enabled | true to send SDK version/name in the connect for metrics gathering purposes |
+
|
+ +noexcept | +
Sets the minimum tls version that is acceptable for connection establishment
+minimumTlsVersion | minimum tls version allowed in client connections |
+
|
+ +noexcept | +
Sets password for the connection
+password | the password that will be passed with the MQTT connection |
+
|
+ +noexcept | +
Overrides the default port. By default, if ALPN is supported, 443 will be used. Otherwise 8883 will be used. If you specify 443 and ALPN is not supported, we will still attempt to connect over 443 without ALPN.
+port | port to connect to |
MqttClientConnectionConfigBuilder & Aws::Iot::MqttClientConnectionConfigBuilder::WithSdkName | +( | +const Crt::String & | +sdkName | ) | ++ |
Overrides the default SDK Name to send as a metric in the MQTT CONNECT packet.
+sdkName | string to use as the SDK name parameter in the connection string |
MqttClientConnectionConfigBuilder & Aws::Iot::MqttClientConnectionConfigBuilder::WithSdkVersion | +( | +const Crt::String & | +sdkVersion | ) | ++ |
Overrides the default SDK Version to send as a metric in the MQTT CONNECT packet.
+sdkVersion | string to use as the SDK version parameter in the connection string |
+
|
+ +noexcept | +
TCP option: Sets the connect timeout. Defaults to 3 seconds.
+connectTimeoutMs | socket connection timeout |
+
|
+ +noexcept | +
TCP option: Enables TCP keep alive. Defaults to off.
+
+
|
+ +noexcept | +
TCP option: Sets the frequency of sending keep alive probes in seconds once the keep alive timeout expires. Defaults to kernel defaults.
+keepAliveIntervalSecs | the frequency of sending keep alive probes in seconds once the keep alive timeout expires |
+
|
+ +noexcept | +
TCP option: Sets the amount of keep alive probes allowed to fail before the connection is terminated. Defaults to kernel defaults.
+maxProbes | the amount of keep alive probes allowed to fail before the connection is terminated |
+
|
+ +noexcept | +
TCP option: Sets time before keep alive probes are sent. Defaults to kernel defaults
+keepAliveTimeoutSecs | time interval of no activity, in seconds, before keep alive probes get sent |
+
|
+ +noexcept | +
Sets username for the connection
+username | the username that will be passed with the MQTT connection |
+ aws-crt-cpp
+
+ C++ wrapper around the aws-c-* libraries. Provides Cross-Platform Transport Protocols and SSL/TLS implementations for C++.
+ |
+
+ aws-crt-cpp
+
+ C++ wrapper around the aws-c-* libraries. Provides Cross-Platform Transport Protocols and SSL/TLS implementations for C++.
+ |
+
#include <aws/crt/http/HttpConnection.h>
#include <aws/crt/mqtt/Mqtt5Types.h>
#include <aws/crt/mqtt/MqttClient.h>
Go to the source code of this file.
++Classes | |
struct | Aws::Crt::Mqtt5::TopicAliasingOptions |
struct | Aws::Crt::Mqtt5::ReconnectOptions |
struct | Aws::Crt::Mqtt5::Mqtt5ClientOperationStatistics |
struct | Aws::Crt::Mqtt5::OnAttemptingConnectEventData |
struct | Aws::Crt::Mqtt5::OnConnectionFailureEventData |
struct | Aws::Crt::Mqtt5::OnConnectionSuccessEventData |
struct | Aws::Crt::Mqtt5::OnDisconnectionEventData |
struct | Aws::Crt::Mqtt5::OnStoppedEventData |
struct | Aws::Crt::Mqtt5::PublishReceivedEventData |
class | Aws::Crt::Mqtt5::Mqtt5Client |
class | Aws::Crt::Mqtt5::Mqtt5ClientOptions |
+Namespaces | |
Aws | |
Aws::Crt | |
Aws::Crt::Mqtt5 | |
+Typedefs | |
using | Aws::Crt::Mqtt5::OnConnectionSuccessHandler = std::function< void(const OnConnectionSuccessEventData &)> |
using | Aws::Crt::Mqtt5::OnConnectionFailureHandler = std::function< void(const OnConnectionFailureEventData &)> |
using | Aws::Crt::Mqtt5::OnDisconnectionHandler = std::function< void(const OnDisconnectionEventData &)> |
using | Aws::Crt::Mqtt5::OnAttemptingConnectHandler = std::function< void(const OnAttemptingConnectEventData &)> |
using | Aws::Crt::Mqtt5::OnStoppedHandler = std::function< void(const OnStoppedEventData &)> |
using | Aws::Crt::Mqtt5::OnPublishCompletionHandler = std::function< void(int, std::shared_ptr< PublishResult >)> |
using | Aws::Crt::Mqtt5::OnSubscribeCompletionHandler = std::function< void(int, std::shared_ptr< SubAckPacket >)> |
using | Aws::Crt::Mqtt5::OnUnsubscribeCompletionHandler = std::function< void(int, std::shared_ptr< UnSubAckPacket >)> |
using | Aws::Crt::Mqtt5::OnPublishReceivedHandler = std::function< void(const PublishReceivedEventData &)> |
using | Aws::Crt::Mqtt5::OnWebSocketHandshakeInterceptComplete = std::function< void(const std::shared_ptr< Http::HttpRequest > &, int)> |
using | Aws::Crt::Mqtt5::OnWebSocketHandshakeIntercept = std::function< void(std::shared_ptr< Http::HttpRequest >, const OnWebSocketHandshakeInterceptComplete &)> |
+Enumerations | |
enum class | Aws::Crt::Mqtt5::OutboundTopicAliasBehaviorType { Aws::Crt::Mqtt5::Default = AWS_MQTT5_COTABT_DEFAULT +, Aws::Crt::Mqtt5::Manual = AWS_MQTT5_COTABT_MANUAL +, Aws::Crt::Mqtt5::LRU = AWS_MQTT5_COTABT_LRU +, Aws::Crt::Mqtt5::Disabled = AWS_MQTT5_COTABT_DISABLED + } |
enum class | Aws::Crt::Mqtt5::InboundTopicAliasBehaviorType { Aws::Crt::Mqtt5::Default = AWS_MQTT5_CITABT_DEFAULT +, Aws::Crt::Mqtt5::Enabled = AWS_MQTT5_CITABT_ENABLED +, Aws::Crt::Mqtt5::Disabled = AWS_MQTT5_CITABT_DISABLED + } |
+ aws-crt-cpp
+
+ C++ wrapper around the aws-c-* libraries. Provides Cross-Platform Transport Protocols and SSL/TLS implementations for C++.
+ |
+
+ aws-crt-cpp
+
+ C++ wrapper around the aws-c-* libraries. Provides Cross-Platform Transport Protocols and SSL/TLS implementations for C++.
+ |
+
#include <aws/crt/Exports.h>
#include <aws/crt/StlAllocator.h>
#include <aws/crt/Types.h>
#include <aws/crt/http/HttpConnection.h>
#include <aws/crt/io/SocketOptions.h>
#include <aws/crt/io/TlsOptions.h>
#include <aws/crt/mqtt/MqttConnection.h>
#include <aws/mqtt/client.h>
#include <aws/mqtt/v5/mqtt5_client.h>
#include <atomic>
#include <functional>
#include <memory>
Go to the source code of this file.
++Classes | |
class | Aws::Crt::Mqtt::MqttClient |
+Namespaces | |
Aws | |
Aws::Crt | |
Aws::Crt::Io | |
Aws::Crt::Http | |
Aws::Crt::Mqtt5 | |
Aws::Crt::Mqtt | |
+ aws-crt-cpp
+
+ C++ wrapper around the aws-c-* libraries. Provides Cross-Platform Transport Protocols and SSL/TLS implementations for C++.
+ |
+
+ aws-crt-cpp
+
+ C++ wrapper around the aws-c-* libraries. Provides Cross-Platform Transport Protocols and SSL/TLS implementations for C++.
+ |
+
ConnAckPacket::getServerKeepAliveSec()
. Server-requested override of the keep alive interval, in seconds. If null, the keep alive value sent by the client should be used. ConnAckPacket::getSessionExpiryIntervalSec()
. ConnectPacket::getMaximumPacketSizeToServer()
Mqtt5ClientOptions::WithAckTimeoutSec(uint32_t)
NegotiatedSettings::getMaximumPacketSizeToServer()
NegotiatedSettings::getServerKeepAliveSec()
Subscription::WithRetainAsPublished(bool)
. Mqtt5ClientBuilder::WithAckTimeoutSec(uint32_t)
tokenKeyName
and tokenValue
. This version is left for backwards compatibility purposes.
+ aws-crt-cpp
+
+ C++ wrapper around the aws-c-* libraries. Provides Cross-Platform Transport Protocols and SSL/TLS implementations for C++.
+ |
+
+Files | |
file | Mqtt5Client.cpp |
file | Mqtt5ClientCore.cpp |
file | Mqtt5Packets.cpp |
file | MqttClient.cpp |
file | MqttConnection.cpp |
file | MqttConnectionCore.cpp |
+ aws-crt-cpp
+
+ C++ wrapper around the aws-c-* libraries. Provides Cross-Platform Transport Protocols and SSL/TLS implementations for C++.
+ |
+
+ aws-crt-cpp
+
+ C++ wrapper around the aws-c-* libraries. Provides Cross-Platform Transport Protocols and SSL/TLS implementations for C++.
+ |
+
+Files | |
file | RuleEngine.h [code] |
+ aws-crt-cpp
+
+ C++ wrapper around the aws-c-* libraries. Provides Cross-Platform Transport Protocols and SSL/TLS implementations for C++.
+ |
+
+Files | |
file | Credentials.h [code] |
file | Signing.h [code] |
file | Sigv4Signing.h [code] |
+ aws-crt-cpp
+
+ C++ wrapper around the aws-c-* libraries. Provides Cross-Platform Transport Protocols and SSL/TLS implementations for C++.
+ |
+
+ aws-crt-cpp
+
+ C++ wrapper around the aws-c-* libraries. Provides Cross-Platform Transport Protocols and SSL/TLS implementations for C++.
+ |
+
+ aws-crt-cpp
+
+ C++ wrapper around the aws-c-* libraries. Provides Cross-Platform Transport Protocols and SSL/TLS implementations for C++.
+ |
+
+Files | |
file | Mqtt5ClientCore.h [code] |
file | MqttConnectionCore.h [code] |
+ aws-crt-cpp
+
+ C++ wrapper around the aws-c-* libraries. Provides Cross-Platform Transport Protocols and SSL/TLS implementations for C++.
+ |
+
+Directories | |
directory | private |
+Files | |
file | Mqtt5Client.h [code] |
file | Mqtt5Packets.h [code] |
file | Mqtt5Types.h [code] |
file | MqttClient.h [code] |
file | MqttConnection.h [code] |
file | MqttTypes.h [code] |
+ aws-crt-cpp
+
+ C++ wrapper around the aws-c-* libraries. Provides Cross-Platform Transport Protocols and SSL/TLS implementations for C++.
+ |
+
+Files | |
file | RuleEngine.cpp |
+ aws-crt-cpp
+
+ C++ wrapper around the aws-c-* libraries. Provides Cross-Platform Transport Protocols and SSL/TLS implementations for C++.
+ |
+
+Files | |
file | Bootstrap.cpp |
file | ChannelHandler.cpp |
file | EventLoopGroup.cpp |
file | HostResolver.cpp |
file | Pkcs11.cpp |
file | SocketOptions.cpp |
file | Stream.cpp |
file | TlsOptions.cpp |
file | Uri.cpp |
+ aws-crt-cpp
+
+ C++ wrapper around the aws-c-* libraries. Provides Cross-Platform Transport Protocols and SSL/TLS implementations for C++.
+ |
+
+Files | |
file | Credentials.cpp |
file | Sigv4Signing.cpp |
+ aws-crt-cpp
+
+ C++ wrapper around the aws-c-* libraries. Provides Cross-Platform Transport Protocols and SSL/TLS implementations for C++.
+ |
+
+Directories | |
directory | auth |
directory | crypto |
directory | endpoints |
directory | http |
directory | io |
directory | iot |
directory | mqtt |
+Files | |
file | Allocator.cpp |
file | Api.cpp |
file | DateTime.cpp |
file | ImdsClient.cpp |
file | JsonObject.cpp |
file | StringUtils.cpp |
file | Types.cpp |
file | UUID.cpp |
+ aws-crt-cpp
+
+ C++ wrapper around the aws-c-* libraries. Provides Cross-Platform Transport Protocols and SSL/TLS implementations for C++.
+ |
+
+Files | |
file | Mqtt5Client.cpp |
file | MqttClient.cpp |
file | MqttCommon.cpp |
+ aws-crt-cpp
+
+ C++ wrapper around the aws-c-* libraries. Provides Cross-Platform Transport Protocols and SSL/TLS implementations for C++.
+ |
+
+Files | |
file | Mqtt5Client.h [code] |
file | MqttClient.h [code] |
file | MqttCommon.h [code] |
+ aws-crt-cpp
+
+ C++ wrapper around the aws-c-* libraries. Provides Cross-Platform Transport Protocols and SSL/TLS implementations for C++.
+ |
+
+Files | |
file | Bootstrap.h [code] |
file | ChannelHandler.h [code] |
file | EventLoopGroup.h [code] |
file | HostResolver.h [code] |
file | Pkcs11.h [code] |
file | SocketOptions.h [code] |
file | Stream.h [code] |
file | TlsOptions.h [code] |
file | Uri.h [code] |
+ aws-crt-cpp
+
+ C++ wrapper around the aws-c-* libraries. Provides Cross-Platform Transport Protocols and SSL/TLS implementations for C++.
+ |
+
+Files | |
file | HttpConnection.cpp |
file | HttpConnectionManager.cpp |
file | HttpProxyStrategy.cpp |
file | HttpRequestResponse.cpp |
+ aws-crt-cpp
+
+ C++ wrapper around the aws-c-* libraries. Provides Cross-Platform Transport Protocols and SSL/TLS implementations for C++.
+ |
+
+ aws-crt-cpp
+
+ C++ wrapper around the aws-c-* libraries. Provides Cross-Platform Transport Protocols and SSL/TLS implementations for C++.
+ |
+
+Directories | |
directory | auth |
directory | crypto |
directory | endpoints |
directory | http |
directory | io |
directory | mqtt |
+Files | |
file | Allocator.h [code] |
file | Api.h [code] |
file | DateTime.h [code] |
file | Exports.h [code] |
file | ImdsClient.h [code] |
file | JsonObject.h [code] |
file | Optional.h [code] |
file | RefCounted.h [code] |
file | StlAllocator.h [code] |
file | StringUtils.h [code] |
file | StringView.h [code] |
file | Types.h [code] |
file | UUID.h [code] |
+ aws-crt-cpp
+
+ C++ wrapper around the aws-c-* libraries. Provides Cross-Platform Transport Protocols and SSL/TLS implementations for C++.
+ |
+
+Directories | |
directory | aws |
+ aws-crt-cpp
+
+ C++ wrapper around the aws-c-* libraries. Provides Cross-Platform Transport Protocols and SSL/TLS implementations for C++.
+ |
+
+Files | |
file | HttpConnection.h [code] |
file | HttpConnectionManager.h [code] |
file | HttpProxyStrategy.h [code] |
file | HttpRequestResponse.h [code] |
+ aws-crt-cpp
+
+ C++ wrapper around the aws-c-* libraries. Provides Cross-Platform Transport Protocols and SSL/TLS implementations for C++.
+ |
+
+ aws-crt-cpp
+
+ C++ wrapper around the aws-c-* libraries. Provides Cross-Platform Transport Protocols and SSL/TLS implementations for C++.
+ |
+
+ aws-crt-cpp
+
+ C++ wrapper around the aws-c-* libraries. Provides Cross-Platform Transport Protocols and SSL/TLS implementations for C++.
+ |
+
+ aws-crt-cpp
+
+ C++ wrapper around the aws-c-* libraries. Provides Cross-Platform Transport Protocols and SSL/TLS implementations for C++.
+ |
+
+ aws-crt-cpp
+
+ C++ wrapper around the aws-c-* libraries. Provides Cross-Platform Transport Protocols and SSL/TLS implementations for C++.
+ |
+
+ aws-crt-cpp
+
+ C++ wrapper around the aws-c-* libraries. Provides Cross-Platform Transport Protocols and SSL/TLS implementations for C++.
+ |
+
+ aws-crt-cpp
+
+ C++ wrapper around the aws-c-* libraries. Provides Cross-Platform Transport Protocols and SSL/TLS implementations for C++.
+ |
+
+ aws-crt-cpp
+
+ C++ wrapper around the aws-c-* libraries. Provides Cross-Platform Transport Protocols and SSL/TLS implementations for C++.
+ |
+
+ aws-crt-cpp
+
+ C++ wrapper around the aws-c-* libraries. Provides Cross-Platform Transport Protocols and SSL/TLS implementations for C++.
+ |
+
+ aws-crt-cpp
+
+ C++ wrapper around the aws-c-* libraries. Provides Cross-Platform Transport Protocols and SSL/TLS implementations for C++.
+ |
+
+ aws-crt-cpp
+
+ C++ wrapper around the aws-c-* libraries. Provides Cross-Platform Transport Protocols and SSL/TLS implementations for C++.
+ |
+
+ aws-crt-cpp
+
+ C++ wrapper around the aws-c-* libraries. Provides Cross-Platform Transport Protocols and SSL/TLS implementations for C++.
+ |
+
+ aws-crt-cpp
+
+ C++ wrapper around the aws-c-* libraries. Provides Cross-Platform Transport Protocols and SSL/TLS implementations for C++.
+ |
+
+ aws-crt-cpp
+
+ C++ wrapper around the aws-c-* libraries. Provides Cross-Platform Transport Protocols and SSL/TLS implementations for C++.
+ |
+
+ aws-crt-cpp
+
+ C++ wrapper around the aws-c-* libraries. Provides Cross-Platform Transport Protocols and SSL/TLS implementations for C++.
+ |
+
+ aws-crt-cpp
+
+ C++ wrapper around the aws-c-* libraries. Provides Cross-Platform Transport Protocols and SSL/TLS implementations for C++.
+ |
+
+ aws-crt-cpp
+
+ C++ wrapper around the aws-c-* libraries. Provides Cross-Platform Transport Protocols and SSL/TLS implementations for C++.
+ |
+
+ aws-crt-cpp
+
+ C++ wrapper around the aws-c-* libraries. Provides Cross-Platform Transport Protocols and SSL/TLS implementations for C++.
+ |
+
+ aws-crt-cpp
+
+ C++ wrapper around the aws-c-* libraries. Provides Cross-Platform Transport Protocols and SSL/TLS implementations for C++.
+ |
+
+ aws-crt-cpp
+
+ C++ wrapper around the aws-c-* libraries. Provides Cross-Platform Transport Protocols and SSL/TLS implementations for C++.
+ |
+
+ aws-crt-cpp
+
+ C++ wrapper around the aws-c-* libraries. Provides Cross-Platform Transport Protocols and SSL/TLS implementations for C++.
+ |
+
+ aws-crt-cpp
+
+ C++ wrapper around the aws-c-* libraries. Provides Cross-Platform Transport Protocols and SSL/TLS implementations for C++.
+ |
+
+ aws-crt-cpp
+
+ C++ wrapper around the aws-c-* libraries. Provides Cross-Platform Transport Protocols and SSL/TLS implementations for C++.
+ |
+
+ aws-crt-cpp
+
+ C++ wrapper around the aws-c-* libraries. Provides Cross-Platform Transport Protocols and SSL/TLS implementations for C++.
+ |
+
+ aws-crt-cpp
+
+ C++ wrapper around the aws-c-* libraries. Provides Cross-Platform Transport Protocols and SSL/TLS implementations for C++.
+ |
+
+ aws-crt-cpp
+
+ C++ wrapper around the aws-c-* libraries. Provides Cross-Platform Transport Protocols and SSL/TLS implementations for C++.
+ |
+
+ aws-crt-cpp
+
+ C++ wrapper around the aws-c-* libraries. Provides Cross-Platform Transport Protocols and SSL/TLS implementations for C++.
+ |
+
+ aws-crt-cpp
+
+ C++ wrapper around the aws-c-* libraries. Provides Cross-Platform Transport Protocols and SSL/TLS implementations for C++.
+ |
+
+ aws-crt-cpp
+
+ C++ wrapper around the aws-c-* libraries. Provides Cross-Platform Transport Protocols and SSL/TLS implementations for C++.
+ |
+
+ aws-crt-cpp
+
+ C++ wrapper around the aws-c-* libraries. Provides Cross-Platform Transport Protocols and SSL/TLS implementations for C++.
+ |
+
+ aws-crt-cpp
+
+ C++ wrapper around the aws-c-* libraries. Provides Cross-Platform Transport Protocols and SSL/TLS implementations for C++.
+ |
+
+ aws-crt-cpp
+
+ C++ wrapper around the aws-c-* libraries. Provides Cross-Platform Transport Protocols and SSL/TLS implementations for C++.
+ |
+
+ aws-crt-cpp
+
+ C++ wrapper around the aws-c-* libraries. Provides Cross-Platform Transport Protocols and SSL/TLS implementations for C++.
+ |
+
+ aws-crt-cpp
+
+ C++ wrapper around the aws-c-* libraries. Provides Cross-Platform Transport Protocols and SSL/TLS implementations for C++.
+ |
+
+ aws-crt-cpp
+
+ C++ wrapper around the aws-c-* libraries. Provides Cross-Platform Transport Protocols and SSL/TLS implementations for C++.
+ |
+
+ aws-crt-cpp
+
+ C++ wrapper around the aws-c-* libraries. Provides Cross-Platform Transport Protocols and SSL/TLS implementations for C++.
+ |
+
+ aws-crt-cpp
+
+ C++ wrapper around the aws-c-* libraries. Provides Cross-Platform Transport Protocols and SSL/TLS implementations for C++.
+ |
+
+ aws-crt-cpp
+
+ C++ wrapper around the aws-c-* libraries. Provides Cross-Platform Transport Protocols and SSL/TLS implementations for C++.
+ |
+
+ aws-crt-cpp
+
+ C++ wrapper around the aws-c-* libraries. Provides Cross-Platform Transport Protocols and SSL/TLS implementations for C++.
+ |
+
+ aws-crt-cpp
+
+ C++ wrapper around the aws-c-* libraries. Provides Cross-Platform Transport Protocols and SSL/TLS implementations for C++.
+ |
+
+ aws-crt-cpp
+
+ C++ wrapper around the aws-c-* libraries. Provides Cross-Platform Transport Protocols and SSL/TLS implementations for C++.
+ |
+
+ aws-crt-cpp
+
+ C++ wrapper around the aws-c-* libraries. Provides Cross-Platform Transport Protocols and SSL/TLS implementations for C++.
+ |
+
+ aws-crt-cpp
+
+ C++ wrapper around the aws-c-* libraries. Provides Cross-Platform Transport Protocols and SSL/TLS implementations for C++.
+ |
+
+ aws-crt-cpp
+
+ C++ wrapper around the aws-c-* libraries. Provides Cross-Platform Transport Protocols and SSL/TLS implementations for C++.
+ |
+
+ aws-crt-cpp
+
+ C++ wrapper around the aws-c-* libraries. Provides Cross-Platform Transport Protocols and SSL/TLS implementations for C++.
+ |
+
+ aws-crt-cpp
+
+ C++ wrapper around the aws-c-* libraries. Provides Cross-Platform Transport Protocols and SSL/TLS implementations for C++.
+ |
+
+ aws-crt-cpp
+
+ C++ wrapper around the aws-c-* libraries. Provides Cross-Platform Transport Protocols and SSL/TLS implementations for C++.
+ |
+
+ aws-crt-cpp
+
+ C++ wrapper around the aws-c-* libraries. Provides Cross-Platform Transport Protocols and SSL/TLS implementations for C++.
+ |
+
+ aws-crt-cpp
+
+ C++ wrapper around the aws-c-* libraries. Provides Cross-Platform Transport Protocols and SSL/TLS implementations for C++.
+ |
+
+ aws-crt-cpp
+
+ C++ wrapper around the aws-c-* libraries. Provides Cross-Platform Transport Protocols and SSL/TLS implementations for C++.
+ |
+
+ aws-crt-cpp
+
+ C++ wrapper around the aws-c-* libraries. Provides Cross-Platform Transport Protocols and SSL/TLS implementations for C++.
+ |
+
+ aws-crt-cpp
+
+ C++ wrapper around the aws-c-* libraries. Provides Cross-Platform Transport Protocols and SSL/TLS implementations for C++.
+ |
+
+ aws-crt-cpp
+
+ C++ wrapper around the aws-c-* libraries. Provides Cross-Platform Transport Protocols and SSL/TLS implementations for C++.
+ |
+
+ aws-crt-cpp
+
+ C++ wrapper around the aws-c-* libraries. Provides Cross-Platform Transport Protocols and SSL/TLS implementations for C++.
+ |
+
+ aws-crt-cpp
+
+ C++ wrapper around the aws-c-* libraries. Provides Cross-Platform Transport Protocols and SSL/TLS implementations for C++.
+ |
+
+ aws-crt-cpp
+
+ C++ wrapper around the aws-c-* libraries. Provides Cross-Platform Transport Protocols and SSL/TLS implementations for C++.
+ |
+
+ aws-crt-cpp
+
+ C++ wrapper around the aws-c-* libraries. Provides Cross-Platform Transport Protocols and SSL/TLS implementations for C++.
+ |
+
#include <aws/crt/Api.h>
#include <aws/crt/auth/Credentials.h>
#include <aws/crt/auth/Sigv4Signing.h>
#include <aws/crt/http/HttpRequestResponse.h>
#include <aws/crt/io/Uri.h>
#include <aws/crt/mqtt/Mqtt5Packets.h>
#include <aws/iot/Mqtt5Client.h>
+Namespaces | |
Aws | |
Aws::Iot | |
+Functions | |
static Crt::String | Aws::Iot::AddToUsernameParameter (Crt::String currentUsername, Crt::String parameterValue, Crt::String parameterPreText) |
static bool | Aws::Iot::buildMqtt5FinalUsername (Crt::Optional< Mqtt5CustomAuthConfig > customAuthConfig, Crt::String &username) |
+ aws-crt-cpp
+
+ C++ wrapper around the aws-c-* libraries. Provides Cross-Platform Transport Protocols and SSL/TLS implementations for C++.
+ |
+
#include <aws/crt/Config.h>
#include <aws/crt/Exports.h>
#include <aws/crt/auth/Sigv4Signing.h>
#include <aws/crt/mqtt/Mqtt5Client.h>
#include <aws/iot/MqttCommon.h>
Go to the source code of this file.
++Classes | |
class | Aws::Iot::Mqtt5CustomAuthConfig |
class | Aws::Iot::Mqtt5ClientBuilder |
+Namespaces | |
Aws | |
Aws::Io | |
Aws::Iot | |
+ aws-crt-cpp
+
+ C++ wrapper around the aws-c-* libraries. Provides Cross-Platform Transport Protocols and SSL/TLS implementations for C++.
+ |
+
+ aws-crt-cpp
+
+ C++ wrapper around the aws-c-* libraries. Provides Cross-Platform Transport Protocols and SSL/TLS implementations for C++.
+ |
+
#include <aws/iot/MqttClient.h>
#include <aws/crt/Api.h>
#include <aws/crt/auth/Credentials.h>
#include <aws/crt/auth/Sigv4Signing.h>
#include <aws/crt/http/HttpRequestResponse.h>
#include <aws/crt/io/Uri.h>
+Namespaces | |
Aws | |
Aws::Iot | |
+ aws-crt-cpp
+
+ C++ wrapper around the aws-c-* libraries. Provides Cross-Platform Transport Protocols and SSL/TLS implementations for C++.
+ |
+
#include <aws/crt/Config.h>
#include <aws/crt/Exports.h>
#include <aws/crt/auth/Sigv4Signing.h>
#include <aws/crt/mqtt/MqttConnection.h>
#include <aws/iot/MqttCommon.h>
Go to the source code of this file.
++Classes | |
class | Aws::Iot::MqttClientConnectionConfig |
class | Aws::Iot::MqttClientConnectionConfigBuilder |
class | Aws::Iot::MqttClient |
+Namespaces | |
Aws | |
Aws::Iot | |
+ aws-crt-cpp
+
+ C++ wrapper around the aws-c-* libraries. Provides Cross-Platform Transport Protocols and SSL/TLS implementations for C++.
+ |
+
+ aws-crt-cpp
+
+ C++ wrapper around the aws-c-* libraries. Provides Cross-Platform Transport Protocols and SSL/TLS implementations for C++.
+ |
+
#include <aws/crt/mqtt/Mqtt5Client.h>
#include <aws/crt/mqtt/Mqtt5Packets.h>
#include <aws/crt/mqtt/private/Mqtt5ClientCore.h>
#include <aws/crt/Api.h>
#include <aws/crt/StlAllocator.h>
#include <aws/crt/http/HttpProxyStrategy.h>
#include <aws/crt/http/HttpRequestResponse.h>
#include <aws/crt/io/Bootstrap.h>
#include <aws/iot/MqttClient.h>
#include <utility>
+Namespaces | |
Aws | |
Aws::Crt | |
Aws::Crt::Mqtt5 | |