diff --git a/docs/.nojekyll b/docs/.nojekyll
new file mode 100644
index 000000000..e69de29bb
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: source/Allocator.cpp File Reference
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ aws-crt-cpp
+
+ C++ wrapper around the aws-c-* libraries. Provides Cross-Platform Transport Protocols and SSL/TLS implementations for C++.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/docs/_allocator_8h.html b/docs/_allocator_8h.html
new file mode 100644
index 000000000..770fb5ce7
--- /dev/null
+++ b/docs/_allocator_8h.html
@@ -0,0 +1,115 @@
+
+
+
+
+
+
+
+aws-crt-cpp: include/aws/crt/Allocator.h File Reference
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ 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 >
+
+
Go to the source code of this file.
+
+
+
+
+
+
diff --git a/docs/_allocator_8h_source.html b/docs/_allocator_8h_source.html
new file mode 100644
index 000000000..b061390f4
--- /dev/null
+++ b/docs/_allocator_8h_source.html
@@ -0,0 +1,107 @@
+
+
+
+
+
+
+
+aws-crt-cpp: include/aws/crt/Allocator.h Source File
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ aws-crt-cpp
+
+ C++ wrapper around the aws-c-* libraries. Provides Cross-Platform Transport Protocols and SSL/TLS implementations for C++.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
Go to the documentation of this file.
+
7 #include <aws/common/common.h>
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
#define AWS_CRT_CPP_API
Definition: Exports.h:37
+
aws_allocator Allocator
Definition: Allocator.h:14
+
AWS_CRT_CPP_API Allocator * ApiAllocator() noexcept
Definition: Allocator.cpp:24
+
AWS_CRT_CPP_API Allocator * DefaultAllocator() noexcept
Definition: Allocator.cpp:17
+
AWS_CRT_CPP_API Allocator * g_allocator
Definition: Allocator.cpp:22
+
AWS_CRT_CPP_API Allocator * DefaultAllocatorImplementation() noexcept
Definition: Allocator.cpp:12
+
Definition: Allocator.h:11
+
+
+
+
+
diff --git a/docs/_api_8cpp.html b/docs/_api_8cpp.html
new file mode 100644
index 000000000..4522e0850
--- /dev/null
+++ b/docs/_api_8cpp.html
@@ -0,0 +1,131 @@
+
+
+
+
+
+
+
+aws-crt-cpp: source/Api.cpp File Reference
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ 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>
+
+
+
+
+
+
diff --git a/docs/_api_8h.html b/docs/_api_8h.html
new file mode 100644
index 000000000..1c6f85d9c
--- /dev/null
+++ b/docs/_api_8h.html
@@ -0,0 +1,136 @@
+
+
+
+
+
+
+
+aws-crt-cpp: include/aws/crt/Api.h File Reference
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ aws-crt-cpp
+
+ C++ wrapper around the aws-c-* libraries. Provides Cross-Platform Transport Protocols and SSL/TLS implementations for C++.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/docs/_api_8h_source.html b/docs/_api_8h_source.html
new file mode 100644
index 000000000..398391be5
--- /dev/null
+++ b/docs/_api_8h_source.html
@@ -0,0 +1,234 @@
+
+
+
+
+
+
+
+aws-crt-cpp: include/aws/crt/Api.h Source File
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ aws-crt-cpp
+
+ C++ wrapper around the aws-c-* libraries. Provides Cross-Platform Transport Protocols and SSL/TLS implementations for C++.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
Go to the documentation of this file.
+
+
+
+
+
+
+
12 #include <aws/common/logging.h>
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
68 void InitializeLogging(
LogLevel level,
const char *filename);
+
+
76 void InitializeLogging(
LogLevel level, FILE *fp);
+
+
+
+
+
+
+
+
+
+
+
+
+
+
124 void SetBYOCryptoTlsContextCallbacks(
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
185 #pragma pack(push, 1)
+
+
+
+
+
+
+
+
+
+
+
200 void InitializeLoggingCommon(
struct aws_logger_standard_options &options);
+
+
+
+
+
+
+
207 static std::mutex s_lock_client_bootstrap;
+
208 static void ReleaseStaticDefaultClientBootstrap();
+
+
+
211 static std::mutex s_lock_event_loop_group;
+
212 static void ReleaseStaticDefaultEventLoopGroup();
+
+
214 static int s_host_resolver_default_max_hosts;
+
+
216 static std::mutex s_lock_default_host_resolver;
+
217 static void ReleaseStaticDefaultHostResolver();
+
+
+
+
+
+
+
+
+
+
+
+
#define AWS_CRT_CPP_API
Definition: Exports.h:37
+
+
+
+
+
ApiHandle & operator=(const ApiHandle &)=delete
+
ApiHandle(ApiHandle &&)=delete
+
ApiHandle & operator=(ApiHandle &&)=delete
+
ApiHandle(const ApiHandle &)=delete
+
Definition: Bootstrap.h:35
+
Definition: EventLoopGroup.h:33
+
Definition: HostResolver.h:35
+
+
+
std::function< std::shared_ptr< ByoHMAC >(size_t digestSize, const ByteCursor &secret, Allocator *)> CreateHMACCallback
Definition: HMAC.h:164
+
std::function< std::shared_ptr< ByoHash >(size_t digestSize, Allocator *)> CreateHashCallback
Definition: Hash.h:208
+
std::function< void *(TlsContextOptions &, TlsMode, Allocator *)> NewTlsContextImplCallback
Definition: TlsOptions.h:386
+
std::function< bool()> IsTlsAlpnSupportedCallback
Definition: TlsOptions.h:388
+
std::function< std::shared_ptr< ClientTlsChannelHandler >(struct aws_channel_slot *slot, const struct aws_tls_connection_options &options, Allocator *allocator)> NewClientTlsHandlerCallback
Definition: TlsOptions.h:449
+
std::function< void(void *)> DeleteTlsContextImplCallback
Definition: TlsOptions.h:387
+
AWS_CRT_CPP_API int LastErrorOrUnknown() noexcept
Definition: Api.cpp:427
+
ApiHandleShutdownBehavior
Definition: Api.h:38
+
+
+
AWS_CRT_CPP_API const char * ErrorDebugString(int error) noexcept
Definition: Api.cpp:417
+
LogLevel
Definition: Api.h:22
+
+
+
+
+
+
+
+
+
aws_allocator Allocator
Definition: Allocator.h:14
+
AWS_CRT_CPP_API int LastError() noexcept
Definition: Api.cpp:422
+
Definition: Allocator.h:11
+
+
uint16_t major
Definition: Api.h:188
+
uint16_t minor
Definition: Api.h:189
+
uint16_t patch
Definition: Api.h:190
+
+
+
+
+
diff --git a/docs/_bootstrap_8cpp.html b/docs/_bootstrap_8cpp.html
new file mode 100644
index 000000000..4ed5a4ff8
--- /dev/null
+++ b/docs/_bootstrap_8cpp.html
@@ -0,0 +1,94 @@
+
+
+
+
+
+
+
+aws-crt-cpp: source/io/Bootstrap.cpp File Reference
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ aws-crt-cpp
+
+ C++ wrapper around the aws-c-* libraries. Provides Cross-Platform Transport Protocols and SSL/TLS implementations for C++.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/docs/_bootstrap_8h.html b/docs/_bootstrap_8h.html
new file mode 100644
index 000000000..5072d2946
--- /dev/null
+++ b/docs/_bootstrap_8h.html
@@ -0,0 +1,112 @@
+
+
+
+
+
+
+
+aws-crt-cpp: include/aws/crt/io/Bootstrap.h File Reference
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ 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.
+
+
+
+
+
+
diff --git a/docs/_bootstrap_8h_source.html b/docs/_bootstrap_8h_source.html
new file mode 100644
index 000000000..19938f9ba
--- /dev/null
+++ b/docs/_bootstrap_8h_source.html
@@ -0,0 +1,152 @@
+
+
+
+
+
+
+
+aws-crt-cpp: include/aws/crt/io/Bootstrap.h Source File
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ aws-crt-cpp
+
+ C++ wrapper around the aws-c-* libraries. Provides Cross-Platform Transport Protocols and SSL/TLS implementations for C++.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
Go to the documentation of this file.
+
+
+
+
+
+
12 #include <aws/io/channel_bootstrap.h>
+
13 #include <aws/io/host_resolver.h>
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
63 operator bool() const noexcept;
+
+
+
+
+
+
90 void EnableBlockingShutdown() noexcept;
+
+
93 aws_client_bootstrap *GetUnderlyingHandle() const noexcept;
+
+
+
96 aws_client_bootstrap *m_bootstrap;
+
+
98 std ::unique_ptr<class ClientBootstrapCallbackData> m_callbackData;
+
99 std ::future<
void > m_shutdownFuture;
+
100 bool m_enableBlockingShutdown;
+
+
+
+
+
+
+
#define AWS_CRT_CPP_API
Definition: Exports.h:37
+
+
+
Definition: Bootstrap.h:35
+
ClientBootstrap & operator=(const ClientBootstrap &)=delete
+
ClientBootstrap(ClientBootstrap &&)=delete
+
ClientBootstrap & operator=(ClientBootstrap &&)=delete
+
ClientBootstrap(const ClientBootstrap &)=delete
+
Definition: EventLoopGroup.h:33
+
Definition: HostResolver.h:35
+
std::function< void()> OnClientBootstrapShutdownComplete
Definition: Bootstrap.h:23
+
aws_allocator Allocator
Definition: Allocator.h:14
+
AWS_CRT_CPP_API Allocator * ApiAllocator() noexcept
Definition: Allocator.cpp:24
+
AWS_CRT_CPP_API int LastError() noexcept
Definition: Api.cpp:422
+
Definition: Allocator.h:11
+
Definition: StringView.h:852
+
+
+
+
+
diff --git a/docs/_c_r_c_8cpp.html b/docs/_c_r_c_8cpp.html
new file mode 100644
index 000000000..b439a929a
--- /dev/null
+++ b/docs/_c_r_c_8cpp.html
@@ -0,0 +1,103 @@
+
+
+
+
+
+
+
+aws-crt-cpp: source/checksum/CRC.cpp File Reference
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ aws-crt-cpp
+
+ C++ wrapper around the aws-c-* libraries. Provides Cross-Platform Transport Protocols and SSL/TLS implementations for C++.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
#include <aws/crt/checksum/CRC.h >
+
#include <aws/checksums/crc.h>
+
+
+
+
+
+
diff --git a/docs/_c_r_c_8h.html b/docs/_c_r_c_8h.html
new file mode 100644
index 000000000..18997caec
--- /dev/null
+++ b/docs/_c_r_c_8h.html
@@ -0,0 +1,105 @@
+
+
+
+
+
+
+
+aws-crt-cpp: include/aws/crt/checksum/CRC.h File Reference
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ aws-crt-cpp
+
+ C++ wrapper around the aws-c-* libraries. Provides Cross-Platform Transport Protocols and SSL/TLS implementations for C++.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/docs/_c_r_c_8h_source.html b/docs/_c_r_c_8h_source.html
new file mode 100644
index 000000000..e44cb4ea9
--- /dev/null
+++ b/docs/_c_r_c_8h_source.html
@@ -0,0 +1,105 @@
+
+
+
+
+
+
+
+aws-crt-cpp: include/aws/crt/checksum/CRC.h Source File
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ aws-crt-cpp
+
+ C++ wrapper around the aws-c-* libraries. Provides Cross-Platform Transport Protocols and SSL/TLS implementations for C++.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
Go to the documentation of this file.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
#define AWS_CRT_CPP_API
Definition: Exports.h:37
+
+
uint32_t AWS_CRT_CPP_API ComputeCRC32(ByteCursor input, uint32_t previousCRC32=0) noexcept
Definition: CRC.cpp:15
+
uint32_t AWS_CRT_CPP_API ComputeCRC32C(ByteCursor input, uint32_t previousCRC32C=0) noexcept
Definition: CRC.cpp:20
+
uint64_t AWS_CRT_CPP_API ComputeCRC64NVME(ByteCursor input, uint64_t previousCRC64NVME=0) noexcept
Definition: CRC.cpp:25
+
aws_byte_cursor ByteCursor
Definition: Types.h:31
+
Definition: Allocator.h:11
+
+
+
+
+
diff --git a/docs/_cbor_8cpp.html b/docs/_cbor_8cpp.html
new file mode 100644
index 000000000..78598ef25
--- /dev/null
+++ b/docs/_cbor_8cpp.html
@@ -0,0 +1,93 @@
+
+
+
+
+
+
+
+aws-crt-cpp: source/cbor/Cbor.cpp File Reference
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ aws-crt-cpp
+
+ C++ wrapper around the aws-c-* libraries. Provides Cross-Platform Transport Protocols and SSL/TLS implementations for C++.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/docs/_cbor_8h.html b/docs/_cbor_8h.html
new file mode 100644
index 000000000..8f4cfcd63
--- /dev/null
+++ b/docs/_cbor_8h.html
@@ -0,0 +1,132 @@
+
+
+
+
+
+
+
+aws-crt-cpp: include/aws/crt/cbor/Cbor.h File Reference
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ aws-crt-cpp
+
+ C++ wrapper around the aws-c-* libraries. Provides Cross-Platform Transport Protocols and SSL/TLS implementations for C++.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
#include <aws/common/cbor.h>
+
#include <aws/crt/Types.h >
+
+
Go to the source code of this file.
+
+
+enum class Aws::Crt::Cbor::CborType {
+ Aws::Crt::Cbor::Unknown = AWS_CBOR_TYPE_UNKNOWN
+, Aws::Crt::Cbor::UInt = AWS_CBOR_TYPE_UINT
+, Aws::Crt::Cbor::NegInt = AWS_CBOR_TYPE_NEGINT
+, Aws::Crt::Cbor::Float = AWS_CBOR_TYPE_FLOAT
+,
+ Aws::Crt::Cbor::Bytes = AWS_CBOR_TYPE_BYTES
+, Aws::Crt::Cbor::Text = AWS_CBOR_TYPE_TEXT
+, Aws::Crt::Cbor::ArrayStart = AWS_CBOR_TYPE_ARRAY_START
+, Aws::Crt::Cbor::MapStart = AWS_CBOR_TYPE_MAP_START
+,
+ Aws::Crt::Cbor::Tag = AWS_CBOR_TYPE_TAG
+, Aws::Crt::Cbor::Bool = AWS_CBOR_TYPE_BOOL
+, Aws::Crt::Cbor::Null = AWS_CBOR_TYPE_NULL
+, Aws::Crt::Cbor::Undefined = AWS_CBOR_TYPE_UNDEFINED
+,
+ Aws::Crt::Cbor::Break = AWS_CBOR_TYPE_BREAK
+, Aws::Crt::Cbor::IndefBytesStart = AWS_CBOR_TYPE_INDEF_BYTES_START
+, Aws::Crt::Cbor::IndefTextStart = AWS_CBOR_TYPE_INDEF_TEXT_START
+, Aws::Crt::Cbor::IndefArrayStart = AWS_CBOR_TYPE_INDEF_ARRAY_START
+,
+ Aws::Crt::Cbor::IndefMapStart = AWS_CBOR_TYPE_INDEF_MAP_START
+
+ }
+
+
+
+
+
+
+
diff --git a/docs/_cbor_8h_source.html b/docs/_cbor_8h_source.html
new file mode 100644
index 000000000..578ab4a95
--- /dev/null
+++ b/docs/_cbor_8h_source.html
@@ -0,0 +1,242 @@
+
+
+
+
+
+
+
+aws-crt-cpp: include/aws/crt/cbor/Cbor.h Source File
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ aws-crt-cpp
+
+ C++ wrapper around the aws-c-* libraries. Provides Cross-Platform Transport Protocols and SSL/TLS implementations for C++.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
Go to the documentation of this file.
+
7 #include <aws/common/cbor.h>
+
+
+
+
+
+
+
+
+
+
+
+
37 Unknown = AWS_CBOR_TYPE_UNKNOWN,
+
38 UInt = AWS_CBOR_TYPE_UINT,
+
39 NegInt = AWS_CBOR_TYPE_NEGINT,
+
40 Float = AWS_CBOR_TYPE_FLOAT,
+
41 Bytes = AWS_CBOR_TYPE_BYTES,
+
42 Text = AWS_CBOR_TYPE_TEXT,
+
+
+
45 Tag = AWS_CBOR_TYPE_TAG,
+
46 Bool = AWS_CBOR_TYPE_BOOL,
+
47 Null = AWS_CBOR_TYPE_NULL,
+
+
49 Break = AWS_CBOR_TYPE_BREAK,
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
78 void Reset() noexcept;
+
+
86 void WriteUInt(uint64_t value) noexcept;
+
+
95 void WriteNegInt(uint64_t value) noexcept;
+
+
106 void WriteFloat(
double value) noexcept;
+
+
+
+
+
+
133 void WriteArrayStart(
size_t number_entries) noexcept;
+
+
144 void WriteMapStart(
size_t number_entries) noexcept;
+
+
155 void WriteTag(uint64_t tag_number) noexcept;
+
+
160 void WriteNull() noexcept;
+
+
165 void WriteUndefined() noexcept;
+
+
170 void WriteBool(
bool value) noexcept;
+
+
177 void WriteBreak() noexcept;
+
+
184 void WriteIndefBytesStart() noexcept;
+
+
191 void WriteIndefTextStart() noexcept;
+
+
198 void WriteIndefArrayStart() noexcept;
+
+
205 void WriteIndefMapStart() noexcept;
+
+
+
208 struct aws_cbor_encoder *m_encoder;
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
235 size_t GetRemainingLength() noexcept;
+
+
+
+
266 bool ConsumeNextWholeDataItem() noexcept;
+
+
286 bool ConsumeNextSingleElement() noexcept;
+
+
302 Optional <uint64_t> PopNextUnsignedIntVal() noexcept;
+
303 Optional <uint64_t> PopNextNegativeIntVal() noexcept;
+
304 Optional <
double > PopNextFloatVal() noexcept;
+
305 Optional <
bool > PopNextBooleanVal() noexcept;
+
+
+
+
324 Optional <uint64_t> PopNextArrayStart() noexcept;
+
+
341 Optional <uint64_t> PopNextMapStart() noexcept;
+
+
352 Optional <uint64_t> PopNextTagVal() noexcept;
+
+
357 int LastError () const noexcept {
return m_lastError ? m_lastError : AWS_ERROR_UNKNOWN; }
+
+
+
360 struct aws_cbor_decoder *m_decoder;
+
+
+
+
+
+
+
+
#define AWS_CRT_CPP_API
Definition: Exports.h:37
+
+
+
CborDecoder & operator=(CborDecoder &&)=delete
+
CborDecoder(CborDecoder &&)=delete
+
CborDecoder & operator=(const CborDecoder &)=delete
+
CborDecoder(const CborDecoder &)=delete
+
+
CborEncoder(CborEncoder &&)=delete
+
CborEncoder & operator=(CborEncoder &&)=delete
+
CborEncoder & operator=(const CborEncoder &)=delete
+
CborEncoder(const CborEncoder &)=delete
+
Definition: Optional.h:18
+
CborType
Definition: Cbor.h:36
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
aws_byte_cursor ByteCursor
Definition: Types.h:31
+
aws_allocator Allocator
Definition: Allocator.h:14
+
AWS_CRT_CPP_API Allocator * ApiAllocator() noexcept
Definition: Allocator.cpp:24
+
AWS_CRT_CPP_API int LastError() noexcept
Definition: Api.cpp:422
+
Definition: Allocator.h:11
+
+
+
+
+
diff --git a/docs/_channel_handler_8cpp.html b/docs/_channel_handler_8cpp.html
new file mode 100644
index 000000000..ed5cf0cec
--- /dev/null
+++ b/docs/_channel_handler_8cpp.html
@@ -0,0 +1,109 @@
+
+
+
+
+
+
+
+aws-crt-cpp: source/io/ChannelHandler.cpp File Reference
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ 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/ChannelHandler.h >
+
#include <chrono>
+
+
+
+
+
+
diff --git a/docs/_channel_handler_8h.html b/docs/_channel_handler_8h.html
new file mode 100644
index 000000000..253190e03
--- /dev/null
+++ b/docs/_channel_handler_8h.html
@@ -0,0 +1,119 @@
+
+
+
+
+
+
+
+aws-crt-cpp: include/aws/crt/io/ChannelHandler.h File Reference
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ 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.
+
+
+
+
+
+
diff --git a/docs/_channel_handler_8h_source.html b/docs/_channel_handler_8h_source.html
new file mode 100644
index 000000000..3ae67498c
--- /dev/null
+++ b/docs/_channel_handler_8h_source.html
@@ -0,0 +1,229 @@
+
+
+
+
+
+
+
+aws-crt-cpp: include/aws/crt/io/ChannelHandler.h Source File
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ aws-crt-cpp
+
+ C++ wrapper around the aws-c-* libraries. Provides Cross-Platform Transport Protocols and SSL/TLS implementations for C++.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
Go to the documentation of this file.
+
+
+
9 #include <aws/io/channel.h>
+
+
+
+
+
14 struct aws_array_list;
+
15 struct aws_io_message;
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
106 bool freeScarceResourcesImmediately) = 0;
+
+
+
+
+
+
+
+
+
+
+
132 struct aws_channel_handler *SeatForCInterop(
const std::shared_ptr<ChannelHandler> &selfRef);
+
+
137 bool ChannelsThreadIsCallersThread()
const ;
+
+
144 void ShutDownChannel(
int errorCode);
+
+
150 void ScheduleTask(std::function<
void (
TaskStatus )> &&task);
+
+
157 void ScheduleTask(std::function<
void (
TaskStatus )> &&task, std::chrono::nanoseconds run_in);
+
+
+
+
+
165 struct aws_io_message *AcquireMessageFromPool(
MessageType messageType,
size_t sizeHint);
+
+
172 struct aws_io_message *AcquireMaxSizeMessageForWrite();
+
+
179 bool SendMessage(
struct aws_io_message *message,
ChannelDirection direction);
+
+
185 bool IncrementUpstreamReadWindow(
size_t windowUpdateSize);
+
+
191 void OnShutdownComplete(
ChannelDirection direction,
int errorCode,
bool freeScarceResourcesImmediately);
+
+
198 size_t DownstreamReadWindow()
const ;
+
+
204 size_t UpstreamMessageOverhead()
const ;
+
+
206 struct aws_channel_slot *GetSlot()
const ;
+
+
208 struct aws_channel_handler m_handler;
+
+
+
+
212 std::shared_ptr<ChannelHandler> m_selfReference;
+
213 static struct aws_channel_handler_vtable s_vtable;
+
+
215 static void s_Destroy(
struct aws_channel_handler *handler);
+
216 static int s_ProcessReadMessage(
+
217 struct aws_channel_handler *,
+
218 struct aws_channel_slot *,
+
219 struct aws_io_message *);
+
220 static int s_ProcessWriteMessage(
+
221 struct aws_channel_handler *,
+
222 struct aws_channel_slot *,
+
223 struct aws_io_message *);
+
224 static int s_IncrementReadWindow(
struct aws_channel_handler *,
struct aws_channel_slot *,
size_t size);
+
225 static int s_ProcessShutdown(
+
226 struct aws_channel_handler *,
+
227 struct aws_channel_slot *,
+
228 enum aws_channel_direction,
+
+
230 bool freeScarceResourcesImmediately);
+
231 static size_t s_InitialWindowSize(
struct aws_channel_handler *);
+
232 static size_t s_MessageOverhead(
struct aws_channel_handler *);
+
233 static void s_ResetStatistics(
struct aws_channel_handler *);
+
234 static void s_GatherStatistics(
struct aws_channel_handler *,
struct aws_array_list *statsList);
+
+
+
+
+
+
#define AWS_CRT_CPP_API
Definition: Exports.h:37
+
+
Definition: ChannelHandler.h:47
+
virtual void ProcessShutdown(ChannelDirection dir, int errorCode, bool freeScarceResourcesImmediately)=0
+
ChannelHandler & operator=(const ChannelHandler &)=delete
+
virtual int ProcessWriteMessage(struct aws_io_message *message)=0
+
virtual size_t MessageOverhead()=0
+
virtual void GatherStatistics(struct aws_array_list *)
Definition: ChannelHandler.h:128
+
ChannelHandler(const ChannelHandler &)=delete
+
virtual int ProcessReadMessage(struct aws_io_message *message)=0
+
virtual void ResetStatistics()
Definition: ChannelHandler.h:122
+
Allocator * m_allocator
Definition: ChannelHandler.h:209
+
virtual int IncrementReadWindow(size_t size)=0
+
virtual ~ChannelHandler()=default
+
virtual size_t InitialWindowSize()=0
+
ChannelDirection
Definition: ChannelHandler.h:24
+
+
+
MessageType
Definition: ChannelHandler.h:30
+
+
TaskStatus
Definition: ChannelHandler.h:35
+
+
+
aws_allocator Allocator
Definition: Allocator.h:14
+
AWS_CRT_CPP_API Allocator * ApiAllocator() noexcept
Definition: Allocator.cpp:24
+
Definition: Allocator.h:11
+
+
+
+
+
diff --git a/docs/_credentials_8cpp.html b/docs/_credentials_8cpp.html
new file mode 100644
index 000000000..b36c7e2b3
--- /dev/null
+++ b/docs/_credentials_8cpp.html
@@ -0,0 +1,117 @@
+
+
+
+
+
+
+
+aws-crt-cpp: source/auth/Credentials.cpp File Reference
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ 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 >
+
+
+
+
+
+
diff --git a/docs/_credentials_8h.html b/docs/_credentials_8h.html
new file mode 100644
index 000000000..093f2503b
--- /dev/null
+++ b/docs/_credentials_8h.html
@@ -0,0 +1,143 @@
+
+
+
+
+
+
+
+aws-crt-cpp: include/aws/crt/auth/Credentials.h File Reference
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ aws-crt-cpp
+
+ C++ wrapper around the aws-c-* libraries. Provides Cross-Platform Transport Protocols and SSL/TLS implementations for C++.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/docs/_credentials_8h_source.html b/docs/_credentials_8h_source.html
new file mode 100644
index 000000000..bc2b50b05
--- /dev/null
+++ b/docs/_credentials_8h_source.html
@@ -0,0 +1,472 @@
+
+
+
+
+
+
+
+aws-crt-cpp: include/aws/crt/auth/Credentials.h Source File
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ aws-crt-cpp
+
+ C++ wrapper around the aws-c-* libraries. Provides Cross-Platform Transport Protocols and SSL/TLS implementations for C++.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
Go to the documentation of this file.
+
+
+
+
+
+
+
+
+
15 struct aws_credentials;
+
16 struct aws_credentials_provider;
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
40 Credentials (
const aws_credentials *credentials) noexcept;
+
+
+
+
+
45 uint64_t expiration_timepoint_in_seconds,
+
+
+
+
+
+
+
+
+
+
+
+
+
+
70 ByteCursor GetSecretAccessKey() const noexcept;
+
+
+
+
80 uint64_t GetExpirationTimepointInSeconds() const noexcept;
+
+
85 explicit operator
bool () const noexcept;
+
+
90 const aws_credentials *GetUnderlyingHandle() const noexcept {
return m_credentials; }
+
+
+
93 const aws_credentials *m_credentials;
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
132 virtual
bool IsValid() const noexcept = 0;
+
+
+
+
+
+
+
142 AWS_ZERO_STRUCT(AccessKeyId);
+
143 AWS_ZERO_STRUCT(SecretAccessKey);
+
144 AWS_ZERO_STRUCT(SessionToken);
+
+
+
+
+
+
+
+
+
+
+
+
+
+
170 AWS_ZERO_STRUCT(ProfileNameOverride);
+
171 AWS_ZERO_STRUCT(ConfigFileNameOverride);
+
172 AWS_ZERO_STRUCT(CredentialsFileNameOverride);
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
293 : Bootstrap(nullptr), TlsOptions(), ThingName(), RoleAlias(), Endpoint(), ProxyOptions()
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
481 virtual bool IsValid () const noexcept
override {
return m_provider !=
nullptr ; }
+
+
+
+
+
+
490 static std::shared_ptr<ICredentialsProvider> CreateCredentialsProviderStatic(
+
+
+
+
498 static std::shared_ptr<ICredentialsProvider> CreateCredentialsProviderAnonymous(
+
+
+
504 static std::shared_ptr<ICredentialsProvider> CreateCredentialsProviderEnvironment(
+
+
+
510 static std::shared_ptr<ICredentialsProvider> CreateCredentialsProviderProfile(
+
+
+
+
517 static std::shared_ptr<ICredentialsProvider> CreateCredentialsProviderImds(
+
+
+
+
525 static std::shared_ptr<ICredentialsProvider> CreateCredentialsProviderChain(
+
+
+
+
+
+
+
+
533 static std::shared_ptr<ICredentialsProvider> CreateCredentialsProviderCached(
+
+
+
+
543 static std::shared_ptr<ICredentialsProvider> CreateCredentialsProviderChainDefault(
+
+
+
+
551 static std::shared_ptr<ICredentialsProvider> CreateCredentialsProviderX509(
+
+
+
+
559 static std::shared_ptr<ICredentialsProvider> CreateCredentialsProviderDelegate(
+
+
+
+
566 static std::shared_ptr<ICredentialsProvider> CreateCredentialsProviderCognito(
+
+
+
+
573 static std::shared_ptr<ICredentialsProvider> CreateCredentialsProviderSTS(
+
+
+
+
+
578 static void s_onCredentialsResolved(aws_credentials *credentials,
int error_code,
void *user_data);
+
+
+
581 aws_credentials_provider *m_provider;
+
+
+
+
+
+
#define AWS_CRT_CPP_API
Definition: Exports.h:37
+
+
+
+
Definition: Credentials.h:38
+
Credentials(const Credentials &)=delete
+
Credentials & operator=(Credentials &&)=delete
+
Credentials(Credentials &&)=delete
+
Credentials & operator=(const Credentials &)=delete
+
Definition: Credentials.h:457
+
CredentialsProvider & operator=(CredentialsProvider &&)=delete
+
CredentialsProvider(const CredentialsProvider &)=delete
+
virtual bool IsValid() const noexcept override
Definition: Credentials.h:481
+
virtual aws_credentials_provider * GetUnderlyingHandle() const noexcept override
Definition: Credentials.h:476
+
CredentialsProvider & operator=(const CredentialsProvider &)=delete
+
CredentialsProvider(CredentialsProvider &&)=delete
+
Definition: Credentials.h:112
+
virtual aws_credentials_provider * GetUnderlyingHandle() const noexcept=0
+
virtual bool GetCredentials(const OnCredentialsResolved &onCredentialsResolved) const =0
+
virtual ~ICredentialsProvider()=default
+
Definition: HttpConnection.h:270
+
Definition: Bootstrap.h:35
+
Definition: TlsOptions.h:293
+
Definition: TlsOptions.h:350
+
Definition: Optional.h:18
+
std::function< void(std::shared_ptr< Credentials >, int errorCode)> OnCredentialsResolved
Definition: Credentials.h:100
+
std::function< std::shared_ptr< Credentials >()> GetCredentialsHandler
Definition: Credentials.h:105
+
aws_byte_cursor ByteCursor
Definition: Types.h:31
+
aws_allocator Allocator
Definition: Allocator.h:14
+
AWS_CRT_CPP_API Allocator * ApiAllocator() noexcept
Definition: Allocator.cpp:24
+
std::basic_string< char, std::char_traits< char >, StlAllocator< char > > String
Definition: Types.h:45
+
std::vector< T, StlAllocator< T > > Vector
Definition: Types.h:53
+
Definition: Allocator.h:11
+
Definition: Credentials.h:342
+
String IdentityProviderName
Definition: Credentials.h:347
+
String IdentityProviderToken
Definition: Credentials.h:352
+
Definition: Credentials.h:245
+
std::shared_ptr< ICredentialsProvider > Provider
Definition: Credentials.h:251
+
CredentialsProviderCachedConfig()
Definition: Credentials.h:246
+
std::chrono::milliseconds CachedCredentialTTL
Definition: Credentials.h:256
+
Definition: Credentials.h:232
+
CredentialsProviderChainConfig()
Definition: Credentials.h:233
+
Vector< std::shared_ptr< ICredentialsProvider > > Providers
Definition: Credentials.h:238
+
Definition: Credentials.h:266
+
Io::TlsContext * TlsContext
Definition: Credentials.h:284
+
Io::ClientBootstrap * Bootstrap
Definition: Credentials.h:275
+
CredentialsProviderChainDefaultConfig()
Definition: Credentials.h:267
+
Definition: Credentials.h:359
+
Optional< Vector< CognitoLoginPair > > Logins
Definition: Credentials.h:375
+
Optional< String > CustomRoleArn
Definition: Credentials.h:381
+
Optional< Http::HttpClientConnectionProxyOptions > ProxyOptions
Definition: Credentials.h:400
+
Io::ClientBootstrap * Bootstrap
Definition: Credentials.h:390
+
String Endpoint
Definition: Credentials.h:365
+
Io::TlsContext TlsCtx
Definition: Credentials.h:395
+
String Identity
Definition: Credentials.h:370
+
Definition: Credentials.h:333
+
GetCredentialsHandler Handler
Definition: Credentials.h:335
+
Definition: Credentials.h:213
+
CredentialsProviderImdsConfig()
Definition: Credentials.h:214
+
Io::ClientBootstrap * Bootstrap
Definition: Credentials.h:223
+
Definition: Credentials.h:167
+
ByteCursor ConfigFileNameOverride
Definition: Credentials.h:184
+
ByteCursor CredentialsFileNameOverride
Definition: Credentials.h:190
+
ByteCursor ProfileNameOverride
Definition: Credentials.h:178
+
Io::ClientBootstrap * Bootstrap
Definition: Credentials.h:196
+
CredentialsProviderProfileConfig()
Definition: Credentials.h:168
+
Io::TlsContext * TlsContext
Definition: Credentials.h:206
+
Definition: Credentials.h:407
+
Optional< Http::HttpClientConnectionProxyOptions > ProxyOptions
Definition: Credentials.h:447
+
Io::ClientBootstrap * Bootstrap
Definition: Credentials.h:437
+
uint16_t DurationSeconds
Definition: Credentials.h:428
+
std::shared_ptr< ICredentialsProvider > Provider
Definition: Credentials.h:413
+
String SessionName
Definition: Credentials.h:423
+
Io::TlsContext TlsCtx
Definition: Credentials.h:442
+
String RoleArn
Definition: Credentials.h:418
+
Definition: Credentials.h:139
+
ByteCursor SecretAccessKey
Definition: Credentials.h:155
+
ByteCursor AccessKeyId
Definition: Credentials.h:150
+
CredentialsProviderStaticConfig()
Definition: Credentials.h:140
+
ByteCursor SessionToken
Definition: Credentials.h:160
+
Definition: Credentials.h:291
+
Optional< Http::HttpClientConnectionProxyOptions > ProxyOptions
Definition: Credentials.h:326
+
CredentialsProviderX509Config()
Definition: Credentials.h:292
+
String Endpoint
Definition: Credentials.h:321
+
String ThingName
Definition: Credentials.h:310
+
String RoleAlias
Definition: Credentials.h:313
+
Io::ClientBootstrap * Bootstrap
Definition: Credentials.h:304
+
Io::TlsConnectionOptions TlsOptions
Definition: Credentials.h:307
+
+
+
+
+
diff --git a/docs/_date_time_8cpp.html b/docs/_date_time_8cpp.html
new file mode 100644
index 000000000..4fc72a4ae
--- /dev/null
+++ b/docs/_date_time_8cpp.html
@@ -0,0 +1,91 @@
+
+
+
+
+
+
+
+aws-crt-cpp: source/DateTime.cpp File Reference
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ 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 <chrono>
+
+
+
+
+
+
diff --git a/docs/_date_time_8h.html b/docs/_date_time_8h.html
new file mode 100644
index 000000000..36d521b3d
--- /dev/null
+++ b/docs/_date_time_8h.html
@@ -0,0 +1,140 @@
+
+
+
+
+
+
+
+aws-crt-cpp: include/aws/crt/DateTime.h File Reference
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ 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.
+
+
+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
+
+ }
+
+
+
+
+
+
+
diff --git a/docs/_date_time_8h_source.html b/docs/_date_time_8h_source.html
new file mode 100644
index 000000000..cca5febc3
--- /dev/null
+++ b/docs/_date_time_8h_source.html
@@ -0,0 +1,233 @@
+
+
+
+
+
+
+
+aws-crt-cpp: include/aws/crt/DateTime.h Source File
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ aws-crt-cpp
+
+ C++ wrapper around the aws-c-* libraries. Provides Cross-Platform Transport Protocols and SSL/TLS implementations for C++.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
Go to the documentation of this file.
+
+
+
+
+
10 #include <aws/common/date_time.h>
+
+
+
+
+
+
+
+
+
+
20 RFC822 = AWS_DATE_FORMAT_RFC822,
+
+
+
+
+
+
+
27 January = AWS_DATE_MONTH_JANUARY,
+
+
29 March = AWS_DATE_MONTH_MARCH,
+
30 April = AWS_DATE_MONTH_APRIL,
+
31 May = AWS_DATE_MONTH_MAY,
+
32 June = AWS_DATE_MONTH_JUNE,
+
33 July = AWS_DATE_MONTH_JULY,
+
34 August = AWS_DATE_MONTH_AUGUST,
+
+
36 October = AWS_DATE_MONTH_OCTOBER,
+
+
+
+
+
+
+
43 Sunday = AWS_DATE_DAY_OF_WEEK_SUNDAY,
+
44 Monday = AWS_DATE_DAY_OF_WEEK_MONDAY,
+
45 Tuesday = AWS_DATE_DAY_OF_WEEK_TUESDAY,
+
46 Wednesday = AWS_DATE_DAY_OF_WEEK_WEDNESDAY,
+
47 Thursday = AWS_DATE_DAY_OF_WEEK_THURSDAY,
+
48 Friday = AWS_DATE_DAY_OF_WEEK_FRIDAY,
+
49 Saturday = AWS_DATE_DAY_OF_WEEK_SATURDAY,
+
+
+
+
+
+
+
+
63 DateTime (
const std::chrono::system_clock::time_point &timepointToAssign) noexcept;
+
+
68 DateTime (uint64_t millisSinceEpoch) noexcept;
+
+
73 DateTime (
double epoch_millis) noexcept;
+
+
+
+
+
+
+
+
+
+
+
87 DateTime operator+(
const std::chrono::milliseconds &a)
const noexcept;
+
88 DateTime operator-(
const std::chrono::milliseconds &a)
const noexcept;
+
+
93 DateTime &operator=(
double secondsSinceEpoch) noexcept;
+
+
98 DateTime &operator=(uint64_t millisSinceEpoch) noexcept;
+
+
103 DateTime &operator=(
const std::chrono::system_clock::time_point &timepointToAssign) noexcept;
+
+
108 DateTime &operator=(
const char *timestamp) noexcept;
+
+
110 explicit operator bool()
const noexcept;
+
111 int GetLastError()
const noexcept;
+
+
+
+
+
+
126 double SecondsWithMSPrecision()
const noexcept;
+
+
131 uint64_t Millis()
const noexcept;
+
+
137 std::chrono::system_clock::time_point UnderlyingTimestamp()
const noexcept;
+
+
142 uint16_t GetYear(
bool localTime =
false )
const noexcept;
+
+
147 Month GetMonth(
bool localTime =
false )
const noexcept;
+
+
153 uint8_t GetDay(
bool localTime =
false )
const noexcept;
+
+
159 DayOfWeek GetDayOfWeek(
bool localTime =
false )
const noexcept;
+
+
164 uint8_t GetHour(
bool localTime =
false )
const noexcept;
+
+
169 uint8_t GetMinute(
bool localTime =
false )
const noexcept;
+
+
174 uint8_t GetSecond(
bool localTime =
false )
const noexcept;
+
+
180 bool IsDST(
bool localTime =
false )
const noexcept;
+
+
+
+
191 std::chrono::milliseconds operator-(
const DateTime &other)
const noexcept;
+
+
+
194 aws_date_time m_date_time;
+
+
+
+
+
+
#define AWS_CRT_CPP_API
Definition: Exports.h:37
+
+
Definition: DateTime.h:53
+
constexpr bool operator<=(const basic_string_view< CharT, Traits > &lhs, const basic_string_view< CharT, Traits > &rhs) noexcept
Definition: StringView.h:766
+
bool operator<(const basic_string_view< CharT, Traits > &lhs, const basic_string_view< CharT, Traits > &rhs) noexcept
Definition: StringView.h:716
+
constexpr bool operator>=(const basic_string_view< CharT, Traits > &lhs, const basic_string_view< CharT, Traits > &rhs) noexcept
Definition: StringView.h:791
+
DateFormat
Definition: DateTime.h:19
+
+
+
+
constexpr bool operator>(const basic_string_view< CharT, Traits > &lhs, const basic_string_view< CharT, Traits > &rhs) noexcept
Definition: StringView.h:741
+
aws_byte_buf ByteBuf
Definition: Types.h:30
+
Month
Definition: DateTime.h:26
+
+
+
+
+
+
+
+
+
+
+
+
+
DayOfWeek
Definition: DateTime.h:42
+
+
+
+
+
+
+
+
bool operator==(const basic_string_view< CharT, Traits > &lhs, const basic_string_view< CharT, Traits > &rhs) noexcept
Definition: StringView.h:666
+
bool operator!=(const basic_string_view< CharT, Traits > &lhs, const basic_string_view< CharT, Traits > &rhs) noexcept
Definition: StringView.h:691
+
Definition: Allocator.h:11
+
+
+
+
+
diff --git a/docs/_event_loop_group_8cpp.html b/docs/_event_loop_group_8cpp.html
new file mode 100644
index 000000000..4428dc8d3
--- /dev/null
+++ b/docs/_event_loop_group_8cpp.html
@@ -0,0 +1,93 @@
+
+
+
+
+
+
+
+aws-crt-cpp: source/io/EventLoopGroup.cpp File Reference
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ 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/EventLoopGroup.h >
+
#include <iostream>
+
+
+
+
+
+
diff --git a/docs/_event_loop_group_8h.html b/docs/_event_loop_group_8h.html
new file mode 100644
index 000000000..42badc117
--- /dev/null
+++ b/docs/_event_loop_group_8h.html
@@ -0,0 +1,101 @@
+
+
+
+
+
+
+
+aws-crt-cpp: include/aws/crt/io/EventLoopGroup.h File Reference
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ 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/io/event_loop.h>
+
+
Go to the source code of this file.
+
+
+
+
+
+
diff --git a/docs/_event_loop_group_8h_source.html b/docs/_event_loop_group_8h_source.html
new file mode 100644
index 000000000..e552f5d5c
--- /dev/null
+++ b/docs/_event_loop_group_8h_source.html
@@ -0,0 +1,123 @@
+
+
+
+
+
+
+
+aws-crt-cpp: include/aws/crt/io/EventLoopGroup.h Source File
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ aws-crt-cpp
+
+ C++ wrapper around the aws-c-* libraries. Provides Cross-Platform Transport Protocols and SSL/TLS implementations for C++.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
Go to the documentation of this file.
+
+
+
8 #include <aws/io/event_loop.h>
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
57 operator
bool () const;
+
+
+
+
65 aws_event_loop_group *GetUnderlyingHandle() noexcept;
+
+
+
68 aws_event_loop_group *m_eventLoopGroup;
+
+
+
+
+
+
+
#define AWS_CRT_CPP_API
Definition: Exports.h:37
+
+
Definition: EventLoopGroup.h:33
+
EventLoopGroup(const EventLoopGroup &)=delete
+
aws_allocator Allocator
Definition: Allocator.h:14
+
AWS_CRT_CPP_API Allocator * ApiAllocator() noexcept
Definition: Allocator.cpp:24
+
AWS_CRT_CPP_API int LastError() noexcept
Definition: Api.cpp:422
+
Definition: Allocator.h:11
+
+
+
+
+
diff --git a/docs/_exports_8h.html b/docs/_exports_8h.html
new file mode 100644
index 000000000..8acc85bd4
--- /dev/null
+++ b/docs/_exports_8h.html
@@ -0,0 +1,104 @@
+
+
+
+
+
+
+
+aws-crt-cpp: include/aws/crt/Exports.h File Reference
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ 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.
+
+
+
+
◆ AWS_CRT_CPP_API
+
+
+
+
+
+ #define AWS_CRT_CPP_API
+
+
+
+
+
+
+
+
+
+
+
diff --git a/docs/_exports_8h_source.html b/docs/_exports_8h_source.html
new file mode 100644
index 000000000..15d51721b
--- /dev/null
+++ b/docs/_exports_8h_source.html
@@ -0,0 +1,118 @@
+
+
+
+
+
+
+
+aws-crt-cpp: include/aws/crt/Exports.h Source File
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ aws-crt-cpp
+
+ C++ wrapper around the aws-c-* libraries. Provides Cross-Platform Transport Protocols and SSL/TLS implementations for C++.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
Go to the documentation of this file.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
18 #if defined(USE_WINDOWS_DLL_SEMANTICS) || defined(WIN32)
+
+
20 # pragma warning(disable : 4251)
+
+
22 # ifdef AWS_CRT_CPP_USE_IMPORT_EXPORT
+
23 # ifdef AWS_CRT_CPP_EXPORTS
+
24 # define AWS_CRT_CPP_API __declspec(dllexport)
+
+
26 # define AWS_CRT_CPP_API __declspec(dllimport)
+
+
+
29 # define AWS_CRT_CPP_API
+
+
+
+
33 # if ((__GNUC__ >= 4) || defined(__clang__)) && defined(AWS_CRT_CPP_USE_IMPORT_EXPORT) && \
+
34 defined(AWS_CRT_CPP_EXPORTS)
+
35 # define AWS_CRT_CPP_API __attribute__((visibility("default" )))
+
+
37 # define AWS_CRT_CPP_API
+
+
+
+
+
+
+
diff --git a/docs/_h_m_a_c_8cpp.html b/docs/_h_m_a_c_8cpp.html
new file mode 100644
index 000000000..de5b990b0
--- /dev/null
+++ b/docs/_h_m_a_c_8cpp.html
@@ -0,0 +1,101 @@
+
+
+
+
+
+
+
+aws-crt-cpp: source/crypto/HMAC.cpp File Reference
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ aws-crt-cpp
+
+ C++ wrapper around the aws-c-* libraries. Provides Cross-Platform Transport Protocols and SSL/TLS implementations for C++.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
#include <aws/crt/crypto/HMAC.h >
+
#include <aws/cal/hmac.h>
+
+
+
+
+
+
diff --git a/docs/_h_m_a_c_8h.html b/docs/_h_m_a_c_8h.html
new file mode 100644
index 000000000..6bfbb5087
--- /dev/null
+++ b/docs/_h_m_a_c_8h.html
@@ -0,0 +1,124 @@
+
+
+
+
+
+
+
+aws-crt-cpp: include/aws/crt/crypto/HMAC.h File Reference
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ aws-crt-cpp
+
+ C++ wrapper around the aws-c-* libraries. Provides Cross-Platform Transport Protocols and SSL/TLS implementations for C++.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/docs/_h_m_a_c_8h_source.html b/docs/_h_m_a_c_8h_source.html
new file mode 100644
index 000000000..bd6ff8e94
--- /dev/null
+++ b/docs/_h_m_a_c_8h_source.html
@@ -0,0 +1,189 @@
+
+
+
+
+
+
+
+aws-crt-cpp: include/aws/crt/crypto/HMAC.h Source File
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ aws-crt-cpp
+
+ C++ wrapper around the aws-c-* libraries. Provides Cross-Platform Transport Protocols and SSL/TLS implementations for C++.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
Go to the documentation of this file.
+
6 #include <aws/cal/hmac.h>
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
30 size_t truncateTo = 0) noexcept;
+
+
+
+
+
+
42 size_t truncateTo = 0) noexcept;
+
+
+
+
+
+
+
+
+
+
60 inline operator bool() const noexcept {
return m_good; }
+
+
65 inline int LastError () const noexcept {
return m_lastError; }
+
+
+
+
+
+
81 bool Update(
const ByteCursor &toHMAC) noexcept;
+
+
89 bool Digest(
ByteBuf &output,
size_t truncateTo = 0) noexcept;
+
+
95 size_t DigestSize() const noexcept;
+
+
107 bool ComputeOneShot(const
ByteCursor &input,
ByteBuf &output,
size_t truncateTo = 0) noexcept;
+
+
+
110 HMAC (aws_hmac *hmac) noexcept;
+
+
+
+
+
+
+
+
+
+
+
+
+
133 aws_hmac *SeatForCInterop(
const std::shared_ptr<ByoHMAC> &selfRef);
+
+
+
+
+
+
+
+
+
+
154 static
void s_Destroy(struct aws_hmac *hmac);
+
155 static
int s_Update(struct aws_hmac *hmac, const struct aws_byte_cursor *buf);
+
156 static
int s_Finalize(struct aws_hmac *hmac, struct aws_byte_buf *out);
+
+
158 static aws_hmac_vtable s_Vtable;
+
159 aws_hmac m_hmacValue;
+
+
+
+
+
+
+
+
+
+
+
#define AWS_CRT_CPP_API
Definition: Exports.h:37
+
+
+
virtual ~ByoHMAC()=default
+
virtual bool DigestInternal(ByteBuf &output, size_t truncateTo=0) noexcept=0
+
virtual bool UpdateInternal(const ByteCursor &toHash) noexcept=0
+
+
int LastError() const noexcept
Definition: HMAC.h:65
+
HMAC(const HMAC &)=delete
+
HMAC & operator=(const HMAC &)=delete
+
std::function< std::shared_ptr< ByoHMAC >(size_t digestSize, const ByteCursor &secret, Allocator *)> CreateHMACCallback
Definition: HMAC.h:164
+
static const size_t SHA256_HMAC_DIGEST_SIZE
Definition: HMAC.h:17
+
bool AWS_CRT_CPP_API ComputeSHA256HMAC(Allocator *allocator, const ByteCursor &secret, const ByteCursor &input, ByteBuf &output, size_t truncateTo=0) noexcept
Definition: HMAC.cpp:15
+
aws_byte_cursor ByteCursor
Definition: Types.h:31
+
aws_allocator Allocator
Definition: Allocator.h:14
+
AWS_CRT_CPP_API Allocator * ApiAllocator() noexcept
Definition: Allocator.cpp:24
+
aws_byte_buf ByteBuf
Definition: Types.h:30
+
Definition: Allocator.h:11
+
Definition: StringView.h:852
+
+
+
+
+
diff --git a/docs/_hash_8cpp.html b/docs/_hash_8cpp.html
new file mode 100644
index 000000000..3b795ac03
--- /dev/null
+++ b/docs/_hash_8cpp.html
@@ -0,0 +1,109 @@
+
+
+
+
+
+
+
+aws-crt-cpp: source/crypto/Hash.cpp File Reference
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ aws-crt-cpp
+
+ C++ wrapper around the aws-c-* libraries. Provides Cross-Platform Transport Protocols and SSL/TLS implementations for C++.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
#include <aws/crt/crypto/Hash.h >
+
#include <aws/cal/hash.h>
+
+
+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::ComputeSHA1 (Allocator *allocator, const ByteCursor &input, ByteBuf &output, size_t truncateTo=0) noexcept
+
+bool AWS_CRT_CPP_API Aws::Crt::Crypto::ComputeSHA1 (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
+
+
+
+
+
+
+
diff --git a/docs/_hash_8h.html b/docs/_hash_8h.html
new file mode 100644
index 000000000..d780a8b08
--- /dev/null
+++ b/docs/_hash_8h.html
@@ -0,0 +1,136 @@
+
+
+
+
+
+
+
+aws-crt-cpp: include/aws/crt/crypto/Hash.h File Reference
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ 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/cal/hash.h>
+
+
Go to the source code of this file.
+
+
+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
+
+bool AWS_CRT_CPP_API Aws::Crt::Crypto::ComputeSHA1 (Allocator *allocator, const ByteCursor &input, ByteBuf &output, size_t truncateTo=0) noexcept
+
+bool AWS_CRT_CPP_API Aws::Crt::Crypto::ComputeSHA1 (const ByteCursor &input, ByteBuf &output, size_t truncateTo=0) noexcept
+
+
+
+
+
+
+
diff --git a/docs/_hash_8h_source.html b/docs/_hash_8h_source.html
new file mode 100644
index 000000000..c67ebbb6f
--- /dev/null
+++ b/docs/_hash_8h_source.html
@@ -0,0 +1,208 @@
+
+
+
+
+
+
+
+aws-crt-cpp: include/aws/crt/crypto/Hash.h Source File
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ aws-crt-cpp
+
+ C++ wrapper around the aws-c-* libraries. Provides Cross-Platform Transport Protocols and SSL/TLS implementations for C++.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
Go to the documentation of this file.
+
+
+
+
9 #include <aws/cal/hash.h>
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
32 size_t truncateTo = 0) noexcept;
+
+
+
+
+
+
+
+
+
53 size_t truncateTo = 0) noexcept;
+
+
+
+
+
+
+
+
73 size_t truncateTo = 0) noexcept;
+
+
+
+
+
+
+
+
+
+
+
+
+
100 operator bool() const noexcept;
+
+
105 inline
int LastError () const noexcept {
return m_lastError; }
+
+
+
+
+
+
+
+
126 bool Update(const
ByteCursor &toHash) noexcept;
+
+
135 bool Digest(
ByteBuf &output,
size_t truncateTo = 0) noexcept;
+
+
147 bool ComputeOneShot(const
ByteCursor &input,
ByteBuf &output,
size_t truncateTo = 0) noexcept;
+
+
153 size_t DigestSize() const noexcept;
+
+
+
156 Hash (aws_hash *hash) noexcept;
+
+
+
+
+
+
+
+
+
+
+
+
178 aws_hash *SeatForCInterop(
const std::shared_ptr<ByoHash> &selfRef);
+
+
+
+
+
+
+
+
+
+
199 static
void s_Destroy(struct aws_hash *hash);
+
200 static
int s_Update(struct aws_hash *hash, const struct aws_byte_cursor *buf);
+
201 static
int s_Finalize(struct aws_hash *hash, struct aws_byte_buf *out);
+
+
203 static aws_hash_vtable s_Vtable;
+
204 aws_hash m_hashValue;
+
+
+
+
+
+
+
+
+
+
#define AWS_CRT_CPP_API
Definition: Exports.h:37
+
+
+
virtual bool DigestInternal(ByteBuf &output, size_t truncateTo=0) noexcept=0
+
virtual bool UpdateInternal(const ByteCursor &toHash) noexcept=0
+
+
Hash & operator=(const Hash &)=delete
+
Hash(const Hash &)=delete
+
bool AWS_CRT_CPP_API ComputeMD5(Allocator *allocator, const ByteCursor &input, ByteBuf &output, size_t truncateTo=0) noexcept
Definition: Hash.cpp:41
+
bool AWS_CRT_CPP_API ComputeSHA1(Allocator *allocator, const ByteCursor &input, ByteBuf &output, size_t truncateTo=0) noexcept
Definition: Hash.cpp:30
+
std::function< std::shared_ptr< ByoHash >(size_t digestSize, Allocator *)> CreateHashCallback
Definition: Hash.h:208
+
static const size_t SHA256_DIGEST_SIZE
Definition: Hash.h:19
+
bool AWS_CRT_CPP_API ComputeSHA256(Allocator *allocator, const ByteCursor &input, ByteBuf &output, size_t truncateTo=0) noexcept
Definition: Hash.cpp:15
+
static const size_t MD5_DIGEST_SIZE
Definition: Hash.h:20
+
static const size_t SHA1_DIGEST_SIZE
Definition: Hash.h:18
+
aws_byte_cursor ByteCursor
Definition: Types.h:31
+
aws_allocator Allocator
Definition: Allocator.h:14
+
AWS_CRT_CPP_API Allocator * ApiAllocator() noexcept
Definition: Allocator.cpp:24
+
aws_byte_buf ByteBuf
Definition: Types.h:30
+
AWS_CRT_CPP_API int LastError() noexcept
Definition: Api.cpp:422
+
Definition: Allocator.h:11
+
Definition: StringView.h:852
+
+
+
+
+
diff --git a/docs/_host_resolver_8cpp.html b/docs/_host_resolver_8cpp.html
new file mode 100644
index 000000000..c3169d35a
--- /dev/null
+++ b/docs/_host_resolver_8cpp.html
@@ -0,0 +1,96 @@
+
+
+
+
+
+
+
+aws-crt-cpp: source/io/HostResolver.cpp File Reference
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ 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 >
+
+
+
+
+
+
diff --git a/docs/_host_resolver_8h.html b/docs/_host_resolver_8h.html
new file mode 100644
index 000000000..cd860ae27
--- /dev/null
+++ b/docs/_host_resolver_8h.html
@@ -0,0 +1,112 @@
+
+
+
+
+
+
+
+aws-crt-cpp: include/aws/crt/io/HostResolver.h File Reference
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ 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/io/host_resolver.h>
+
#include <functional>
+
+
Go to the source code of this file.
+
+
+
+
+
+
diff --git a/docs/_host_resolver_8h_source.html b/docs/_host_resolver_8h_source.html
new file mode 100644
index 000000000..0735418e3
--- /dev/null
+++ b/docs/_host_resolver_8h_source.html
@@ -0,0 +1,170 @@
+
+
+
+
+
+
+
+aws-crt-cpp: include/aws/crt/io/HostResolver.h Source File
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ aws-crt-cpp
+
+ C++ wrapper around the aws-c-* libraries. Provides Cross-Platform Transport Protocols and SSL/TLS implementations for C++.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
Go to the documentation of this file.
+
+
+
8 #include <aws/io/host_resolver.h>
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
41 virtual aws_host_resolver *GetUnderlyingHandle() noexcept = 0;
+
43 virtual aws_host_resolution_config *GetConfig() noexcept = 0;
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
88 operator bool() const noexcept {
return m_initialized; }
+
+
93 int LastError () const noexcept {
return aws_last_error(); }
+
+
+
+
104 aws_host_resolver *GetUnderlyingHandle() noexcept
override {
return m_resolver; }
+
106 aws_host_resolution_config *GetConfig() noexcept
override {
return &m_config; }
+
+
+
109 aws_host_resolver *m_resolver;
+
110 aws_host_resolution_config m_config;
+
+
+
+
114 static void s_onHostResolved(
+
115 struct aws_host_resolver *resolver,
+
116 const struct aws_string *host_name,
+
+
118 const struct aws_array_list *host_addresses,
+
+
+
+
+
+
#define AWS_CRT_CPP_API
Definition: Exports.h:37
+
+
Definition: HostResolver.h:51
+
DefaultHostResolver & operator=(DefaultHostResolver &&)=delete
+
DefaultHostResolver & operator=(const DefaultHostResolver &)=delete
+
DefaultHostResolver(DefaultHostResolver &&)=delete
+
DefaultHostResolver(const DefaultHostResolver &)=delete
+
int LastError() const noexcept
Definition: HostResolver.h:93
+
Definition: EventLoopGroup.h:33
+
Definition: HostResolver.h:35
+
virtual bool ResolveHost(const String &host, const OnHostResolved &onResolved) noexcept=0
+
aws_host_address HostAddress
Definition: HostResolver.h:21
+
std::function< void(HostResolver &resolver, const Vector< HostAddress > &addresses, int errorCode)> OnHostResolved
Definition: HostResolver.h:29
+
aws_allocator Allocator
Definition: Allocator.h:14
+
AWS_CRT_CPP_API Allocator * ApiAllocator() noexcept
Definition: Allocator.cpp:24
+
std::basic_string< char, std::char_traits< char >, StlAllocator< char > > String
Definition: Types.h:45
+
std::vector< T, StlAllocator< T > > Vector
Definition: Types.h:53
+
Definition: Allocator.h:11
+
+
+
+
+
diff --git a/docs/_http_connection_8cpp.html b/docs/_http_connection_8cpp.html
new file mode 100644
index 000000000..bc79c90a5
--- /dev/null
+++ b/docs/_http_connection_8cpp.html
@@ -0,0 +1,104 @@
+
+
+
+
+
+
+
+aws-crt-cpp: source/http/HttpConnection.cpp File Reference
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ aws-crt-cpp
+
+ C++ wrapper around the aws-c-* libraries. Provides Cross-Platform Transport Protocols and SSL/TLS implementations for C++.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/docs/_http_connection_8h.html b/docs/_http_connection_8h.html
new file mode 100644
index 000000000..423b45f54
--- /dev/null
+++ b/docs/_http_connection_8h.html
@@ -0,0 +1,159 @@
+
+
+
+
+
+
+
+aws-crt-cpp: include/aws/crt/http/HttpConnection.h File Reference
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ 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.
+
+
+
+
+
+
diff --git a/docs/_http_connection_8h_source.html b/docs/_http_connection_8h_source.html
new file mode 100644
index 000000000..1a0d07c97
--- /dev/null
+++ b/docs/_http_connection_8h_source.html
@@ -0,0 +1,433 @@
+
+
+
+
+
+
+
+aws-crt-cpp: include/aws/crt/http/HttpConnection.h Source File
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ aws-crt-cpp
+
+ C++ wrapper around the aws-c-* libraries. Provides Cross-Platform Transport Protocols and SSL/TLS implementations for C++.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
Go to the documentation of this file.
+
6 #include <aws/http/connection.h>
+
7 #include <aws/http/proxy.h>
+
8 #include <aws/http/request_response.h>
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
24 class ClientBootstrap;
+
+
+
+
+
29 class HttpClientConnection;
+
+
31 class HttpClientStream;
+
+
33 class HttpProxyStrategy;
+
+
+
+
43 std::function<void(
const std::shared_ptr<HttpClientConnection> &connection,
int errorCode)>;
+
+
+
+
+
+
65 enum aws_http_header_block headerBlock,
+
+
67 std::size_t headersCount)>;
+
+
+
76 std::function<void(
HttpStream &stream,
enum aws_http_header_block block)>;
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
144 virtual
int GetResponseStatusCode() const noexcept = 0;
+
+
155 void UpdateWindow(
std ::
size_t incrementSize) noexcept;
+
+
+
158 aws_http_stream *m_stream;
+
+
+
+
+
+
+
+
+
+
168 static
int s_onIncomingHeaders(
+
169 struct aws_http_stream *stream,
+
170 enum aws_http_header_block headerBlock,
+
171 const struct aws_http_header *headerArray,
+
+
173 void *userData) noexcept;
+
174 static
int s_onIncomingHeaderBlockDone(
+
175 struct aws_http_stream *stream,
+
176 enum aws_http_header_block headerBlock,
+
177 void *userData) noexcept;
+
178 static
int s_onIncomingBody(
+
179 struct aws_http_stream *stream,
+
180 const struct aws_byte_cursor *data,
+
181 void *userData) noexcept;
+
182 static
void s_onStreamComplete(struct aws_http_stream *stream,
int errorCode,
void *userData) noexcept;
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
210 virtual int GetResponseStatusCode() const noexcept override;
+
+
217 bool Activate() noexcept;
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
251 Legacy = AWS_HPCT_HTTP_LEGACY,
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
289 void InitializeRawProxyOptions(
struct aws_http_proxy_options &raw_options)
const ;
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
426 Unknown = AWS_HTTP_VERSION_UNKNOWN,
+
427 Http1_0 = AWS_HTTP_VERSION_1_0,
+
428 Http1_1 = AWS_HTTP_VERSION_1_1,
+
429 Http2 = AWS_HTTP_VERSION_2,
+
+
+
+
+
+
+
+
+
+
+
+
456 std::shared_ptr<HttpClientStream> NewClientStream(
const HttpRequestOptions &requestOptions) noexcept;
+
+
461 bool IsOpen() const noexcept;
+
+
470 void Close() noexcept;
+
+
+
+
+
+
490 static bool CreateConnection(
+
+
+
+
+
+
+
+
+
+
+
+
502 static void s_onClientConnectionSetup(
+
503 struct aws_http_connection *connection,
+
+
505 void *user_data) noexcept;
+
506 static void s_onClientConnectionShutdown(
+
507 struct aws_http_connection *connection,
+
+
509 void *user_data) noexcept;
+
+
+
+
+
+
+
#define AWS_CRT_CPP_API
Definition: Exports.h:37
+
+
+
+
Definition: HttpConnection.h:436
+
HttpClientConnection & operator=(HttpClientConnection &&)=delete
+
virtual ~HttpClientConnection()=default
+
aws_http_connection * m_connection
Definition: HttpConnection.h:496
+
HttpClientConnection & operator=(const HttpClientConnection &)=delete
+
HttpClientConnection(const HttpClientConnection &)=delete
+
HttpClientConnection(HttpClientConnection &&)=delete
+
Definition: HttpConnection.h:347
+
Optional< HttpClientConnectionProxyOptions > ProxyOptions
Definition: HttpConnection.h:412
+
HttpClientConnectionOptions(HttpClientConnectionOptions &&rhs)=default
+
HttpClientConnectionOptions & operator=(HttpClientConnectionOptions &&rhs)=default
+
Optional< Io::TlsConnectionOptions > TlsOptions
Definition: HttpConnection.h:406
+
size_t InitialWindowSize
Definition: HttpConnection.h:368
+
HttpClientConnectionOptions(const HttpClientConnectionOptions &rhs)=default
+
OnConnectionSetup OnConnectionSetupCallback
Definition: HttpConnection.h:375
+
Io::SocketOptions SocketOptions
Definition: HttpConnection.h:400
+
String HostName
Definition: HttpConnection.h:388
+
OnConnectionShutdown OnConnectionShutdownCallback
Definition: HttpConnection.h:382
+
Io::ClientBootstrap * Bootstrap
Definition: HttpConnection.h:363
+
HttpClientConnectionOptions & operator=(const HttpClientConnectionOptions &rhs)=default
+
~HttpClientConnectionOptions()=default
+
bool ManualWindowManagement
Definition: HttpConnection.h:421
+
uint32_t Port
Definition: HttpConnection.h:394
+
Definition: HttpConnection.h:270
+
AwsHttpProxyConnectionType ProxyConnectionType
Definition: HttpConnection.h:312
+
~HttpClientConnectionProxyOptions()=default
+
HttpClientConnectionProxyOptions & operator=(HttpClientConnectionProxyOptions &&rhs)=default
+
HttpClientConnectionProxyOptions(const HttpClientConnectionProxyOptions &rhs)=default
+
HttpClientConnectionProxyOptions(HttpClientConnectionProxyOptions &&rhs)=default
+
Optional< Io::TlsConnectionOptions > TlsOptions
Definition: HttpConnection.h:307
+
String BasicAuthPassword
Definition: HttpConnection.h:340
+
HttpClientConnectionProxyOptions & operator=(const HttpClientConnectionProxyOptions &rhs)=default
+
uint32_t Port
Definition: HttpConnection.h:301
+
std::shared_ptr< HttpProxyStrategy > ProxyStrategy
Definition: HttpConnection.h:318
+
AwsHttpProxyAuthenticationType AuthType
Definition: HttpConnection.h:328
+
String BasicAuthUsername
Definition: HttpConnection.h:334
+
String HostName
Definition: HttpConnection.h:295
+
Definition: HttpConnection.h:198
+
HttpClientStream & operator=(const HttpClientStream &)=delete
+
HttpClientStream(const HttpClientStream &)=delete
+
HttpClientStream(HttpClientStream &&)=delete
+
HttpClientStream & operator=(HttpClientStream &&)=delete
+
Definition: HttpRequestResponse.h:110
+
Definition: HttpConnection.h:128
+
HttpStream(const HttpStream &)=delete
+
HttpStream(HttpStream &&)=delete
+
HttpStream & operator=(const HttpStream &)=delete
+
HttpStream & operator=(HttpStream &&)=delete
+
Definition: Bootstrap.h:35
+
Definition: SocketOptions.h:48
+
Definition: Optional.h:18
+
aws_http_header HttpHeader
Definition: HttpConnection.h:34
+
std::function< void(HttpClientConnection &connection, int errorCode)> OnConnectionShutdown
Definition: HttpConnection.h:53
+
AwsHttpProxyConnectionType
Definition: HttpConnection.h:243
+
+
+
+
std::function< void(HttpStream &stream, int errorCode)> OnStreamComplete
Definition: HttpConnection.h:94
+
std::function< void(HttpStream &stream, enum aws_http_header_block block)> OnIncomingHeadersBlockDone
Definition: HttpConnection.h:76
+
std::function< void(HttpStream &stream, enum aws_http_header_block headerBlock, const HttpHeader *headersArray, std::size_t headersCount)> OnIncomingHeaders
Definition: HttpConnection.h:67
+
std::function< void(HttpStream &stream, const ByteCursor &data)> OnIncomingBody
Definition: HttpConnection.h:84
+
std::function< void(const std::shared_ptr< HttpClientConnection > &connection, int errorCode)> OnConnectionSetup
Definition: HttpConnection.h:43
+
AwsHttpProxyAuthenticationType
Definition: HttpConnection.h:233
+
+
HttpVersion
Definition: HttpConnection.h:425
+
+
+
+
aws_byte_cursor ByteCursor
Definition: Types.h:31
+
+
aws_allocator Allocator
Definition: Allocator.h:14
+
std::basic_string< char, std::char_traits< char >, StlAllocator< char > > String
Definition: Types.h:45
+
AWS_CRT_CPP_API int LastError() noexcept
Definition: Api.cpp:422
+
Definition: Allocator.h:11
+
Definition: StringView.h:852
+
Definition: HttpConnection.h:188
+
ClientStreamCallbackData()
Definition: HttpConnection.h:189
+
Allocator * allocator
Definition: HttpConnection.h:190
+
std::shared_ptr< HttpStream > stream
Definition: HttpConnection.h:191
+
Definition: HttpConnection.h:100
+
OnStreamComplete onStreamComplete
Definition: HttpConnection.h:120
+
OnIncomingHeaders onIncomingHeaders
Definition: HttpConnection.h:109
+
OnIncomingHeadersBlockDone onIncomingHeadersBlockDone
Definition: HttpConnection.h:110
+
HttpRequest * request
Definition: HttpConnection.h:104
+
OnIncomingBody onIncomingBody
Definition: HttpConnection.h:115
+
+
+
+
+
diff --git a/docs/_http_connection_manager_8cpp.html b/docs/_http_connection_manager_8cpp.html
new file mode 100644
index 000000000..5d22014d8
--- /dev/null
+++ b/docs/_http_connection_manager_8cpp.html
@@ -0,0 +1,104 @@
+
+
+
+
+
+
+
+aws-crt-cpp: source/http/HttpConnectionManager.cpp File Reference
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ 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>
+
+
+
+
+
+
diff --git a/docs/_http_connection_manager_8h.html b/docs/_http_connection_manager_8h.html
new file mode 100644
index 000000000..5d21940ea
--- /dev/null
+++ b/docs/_http_connection_manager_8h.html
@@ -0,0 +1,112 @@
+
+
+
+
+
+
+
+aws-crt-cpp: include/aws/crt/http/HttpConnectionManager.h File Reference
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ 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.
+
+
+
+
+
+
diff --git a/docs/_http_connection_manager_8h_source.html b/docs/_http_connection_manager_8h_source.html
new file mode 100644
index 000000000..7a991af8e
--- /dev/null
+++ b/docs/_http_connection_manager_8h_source.html
@@ -0,0 +1,171 @@
+
+
+
+
+
+
+
+aws-crt-cpp: include/aws/crt/http/HttpConnectionManager.h Source File
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ aws-crt-cpp
+
+ C++ wrapper around the aws-c-* libraries. Provides Cross-Platform Transport Protocols and SSL/TLS implementations for C++.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
Go to the documentation of this file.
+
+
+
+
9 #include <condition_variable>
+
+
+
+
13 struct aws_http_connection_manager;
+
+
+
+
+
+
+
+
+
27 std::function<void(std::shared_ptr<HttpClientConnection>,
int errorCode)>;
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
66 :
public std::enable_shared_from_this<HttpClientConnectionManager>
+
+
+
+
+
+
+
90 std::future<void> InitiateShutdown() noexcept;
+
+
99 static std::shared_ptr<HttpClientConnectionManager> NewClientConnectionManager(
+
+
+
+
+
+
+
+
+
+
+
110 aws_http_connection_manager *m_connectionManager;
+
+
+
113 std::promise<void> m_shutdownPromise;
+
114 std::atomic<bool> m_releaseInvoked;
+
+
116 static void s_onConnectionSetup(
+
117 aws_http_connection *connection,
+
+
119 void *userData) noexcept;
+
+
121 static void s_shutdownCompleted(
void *userData) noexcept;
+
+
+
+
+
+
+
#define AWS_CRT_CPP_API
Definition: Exports.h:37
+
+
Definition: HttpConnectionManager.h:67
+
Definition: HttpConnectionManager.h:33
+
HttpClientConnectionOptions ConnectionOptions
Definition: HttpConnectionManager.h:45
+
HttpClientConnectionManagerOptions & operator=(const HttpClientConnectionManagerOptions &rhs)=default
+
size_t MaxConnections
Definition: HttpConnectionManager.h:50
+
HttpClientConnectionManagerOptions & operator=(HttpClientConnectionManagerOptions &&rhs)=default
+
HttpClientConnectionManagerOptions(HttpClientConnectionManagerOptions &&rhs)=default
+
bool EnableBlockingShutdown
Definition: HttpConnectionManager.h:59
+
HttpClientConnectionManagerOptions(const HttpClientConnectionManagerOptions &rhs)=default
+
Definition: HttpConnection.h:347
+
Definition: HttpConnectionManager.cpp:177
+
std::function< void(std::shared_ptr< HttpClientConnection >, int errorCode)> OnClientConnectionAvailable
Definition: HttpConnectionManager.h:27
+
aws_allocator Allocator
Definition: Allocator.h:14
+
AWS_CRT_CPP_API Allocator * ApiAllocator() noexcept
Definition: Allocator.cpp:24
+
Definition: Allocator.h:11
+
+
+
+
+
diff --git a/docs/_http_proxy_strategy_8cpp.html b/docs/_http_proxy_strategy_8cpp.html
new file mode 100644
index 000000000..828da57d8
--- /dev/null
+++ b/docs/_http_proxy_strategy_8cpp.html
@@ -0,0 +1,101 @@
+
+
+
+
+
+
+
+aws-crt-cpp: source/http/HttpProxyStrategy.cpp File Reference
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ 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>
+
+
+
+
+
+
diff --git a/docs/_http_proxy_strategy_8h.html b/docs/_http_proxy_strategy_8h.html
new file mode 100644
index 000000000..86693d137
--- /dev/null
+++ b/docs/_http_proxy_strategy_8h.html
@@ -0,0 +1,113 @@
+
+
+
+
+
+
+
+aws-crt-cpp: include/aws/crt/http/HttpProxyStrategy.h File Reference
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ aws-crt-cpp
+
+ C++ wrapper around the aws-c-* libraries. Provides Cross-Platform Transport Protocols and SSL/TLS implementations for C++.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/docs/_http_proxy_strategy_8h_source.html b/docs/_http_proxy_strategy_8h_source.html
new file mode 100644
index 000000000..ca4e5b1de
--- /dev/null
+++ b/docs/_http_proxy_strategy_8h_source.html
@@ -0,0 +1,161 @@
+
+
+
+
+
+
+
+aws-crt-cpp: include/aws/crt/http/HttpProxyStrategy.h Source File
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ aws-crt-cpp
+
+ C++ wrapper around the aws-c-* libraries. Provides Cross-Platform Transport Protocols and SSL/TLS implementations for C++.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
Go to the documentation of this file.
+
+
+
+
+
11 struct aws_http_proxy_strategy;
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
88 struct aws_http_proxy_strategy *GetUnderlyingHandle()
const noexcept {
return m_strategy; }
+
+
96 static std::shared_ptr<HttpProxyStrategy> CreateBasicHttpProxyStrategy(
+
+
+
+
107 static std::shared_ptr<HttpProxyStrategy> CreateAdaptiveHttpProxyStrategy(
+
+
+
+
+
+
+
+
+
+
#define AWS_CRT_CPP_API
Definition: Exports.h:37
+
+
Definition: HttpProxyStrategy.h:82
+
struct aws_http_proxy_strategy * m_strategy
Definition: HttpProxyStrategy.h:112
+
AwsHttpProxyConnectionType
Definition: HttpConnection.h:243
+
std::function< bool(String &)> KerberosGetTokenFunction
Definition: HttpProxyStrategy.h:45
+
std::function< bool(const String &, String &)> NtlmGetTokenFunction
Definition: HttpProxyStrategy.h:46
+
aws_allocator Allocator
Definition: Allocator.h:14
+
AWS_CRT_CPP_API Allocator * ApiAllocator() noexcept
Definition: Allocator.cpp:24
+
std::basic_string< char, std::char_traits< char >, StlAllocator< char > > String
Definition: Types.h:45
+
Definition: Allocator.h:11
+
Definition: HttpProxyStrategy.h:58
+
KerberosGetTokenFunction NtlmGetCredential
Definition: HttpProxyStrategy.h:69
+
HttpProxyStrategyAdaptiveConfig()
Definition: HttpProxyStrategy.h:59
+
KerberosGetTokenFunction KerberosGetToken
Definition: HttpProxyStrategy.h:64
+
NtlmGetTokenFunction NtlmGetToken
Definition: HttpProxyStrategy.h:74
+
Definition: HttpProxyStrategy.h:25
+
String Username
Definition: HttpProxyStrategy.h:37
+
AwsHttpProxyConnectionType ConnectionType
Definition: HttpProxyStrategy.h:32
+
String Password
Definition: HttpProxyStrategy.h:42
+
+
+
+
+
diff --git a/docs/_http_request_response_8cpp.html b/docs/_http_request_response_8cpp.html
new file mode 100644
index 000000000..661be5423
--- /dev/null
+++ b/docs/_http_request_response_8cpp.html
@@ -0,0 +1,95 @@
+
+
+
+
+
+
+
+aws-crt-cpp: source/http/HttpRequestResponse.cpp File Reference
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ 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>
+
+
+
+
+
+
diff --git a/docs/_http_request_response_8h.html b/docs/_http_request_response_8h.html
new file mode 100644
index 000000000..261cb15d2
--- /dev/null
+++ b/docs/_http_request_response_8h.html
@@ -0,0 +1,110 @@
+
+
+
+
+
+
+
+aws-crt-cpp: include/aws/crt/http/HttpRequestResponse.h File Reference
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ aws-crt-cpp
+
+ C++ wrapper around the aws-c-* libraries. Provides Cross-Platform Transport Protocols and SSL/TLS implementations for C++.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/docs/_http_request_response_8h_source.html b/docs/_http_request_response_8h_source.html
new file mode 100644
index 000000000..ebd770ca1
--- /dev/null
+++ b/docs/_http_request_response_8h_source.html
@@ -0,0 +1,195 @@
+
+
+
+
+
+
+
+aws-crt-cpp: include/aws/crt/http/HttpRequestResponse.h Source File
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ aws-crt-cpp
+
+ C++ wrapper around the aws-c-* libraries. Provides Cross-Platform Transport Protocols and SSL/TLS implementations for C++.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
Go to the documentation of this file.
+
+
+
+
+
11 struct aws_http_header;
+
12 struct aws_http_message;
+
+
+
+
+
+
+
+
+
21 class MqttConnectionCore;
+
+
+
+
25 class Mqtt5ClientCore;
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
47 std::shared_ptr<Aws::Crt::Io::InputStream> GetBody() const noexcept;
+
+
54 bool SetBody(const
std ::shared_ptr<
Aws ::Crt::Io::
IStream > &body) noexcept;
+
+
61 bool SetBody(const
std ::shared_ptr<
Aws ::Crt::Io::InputStream> &body) noexcept;
+
+
67 size_t GetHeaderCount() const noexcept;
+
+
+
+
81 bool AddHeader(const
HttpHeader &header) noexcept;
+
+
88 bool EraseHeader(
size_t index) noexcept;
+
+
93 operator
bool () const noexcept {
return m_message !=
nullptr ; }
+
+
96 struct aws_http_message *GetUnderlyingMessage() const noexcept {
return m_message; }
+
+
+
99 HttpMessage(
Allocator *allocator,
struct aws_http_message *message) noexcept;
+
+
+
+
+
+
+
+
+
111 friend class Mqtt::MqttConnectionCore;
+
112 friend class Mqtt5::Mqtt5ClientCore;
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
157 bool SetResponseCode(
int response) noexcept;
+
+
+
+
+
+
#define AWS_CRT_CPP_API
Definition: Exports.h:37
+
+
+
Definition: HttpRequestResponse.h:35
+
HttpMessage & operator=(HttpMessage &&)=delete
+
std::shared_ptr< Aws::Crt::Io::InputStream > m_bodyStream
Definition: HttpRequestResponse.h:103
+
HttpMessage(HttpMessage &&)=delete
+
struct aws_http_message * m_message
Definition: HttpRequestResponse.h:102
+
HttpMessage & operator=(const HttpMessage &)=delete
+
Allocator * m_allocator
Definition: HttpRequestResponse.h:101
+
HttpMessage(const HttpMessage &)=delete
+
Definition: HttpRequestResponse.h:110
+
Definition: HttpRequestResponse.h:145
+
Definition: MqttConnection.h:158
+
Definition: Optional.h:18
+
aws_http_header HttpHeader
Definition: HttpConnection.h:34
+
std::basic_istream< char, std::char_traits< char > > IStream
Definition: Types.h:35
+
aws_byte_cursor ByteCursor
Definition: Types.h:31
+
aws_allocator Allocator
Definition: Allocator.h:14
+
AWS_CRT_CPP_API Allocator * ApiAllocator() noexcept
Definition: Allocator.cpp:24
+
Definition: Allocator.h:11
+
Definition: StringView.h:852
+
+
+
+
+
diff --git a/docs/_imds_client_8cpp.html b/docs/_imds_client_8cpp.html
new file mode 100644
index 000000000..4a80612fa
--- /dev/null
+++ b/docs/_imds_client_8cpp.html
@@ -0,0 +1,104 @@
+
+
+
+
+
+
+
+aws-crt-cpp: source/ImdsClient.cpp File Reference
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ 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 >
+
+
+
+
+
+
diff --git a/docs/_imds_client_8h.html b/docs/_imds_client_8h.html
new file mode 100644
index 000000000..5c283a460
--- /dev/null
+++ b/docs/_imds_client_8h.html
@@ -0,0 +1,131 @@
+
+
+
+
+
+
+
+aws-crt-cpp: include/aws/crt/ImdsClient.h File Reference
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ 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.
+
+
+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)>
+
+
+
+
+
+
+
diff --git a/docs/_imds_client_8h_source.html b/docs/_imds_client_8h_source.html
new file mode 100644
index 000000000..bac53bb74
--- /dev/null
+++ b/docs/_imds_client_8h_source.html
@@ -0,0 +1,343 @@
+
+
+
+
+
+
+
+aws-crt-cpp: include/aws/crt/ImdsClient.h Source File
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ aws-crt-cpp
+
+ C++ wrapper around the aws-c-* libraries. Provides Cross-Platform Transport Protocols and SSL/TLS implementations for C++.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
Go to the documentation of this file.
+
+
+
+
+
+
12 struct aws_credentials;
+
13 struct aws_imds_client;
+
14 struct aws_imds_instance_info;
+
15 struct aws_imds_iam_profile;
+
+
+
+
+
+
+
+
+
+
25 class ClientBootstrap;
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
132 std::function<void(
const Vector<StringView> &resource,
int errorCode,
void *userData)>;
+
+
134 std::function<void(
const Auth::Credentials &credentials,
int errorCode,
void *userData)>;
+
+
136 std::function<void(
const IamProfileView &iamProfile,
int errorCode,
void *userData)>;
+
+
138 std::function<void(
const InstanceInfoView &instanceInfo,
int errorCode,
void *userData)>;
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
364 static void s_onResourceAcquired(
const aws_byte_buf *resource,
int erroCode,
void *userData);
+
+
366 static void s_onVectorResourceAcquired(
const aws_array_list *array,
int errorCode,
void *userData);
+
+
368 static void s_onCredentialsAcquired(
const aws_credentials *credentials,
int errorCode,
void *userData);
+
+
370 static void s_onIamProfileAcquired(
+
371 const aws_imds_iam_profile *iamProfileInfo,
+
+
+
+
375 static void s_onInstanceInfoAcquired(
+
376 const aws_imds_instance_info *instanceInfo,
+
+
+
+
380 aws_imds_client *m_client;
+
+
+
+
+
+
+
+
+
#define AWS_CRT_CPP_API
Definition: Exports.h:37
+
+
Definition: Credentials.h:38
+
Definition: DateTime.h:53
+
Definition: ImdsClient.h:141
+
ImdsClient(ImdsClient &&)=delete
+
ImdsClient & operator=(ImdsClient &&)=delete
+
ImdsClient & operator=(const ImdsClient &)=delete
+
ImdsClient(const ImdsClient &)=delete
+
aws_imds_client * GetUnderlyingHandle()
Definition: ImdsClient.h:152
+
Definition: Bootstrap.h:35
+
Definition: StringView.h:33
+
std::function< void(const StringView &resource, int errorCode, void *userData)> OnResourceAcquired
Definition: ImdsClient.h:130
+
std::function< void(const Vector< StringView > &resource, int errorCode, void *userData)> OnVectorResourceAcquired
Definition: ImdsClient.h:132
+
std::function< void(const Auth::Credentials &credentials, int errorCode, void *userData)> OnCredentialsAcquired
Definition: ImdsClient.h:134
+
std::function< void(const InstanceInfoView &instanceInfo, int errorCode, void *userData)> OnInstanceInfoAcquired
Definition: ImdsClient.h:138
+
std::function< void(const IamProfileView &iamProfile, int errorCode, void *userData)> OnIamProfileAcquired
Definition: ImdsClient.h:136
+
aws_allocator Allocator
Definition: Allocator.h:14
+
AWS_CRT_CPP_API Allocator * ApiAllocator() noexcept
Definition: Allocator.cpp:24
+
std::basic_string< char, std::char_traits< char >, StlAllocator< char > > String
Definition: Types.h:45
+
std::vector< T, StlAllocator< T > > Vector
Definition: Types.h:53
+
Definition: Allocator.h:11
+
Definition: ImdsClient.h:66
+
DateTime lastUpdated
Definition: ImdsClient.h:72
+
String instanceProfileArn
Definition: ImdsClient.h:73
+
IamProfile()
Definition: ImdsClient.h:67
+
String instanceProfileId
Definition: ImdsClient.h:74
+
Definition: ImdsClient.h:56
+
DateTime lastUpdated
Definition: ImdsClient.h:57
+
StringView instanceProfileArn
Definition: ImdsClient.h:58
+
StringView instanceProfileId
Definition: ImdsClient.h:59
+
Definition: ImdsClient.h:37
+
Io::ClientBootstrap * Bootstrap
Definition: ImdsClient.h:47
+
ImdsClientConfig()
Definition: ImdsClient.h:38
+
Definition: ImdsClient.h:106
+
String availabilityZone
Definition: ImdsClient.h:114
+
Vector< String > marketplaceProductCodes
Definition: ImdsClient.h:113
+
String region
Definition: ImdsClient.h:127
+
String imageId
Definition: ImdsClient.h:122
+
String instanceType
Definition: ImdsClient.h:120
+
String version
Definition: ImdsClient.h:116
+
String ramdiskId
Definition: ImdsClient.h:126
+
String privateIp
Definition: ImdsClient.h:115
+
InstanceInfo()
Definition: ImdsClient.h:107
+
String architecture
Definition: ImdsClient.h:124
+
String instanceId
Definition: ImdsClient.h:117
+
Vector< String > billingProducts
Definition: ImdsClient.h:119
+
String accountId
Definition: ImdsClient.h:121
+
String kernelId
Definition: ImdsClient.h:125
+
DateTime pendingTime
Definition: ImdsClient.h:123
+
Definition: ImdsClient.h:83
+
Vector< StringView > marketplaceProductCodes
Definition: ImdsClient.h:85
+
StringView ramdiskId
Definition: ImdsClient.h:98
+
StringView imageId
Definition: ImdsClient.h:94
+
StringView privateIp
Definition: ImdsClient.h:87
+
StringView region
Definition: ImdsClient.h:99
+
StringView version
Definition: ImdsClient.h:88
+
StringView kernelId
Definition: ImdsClient.h:97
+
Vector< StringView > billingProducts
Definition: ImdsClient.h:91
+
StringView architecture
Definition: ImdsClient.h:96
+
StringView instanceType
Definition: ImdsClient.h:92
+
StringView instanceId
Definition: ImdsClient.h:89
+
StringView availabilityZone
Definition: ImdsClient.h:86
+
StringView accountId
Definition: ImdsClient.h:93
+
DateTime pendingTime
Definition: ImdsClient.h:95
+
+
+
+
+
diff --git a/docs/_json_object_8cpp.html b/docs/_json_object_8cpp.html
new file mode 100644
index 000000000..eb38f3f0e
--- /dev/null
+++ b/docs/_json_object_8cpp.html
@@ -0,0 +1,93 @@
+
+
+
+
+
+
+
+aws-crt-cpp: source/JsonObject.cpp File Reference
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ 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>
+
+
+
+
+
+
diff --git a/docs/_json_object_8h.html b/docs/_json_object_8h.html
new file mode 100644
index 000000000..58917c6b1
--- /dev/null
+++ b/docs/_json_object_8h.html
@@ -0,0 +1,101 @@
+
+
+
+
+
+
+
+aws-crt-cpp: include/aws/crt/JsonObject.h File Reference
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ aws-crt-cpp
+
+ C++ wrapper around the aws-c-* libraries. Provides Cross-Platform Transport Protocols and SSL/TLS implementations for C++.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/docs/_json_object_8h_source.html b/docs/_json_object_8h_source.html
new file mode 100644
index 000000000..a3791ea4c
--- /dev/null
+++ b/docs/_json_object_8h_source.html
@@ -0,0 +1,291 @@
+
+
+
+
+
+
+
+aws-crt-cpp: include/aws/crt/JsonObject.h Source File
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ aws-crt-cpp
+
+ C++ wrapper around the aws-c-* libraries. Provides Cross-Platform Transport Protocols and SSL/TLS implementations for C++.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
Go to the documentation of this file.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
80 JsonObject &WithBool(
const char *key,
bool value);
+
+
+
+
+
92 JsonObject &WithInteger(
const char *key,
int value);
+
+
+
+
+
105 JsonObject &WithInt64(
const char *key, int64_t value);
+
+
+
+
+
117 JsonObject &WithDouble(
const char *key,
double value);
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
188 const String &GetErrorMessage()
const ;
+
+
+
+
+
199 JsonObject (
const aws_json_value *valueToCopy);
+
+
205 JsonObject &AsNewValue(aws_json_value *valueToOwn);
+
+
212 JsonObject &WithNewKeyValue(
const char *key, aws_json_value *valueToOwn);
+
+
+
+
+
+
224 aws_json_value *m_value;
+
+
+
+
+
+
+
+
232 static std::unique_ptr<String> s_errorMessage;
+
233 static std::unique_ptr<String> s_okMessage;
+
234 static void OnLibraryInit();
+
235 static void OnLibraryCleanup();
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
262 String GetString(
const char *key)
const ;
+
+
+
+
273 bool GetBool(
const String &key)
const ;
+
277 bool GetBool(
const char *key)
const ;
+
+
+
+
288 int GetInteger(
const String &key)
const ;
+
293 int GetInteger(
const char *key)
const ;
+
+
298 int AsInteger()
const ;
+
+
304 int64_t GetInt64(
const String &key)
const ;
+
309 int64_t GetInt64(
const char *key)
const ;
+
+
314 int64_t AsInt64()
const ;
+
+
319 double GetDouble(
const String &key)
const ;
+
323 double GetDouble(
const char *key)
const ;
+
+
328 double AsDouble()
const ;
+
+
+
+
+
+
+
+
351 JsonView GetJsonObject(
const char *key)
const ;
+
+
+
+
355 JsonObject GetJsonObjectCopy(
const char *key)
const ;
+
+
+
+
+
+
372 bool ValueExists(
const String &key)
const ;
+
377 bool ValueExists(
const char *key)
const ;
+
+
382 bool KeyExists(
const String &key)
const ;
+
386 bool KeyExists(
const char *key)
const ;
+
+
391 bool IsObject()
const ;
+
+
+
+
401 bool IsString()
const ;
+
+
406 bool IsNumber()
const ;
+
+
411 bool IsIntegerType()
const ;
+
+
416 bool IsFloatingPointType()
const ;
+
+
421 bool IsListType()
const ;
+
+
+
+
432 String WriteCompact(
bool treatAsObject =
true )
const ;
+
+
438 String WriteReadable(
bool treatAsObject =
true )
const ;
+
+
+
+
+
446 JsonView (
const aws_json_value *val);
+
+
448 String Write(
bool treatAsObject,
bool readable)
const ;
+
+
450 const aws_json_value *m_value;
+
+
+
+
#define AWS_CRT_CPP_API
Definition: Exports.h:37
+
+
+
+
Definition: JsonObject.h:21
+
bool WasParseSuccessful() const
Definition: JsonObject.h:183
+
Definition: JsonObject.h:248
+
std::map< K, V, std::less< K >, StlAllocator< std::pair< const K, V > >> Map
Definition: Types.h:47
+
std::basic_string< char, std::char_traits< char >, StlAllocator< char > > String
Definition: Types.h:45
+
std::vector< T, StlAllocator< T > > Vector
Definition: Types.h:53
+
bool operator==(const basic_string_view< CharT, Traits > &lhs, const basic_string_view< CharT, Traits > &rhs) noexcept
Definition: StringView.h:666
+
bool operator!=(const basic_string_view< CharT, Traits > &lhs, const basic_string_view< CharT, Traits > &rhs) noexcept
Definition: StringView.h:691
+
Definition: Allocator.h:11
+
+
+
+
+
diff --git a/docs/_mqtt5_client_core_8cpp.html b/docs/_mqtt5_client_core_8cpp.html
new file mode 100644
index 000000000..60f5ab153
--- /dev/null
+++ b/docs/_mqtt5_client_core_8cpp.html
@@ -0,0 +1,79 @@
+
+
+
+
+
+
+
+aws-crt-cpp: source/mqtt/Mqtt5ClientCore.cpp File Reference
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ aws-crt-cpp
+
+ C++ wrapper around the aws-c-* libraries. Provides Cross-Platform Transport Protocols and SSL/TLS implementations for C++.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/docs/_mqtt5_client_core_8h.html b/docs/_mqtt5_client_core_8h.html
new file mode 100644
index 000000000..30cb0aa99
--- /dev/null
+++ b/docs/_mqtt5_client_core_8h.html
@@ -0,0 +1,81 @@
+
+
+
+
+
+
+
+aws-crt-cpp: include/aws/crt/mqtt/private/Mqtt5ClientCore.h File Reference
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ aws-crt-cpp
+
+ C++ wrapper around the aws-c-* libraries. Provides Cross-Platform Transport Protocols and SSL/TLS implementations for C++.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/docs/_mqtt5_client_core_8h_source.html b/docs/_mqtt5_client_core_8h_source.html
new file mode 100644
index 000000000..003cc9937
--- /dev/null
+++ b/docs/_mqtt5_client_core_8h_source.html
@@ -0,0 +1,259 @@
+
+
+
+
+
+
+
+aws-crt-cpp: include/aws/crt/mqtt/private/Mqtt5ClientCore.h Source File
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ aws-crt-cpp
+
+ C++ wrapper around the aws-c-* libraries. Provides Cross-Platform Transport Protocols and SSL/TLS implementations for C++.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
Go to the documentation of this file.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
28 class AWS_CRT_CPP_API Mqtt5ClientCore final :
public std::enable_shared_from_this<Mqtt5ClientCore>
+
+
30 friend class Mqtt5Client;
+
31 friend class Mqtt::MqttConnection;
+
+
+
41 static std::shared_ptr<Mqtt5ClientCore> NewMqtt5ClientCore(
+
42 const Mqtt5ClientOptions &options,
+
+
+
51 std ::shared_ptr<Mqtt5ClientCore> getptr() {
return shared_from_this(); }
+
+
56 operator bool() const noexcept;
+
+
+
+
+
72 std ::shared_ptr<PublishPacket> publishOptions,
+
+
+
+
84 std ::shared_ptr<SubscribePacket> subscribeOptions,
+
+
+
+
96 std ::shared_ptr<UnsubscribePacket> unsubscribeOptions,
+
+
+
108 void Close() noexcept;
+
+
110 virtual ~Mqtt5ClientCore();
+
+
+
+
+
123 std ::shared_ptr<Crt::Mqtt::MqttConnection> NewConnection(
+
124 const Mqtt5::Mqtt5to3AdapterOptions *options) noexcept;
+
+
+
127 static
void s_publishCompletionCallback(
+
128 enum aws_mqtt5_packet_type packet_type,
+
+
+
+
+
133 static
void s_subscribeCompletionCallback(
+
134 const struct aws_mqtt5_packet_suback_view *puback,
+
+
+
+
138 static
void s_unsubscribeCompletionCallback(
+
139 const struct aws_mqtt5_packet_unsuback_view *puback,
+
+
+
+
143 static
void s_lifeCycleEventCallback(const aws_mqtt5_client_lifecycle_event *event);
+
+
145 static
void s_publishReceivedCallback(const aws_mqtt5_packet_publish_view *publish,
void *user_data);
+
+
147 static
void s_onWebsocketHandshake(
+
148 aws_http_message *rawRequest,
+
+
150 aws_mqtt5_transform_websocket_handshake_complete_fn *complete_fn,
+
+
+
153 static
void s_clientTerminationCompletion(
void *complete_ctx);
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
191 std ::shared_ptr<Mqtt5ClientCore> m_selfReference;
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
210 std::recursive_mutex m_callback_lock;
+
+
212 aws_mqtt5_client *m_client;
+
+
+
+
219 class Mqtt5to3AdapterOptions
+
+
221 friend class Mqtt5ClientOptions;
+
222 friend class Mqtt5ClientCore;
+
223 friend class Mqtt::MqttConnection;
+
+
+
+
227 Mqtt5to3AdapterOptions();
+
+
+
+
+
+
+
234 static ScopedResource<Mqtt5to3AdapterOptions> NewMqtt5to3AdapterOptions(
+
235 const Mqtt5ClientOptions &options) noexcept;
+
+
+
238 Mqtt::MqttConnectionOptions m_mqtt3Options;
+
+
+
+
+
+
+
+
+
+
+
+
+
254 Crt::Optional<Crt::Http::HttpClientConnectionProxyOptions> m_proxyOptions;
+
+
+
+
+
+
#define AWS_CRT_CPP_API
Definition: Exports.h:37
+
+
+
+
std::function< void(const PublishReceivedEventData &)> OnPublishReceivedHandler
Definition: Mqtt5Client.h:308
+
std::function< void(int, std::shared_ptr< PublishResult >)> OnPublishCompletionHandler
Definition: Mqtt5Client.h:293
+
std::function< void(const OnStoppedEventData &)> OnStoppedHandler
Definition: Mqtt5Client.h:288
+
std::function< void(const OnDisconnectionEventData &)> OnDisconnectionHandler
Definition: Mqtt5Client.h:276
+
std::function< void(const OnConnectionSuccessEventData &)> OnConnectionSuccessHandler
Definition: Mqtt5Client.h:266
+
std::function< void(const OnAttemptingConnectEventData &)> OnAttemptingConnectHandler
Definition: Mqtt5Client.h:282
+
std::function< void(std::shared_ptr< Http::HttpRequest >, const OnWebSocketHandshakeInterceptComplete &)> OnWebSocketHandshakeIntercept
Definition: Mqtt5Client.h:324
+
std::function< void(const OnConnectionFailureEventData &)> OnConnectionFailureHandler
Definition: Mqtt5Client.h:271
+
std::function< void(int, std::shared_ptr< UnSubAckPacket >)> OnUnsubscribeCompletionHandler
Definition: Mqtt5Client.h:303
+
std::function< void(int, std::shared_ptr< SubAckPacket >)> OnSubscribeCompletionHandler
Definition: Mqtt5Client.h:298
+
std::function< void(std::shared_ptr< Http::HttpRequest > req, const OnWebSocketHandshakeInterceptComplete &onComplete)> OnWebSocketHandshakeIntercept
Definition: MqttConnection.h:146
+
aws_allocator Allocator
Definition: Allocator.h:14
+
AWS_CRT_CPP_API Allocator * ApiAllocator() noexcept
Definition: Allocator.cpp:24
+
std::basic_string< char, std::char_traits< char >, StlAllocator< char > > String
Definition: Types.h:45
+
std::unique_ptr< T, std::function< void(T *)> > ScopedResource
Definition: Types.h:163
+
AWS_CRT_CPP_API int LastError() noexcept
Definition: Api.cpp:422
+
Definition: Allocator.h:11
+
Definition: StringView.h:852
+
+
+
+
+
diff --git a/docs/_mqtt5_packets_8cpp.html b/docs/_mqtt5_packets_8cpp.html
new file mode 100644
index 000000000..6f7186b74
--- /dev/null
+++ b/docs/_mqtt5_packets_8cpp.html
@@ -0,0 +1,122 @@
+
+
+
+
+
+
+
+aws-crt-cpp: source/mqtt/Mqtt5Packets.cpp File Reference
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ aws-crt-cpp
+
+ C++ wrapper around the aws-c-* libraries. Provides Cross-Platform Transport Protocols and SSL/TLS implementations for C++.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+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)
+
+
+
+
+
+
+
diff --git a/docs/_mqtt5_packets_8h.html b/docs/_mqtt5_packets_8h.html
new file mode 100644
index 000000000..8a094ae7e
--- /dev/null
+++ b/docs/_mqtt5_packets_8h.html
@@ -0,0 +1,128 @@
+
+
+
+
+
+
+
+aws-crt-cpp: include/aws/crt/mqtt/Mqtt5Packets.h File Reference
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ aws-crt-cpp
+
+ C++ wrapper around the aws-c-* libraries. Provides Cross-Platform Transport Protocols and SSL/TLS implementations for C++.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/docs/_mqtt5_packets_8h_source.html b/docs/_mqtt5_packets_8h_source.html
new file mode 100644
index 000000000..42e2224bf
--- /dev/null
+++ b/docs/_mqtt5_packets_8h_source.html
@@ -0,0 +1,865 @@
+
+
+
+
+
+
+
+aws-crt-cpp: include/aws/crt/mqtt/Mqtt5Packets.h Source File
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ aws-crt-cpp
+
+ C++ wrapper around the aws-c-* libraries. Provides Cross-Platform Transport Protocols and SSL/TLS implementations for C++.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
Go to the documentation of this file.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
56 const aws_mqtt5_packet_publish_view &raw_options,
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
129 PublishPacket &WithMessageExpiryIntervalSec(uint32_t second) noexcept;
+
+
+
+
+
+
+
+
+
+
+
+
+
+
195 bool initializeRawOptions(aws_mqtt5_packet_publish_view &raw_options) noexcept;
+
+
205 const ByteCursor &getPayload() const noexcept;
+
+
216 Mqtt5::
QOS getQOS() const noexcept;
+
+
227 bool getRetain() const noexcept;
+
+
237 const Crt::
String &getTopic() const noexcept;
+
+
+
+
264 const Crt::
Optional <uint32_t> &getMessageExpiryIntervalSec() const noexcept;
+
+
276 const Crt::
Optional <uint16_t> &getTopicAlias() const noexcept;
+
+
+
+
+
+
310 const Crt::
Vector <uint32_t> &getSubscriptionIdentifiers() const noexcept;
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
396 Crt::
Optional <uint32_t> m_messageExpiryIntervalSec;
+
+
406 Crt::
Optional <uint16_t> m_topicAlias;
+
+
+
+
+
+
+
+
+
+
446 Crt::
Vector <uint32_t> m_subscriptionIdentifiers;
+
+
+
+
+
+
+
460 ByteBuf m_correlationDataStorage;
+
461 Crt::
String m_responseTopicString;
+
462 struct aws_mqtt5_user_property *m_userPropertiesStorage;
+
+
+
+
+
+
+
482 const aws_mqtt5_negotiated_settings &negotiated_settings,
+
+
+
+
+
+
494 uint32_t getSessionExpiryIntervalSec()
const noexcept;
+
+
500 uint16_t getReceiveMaximumFromServer()
const noexcept;
+
+
508 uint32_t getMaximumPacketSizeBytes()
const noexcept;
+
+
513 uint32_t getMaximumPacketSizeToServer()
const noexcept;
+
+
518 uint16_t getTopicAliasMaximumToServer()
const noexcept;
+
+
523 uint16_t getTopicAliasMaximumToClient()
const noexcept;
+
+
532 uint16_t getServerKeepAliveSec()
const noexcept;
+
+
543 uint16_t getServerKeepAlive()
const noexcept;
+
+
548 bool getRetainAvailable()
const noexcept;
+
+
553 bool getWildcardSubscriptionsAvailable()
const noexcept;
+
+
558 bool getSubscriptionIdentifiersAvailable()
const noexcept;
+
+
563 bool getSharedSubscriptionsAvailable()
const noexcept;
+
+
568 bool getRejoinedSession()
const noexcept;
+
+
+
+
+
+
+
+
+
+
+
590 Mqtt5::
QOS m_maximumQOS;
+
+
595 uint32_t m_sessionExpiryIntervalSec;
+
+
600 uint16_t m_receiveMaximumFromServer;
+
+
605 uint32_t m_maximumPacketSizeBytes;
+
+
610 uint16_t m_topicAliasMaximumToServer;
+
+
615 uint16_t m_topicAliasMaximumToClient;
+
+
622 uint16_t m_serverKeepAliveSec;
+
+
627 bool m_retainAvailable;
+
+
632 bool m_wildcardSubscriptionsAvailable;
+
+
637 bool m_subscriptionIdentifiersAvailable;
+
+
642 bool m_sharedSubscriptionsAvailable;
+
+
647 bool m_rejoinedSession;
+
+
+
+
+
+
+
+
+
+
+
+
+
+
689 ConnectPacket &WithKeepAliveIntervalSec(uint16_t keepAliveInteralSeconds) noexcept;
+
+
+
+
+
+
+
+
742 ConnectPacket &WithSessionExpiryIntervalSec(uint32_t sessionExpiryIntervalSeconds) noexcept;
+
+
756 ConnectPacket &WithRequestResponseInformation(
bool requestResponseInformation) noexcept;
+
+
770 ConnectPacket &WithRequestProblemInformation(
bool requestProblemInformation) noexcept;
+
+
783 ConnectPacket &WithReceiveMaximum(uint16_t receiveMaximum) noexcept;
+
+
795 ConnectPacket &WithMaximumPacketSizeBytes(uint32_t maximumPacketSizeBytes) noexcept;
+
+
810 ConnectPacket &WithWillDelayIntervalSec(uint32_t willDelayIntervalSeconds) noexcept;
+
+
823 ConnectPacket &WithWill(std::shared_ptr<PublishPacket> will) noexcept;
+
+
+
+
+
+
+
+
+
+
+
+
875 uint16_t getKeepAliveIntervalSec() const noexcept;
+
+
889 const Crt::
String &getClientId() const noexcept;
+
+
+
+
+
+
923 const Crt::
Optional <uint32_t> &getSessionExpiryIntervalSec() const noexcept;
+
+
935 const Crt::
Optional <
bool > &getRequestResponseInformation() const noexcept;
+
+
947 const Crt::
Optional <
bool > &getRequestProblemInformation() const noexcept;
+
+
958 const Crt::
Optional <uint16_t> &getReceiveMaximum() const noexcept;
+
+
971 const Crt::
Optional <uint32_t> &getMaximumPacketSizeBytes() const noexcept;
+
+
982 const Crt::
Optional <uint32_t> &getMaximumPacketSizeToServer() const noexcept;
+
+
996 const Crt::
Optional <uint32_t> &getWillDelayIntervalSec() const noexcept;
+
+
+
+
+
+
1028 bool initializeRawOptions(aws_mqtt5_packet_connect_view &raw_options,
Allocator *allocator) noexcept;
+
+
+
+
+
+
+
+
+
+
+
1049 uint16_t m_keepAliveIntervalSec;
+
+
+
+
+
+
+
+
1088 Crt::
Optional <uint32_t> m_sessionExpiryIntervalSec;
+
+
1098 Crt::
Optional <
bool > m_requestResponseInformation;
+
+
1107 Crt::
Optional <
bool > m_requestProblemInformation;
+
+
1116 Crt::
Optional <uint16_t> m_receiveMaximum;
+
+
1125 Crt::
Optional <uint32_t> m_maximumPacketSizeBytes;
+
+
1136 Crt::
Optional <uint32_t> m_willDelayIntervalSeconds;
+
+
+
+
+
+
+
1158 struct aws_byte_cursor m_usernameCursor;
+
1159 struct aws_byte_buf m_passowrdStorage;
+
1160 struct aws_mqtt5_packet_publish_view m_willStorage;
+
1161 struct aws_mqtt5_user_property *m_userPropertiesStorage;
+
1162 uint8_t m_requestResponseInformationStorage;
+
1163 uint8_t m_requestProblemInformationStorage;
+
+
+
+
+
+
+
1174 const aws_mqtt5_packet_connack_view &packet,
+
+
+
+
+
+
1188 bool getSessionPresent() const noexcept;
+
+
+
+
1210 const Crt::
Optional <uint32_t> &getSessionExpiryIntervalSec() const noexcept;
+
+
1224 const Crt::
Optional <uint32_t> &getSessionExpiryInterval() const noexcept;
+
+
1236 const Crt::
Optional <uint16_t> &getReceiveMaximum() const noexcept;
+
+
1246 const Crt::
Optional <
QOS > &getMaximumQOS() const noexcept;
+
+
1257 const Crt::
Optional <
bool > &getRetainAvailable() const noexcept;
+
+
1268 const Crt::
Optional <uint32_t> &getMaximumPacketSize() const noexcept;
+
+
1279 const Crt::
Optional <
String > &getAssignedClientIdentifier() const noexcept;
+
+
1289 const Crt::
Optional <uint16_t> getTopicAliasMaximum() const noexcept;
+
+
+
+
+
+
1320 const Crt::
Optional <
bool > &getWildcardSubscriptionsAvailable() const noexcept;
+
+
1331 const Crt::
Optional <
bool > &getSubscriptionIdentifiersAvailable() const noexcept;
+
+
1342 const Crt::
Optional <
bool > &getSharedSubscriptionsAvailable() const noexcept;
+
+
1353 const Crt::
Optional <uint16_t> &getServerKeepAliveSec() const noexcept;
+
+
1365 const Crt::
Optional <uint16_t> &getServerKeepAlive() const noexcept;
+
+
1376 const Crt::
Optional <
String > &getResponseInformation() const noexcept;
+
+
1389 const Crt::
Optional <
String > &getServerReference() const noexcept;
+
+
+
+
+
+
+
+
+
1404 bool m_sessionPresent;
+
+
+
+
1421 Crt::
Optional <uint32_t> m_sessionExpiryIntervalSec;
+
+
1430 Crt::
Optional <uint16_t> m_receiveMaximum;
+
+
+
+
1446 Crt::
Optional <
bool > m_retainAvailable;
+
+
1455 Crt::
Optional <uint32_t> m_maximumPacketSize;
+
+
+
+
1472 Crt::
Optional <uint16_t> m_topicAliasMaximum;
+
+
+
+
1489 Crt::
Optional <
bool > m_wildcardSubscriptionsAvailable;
+
+
1498 Crt::
Optional <
bool > m_subscriptionIdentifiersAvailable;
+
+
1507 Crt::
Optional <
bool > m_sharedSubscriptionsAvailable;
+
+
1516 Crt::
Optional <uint16_t> m_serverKeepAliveSec;
+
+
+
+
+
+
+
+
+
+
+
+
+
+
1555 const aws_mqtt5_packet_disconnect_view &raw_options,
+
+
+
+
+
1560 bool initializeRawOptions(aws_mqtt5_packet_disconnect_view &raw_options) noexcept;
+
+
+
+
1584 DisconnectPacket &WithSessionExpiryIntervalSec(
const uint32_t sessionExpiryIntervalSeconds) noexcept;
+
+
+
+
+
+
+
+
+
+
+
+
+
+
1666 const Crt::
Optional <uint32_t> &getSessionExpiryIntervalSec() const noexcept;
+
+
1676 const Crt::
Optional <Crt::
String > &getReasonString() const noexcept;
+
+
1689 const Crt::
Optional <Crt::
String > &getServerReference() const noexcept;
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
1726 Crt::
Optional <uint32_t> m_sessionExpiryIntervalSec;
+
+
+
+
+
+
+
+
+
1757 struct aws_byte_cursor m_reasonStringCursor;
+
1758 struct aws_byte_cursor m_serverReferenceCursor;
+
1759 struct aws_mqtt5_user_property *m_userPropertiesStorage;
+
+
+
+
+
+
+
1770 const aws_mqtt5_packet_puback_view &packet,
+
+
+
+
+
+
+
1793 const Crt::
Optional <Crt::
String > &getReasonString() const noexcept;
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
1870 std::shared_ptr<IPacket>
getAck ()
const {
return m_ack; };
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
1941 Subscription &WithRetainAsPublished(
bool retain) noexcept;
+
+
+
+
+
+
1969 bool initializeRawOptions(aws_mqtt5_subscription_view &raw_options)
const noexcept;
+
+
+
+
+
+
+
+
+
+
+
1986 Crt::
String m_topicFilter;
+
+
+
+
+
+
2012 bool m_retainAsPublished;
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
2079 SubscribePacket &WithSubscriptionIdentifier(uint32_t subscriptionIdentifier) noexcept;
+
+
+
+
+
+
+
+
2108 bool initializeRawOptions(aws_mqtt5_packet_subscribe_view &raw_options) noexcept;
+
+
+
+
+
+
+
+
+
+
+
+
+
2134 Crt::
Optional <uint32_t> m_subscriptionIdentifier;
+
+
+
+
+
2147 struct aws_mqtt5_subscription_view *m_subscriptionViewStorage;
+
2148 struct aws_mqtt5_user_property *m_userPropertiesStorage;
+
+
+
+
+
+
+
2159 const aws_mqtt5_packet_suback_view &packet,
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
2293 bool initializeRawOptions(aws_mqtt5_packet_unsubscribe_view &raw_options) noexcept;
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
2323 struct aws_array_list m_topicFiltersList;
+
2324 struct aws_mqtt5_user_property *m_userPropertiesStorage;
+
+
+
+
+
+
+
2335 const aws_mqtt5_packet_unsuback_view &packet,
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
#define AWS_CRT_CPP_API
Definition: Exports.h:37
+
+
+
Definition: Mqtt5Packets.h:1171
+
ConnAckPacket(const ConnAckPacket &)=delete
+
ConnAckPacket(ConnAckPacket &&) noexcept=delete
+
PacketType getType() override
Definition: Mqtt5Packets.h:1178
+
Definition: Mqtt5Packets.h:663
+
PacketType getType() override
Definition: Mqtt5Packets.h:669
+
Definition: Mqtt5Packets.h:1551
+
PacketType getType() override
Definition: Mqtt5Packets.h:1558
+
Definition: Mqtt5Packets.h:43
+
virtual PacketType getType()=0
+
Definition: Mqtt5Packets.h:479
+
virtual ~NegotiatedSettings()
Definition: Mqtt5Packets.h:580
+
NegotiatedSettings(NegotiatedSettings &&) noexcept=delete
+
NegotiatedSettings(const NegotiatedSettings &)=delete
+
Definition: Mqtt5Packets.h:1767
+
PubAckPacket & operator=(PubAckPacket &&toMove) noexcept=delete
+
PubAckPacket(const PubAckPacket &toCopy) noexcept=delete
+
PubAckPacket(PubAckPacket &&toMove) noexcept=delete
+
PacketType getType() override
Definition: Mqtt5Packets.h:1773
+
PubAckPacket & operator=(const PubAckPacket &toCopy) noexcept=delete
+
Definition: Mqtt5Packets.h:53
+
PacketType getType() override
Definition: Mqtt5Packets.h:64
+
Definition: Mqtt5Packets.h:1844
+
std::shared_ptr< IPacket > getAck() const
Definition: Mqtt5Packets.h:1870
+
bool wasSuccessful() const
Definition: Mqtt5Packets.h:1855
+
int getErrorCode() const
Definition: Mqtt5Packets.h:1862
+
Definition: Mqtt5Packets.h:2156
+
PacketType getType() override
Definition: Mqtt5Packets.h:2163
+
SubAckPacket(SubAckPacket &&) noexcept=delete
+
SubAckPacket(const SubAckPacket &) noexcept=delete
+
Definition: Mqtt5Packets.h:2029
+
SubscribePacket(const SubscribePacket &) noexcept=delete
+
PacketType getType() override
Definition: Mqtt5Packets.h:2034
+
SubscribePacket(SubscribePacket &&) noexcept=delete
+
Definition: Mqtt5Packets.h:1890
+
virtual ~Subscription()
Definition: Mqtt5Packets.h:1971
+
Definition: Mqtt5Packets.h:2332
+
PacketType getType() override
Definition: Mqtt5Packets.h:2339
+
UnSubAckPacket(UnSubAckPacket &&) noexcept=delete
+
UnSubAckPacket(const UnSubAckPacket &) noexcept=delete
+
Definition: Mqtt5Packets.h:2235
+
UnsubscribePacket(const UnsubscribePacket &) noexcept=delete
+
PacketType getType() override
Definition: Mqtt5Packets.h:2240
+
UnsubscribePacket(UnsubscribePacket &&) noexcept=delete
+
Definition: Mqtt5Packets.h:24
+
const Crt::String & getName() const noexcept
Definition: Mqtt5Packets.h:28
+
const Crt::String & getValue() const noexcept
Definition: Mqtt5Packets.h:29
+
Definition: Optional.h:18
+
+
aws_mqtt5_unsuback_reason_code UnSubAckReasonCode
Definition: Mqtt5Types.h:169
+
aws_mqtt5_qos QOS
Definition: Mqtt5Types.h:29
+
aws_mqtt5_connect_reason_code ConnectReasonCode
Definition: Mqtt5Types.h:65
+
aws_mqtt5_suback_reason_code SubAckReasonCode
Definition: Mqtt5Types.h:148
+
aws_mqtt5_retain_handling_type RetainHandlingType
Definition: Mqtt5Types.h:278
+
aws_mqtt5_puback_reason_code PubAckReasonCode
Definition: Mqtt5Types.h:127
+
aws_mqtt5_payload_format_indicator PayloadFormatIndicator
Definition: Mqtt5Types.h:259
+
aws_mqtt5_disconnect_reason_code DisconnectReasonCode
Definition: Mqtt5Types.h:107
+
aws_mqtt5_packet_type PacketType
Definition: Mqtt5Types.h:308
+
aws_byte_cursor ByteCursor
Definition: Types.h:31
+
aws_allocator Allocator
Definition: Allocator.h:14
+
AWS_CRT_CPP_API Allocator * ApiAllocator() noexcept
Definition: Allocator.cpp:24
+
std::basic_string< char, std::char_traits< char >, StlAllocator< char > > String
Definition: Types.h:45
+
aws_byte_buf ByteBuf
Definition: Types.h:30
+
std::vector< T, StlAllocator< T > > Vector
Definition: Types.h:53
+
Definition: Allocator.h:11
+
Definition: StringView.h:852
+
+
+
+
+
diff --git a/docs/_mqtt5_types_8h.html b/docs/_mqtt5_types_8h.html
new file mode 100644
index 000000000..707db5444
--- /dev/null
+++ b/docs/_mqtt5_types_8h.html
@@ -0,0 +1,127 @@
+
+
+
+
+
+
+
+aws-crt-cpp: include/aws/crt/mqtt/Mqtt5Types.h File Reference
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ 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.
+
+
+
+
+
+
diff --git a/docs/_mqtt5_types_8h_source.html b/docs/_mqtt5_types_8h_source.html
new file mode 100644
index 000000000..b80599403
--- /dev/null
+++ b/docs/_mqtt5_types_8h_source.html
@@ -0,0 +1,136 @@
+
+
+
+
+
+
+
+aws-crt-cpp: include/aws/crt/mqtt/Mqtt5Types.h Source File
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ aws-crt-cpp
+
+ C++ wrapper around the aws-c-* libraries. Provides Cross-Platform Transport Protocols and SSL/TLS implementations for C++.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
Go to the documentation of this file.
+
6 #include <aws/mqtt/v5/mqtt5_client.h>
+
7 #include <aws/mqtt/v5/mqtt5_types.h>
+
+
+
+
+
+
+
+
29 using QOS = aws_mqtt5_qos;
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
aws_mqtt5_unsuback_reason_code UnSubAckReasonCode
Definition: Mqtt5Types.h:169
+
aws_mqtt5_client_operation_queue_behavior_type ClientOperationQueueBehaviorType
Definition: Mqtt5Types.h:223
+
aws_mqtt5_qos QOS
Definition: Mqtt5Types.h:29
+
aws_mqtt5_connect_reason_code ConnectReasonCode
Definition: Mqtt5Types.h:65
+
aws_mqtt5_suback_reason_code SubAckReasonCode
Definition: Mqtt5Types.h:148
+
aws_mqtt5_retain_handling_type RetainHandlingType
Definition: Mqtt5Types.h:278
+
aws_mqtt5_client_session_behavior_type ClientSessionBehaviorType
Definition: Mqtt5Types.h:186
+
aws_mqtt5_puback_reason_code PubAckReasonCode
Definition: Mqtt5Types.h:127
+
ExponentialBackoffJitterMode JitterMode
Definition: Mqtt5Types.h:245
+
aws_mqtt5_payload_format_indicator PayloadFormatIndicator
Definition: Mqtt5Types.h:259
+
aws_exponential_backoff_jitter_mode ExponentialBackoffJitterMode
Definition: Mqtt5Types.h:242
+
aws_mqtt5_disconnect_reason_code DisconnectReasonCode
Definition: Mqtt5Types.h:107
+
aws_mqtt5_packet_type PacketType
Definition: Mqtt5Types.h:308
+
aws_mqtt5_extended_validation_and_flow_control_options ClientExtendedValidationAndFlowControl
Definition: Mqtt5Types.h:200
+
Definition: Allocator.h:11
+
+
+
+
+
diff --git a/docs/_mqtt_common_8cpp.html b/docs/_mqtt_common_8cpp.html
new file mode 100644
index 000000000..072e9b22c
--- /dev/null
+++ b/docs/_mqtt_common_8cpp.html
@@ -0,0 +1,94 @@
+
+
+
+
+
+
+
+aws-crt-cpp: source/iot/MqttCommon.cpp File Reference
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ aws-crt-cpp
+
+ C++ wrapper around the aws-c-* libraries. Provides Cross-Platform Transport Protocols and SSL/TLS implementations for C++.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/docs/_mqtt_common_8h.html b/docs/_mqtt_common_8h.html
new file mode 100644
index 000000000..660a404ea
--- /dev/null
+++ b/docs/_mqtt_common_8h.html
@@ -0,0 +1,109 @@
+
+
+
+
+
+
+
+aws-crt-cpp: include/aws/iot/MqttCommon.h File Reference
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ aws-crt-cpp
+
+ C++ wrapper around the aws-c-* libraries. Provides Cross-Platform Transport Protocols and SSL/TLS implementations for C++.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/docs/_mqtt_common_8h_source.html b/docs/_mqtt_common_8h_source.html
new file mode 100644
index 000000000..6e53146e3
--- /dev/null
+++ b/docs/_mqtt_common_8h_source.html
@@ -0,0 +1,153 @@
+
+
+
+
+
+
+
+aws-crt-cpp: include/aws/iot/MqttCommon.h Source File
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ aws-crt-cpp
+
+ C++ wrapper around the aws-c-* libraries. Provides Cross-Platform Transport Protocols and SSL/TLS implementations for C++.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
Go to the documentation of this file.
+
6 #include <aws/crt/Config.h>
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
64 const std::shared_ptr<Crt::Auth::ICredentialsProvider> &credentialsProvider,
+
+
+
+
81 const std::shared_ptr<Crt::Auth::ICredentialsProvider> &credentialsProvider,
+
82 const std::shared_ptr<Crt::Auth::IHttpRequestSigner> &signer,
+
+
+
+
86 std::shared_ptr<Crt::Auth::IHttpRequestSigner>
Signer ;
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
#define AWS_CRT_CPP_API
Definition: Exports.h:37
+
+
Definition: Bootstrap.h:35
+
Definition: Optional.h:18
+
+
aws_allocator Allocator
Definition: Allocator.h:14
+
AWS_CRT_CPP_API Allocator * ApiAllocator() noexcept
Definition: Allocator.cpp:24
+
std::basic_string< char, std::char_traits< char >, StlAllocator< char > > String
Definition: Types.h:45
+
std::function< std::shared_ptr< Crt::Auth::ISigningConfig >(void)> CreateSigningConfig
Definition: MqttCommon.h:18
+
Definition: Allocator.h:11
+
Definition: MqttCommon.h:105
+
Crt::String pkcs12_file
Definition: MqttCommon.h:106
+
Crt::String pkcs12_password
Definition: MqttCommon.h:107
+
Definition: MqttCommon.h:24
+
std::shared_ptr< Crt::Auth::IHttpRequestSigner > Signer
Definition: MqttCommon.h:86
+
Crt::String ServiceName
Definition: MqttCommon.h:97
+
Crt::String SigningRegion
Definition: MqttCommon.h:96
+
Crt::Optional< Crt::Http::HttpClientConnectionProxyOptions > ProxyOptions
Definition: MqttCommon.h:95
+
CreateSigningConfig CreateSigningConfigCb
Definition: MqttCommon.h:87
+
std::shared_ptr< Crt::Auth::ICredentialsProvider > CredentialsProvider
Definition: MqttCommon.h:85
+
+
+
+
+
diff --git a/docs/_mqtt_connection_8cpp.html b/docs/_mqtt_connection_8cpp.html
new file mode 100644
index 000000000..01b74d444
--- /dev/null
+++ b/docs/_mqtt_connection_8cpp.html
@@ -0,0 +1,95 @@
+
+
+
+
+
+
+
+aws-crt-cpp: source/mqtt/MqttConnection.cpp File Reference
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ aws-crt-cpp
+
+ C++ wrapper around the aws-c-* libraries. Provides Cross-Platform Transport Protocols and SSL/TLS implementations for C++.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/docs/_mqtt_connection_8h.html b/docs/_mqtt_connection_8h.html
new file mode 100644
index 000000000..73038c902
--- /dev/null
+++ b/docs/_mqtt_connection_8h.html
@@ -0,0 +1,144 @@
+
+
+
+
+
+
+
+aws-crt-cpp: include/aws/crt/mqtt/MqttConnection.h File Reference
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ 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.
+
+
+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)>
+
+
+
+
+
+
+
diff --git a/docs/_mqtt_connection_8h_source.html b/docs/_mqtt_connection_8h_source.html
new file mode 100644
index 000000000..713b3d916
--- /dev/null
+++ b/docs/_mqtt_connection_8h_source.html
@@ -0,0 +1,311 @@
+
+
+
+
+
+
+
+aws-crt-cpp: include/aws/crt/mqtt/MqttConnection.h Source File
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ aws-crt-cpp
+
+ C++ wrapper around the aws-c-* libraries. Provides Cross-Platform Transport Protocols and SSL/TLS implementations for C++.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
Go to the documentation of this file.
+
+
+
+
+
+
+
+
+
15 #include <aws/mqtt/client.h>
+
16 #include <aws/mqtt/v5/mqtt5_client.h>
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
33 class Mqtt5ClientCore;
+
+
+
+
+
+
39 class MqttConnectionCore;
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
137 std::function<void(
const std::shared_ptr<Http::HttpRequest> &,
int errorCode)>;
+
+
+
+
+
+
+
+
160 friend class Mqtt5::Mqtt5ClientCore;
+
+
+
+
+
+
+
+
+
175 static std::shared_ptr<Crt::Mqtt::MqttConnection> NewConnectionFromMqtt5Client(
+
176 std::shared_ptr<Mqtt5::Mqtt5Client> mqtt5client) noexcept;
+
+
181 operator bool() const noexcept;
+
+
+
+
196 bool SetWill(const
char *topic,
QOS qos,
bool retain, const
ByteBuf &payload) noexcept;
+
+
205 bool SetLogin(const
char *username, const
char *password) noexcept;
+
+
210 bool SetWebsocketProxyOptions(const Http::HttpClientConnectionProxyOptions &proxyOptions) noexcept;
+
+
221 bool SetHttpProxyOptions(const Http::HttpClientConnectionProxyOptions &proxyOptions) noexcept;
+
+
234 bool SetReconnectTimeout(uint64_t min_seconds, uint64_t max_seconds) noexcept;
+
+
+
253 const
char *clientId,
+
+
255 uint16_t keepAliveTimeSecs = 0,
+
256 uint32_t pingTimeoutMs = 0,
+
257 uint32_t protocolOperationTimeoutMs = 0) noexcept;
+
+
263 bool Disconnect() noexcept;
+
+
266 aws_mqtt_client_connection *GetUnderlyingConnection() noexcept;
+
+
+
281 const
char *topicFilter,
+
+
+
+
+
+
290 const
char *topicFilter,
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
440 aws_mqtt_client *client,
+
+
+
+
452 aws_mqtt5_client *mqtt5Client,
+
+
458 std ::shared_ptr<MqttConnectionCore> m_connectionCore;
+
+
+
+
+
+
#define AWS_CRT_CPP_API
Definition: Exports.h:37
+
+
+
+
+
+
+
Definition: MqttClient.h:48
+
Definition: MqttConnection.h:158
+
MqttConnection & operator=(const MqttConnection &)=delete
+
MqttConnection & operator=(MqttConnection &&)=delete
+
MqttConnection(MqttConnection &&)=delete
+
MqttConnection(const MqttConnection &)=delete
+
std::function< void(MqttConnection &connection, uint16_t packetId, const Vector< String > &topics, QOS qos, int errorCode)> OnMultiSubAckHandler
Definition: MqttTypes.h:84
+
std::function< void(std::shared_ptr< Http::HttpRequest > req, const OnWebSocketHandshakeInterceptComplete &onComplete)> OnWebSocketHandshakeIntercept
Definition: MqttConnection.h:146
+
std::function< void(MqttConnection &connection, OnConnectionClosedData *callbackData)> OnConnectionClosedHandler
Definition: MqttConnection.h:103
+
std::function< void(MqttConnection &connection, ReturnCode connectCode, bool sessionPresent)> OnConnectionResumedHandler
Definition: MqttConnection.h:88
+
std::function< void(MqttConnection &connection, const String &topic, const ByteBuf &payload, bool dup, QOS qos, bool retain)> OnMessageReceivedHandler
Definition: MqttTypes.h:56
+
std::function< void(MqttConnection &connection, uint16_t packetId, int errorCode)> OnOperationCompleteHandler
Definition: MqttTypes.h:97
+
std::function< void(MqttConnection &connection, const String &topic, const ByteBuf &payload)> OnPublishReceivedHandler
Definition: MqttConnection.h:130
+
std::function< void(MqttConnection &connection, int error)> OnConnectionInterruptedHandler
Definition: MqttConnection.h:82
+
std::function< void(const std::shared_ptr< Http::HttpRequest > &, int errorCode)> OnWebSocketHandshakeInterceptComplete
Definition: MqttConnection.h:137
+
aws_mqtt_qos QOS
Definition: Types.h:40
+
std::function< void(MqttConnection &connection, OnConnectionSuccessData *callbackData)> OnConnectionSuccessHandler
Definition: MqttConnection.h:111
+
std::function< void(MqttConnection &connection)> OnDisconnectHandler
Definition: MqttConnection.h:124
+
aws_mqtt_connect_return_code ReturnCode
Definition: Types.h:41
+
std::function< void(MqttConnection &connection, OnConnectionFailureData *callbackData)> OnConnectionFailureHandler
Definition: MqttConnection.h:119
+
std::function< void(MqttConnection &connection, uint16_t packetId, const String &topic, QOS qos, int errorCode)> OnSubAckHandler
Definition: MqttTypes.h:68
+
std::function< void(MqttConnection &connection, int errorCode, ReturnCode returnCode, bool sessionPresent)> OnConnectionCompletedHandler
Definition: MqttConnection.h:94
+
std::basic_string< char, std::char_traits< char >, StlAllocator< char > > String
Definition: Types.h:45
+
aws_byte_buf ByteBuf
Definition: Types.h:30
+
std::vector< T, StlAllocator< T > > Vector
Definition: Types.h:53
+
AWS_CRT_CPP_API int LastError() noexcept
Definition: Api.cpp:422
+
Definition: Allocator.h:11
+
Definition: StringView.h:852
+
Definition: MqttTypes.h:103
+
Definition: MqttTypes.h:28
+
Definition: MqttConnection.h:47
+
Definition: MqttConnection.h:71
+
int error
Definition: MqttConnection.h:76
+
Definition: MqttConnection.h:54
+
bool sessionPresent
Definition: MqttConnection.h:64
+
ReturnCode returnCode
Definition: MqttConnection.h:58
+
+
+
+
+
diff --git a/docs/_mqtt_connection_core_8cpp.html b/docs/_mqtt_connection_core_8cpp.html
new file mode 100644
index 000000000..7510221ea
--- /dev/null
+++ b/docs/_mqtt_connection_core_8cpp.html
@@ -0,0 +1,79 @@
+
+
+
+
+
+
+
+aws-crt-cpp: source/mqtt/MqttConnectionCore.cpp File Reference
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ aws-crt-cpp
+
+ C++ wrapper around the aws-c-* libraries. Provides Cross-Platform Transport Protocols and SSL/TLS implementations for C++.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/docs/_mqtt_connection_core_8h.html b/docs/_mqtt_connection_core_8h.html
new file mode 100644
index 000000000..43a0020f1
--- /dev/null
+++ b/docs/_mqtt_connection_core_8h.html
@@ -0,0 +1,81 @@
+
+
+
+
+
+
+
+aws-crt-cpp: include/aws/crt/mqtt/private/MqttConnectionCore.h File Reference
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ aws-crt-cpp
+
+ C++ wrapper around the aws-c-* libraries. Provides Cross-Platform Transport Protocols and SSL/TLS implementations for C++.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/docs/_mqtt_connection_core_8h_source.html b/docs/_mqtt_connection_core_8h_source.html
new file mode 100644
index 000000000..bb0edceed
--- /dev/null
+++ b/docs/_mqtt_connection_core_8h_source.html
@@ -0,0 +1,291 @@
+
+
+
+
+
+
+
+aws-crt-cpp: include/aws/crt/mqtt/private/MqttConnectionCore.h Source File
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ aws-crt-cpp
+
+ C++ wrapper around the aws-c-* libraries. Provides Cross-Platform Transport Protocols and SSL/TLS implementations for C++.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
Go to the documentation of this file.
+
+
+
+
+
+
+
+
+
+
19 #include <aws/mqtt/client.h>
+
20 #include <aws/mqtt/v5/mqtt5_client.h>
+
+
+
+
+
+
+
+
+
+
+
+
+
41 class MqttConnectionCore final :
public std::enable_shared_from_this<MqttConnectionCore>
+
+
43 friend MqttConnection;
+
+
+
46 ~MqttConnectionCore();
+
47 MqttConnectionCore(
const MqttConnectionCore &) =
delete ;
+
48 MqttConnectionCore(MqttConnectionCore &&) =
delete ;
+
49 MqttConnectionCore &operator=(
const MqttConnectionCore &) =
delete ;
+
50 MqttConnectionCore &operator=(MqttConnectionCore &&) =
delete ;
+
+
56 operator bool() const noexcept;
+
+
+
+
+
+
82 bool SetWill(const
char *topic,
QOS qos,
bool retain, const
ByteBuf &payload) noexcept;
+
+
92 bool SetLogin(const
char *username, const
char *password) noexcept;
+
+
104 bool SetHttpProxyOptions(const Http::HttpClientConnectionProxyOptions &proxyOptions) noexcept;
+
+
118 bool SetReconnectTimeout(uint64_t min_seconds, uint64_t max_seconds) noexcept;
+
+
+
139 const
char *clientId,
+
+
141 uint16_t keepAliveTimeSecs,
+
142 uint32_t pingTimeoutMs,
+
143 uint32_t protocolOperationTimeoutMs,
+
144 bool setWebSocketInterceptor) noexcept;
+
+
151 bool Disconnect() noexcept;
+
+
154 aws_mqtt_client_connection *GetUnderlyingConnection() noexcept;
+
+
+
170 const
char *topicFilter,
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
242 const MqttConnectionOperationStatistics &GetOperationStatistics() noexcept;
+
+
+
252 static
std ::shared_ptr<MqttConnectionCore> s_createMqttConnectionCore(
+
253 aws_mqtt_client *client,
+
254 std ::shared_ptr<MqttConnection> connection,
+
255 MqttConnectionOptions options) noexcept;
+
+
264 static
std ::shared_ptr<MqttConnectionCore> s_createMqttConnectionCore(
+
265 aws_mqtt5_client *mqtt5Client,
+
266 std ::shared_ptr<MqttConnection> connection,
+
267 MqttConnectionOptions options) noexcept;
+
+
269 static
void s_onConnectionTermination(
void *userData);
+
+
271 static
void s_onConnectionInterrupted(aws_mqtt_client_connection *,
int errorCode,
void *userData);
+
272 static
void s_onConnectionCompleted(
+
273 aws_mqtt_client_connection *,
+
+
275 enum aws_mqtt_connect_return_code returnCode,
+
+
+
+
279 static
void s_onConnectionSuccess(
+
280 aws_mqtt_client_connection *,
+
+
+
+
+
285 static
void s_onConnectionFailure(aws_mqtt_client_connection *,
int errorCode,
void *userData);
+
+
287 static
void s_onConnectionResumed(
+
288 aws_mqtt_client_connection *,
+
+
+
+
+
293 static
void s_onConnectionClosed(
+
294 aws_mqtt_client_connection *,
+
295 on_connection_closed_data *data,
+
+
+
298 static
void s_onDisconnect(aws_mqtt_client_connection *connection,
void *userData);
+
299 static
void s_onPublish(
+
300 aws_mqtt_client_connection *connection,
+
301 const aws_byte_cursor *topic,
+
302 const aws_byte_cursor *payload,
+
+
304 enum aws_mqtt_qos qos,
+
+
+
+
308 static
void s_onSubAck(
+
309 aws_mqtt_client_connection *connection,
+
+
311 const struct aws_byte_cursor *topic,
+
312 enum aws_mqtt_qos qos,
+
+
+
315 static
void s_onMultiSubAck(
+
316 aws_mqtt_client_connection *connection,
+
+
318 const struct aws_array_list *topicSubacks,
+
+
+
321 static
void s_onOpComplete(
+
322 aws_mqtt_client_connection *connection,
+
+
+
+
+
327 static
void s_onWebsocketHandshake(
+
328 struct aws_http_message *request,
+
+
330 aws_mqtt_transform_websocket_handshake_complete_fn *completeFn,
+
+
+
+
347 aws_mqtt_client *client,
+
348 aws_mqtt5_client *mqtt5Client,
+
349 std ::shared_ptr<MqttConnection> connection,
+
350 MqttConnectionOptions options) noexcept;
+
+
352 void createUnderlyingConnection(aws_mqtt_client *mqttClient);
+
353 void createUnderlyingConnection(aws_mqtt5_client *mqtt5Client);
+
354 void connectionInit();
+
+
362 std ::shared_ptr<MqttConnection> obtainConnectionInstance();
+
+
364 aws_mqtt_client_connection *m_underlyingConnection;
+
+
+
367 Crt::Io::TlsContext m_tlsContext;
+
368 Io::TlsConnectionOptions m_tlsOptions;
+
369 Io::SocketOptions m_socketOptions;
+
370 Crt::Optional<Http::HttpClientConnectionProxyOptions> m_proxyOptions;
+
+
+
+
374 MqttConnectionOperationStatistics m_operationStatistics;
+
+
+
383 std ::weak_ptr<MqttConnection> m_connection;
+
+
390 std ::shared_ptr<MqttConnectionCore> m_self;
+
+
+
+
+
+
+
+
+
+
+
+
std::function< void(MqttConnection &connection, uint16_t packetId, const Vector< String > &topics, QOS qos, int errorCode)> OnMultiSubAckHandler
Definition: MqttTypes.h:84
+
std::function< void(MqttConnection &connection, const String &topic, const ByteBuf &payload, bool dup, QOS qos, bool retain)> OnMessageReceivedHandler
Definition: MqttTypes.h:56
+
std::function< void(MqttConnection &connection, uint16_t packetId, int errorCode)> OnOperationCompleteHandler
Definition: MqttTypes.h:97
+
aws_mqtt_qos QOS
Definition: Types.h:40
+
aws_mqtt_connect_return_code ReturnCode
Definition: Types.h:41
+
std::function< void(MqttConnection &connection, uint16_t packetId, const String &topic, QOS qos, int errorCode)> OnSubAckHandler
Definition: MqttTypes.h:68
+
aws_allocator Allocator
Definition: Allocator.h:14
+
std::basic_string< char, std::char_traits< char >, StlAllocator< char > > String
Definition: Types.h:45
+
aws_byte_buf ByteBuf
Definition: Types.h:30
+
std::vector< T, StlAllocator< T > > Vector
Definition: Types.h:53
+
AWS_CRT_CPP_API int LastError() noexcept
Definition: Api.cpp:422
+
Definition: Allocator.h:11
+
Definition: StringView.h:852
+
+
+
+
+
diff --git a/docs/_mqtt_types_8h.html b/docs/_mqtt_types_8h.html
new file mode 100644
index 000000000..efd6d3761
--- /dev/null
+++ b/docs/_mqtt_types_8h.html
@@ -0,0 +1,119 @@
+
+
+
+
+
+
+
+aws-crt-cpp: include/aws/crt/mqtt/MqttTypes.h File Reference
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ 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.
+
+
+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)>
+
+
+
+
+
+
+
diff --git a/docs/_mqtt_types_8h_source.html b/docs/_mqtt_types_8h_source.html
new file mode 100644
index 000000000..a93902152
--- /dev/null
+++ b/docs/_mqtt_types_8h_source.html
@@ -0,0 +1,191 @@
+
+
+
+
+
+
+
+aws-crt-cpp: include/aws/crt/mqtt/MqttTypes.h Source File
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ aws-crt-cpp
+
+ C++ wrapper around the aws-c-* libraries. Provides Cross-Platform Transport Protocols and SSL/TLS implementations for C++.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
Go to the documentation of this file.
+
+
+
+
+
11 #include <aws/mqtt/client.h>
+
12 #include <aws/mqtt/v5/mqtt5_client.h>
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
97 std::function<void(
MqttConnection &connection, uint16_t packetId,
int errorCode)>;
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
#define AWS_CRT_CPP_API
Definition: Exports.h:37
+
+
+
+
Definition: SocketOptions.h:48
+
Definition: TlsOptions.h:293
+
Definition: TlsOptions.h:350
+
Definition: MqttConnection.h:158
+
std::function< void(MqttConnection &connection, uint16_t packetId, const Vector< String > &topics, QOS qos, int errorCode)> OnMultiSubAckHandler
Definition: MqttTypes.h:84
+
std::function< void(MqttConnection &connection, const String &topic, const ByteBuf &payload, bool dup, QOS qos, bool retain)> OnMessageReceivedHandler
Definition: MqttTypes.h:56
+
std::function< void(MqttConnection &connection, uint16_t packetId, int errorCode)> OnOperationCompleteHandler
Definition: MqttTypes.h:97
+
aws_mqtt_qos QOS
Definition: Types.h:40
+
std::function< void(MqttConnection &connection, uint16_t packetId, const String &topic, QOS qos, int errorCode)> OnSubAckHandler
Definition: MqttTypes.h:68
+
aws_allocator Allocator
Definition: Allocator.h:14
+
std::basic_string< char, std::char_traits< char >, StlAllocator< char > > String
Definition: Types.h:45
+
aws_byte_buf ByteBuf
Definition: Types.h:30
+
std::vector< T, StlAllocator< T > > Vector
Definition: Types.h:53
+
Definition: Allocator.h:11
+
Definition: MqttTypes.h:103
+
uint64_t unackedOperationSize
Definition: MqttTypes.h:126
+
uint64_t incompleteOperationCount
Definition: MqttTypes.h:108
+
uint64_t unackedOperationCount
Definition: MqttTypes.h:120
+
uint64_t incompleteOperationSize
Definition: MqttTypes.h:114
+
Definition: MqttTypes.h:28
+
Crt::Io::TlsConnectionOptions tlsConnectionOptions
Definition: MqttTypes.h:33
+
bool useWebsocket
Definition: MqttTypes.h:34
+
uint32_t port
Definition: MqttTypes.h:30
+
Crt::Io::TlsContext tlsContext
Definition: MqttTypes.h:32
+
Io::SocketOptions socketOptions
Definition: MqttTypes.h:31
+
const char * hostName
Definition: MqttTypes.h:29
+
Allocator * allocator
Definition: MqttTypes.h:36
+
bool useTls
Definition: MqttTypes.h:35
+
+
+
+
+
diff --git a/docs/_optional_8h.html b/docs/_optional_8h.html
new file mode 100644
index 000000000..472635d04
--- /dev/null
+++ b/docs/_optional_8h.html
@@ -0,0 +1,99 @@
+
+
+
+
+
+
+
+aws-crt-cpp: include/aws/crt/Optional.h File Reference
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ aws-crt-cpp
+
+ C++ wrapper around the aws-c-* libraries. Provides Cross-Platform Transport Protocols and SSL/TLS implementations for C++.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/docs/_optional_8h_source.html b/docs/_optional_8h_source.html
new file mode 100644
index 000000000..d1f075568
--- /dev/null
+++ b/docs/_optional_8h_source.html
@@ -0,0 +1,319 @@
+
+
+
+
+
+
+
+aws-crt-cpp: include/aws/crt/Optional.h Source File
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ aws-crt-cpp
+
+ C++ wrapper around the aws-c-* libraries. Provides Cross-Platform Transport Protocols and SSL/TLS implementations for C++.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
Go to the documentation of this file.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
23 new (m_storage) T(val);
+
24 m_value =
reinterpret_cast< T *
> (m_storage);
+
+
+
+
+
29 new (m_storage) T(std::forward<T>(val));
+
30 m_value =
reinterpret_cast< T *
> (m_storage);
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
45 *m_value = std::forward<U>(u);
+
+
+
+
49 new (m_storage) T(std::forward<U>(u));
+
50 m_value =
reinterpret_cast< T *
> (m_storage);
+
+
+
+
+
+
+
+
+
59 new (m_storage) T(*other.m_value);
+
60 m_value =
reinterpret_cast< T *
> (m_storage);
+
+
+
+
+
+
+
+
+
+
+
+
72 new (m_storage) T(std::forward<T>(*other.m_value));
+
73 m_value =
reinterpret_cast< T *
> (m_storage);
+
+
+
+
+
+
+
+
+
+
83 new (m_storage) T(std::forward<Args>(args)...);
+
84 m_value =
reinterpret_cast< T *
> (m_storage);
+
+
+
+
+
+
+
+
+
+
+
+
+
+
98 *m_value = *other.m_value;
+
+
+
+
+
+
+
+
+
+
+
+
+
111 new (m_storage) T(*other.m_value);
+
112 m_value =
reinterpret_cast< T *
> (m_storage);
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
129 *m_value = *other.m_value;
+
+
+
+
+
+
+
+
+
+
+
+
+
142 new (m_storage) T(*other.m_value);
+
143 m_value =
reinterpret_cast< T *
> (m_storage);
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
160 *m_value = std::forward<U>(*other.m_value);
+
+
+
+
+
+
+
+
+
+
+
+
+
173 new (m_storage) T(std::forward<U>(*other.m_value));
+
174 m_value =
reinterpret_cast< T *
> (m_storage);
+
+
+
+
+
+
180 template <
typename ... Args> T &
emplace (Args &&...args)
+
+
+
+
184 new (m_storage) T(std::forward<Args>(args)...);
+
185 m_value =
reinterpret_cast< T *
> (m_storage);
+
+
+
+
+
+
+
+
+
194 const T &&
operator* () const && {
return std::move(*m_value); }
+
+
+
197 explicit operator bool() const noexcept {
return m_value !=
nullptr ; }
+
198 bool has_value () const noexcept {
return m_value !=
nullptr ; }
+
+
+
201 const T &
value () const & {
return *m_value; }
+
+
203 T &&
value () && {
return std::move(*m_value); }
+
204 const T &&
value () const && {
return std::move(*m_value); }
+
+
+
+
+
+
+
+
+
+
+
+
216 alignas (T)
char m_storage[
sizeof (T)];
+
+
+
+
+
+
Definition: Optional.h:18
+
Optional(const T &val)
Definition: Optional.h:21
+
Optional< T > & operator=(Optional< U > &&other)
Definition: Optional.h:149
+
const T & operator*() const &
Definition: Optional.h:192
+
Optional & operator=(U &&u)
Definition: Optional.h:41
+
Optional()
Definition: Optional.h:20
+
Optional & operator=(const Optional &other)
Definition: Optional.h:87
+
bool has_value() const noexcept
Definition: Optional.h:198
+
void reset()
Definition: Optional.h:206
+
Optional(const Optional< T > &other)
Definition: Optional.h:55
+
Optional< T > & operator=(const Optional< U > &other)
Definition: Optional.h:118
+
Optional(Aws::Crt::InPlaceT, Args &&...args)
Definition: Optional.h:81
+
T & emplace(Args &&...args)
Definition: Optional.h:180
+
Optional(Optional< T > &&other)
Definition: Optional.h:68
+
const T & value() const &
Definition: Optional.h:201
+
T * operator->()
Definition: Optional.h:191
+
Optional(T &&val)
Definition: Optional.h:27
+
const T && operator*() const &&
Definition: Optional.h:194
+
T && operator*() &&
Definition: Optional.h:195
+
T & value() &
Definition: Optional.h:200
+
const T && value() const &&
Definition: Optional.h:204
+
T & operator*() &
Definition: Optional.h:193
+
const T * operator->() const
Definition: Optional.h:190
+
T && value() &&
Definition: Optional.h:203
+
~Optional()
Definition: Optional.h:33
+
Definition: Allocator.h:11
+
+
+
+
+
+
diff --git a/docs/_pkcs11_8cpp.html b/docs/_pkcs11_8cpp.html
new file mode 100644
index 000000000..2b4bc993f
--- /dev/null
+++ b/docs/_pkcs11_8cpp.html
@@ -0,0 +1,94 @@
+
+
+
+
+
+
+
+aws-crt-cpp: source/io/Pkcs11.cpp File Reference
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ 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/Pkcs11.h >
+
#include <aws/io/logging.h>
+
#include <aws/io/pkcs11.h>
+
+
+
+
+
+
diff --git a/docs/_pkcs11_8h.html b/docs/_pkcs11_8h.html
new file mode 100644
index 000000000..41b612809
--- /dev/null
+++ b/docs/_pkcs11_8h.html
@@ -0,0 +1,100 @@
+
+
+
+
+
+
+
+aws-crt-cpp: include/aws/crt/io/Pkcs11.h File Reference
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ aws-crt-cpp
+
+ C++ wrapper around the aws-c-* libraries. Provides Cross-Platform Transport Protocols and SSL/TLS implementations for C++.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/docs/_pkcs11_8h_source.html b/docs/_pkcs11_8h_source.html
new file mode 100644
index 000000000..98eb7246d
--- /dev/null
+++ b/docs/_pkcs11_8h_source.html
@@ -0,0 +1,136 @@
+
+
+
+
+
+
+
+aws-crt-cpp: include/aws/crt/io/Pkcs11.h Source File
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ aws-crt-cpp
+
+ C++ wrapper around the aws-c-* libraries. Provides Cross-Platform Transport Protocols and SSL/TLS implementations for C++.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
Go to the documentation of this file.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
92 static std::shared_ptr<Pkcs11Lib> Create(
+
+
94 InitializeFinalizeBehavior initializeFinalizeBehavior,
+
+
+
+
+
100 aws_pkcs11_lib *GetNativeHandle() {
return impl; }
+
+
103 explicit Pkcs11Lib(aws_pkcs11_lib &impl);
+
+
+
+
107 Pkcs11Lib(
const Pkcs11Lib &) =
delete ;
+
108 Pkcs11Lib(Pkcs11Lib &&) =
delete ;
+
109 Pkcs11Lib &operator=(
const Pkcs11Lib &) =
delete ;
+
110 Pkcs11Lib &operator=(Pkcs11Lib &&) =
delete ;
+
+
112 aws_pkcs11_lib *impl =
nullptr ;
+
+
+
+
+
#define AWS_CRT_CPP_API
Definition: Exports.h:37
+
+
+
InitializeFinalizeBehavior
Definition: Pkcs11.h:31
+
+
aws_allocator Allocator
Definition: Allocator.h:14
+
AWS_CRT_CPP_API Allocator * ApiAllocator() noexcept
Definition: Allocator.cpp:24
+
std::basic_string< char, std::char_traits< char >, StlAllocator< char > > String
Definition: Types.h:45
+
Definition: Allocator.h:11
+
+
+
+
+
diff --git a/docs/_ref_counted_8h.html b/docs/_ref_counted_8h.html
new file mode 100644
index 000000000..61bcafc71
--- /dev/null
+++ b/docs/_ref_counted_8h.html
@@ -0,0 +1,100 @@
+
+
+
+
+
+
+
+aws-crt-cpp: include/aws/crt/RefCounted.h File Reference
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ 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.
+
+
+
+
+
+
diff --git a/docs/_ref_counted_8h_source.html b/docs/_ref_counted_8h_source.html
new file mode 100644
index 000000000..f693dccf8
--- /dev/null
+++ b/docs/_ref_counted_8h_source.html
@@ -0,0 +1,135 @@
+
+
+
+
+
+
+
+aws-crt-cpp: include/aws/crt/RefCounted.h Source File
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ aws-crt-cpp
+
+ C++ wrapper around the aws-c-* libraries. Provides Cross-Platform Transport Protocols and SSL/TLS implementations for C++.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
Go to the documentation of this file.
+
7 #include <aws/common/assert.h>
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
39 m_strongPtr =
static_cast< T *
> (
this )->shared_from_this();
+
+
+
+
+
+
+
+
+
48 std::shared_ptr<T> tmpStrongPtr;
+
+
+
51 AWS_ASSERT(m_count > 0 &&
"refcount has gone negative" );
+
+
+
54 std::swap(m_strongPtr, tmpStrongPtr);
+
+
+
+
+
+
+
+
+
+
64 std::shared_ptr<T> m_strongPtr;
+
+
+
+
+
Definition: RefCounted.h:29
+
RefCounted()
Definition: RefCounted.h:31
+
void AcquireRef()
Definition: RefCounted.h:34
+
void ReleaseRef()
Definition: RefCounted.h:44
+
~RefCounted()
Definition: RefCounted.h:32
+
Definition: Allocator.h:11
+
+
+
+
+
diff --git a/docs/_rule_engine_8cpp.html b/docs/_rule_engine_8cpp.html
new file mode 100644
index 000000000..066a1e833
--- /dev/null
+++ b/docs/_rule_engine_8cpp.html
@@ -0,0 +1,102 @@
+
+
+
+
+
+
+
+aws-crt-cpp: source/endpoints/RuleEngine.cpp File Reference
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ 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>
+
+
+
+
+
+
diff --git a/docs/_rule_engine_8h.html b/docs/_rule_engine_8h.html
new file mode 100644
index 000000000..74d768dcf
--- /dev/null
+++ b/docs/_rule_engine_8h.html
@@ -0,0 +1,104 @@
+
+
+
+
+
+
+
+aws-crt-cpp: include/aws/crt/endpoints/RuleEngine.h File Reference
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ aws-crt-cpp
+
+ C++ wrapper around the aws-c-* libraries. Provides Cross-Platform Transport Protocols and SSL/TLS implementations for C++.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/docs/_rule_engine_8h_source.html b/docs/_rule_engine_8h_source.html
new file mode 100644
index 000000000..0ff5e90e9
--- /dev/null
+++ b/docs/_rule_engine_8h_source.html
@@ -0,0 +1,245 @@
+
+
+
+
+
+
+
+aws-crt-cpp: include/aws/crt/endpoints/RuleEngine.h Source File
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ aws-crt-cpp
+
+ C++ wrapper around the aws-c-* libraries. Provides Cross-Platform Transport Protocols and SSL/TLS implementations for C++.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
Go to the documentation of this file.
+
+
+
9 struct aws_endpoints_rule_engine;
+
10 struct aws_endpoints_request_context;
+
11 struct aws_endpoints_resolved_endpoint;
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
40 operator bool() const noexcept {
return m_requestContext !=
nullptr ; }
+
+
+
+
+
+
+
+
+
+
+
+
+
+
54 bool AddBoolean(
const ByteCursor &name,
bool value);
+
+
+
+
+
+
+
+
+
64 aws_endpoints_request_context *GetNativeHandle() const noexcept {
return m_requestContext; }
+
+
+
+
68 aws_endpoints_request_context *m_requestContext;
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
97 bool IsEndpoint() const noexcept;
+
98 bool IsError() const noexcept;
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
118 operator
bool () const noexcept {
return m_resolvedEndpoint !=
nullptr ; }
+
+
+
+
+
124 aws_endpoints_resolved_endpoint *m_resolvedEndpoint;
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
147 operator bool() const noexcept {
return m_ruleEngine !=
nullptr ; }
+
+
+
+
+
+
+
+
+
+
+
158 aws_endpoints_rule_engine *m_ruleEngine;
+
+
+
+
+
#define AWS_CRT_CPP_API
Definition: Exports.h:37
+
+
Definition: RuleEngine.h:26
+
RequestContext & operator=(RequestContext &&)=delete
+
RequestContext(const RequestContext &)=delete
+
RequestContext(RequestContext &&)=delete
+
RequestContext & operator=(const RequestContext &)=delete
+
Definition: RuleEngine.h:87
+
ResolutionOutcome & operator=(const ResolutionOutcome &)=delete
+
ResolutionOutcome(const ResolutionOutcome &)=delete
+
Definition: RuleEngine.h:131
+
RuleEngine & operator=(const RuleEngine &)=delete
+
RuleEngine(const RuleEngine &)=delete
+
RuleEngine & operator=(RuleEngine &&)=delete
+
RuleEngine(RuleEngine &&)=delete
+
Definition: Optional.h:18
+
Definition: StringView.h:33
+
aws_byte_cursor ByteCursor
Definition: Types.h:31
+
aws_allocator Allocator
Definition: Allocator.h:14
+
AWS_CRT_CPP_API Allocator * ApiAllocator() noexcept
Definition: Allocator.cpp:24
+
std::unordered_map< K, V, std::hash< K >, std::equal_to< K >, StlAllocator< std::pair< const K, V > >> UnorderedMap
Definition: Types.h:50
+
std::vector< T, StlAllocator< T > > Vector
Definition: Types.h:53
+
Definition: Allocator.h:11
+
+
+
+
+
diff --git a/docs/_secure_random_8cpp.html b/docs/_secure_random_8cpp.html
new file mode 100644
index 000000000..826ba3920
--- /dev/null
+++ b/docs/_secure_random_8cpp.html
@@ -0,0 +1,99 @@
+
+
+
+
+
+
+
+aws-crt-cpp: source/crypto/SecureRandom.cpp File Reference
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ aws-crt-cpp
+
+ C++ wrapper around the aws-c-* libraries. Provides Cross-Platform Transport Protocols and SSL/TLS implementations for C++.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
#include <aws/crt/crypto/SecureRandom.h >
+
#include <aws/common/device_random.h>
+
+
+
+
+
+
diff --git a/docs/_secure_random_8h.html b/docs/_secure_random_8h.html
new file mode 100644
index 000000000..14d0d45e3
--- /dev/null
+++ b/docs/_secure_random_8h.html
@@ -0,0 +1,101 @@
+
+
+
+
+
+
+
+aws-crt-cpp: include/aws/crt/crypto/SecureRandom.h File Reference
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ aws-crt-cpp
+
+ C++ wrapper around the aws-c-* libraries. Provides Cross-Platform Transport Protocols and SSL/TLS implementations for C++.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/docs/_secure_random_8h_source.html b/docs/_secure_random_8h_source.html
new file mode 100644
index 000000000..c31a29340
--- /dev/null
+++ b/docs/_secure_random_8h_source.html
@@ -0,0 +1,99 @@
+
+
+
+
+
+
+
+aws-crt-cpp: include/aws/crt/crypto/SecureRandom.h Source File
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ aws-crt-cpp
+
+ C++ wrapper around the aws-c-* libraries. Provides Cross-Platform Transport Protocols and SSL/TLS implementations for C++.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
Go to the documentation of this file.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
#define AWS_CRT_CPP_API
Definition: Exports.h:37
+
+
bool AWS_CRT_CPP_API GenerateRandomBytes(ByteBuf &output, size_t lengthToGenerate)
Definition: SecureRandom.cpp:15
+
aws_byte_buf ByteBuf
Definition: Types.h:30
+
Definition: Allocator.h:11
+
+
+
+
+
diff --git a/docs/_signing_8h.html b/docs/_signing_8h.html
new file mode 100644
index 000000000..7366cc294
--- /dev/null
+++ b/docs/_signing_8h.html
@@ -0,0 +1,120 @@
+
+
+
+
+
+
+
+aws-crt-cpp: include/aws/crt/auth/Signing.h File Reference
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ 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.
+
+
+
+
+
+
diff --git a/docs/_signing_8h_source.html b/docs/_signing_8h_source.html
new file mode 100644
index 000000000..75956a64b
--- /dev/null
+++ b/docs/_signing_8h_source.html
@@ -0,0 +1,164 @@
+
+
+
+
+
+
+
+aws-crt-cpp: include/aws/crt/auth/Signing.h Source File
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ aws-crt-cpp
+
+ C++ wrapper around the aws-c-* libraries. Provides Cross-Platform Transport Protocols and SSL/TLS implementations for C++.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
Go to the documentation of this file.
+
+
+
9 #include <aws/auth/signing_config.h>
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
31 Aws = AWS_SIGNING_CONFIG_AWS
+
+
+
+
39 std::function<void(
const std::shared_ptr<Aws::Crt::Http::HttpRequest> &,
int )>;
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
87 const std::shared_ptr<Aws::Crt::Http::HttpRequest> &request,
+
+
+
+
+
+
+
+
+
+
+
#define AWS_CRT_CPP_API
Definition: Exports.h:37
+
+
virtual ~IHttpRequestSigner()=default
+
IHttpRequestSigner()=default
+
IHttpRequestSigner(const IHttpRequestSigner &)=delete
+
IHttpRequestSigner & operator=(const IHttpRequestSigner &)=delete
+
virtual bool SignRequest(const std::shared_ptr< Aws::Crt::Http::HttpRequest > &request, const ISigningConfig &config, const OnHttpRequestSigningComplete &completionCallback)=0
+
virtual bool IsValid() const =0
+
IHttpRequestSigner & operator=(IHttpRequestSigner &&)=delete
+
IHttpRequestSigner(IHttpRequestSigner &&)=delete
+
+
ISigningConfig & operator=(const ISigningConfig &)=delete
+
+
ISigningConfig(const ISigningConfig &)=delete
+
ISigningConfig & operator=(ISigningConfig &&)=delete
+
virtual SigningConfigType GetType(void) const =0
+
virtual ~ISigningConfig()=default
+
ISigningConfig(ISigningConfig &&)=delete
+
SigningConfigType
Definition: Signing.h:30
+
std::function< void(const std::shared_ptr< Aws::Crt::Http::HttpRequest > &, int)> OnHttpRequestSigningComplete
Definition: Signing.h:39
+
Definition: Allocator.h:11
+
+
+
+
+
diff --git a/docs/_sigv4_signing_8cpp.html b/docs/_sigv4_signing_8cpp.html
new file mode 100644
index 000000000..f0ce41979
--- /dev/null
+++ b/docs/_sigv4_signing_8cpp.html
@@ -0,0 +1,119 @@
+
+
+
+
+
+
+
+aws-crt-cpp: source/auth/Sigv4Signing.cpp File Reference
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ 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>
+
+
+
+
+
+
diff --git a/docs/_sigv4_signing_8h.html b/docs/_sigv4_signing_8h.html
new file mode 100644
index 000000000..f353483b5
--- /dev/null
+++ b/docs/_sigv4_signing_8h.html
@@ -0,0 +1,155 @@
+
+
+
+
+
+
+
+aws-crt-cpp: include/aws/crt/auth/Sigv4Signing.h File Reference
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ aws-crt-cpp
+
+ C++ wrapper around the aws-c-* libraries. Provides Cross-Platform Transport Protocols and SSL/TLS implementations for C++.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/docs/_sigv4_signing_8h_source.html b/docs/_sigv4_signing_8h_source.html
new file mode 100644
index 000000000..38b340fbe
--- /dev/null
+++ b/docs/_sigv4_signing_8h_source.html
@@ -0,0 +1,293 @@
+
+
+
+
+
+
+
+aws-crt-cpp: include/aws/crt/auth/Sigv4Signing.h Source File
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ aws-crt-cpp
+
+ C++ wrapper around the aws-c-* libraries. Provides Cross-Platform Transport Protocols and SSL/TLS implementations for C++.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
Go to the documentation of this file.
+
+
+
+
+
+
+
13 struct aws_signing_config_aws;
+
+
+
+
+
+
+
+
+
22 class ICredentialsProvider;
+
+
+
+
33 SigV4 = AWS_SIGNING_ALGORITHM_V4,
+
+
39 SigV4A = AWS_SIGNING_ALGORITHM_V4_ASYMMETRIC,
+
+
+
+
+
+
+
+
+
+
+
+
+
+
76 namespace SignedBodyValue
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
120 None = AWS_SBHT_NONE,
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
165 const Crt::
String &GetRegion() const noexcept;
+
+
170 void SetRegion(const Crt::
String ®ion) noexcept;
+
+
175 const Crt::
String &GetService() const noexcept;
+
+
180 void SetService(const Crt::
String &service) noexcept;
+
+
185 DateTime GetSigningTimepoint() const noexcept;
+
+
190 void SetSigningTimepoint(const
DateTime &date) noexcept;
+
+
+
+
+
+
+
+
202 bool GetUseDoubleUriEncode() const noexcept;
+
+
208 void SetUseDoubleUriEncode(
bool useDoubleUriEncode) noexcept;
+
+
213 bool GetShouldNormalizeUriPath() const noexcept;
+
+
218 void SetShouldNormalizeUriPath(
bool shouldNormalizeUriPath) noexcept;
+
+
224 bool GetOmitSessionToken() const noexcept;
+
+
230 void SetOmitSessionToken(
bool omitSessionToken) noexcept;
+
+
+
+
+
+
246 void *GetShouldSignHeaderUserData() const noexcept;
+
+
251 void SetShouldSignHeaderUserData(
void *userData) noexcept;
+
+
257 const Crt::
String &GetSignedBodyValue() const noexcept;
+
+
266 void SetSignedBodyValue(const Crt::
String &signedBodyValue) noexcept;
+
+
+
+
+
+
282 uint64_t GetExpirationInSeconds() const noexcept;
+
+
287 void SetExpirationInSeconds(uint64_t expirationInSeconds) noexcept;
+
+
+
+
+
+
+
+
+
+
+
307 const
std ::shared_ptr<
Credentials > &GetCredentials() const noexcept;
+
+
312 void SetCredentials(const
std ::shared_ptr<
Credentials > &credentials) noexcept;
+
+
315 const struct aws_signing_config_aws *GetUnderlyingHandle() const noexcept;
+
+
+
+
+
+
321 struct aws_signing_config_aws m_config;
+
322 Crt::
String m_signingRegion;
+
323 Crt::
String m_serviceName;
+
324 Crt::
String m_signedBodyValue;
+
+
+
+
+
+
+
+
+
337 bool IsValid ()
const override {
return true ; }
+
+
342 virtual bool SignRequest(
+
343 const std::shared_ptr<Aws::Crt::Http::HttpRequest> &request,
+
+
+
+
+
+
+
+
+
+
+
+
#define AWS_CRT_CPP_API
Definition: Exports.h:37
+
+
+
Definition: Sigv4Signing.h:135
+
virtual SigningConfigType GetType() const noexcept override
Definition: Sigv4Signing.h:140
+
Definition: Credentials.h:38
+
Definition: Credentials.h:112
+
+
+
Definition: Sigv4Signing.h:332
+
bool IsValid() const override
Definition: Sigv4Signing.h:337
+
virtual ~Sigv4HttpRequestSigner()=default
+
Definition: DateTime.h:53
+
AWS_CRT_CPP_API const char * StreamingAws4HmacSha256Payload
Definition: Sigv4Signing.cpp:35
+
AWS_CRT_CPP_API const char * StreamingAws4HmacSha256Events
Definition: Sigv4Signing.cpp:41
+
AWS_CRT_CPP_API const char * EmptySha256Str()
Definition: Sigv4Signing.cpp:24
+
AWS_CRT_CPP_API const char * StreamingAws4HmacSha256EventsStr()
Definition: Sigv4Signing.cpp:42
+
AWS_CRT_CPP_API const char * UnsignedPayload
Definition: Sigv4Signing.cpp:29
+
AWS_CRT_CPP_API const char * StreamingAws4HmacSha256PayloadStr()
Definition: Sigv4Signing.cpp:36
+
AWS_CRT_CPP_API const char * UnsignedPayloadStr()
Definition: Sigv4Signing.cpp:30
+
AWS_CRT_CPP_API const char * EmptySha256
Definition: Sigv4Signing.cpp:23
+
SigningAlgorithm
Definition: Sigv4Signing.h:28
+
+
+
SigningConfigType
Definition: Signing.h:30
+
+
SignedBodyHeaderType
Definition: Sigv4Signing.h:116
+
+
+
std::function< void(const std::shared_ptr< Aws::Crt::Http::HttpRequest > &, int)> OnHttpRequestSigningComplete
Definition: Signing.h:39
+
bool(*)(const Crt::ByteCursor *, void *) ShouldSignHeaderCb
Definition: Sigv4Signing.h:128
+
SignatureType
Definition: Sigv4Signing.h:46
+
+
@ HttpRequestViaQueryParams
+
+
+
aws_byte_cursor ByteCursor
Definition: Types.h:31
+
aws_allocator Allocator
Definition: Allocator.h:14
+
AWS_CRT_CPP_API Allocator * ApiAllocator() noexcept
Definition: Allocator.cpp:24
+
std::basic_string< char, std::char_traits< char >, StlAllocator< char > > String
Definition: Types.h:45
+
Definition: Allocator.h:11
+
Definition: StringView.h:852
+
+
+
+
+
diff --git a/docs/_socket_options_8cpp.html b/docs/_socket_options_8cpp.html
new file mode 100644
index 000000000..51492fada
--- /dev/null
+++ b/docs/_socket_options_8cpp.html
@@ -0,0 +1,98 @@
+
+
+
+
+
+
+
+aws-crt-cpp: source/io/SocketOptions.cpp File Reference
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ aws-crt-cpp
+
+ C++ wrapper around the aws-c-* libraries. Provides Cross-Platform Transport Protocols and SSL/TLS implementations for C++.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/docs/_socket_options_8h.html b/docs/_socket_options_8h.html
new file mode 100644
index 000000000..132839203
--- /dev/null
+++ b/docs/_socket_options_8h.html
@@ -0,0 +1,114 @@
+
+
+
+
+
+
+
+aws-crt-cpp: include/aws/crt/io/SocketOptions.h File Reference
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ aws-crt-cpp
+
+ C++ wrapper around the aws-c-* libraries. Provides Cross-Platform Transport Protocols and SSL/TLS implementations for C++.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/docs/_socket_options_8h_source.html b/docs/_socket_options_8h_source.html
new file mode 100644
index 000000000..750d5a66a
--- /dev/null
+++ b/docs/_socket_options_8h_source.html
@@ -0,0 +1,189 @@
+
+
+
+
+
+
+
+aws-crt-cpp: include/aws/crt/io/SocketOptions.h Source File
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ aws-crt-cpp
+
+ C++ wrapper around the aws-c-* libraries. Provides Cross-Platform Transport Protocols and SSL/TLS implementations for C++.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
Go to the documentation of this file.
+
+
+
9 #include <aws/io/socket.h>
+
+
+
+
+
+
+
+
+
+
24 Stream = AWS_SOCKET_STREAM,
+
+
31 Dgram = AWS_SOCKET_DGRAM,
+
+
+
+
+
36 IPv4 = AWS_SOCKET_IPV4,
+
37 IPv6 = AWS_SOCKET_IPV6,
+
41 Local = AWS_SOCKET_LOCAL,
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
97 options.keep_alive_interval_sec = keepAliveInterval;
+
+
+
+
+
+
+
112 options.keep_alive_timeout_sec = keepAliveTimeout;
+
+
+
+
+
+
+
128 options.keep_alive_max_failed_probes = maxProbes;
+
+
+
+
+
+
+
+
+
148 aws_socket_options &GetImpl() {
return options; }
+
150 const aws_socket_options &GetImpl()
const {
return options; }
+
+
+
153 aws_socket_options options;
+
+
+
+
+
+
#define AWS_CRT_CPP_API
Definition: Exports.h:37
+
Definition: SocketOptions.h:48
+
SocketOptions & operator=(SocketOptions &&rhs)=default
+
void SetKeepAliveMaxFailedProbes(uint16_t maxProbes)
Definition: SocketOptions.h:126
+
SocketOptions(const SocketOptions &rhs)=default
+
uint32_t GetConnectTimeoutMs() const
Definition: SocketOptions.h:88
+
void SetSocketDomain(SocketDomain domain)
Definition: SocketOptions.h:72
+
void SetSocketType(SocketType type)
Definition: SocketOptions.h:61
+
void SetKeepAliveTimeoutSec(uint16_t keepAliveTimeout)
Definition: SocketOptions.h:110
+
void SetKeepAliveIntervalSec(uint16_t keepAliveInterval)
Definition: SocketOptions.h:95
+
SocketOptions & operator=(const SocketOptions &rhs)=default
+
SocketType GetSocketType() const
Definition: SocketOptions.h:66
+
void SetConnectTimeoutMs(uint32_t timeout)
Definition: SocketOptions.h:83
+
SocketDomain GetSocketDomain() const
Definition: SocketOptions.h:77
+
void SetKeepAlive(bool keepAlive)
Definition: SocketOptions.h:140
+
uint16_t GetKeepAliveMaxFailedProbes() const
Definition: SocketOptions.h:134
+
uint16_t GetKeepAliveTimeoutSec() const
Definition: SocketOptions.h:119
+
SocketOptions(SocketOptions &&rhs)=default
+
uint16_t GetKeepAliveIntervalSec() const
Definition: SocketOptions.h:103
+
bool GetKeepAlive() const
Definition: SocketOptions.h:145
+
SocketDomain
Definition: SocketOptions.h:35
+
+
+
+
SocketType
Definition: SocketOptions.h:18
+
+
+
Definition: Allocator.h:11
+
+
+
+
+
diff --git a/docs/_stl_allocator_8h.html b/docs/_stl_allocator_8h.html
new file mode 100644
index 000000000..888650886
--- /dev/null
+++ b/docs/_stl_allocator_8h.html
@@ -0,0 +1,102 @@
+
+
+
+
+
+
+
+aws-crt-cpp: include/aws/crt/StlAllocator.h File Reference
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ 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 >
+
#include <memory>
+
#include <type_traits>
+
+
Go to the source code of this file.
+
+
+
+
+
+
diff --git a/docs/_stl_allocator_8h_source.html b/docs/_stl_allocator_8h_source.html
new file mode 100644
index 000000000..36e2832ad
--- /dev/null
+++ b/docs/_stl_allocator_8h_source.html
@@ -0,0 +1,155 @@
+
+
+
+
+
+
+
+aws-crt-cpp: include/aws/crt/StlAllocator.h Source File
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ aws-crt-cpp
+
+ C++ wrapper around the aws-c-* libraries. Provides Cross-Platform Transport Protocols and SSL/TLS implementations for C++.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
Go to the documentation of this file.
+
+
+
+
10 #include <type_traits>
+
+
+
+
+
+
20 template <
typename T>
class StlAllocator :
public std::allocator<T>
+
+
+
23 using Base = std::allocator<T>;
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
45 using RawPointer =
typename std::allocator_traits<std::allocator<T>>::pointer;
+
+
+
+
+
+
+
+
+
54 #if _LIBCPP_STD_VER > 20
+
55 std::allocation_result<T *> allocate_at_least(
size_type n) {
return {
allocate (n), n}; }
+
+
+
+
+
+
+
+
+
+
+
+
+
+
Definition: StlAllocator.h:21
+
void deallocate(RawPointer p, size_type)
Definition: StlAllocator.h:58
+
typename std::allocator_traits< std::allocator< T > >::pointer RawPointer
Definition: StlAllocator.h:45
+
RawPointer allocate(size_type n, const void *hint=nullptr)
Definition: StlAllocator.h:47
+
std::size_t size_type
Definition: StlAllocator.h:38
+
Allocator * m_allocator
Definition: StlAllocator.h:64
+
StlAllocator(Allocator *allocator) noexcept
Definition: StlAllocator.h:27
+
StlAllocator() noexcept
Definition: StlAllocator.h:25
+
StlAllocator(const StlAllocator< U > &a) noexcept
Definition: StlAllocator.h:31
+
~StlAllocator()
Definition: StlAllocator.h:36
+
std::allocator< T > Base
Definition: StlAllocator.h:23
+
StlAllocator(const StlAllocator< T > &a) noexcept
Definition: StlAllocator.h:29
+
aws_allocator Allocator
Definition: Allocator.h:14
+
AWS_CRT_CPP_API Allocator * ApiAllocator() noexcept
Definition: Allocator.cpp:24
+
Definition: Allocator.h:11
+
Definition: StlAllocator.h:41
+
StlAllocator< U > other
Definition: StlAllocator.h:42
+
+
+
+
+
diff --git a/docs/_stream_8cpp.html b/docs/_stream_8cpp.html
new file mode 100644
index 000000000..3afb014bf
--- /dev/null
+++ b/docs/_stream_8cpp.html
@@ -0,0 +1,95 @@
+
+
+
+
+
+
+
+aws-crt-cpp: source/io/Stream.cpp File Reference
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ aws-crt-cpp
+
+ C++ wrapper around the aws-c-* libraries. Provides Cross-Platform Transport Protocols and SSL/TLS implementations for C++.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
#include <aws/crt/StlAllocator.h >
+
#include <aws/crt/io/Stream.h >
+
#include <iostream>
+
#include <aws/io/stream.h>
+
+
+
+
+
+
diff --git a/docs/_stream_8h.html b/docs/_stream_8h.html
new file mode 100644
index 000000000..980abc474
--- /dev/null
+++ b/docs/_stream_8h.html
@@ -0,0 +1,121 @@
+
+
+
+
+
+
+
+aws-crt-cpp: include/aws/crt/io/Stream.h File Reference
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ aws-crt-cpp
+
+ C++ wrapper around the aws-c-* libraries. Provides Cross-Platform Transport Protocols and SSL/TLS implementations for C++.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/docs/_stream_8h_source.html b/docs/_stream_8h_source.html
new file mode 100644
index 000000000..0eea94bd3
--- /dev/null
+++ b/docs/_stream_8h_source.html
@@ -0,0 +1,247 @@
+
+
+
+
+
+
+
+aws-crt-cpp: include/aws/crt/io/Stream.h Source File
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ aws-crt-cpp
+
+ C++ wrapper around the aws-c-* libraries. Provides Cross-Platform Transport Protocols and SSL/TLS implementations for C++.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
Go to the documentation of this file.
+
+
+
+
10 #include <aws/io/stream.h>
+
+
+
+
+
+
+
+
+
+
+
+
+
+
30 Begin = AWS_SSB_BEGIN,
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
50 explicit operator bool() const noexcept {
return IsValid(); }
+
+
55 virtual bool IsValid () const noexcept = 0;
+
+
58 aws_input_stream *GetUnderlyingStream() noexcept {
return &m_underlying_stream; }
+
+
65 bool Read (
ByteBuf &dest) {
return aws_input_stream_read(&m_underlying_stream, &dest) == 0; }
+
+
+
+
75 return aws_input_stream_seek(&m_underlying_stream, offset, (aws_stream_seek_basis)seekBasis) == 0;
+
+
+
+
+
85 return aws_input_stream_get_status(&m_underlying_stream, &status) == 0;
+
+
+
+
+
95 return aws_input_stream_get_length(&m_underlying_stream, &length) == 0;
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
139 virtual int64_t GetLengthImpl() const noexcept = 0;
+
+
+
+
159 virtual int64_t PeekImpl() const noexcept = 0;
+
+
+
162 static
int s_Seek(aws_input_stream *stream, int64_t offset, enum aws_stream_seek_basis basis);
+
163 static
int s_Read(aws_input_stream *stream, aws_byte_buf *dest);
+
164 static
int s_GetStatus(aws_input_stream *stream, aws_stream_status *status);
+
165 static
int s_GetLength(struct aws_input_stream *stream, int64_t *out_length);
+
166 static
void s_Acquire(aws_input_stream *stream);
+
167 static
void s_Release(aws_input_stream *stream);
+
+
169 static aws_input_stream_vtable s_vtable;
+
+
+
+
+
+
+
+
+
+
179 std::shared_ptr<Aws::Crt::Io::IStream> stream,
+
+
+
182 bool IsValid()
const noexcept
override ;
+
+
+
185 bool ReadImpl(
ByteBuf &buffer) noexcept
override ;
+
186 bool ReadSomeImpl(
ByteBuf &buffer) noexcept
override ;
+
+
188 int64_t GetLengthImpl()
const noexcept
override ;
+
+
190 int64_t PeekImpl()
const noexcept
override ;
+
+
+
193 std::shared_ptr<Aws::Crt::Io::IStream> m_stream;
+
+
+
+
+
+
#define AWS_CRT_CPP_API
Definition: Exports.h:37
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
Definition: RefCounted.h:29
+
aws_stream_status StreamStatus
Definition: Stream.h:18
+
StreamSeekBasis
Definition: Stream.h:29
+
+
+
aws_off_t OffsetType
Definition: Stream.h:23
+
aws_allocator Allocator
Definition: Allocator.h:14
+
AWS_CRT_CPP_API Allocator * ApiAllocator() noexcept
Definition: Allocator.cpp:24
+
aws_byte_buf ByteBuf
Definition: Types.h:30
+
Definition: Allocator.h:11
+
+
+
+
+
diff --git a/docs/_string_utils_8cpp.html b/docs/_string_utils_8cpp.html
new file mode 100644
index 000000000..0ff68dcb6
--- /dev/null
+++ b/docs/_string_utils_8cpp.html
@@ -0,0 +1,97 @@
+
+
+
+
+
+
+
+aws-crt-cpp: source/StringUtils.cpp File Reference
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ aws-crt-cpp
+
+ C++ wrapper around the aws-c-* libraries. Provides Cross-Platform Transport Protocols and SSL/TLS implementations for C++.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
#include <aws/crt/StringUtils.h >
+
#include <aws/common/hash_table.h>
+
+
+
+
+
+
diff --git a/docs/_string_utils_8h.html b/docs/_string_utils_8h.html
new file mode 100644
index 000000000..53f409bdc
--- /dev/null
+++ b/docs/_string_utils_8h.html
@@ -0,0 +1,99 @@
+
+
+
+
+
+
+
+aws-crt-cpp: include/aws/crt/StringUtils.h File Reference
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ aws-crt-cpp
+
+ C++ wrapper around the aws-c-* libraries. Provides Cross-Platform Transport Protocols and SSL/TLS implementations for C++.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/docs/_string_utils_8h_source.html b/docs/_string_utils_8h_source.html
new file mode 100644
index 000000000..d61ab6ca9
--- /dev/null
+++ b/docs/_string_utils_8h_source.html
@@ -0,0 +1,95 @@
+
+
+
+
+
+
+
+aws-crt-cpp: include/aws/crt/StringUtils.h Source File
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ aws-crt-cpp
+
+ C++ wrapper around the aws-c-* libraries. Provides Cross-Platform Transport Protocols and SSL/TLS implementations for C++.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
Go to the documentation of this file.
+
+
+
+
+
+
+
+
+
+
+
+
+
#define AWS_CRT_CPP_API
Definition: Exports.h:37
+
size_t AWS_CRT_CPP_API HashString(const char *str) noexcept
Definition: StringUtils.cpp:13
+
Definition: Allocator.h:11
+
+
+
+
+
diff --git a/docs/_string_view_8h.html b/docs/_string_view_8h.html
new file mode 100644
index 000000000..21f67c87a
--- /dev/null
+++ b/docs/_string_view_8h.html
@@ -0,0 +1,192 @@
+
+
+
+
+
+
+
+aws-crt-cpp: include/aws/crt/StringView.h File Reference
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ 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 <string>
+#include <type_traits>
+
+
Go to the source code of this file.
+
+
+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
+
+
+
+
+
+
+
diff --git a/docs/_string_view_8h_source.html b/docs/_string_view_8h_source.html
new file mode 100644
index 000000000..0f8563fc1
--- /dev/null
+++ b/docs/_string_view_8h_source.html
@@ -0,0 +1,1019 @@
+
+
+
+
+
+
+
+aws-crt-cpp: include/aws/crt/StringView.h Source File
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ aws-crt-cpp
+
+ C++ wrapper around the aws-c-* libraries. Provides Cross-Platform Transport Protocols and SSL/TLS implementations for C++.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
Go to the documentation of this file.
+
+
+
+
+
+
+
17 #include <type_traits>
+
+
19 #if __cplusplus >= 201703L || (defined(_MSVC_LANG) && _MSVC_LANG >= 201703L)
+
20 # include <string_view>
+
+
+
+
+
+
+
32 template <
typename CharT,
typename Traits = std::
char _traits<CharT>>
class basic_string_view
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
56 constexpr
basic_string_view (
const CharT *s) noexcept : m_size{traits_type::length(s)}, m_data{s} {}
+
+
+
+
+
+
62 #if __cplusplus >= 201703L || (defined(_MSVC_LANG) && _MSVC_LANG >= 201703L)
+
63 constexpr
basic_string_view (
const std::basic_string_view<CharT, Traits> &other) noexcept
+
64 : m_size(other.size()), m_data(other.data())
+
+
+
+
+
+
70 m_data = other->data();
+
71 m_size = other->size();
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
97 constexpr
size_type max_size () const noexcept {
return (std::numeric_limits<size_type>::max)(); }
+
+
99 constexpr
bool empty () const noexcept {
return this->m_size == 0; }
+
+
+
+
+
+
105 assert(pos < m_size);
+
106 return *(this->m_data + pos);
+
+
+
+
+
111 assert(pos < m_size);
+
112 return *(this->m_data + pos);
+
+
+
+
+
+
118 return *this->m_data;
+
+
+
+
+
+
124 return *(this->m_data + this->m_size - 1);
+
+
+
+
+
+
+
+
132 assert(this->m_size >= n);
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
149 assert(pos <=
size ());
+
150 const size_type copyLen = (std::min)(n, m_size - pos);
+
151 traits_type::copy(s,
data () + pos, copyLen);
+
+
+
+
+
+
157 assert(pos <=
size ());
+
158 const size_type copyLen = (std::min)(n, m_size - pos);
+
+
+
+
+
+
164 const size_type compareLen = (std::min)(this->m_size, s.m_size);
+
165 int ret = traits_type::compare(this->m_data, s.m_data, compareLen);
+
+
+
168 ret = _s_compare(this->m_size, s.m_size);
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
202 return this->
substr (0, other.size()) == other;
+
+
+
+
+
207 return !this->
empty () && traits_type::eq(this->
front (), c);
+
+
+
+
+
+
+
+
+
+
217 return this->m_size >= other.m_size && this->
compare (this->m_size - other.m_size,
npos , other) == 0;
+
+
+
+
+
222 return !this->
empty () && traits_type::eq(this->
back (), c);
+
+
+
+
+
+
+
+
230 return this->
find (s.m_data, pos, s.m_size);
+
+
+
+
+
+
+
+
+
239 const CharT *r = Traits::find(m_data + pos, m_size - pos, c);
+
+
+
+
+
244 return static_cast< size_type > (r - m_data);
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
264 const CharT *r = _s_search_substr(m_data + pos, m_data + m_size, s, s + n);
+
+
266 if (r == m_data + m_size)
+
+
+
+
270 return static_cast< size_type > (r - m_data);
+
+
+
+
+
275 return this->
find (s, pos, traits_type::length(s));
+
+
+
+
+
280 if (s.m_size && !s.m_data)
+
+
+
+
284 return this->
rfind (s.m_data, pos, s.m_size);
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
303 for (
const CharT *ptr = m_data + pos; ptr != m_data;)
+
+
305 if (Traits::eq(*--ptr, c))
+
+
307 return static_cast< size_type > (ptr - m_data);
+
+
+
+
+
+
+
+
+
+
+
+
+
320 pos = (std::min)(pos, m_size);
+
321 if (n < m_size - pos)
+
+
+
+
+
+
+
+
329 const CharT *r = _s_find_end(m_data, m_data + pos, s, s + n);
+
330 if (n > 0 && r == m_data + pos)
+
+
+
+
334 return static_cast< size_type > (r - m_data);
+
+
+
+
+
339 return this->
rfind (s, pos, traits_type::length(s));
+
+
+
+
+
+
+
+
+
+
+
+
351 if (pos >= m_size || !n || !s)
+
+
+
+
+
356 const CharT *r = _s_find_first_of_ce(m_data + pos, m_data + m_size, s, s + n);
+
+
358 if (r == m_data + m_size)
+
+
+
+
+
363 return static_cast< size_type > (r - m_data);
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
378 return this->
rfind (c, pos);
+
+
+
+
+
383 if (!n || s ==
nullptr )
+
+
+
+
+
+
+
+
+
+
+
+
+
+
397 for (
const CharT *ptr = m_data + pos; ptr != m_data;)
+
+
399 const CharT *r = Traits::find(s, n, *--ptr);
+
+
+
402 return static_cast< size_type > (ptr - m_data);
+
+
+
+
+
+
+
+
+
411 return this->
find_last_of (s, pos, traits_type::length(s));
+
+
+
+
+
416 if (s.m_size && !s.m_data)
+
+
+
+
+
+
+
+
+
425 if (!m_data || pos >= m_size)
+
+
+
+
+
430 const CharT *pend = m_data + m_size;
+
431 for (
const CharT *ptr = m_data + pos; ptr != pend; ++ptr)
+
+
433 if (!Traits::eq(*ptr, c))
+
+
435 return static_cast< size_type > (ptr - m_data);
+
+
+
+
+
+
+
+
+
444 if (n && s ==
nullptr )
+
+
+
+
+
449 if (m_data ==
nullptr || pos >= m_size)
+
+
+
+
+
454 const CharT *pend = m_data + m_size;
+
455 for (
const CharT *ptr = m_data + pos; ptr != pend; ++ptr)
+
+
457 if (Traits::find(s, n, *ptr) == 0)
+
+
459 return static_cast< size_type > (ptr - m_data);
+
+
+
+
+
+
+
+
+
+
+
+
+
+
473 if (s.m_size && !s.m_data)
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
491 for (
const CharT *ptr = m_data + pos; ptr != m_data;)
+
+
493 if (!Traits::eq(*--ptr, c))
+
+
495 return static_cast< size_type > (ptr - m_data);
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
517 for (
const CharT *ptr = m_data + pos; ptr != m_data;)
+
+
519 if (Traits::find(s, n, *--ptr) == 0)
+
+
521 return static_cast< size_type > (ptr - m_data);
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
537 if (diff > (std::numeric_limits<int>::max)())
+
+
539 return (std::numeric_limits<int>::max)();
+
+
+
542 if (diff < (std::numeric_limits<int>::min)())
+
+
544 return (std::numeric_limits<int>::min)();
+
+
+
547 return static_cast< int > (diff);
+
+
+
550 static const CharT *_s_search_substr(
+
+
+
+
+
+
556 const ptrdiff_t length2 = last2 - first2;
+
+
+
+
+
+
562 ptrdiff_t length1 = last1 - first1;
+
563 if (length1 < length2)
+
+
+
+
+
+
+
570 length1 = last1 - first1;
+
571 if (length1 < length2)
+
+
+
+
+
576 first1 = Traits::find(first1, length1 - length2 + 1, *first2);
+
+
+
+
+
+
582 if (Traits::compare(first1, first2, length2) == 0)
+
+
+
+
+
+
+
+
+
591 static const CharT *_s_find_end(
+
+
+
+
+
+
597 const CharT *r = last1;
+
+
+
+
+
+
+
+
+
+
+
+
+
+
611 if (Traits::eq(*first1, *first2))
+
+
+
+
+
+
+
618 const CharT *m1 = first1;
+
619 const CharT *m2 = first2;
+
+
+
+
+
+
+
+
+
+
+
+
+
632 if (!Traits::eq(*m1, *m2))
+
+
+
+
+
+
+
+
+
641 static const CharT *_s_find_first_of_ce(
+
+
+
+
+
+
647 for (; first1 != last1; ++first1)
+
+
649 for (
const CharT *ptr = first2; ptr != last2; ++ptr)
+
+
651 if (Traits::eq(*first1, *ptr))
+
+
+
+
+
+
+
+
+
+
+
+
+
+
665 template <
class CharT,
class Traits>
+
+
+
+
+
670 return (lhs.size() != rhs.size()) ? false : lhs.compare(rhs) == 0;
+
+
+
673 template <
class CharT,
class Traits>
+
+
+
+
+
678 return (lhs.size() != rhs.size()) ? false : lhs.compare(rhs) == 0;
+
+
+
681 template <
class CharT,
class Traits>
+
+
+
+
+
686 return (lhs.size() != rhs.size()) ? false : lhs.compare(rhs) == 0;
+
+
+
+
690 template <
class CharT,
class Traits>
+
+
+
+
+
695 return (lhs.size() != rhs.size()) ? true : lhs.compare(rhs) != 0;
+
+
+
698 template <
class CharT,
class Traits>
+
+
+
+
+
703 return (lhs.size() != rhs.size()) ? true : lhs.compare(rhs) != 0;
+
+
+
706 template <
class CharT,
class Traits>
+
+
+
+
+
711 return (lhs.size() != rhs.size()) ? true : lhs.compare(rhs) != 0;
+
+
+
+
715 template <
class CharT,
class Traits>
+
+
+
+
+
720 return lhs.compare(rhs) < 0;
+
+
+
723 template <
class CharT,
class Traits>
+
+
+
+
+
728 return lhs.compare(rhs) < 0;
+
+
+
731 template <
class CharT,
class Traits>
+
+
+
+
+
736 return lhs.compare(rhs) < 0;
+
+
+
+
740 template <
class CharT,
class Traits>
+
+
+
+
+
745 return lhs.compare(rhs) > 0;
+
+
+
748 template <
class CharT,
class Traits>
+
+
+
+
+
753 return lhs.compare(rhs) > 0;
+
+
+
756 template <
class CharT,
class Traits>
+
+
+
+
+
761 return lhs.compare(rhs) > 0;
+
+
+
+
765 template <
class CharT,
class Traits>
+
+
+
+
+
770 return lhs.compare(rhs) <= 0;
+
+
+
773 template <
class CharT,
class Traits>
+
+
+
+
+
778 return lhs.compare(rhs) <= 0;
+
+
+
781 template <
class CharT,
class Traits>
+
+
+
+
+
786 return lhs.compare(rhs) <= 0;
+
+
+
+
790 template <
class CharT,
class Traits>
+
+
+
+
+
795 return lhs.compare(rhs) >= 0;
+
+
+
798 template <
class CharT,
class Traits>
+
+
+
+
+
803 return lhs.compare(rhs) >= 0;
+
+
+
806 template <
class CharT,
class Traits>
+
+
+
+
+
811 return lhs.compare(rhs) >= 0;
+
+
+
+
+
+
+
+
819 inline namespace literals
+
+
821 inline namespace string_view_literals
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
853 template <
class CharT,
class Traits>
struct hash<
Aws ::Crt::basic_string_view<CharT, Traits>>
+
+
+
+
+
858 template <
class CharT,
class Traits>
+
859 size_t hash<Aws::Crt::basic_string_view<CharT, Traits>>::operator()(
+
+
+
862 auto str = std::basic_string<CharT, Traits>(val.data(), val.size());
+
863 return std::hash<std::basic_string<CharT, Traits>>{}(str);
+
+
+
Definition: StringView.h:33
+
constexpr const_iterator begin() const noexcept
Definition: StringView.h:77
+
constexpr size_type find(const CharT *s, size_type pos=0) const noexcept
Definition: StringView.h:273
+
constexpr size_type rfind(const CharT *s, size_type pos=npos) const noexcept
Definition: StringView.h:337
+
size_type find(CharT c, size_type pos=0) const noexcept
Definition: StringView.h:233
+
size_type find_first_not_of(CharT c, size_type pos=0) const noexcept
Definition: StringView.h:423
+
constexpr int compare(size_type pos1, size_type n1, const CharT *s) const
Definition: StringView.h:190
+
constexpr basic_string_view(const basic_string_view &) noexcept=default
+
constexpr int compare(size_type pos1, size_type n1, const basic_string_view &s) const
Definition: StringView.h:173
+
constexpr int compare(size_type pos1, size_type n1, const CharT *s, size_type n2) const noexcept(false)
Definition: StringView.h:195
+
constexpr const_iterator end() const noexcept
Definition: StringView.h:79
+
value_type * pointer
Definition: StringView.h:38
+
Traits traits_type
Definition: StringView.h:36
+
constexpr basic_string_view(const CharT *s, size_type count) noexcept
Definition: StringView.h:58
+
void remove_suffix(size_type n) noexcept
Definition: StringView.h:137
+
constexpr size_type find(const basic_string_view &s, size_type pos=0) const noexcept
Definition: StringView.h:228
+
constexpr size_type find_first_of(basic_string_view s, size_type pos=0) const noexcept
Definition: StringView.h:342
+
constexpr const_iterator cbegin() const noexcept
Definition: StringView.h:81
+
const_reference front() const noexcept
Definition: StringView.h:115
+
size_type copy(CharT *s, size_type n, size_type pos=0) const
Definition: StringView.h:147
+
constexpr const_reverse_iterator rend() const noexcept
Definition: StringView.h:87
+
size_type find_last_of(const CharT *s, size_type pos, size_type n) const noexcept
Definition: StringView.h:381
+
const_reference operator[](size_type pos) const noexcept
Definition: StringView.h:103
+
constexpr size_type find_last_of(basic_string_view s, size_type pos=npos) const noexcept
Definition: StringView.h:371
+
constexpr const_reverse_iterator crbegin() const noexcept
Definition: StringView.h:89
+
ptrdiff_t difference_type
Definition: StringView.h:47
+
size_t size_type
Definition: StringView.h:46
+
std::reverse_iterator< const_iterator > const_reverse_iterator
Definition: StringView.h:44
+
constexpr const_reverse_iterator crend() const noexcept
Definition: StringView.h:91
+
constexpr bool ends_with(const CharT *s) const noexcept
Definition: StringView.h:225
+
value_type & reference
Definition: StringView.h:40
+
size_type find_first_not_of(const CharT *s, size_type pos, size_type n) const noexcept
Definition: StringView.h:442
+
size_type rfind(const CharT *s, size_type pos, size_type n) const noexcept
Definition: StringView.h:313
+
constexpr size_type find_first_not_of(const CharT *s, size_type pos=0) const noexcept
Definition: StringView.h:466
+
constexpr const_iterator cend() const noexcept
Definition: StringView.h:83
+
const_reference at(size_type pos) const
Definition: StringView.h:109
+
static constexpr size_type npos
Definition: StringView.h:48
+
constexpr bool empty() const noexcept
Definition: StringView.h:99
+
constexpr size_type size() const noexcept
Definition: StringView.h:93
+
constexpr basic_string_view(const CharT *s) noexcept
Definition: StringView.h:56
+
const_reverse_iterator reverse_iterator
Definition: StringView.h:45
+
size_type find_last_not_of(CharT c, size_type pos=npos) const noexcept
Definition: StringView.h:480
+
constexpr bool ends_with(const basic_string_view &other) const noexcept
Definition: StringView.h:215
+
constexpr bool starts_with(const CharT *s) const noexcept
Definition: StringView.h:210
+
size_type find(const CharT *s, size_type pos, size_type n) const noexcept
Definition: StringView.h:247
+
size_type find_last_not_of(const CharT *s, size_type pos, size_type n) const noexcept
Definition: StringView.h:501
+
void remove_prefix(size_type n) noexcept
Definition: StringView.h:130
+
size_type find_last_not_of(basic_string_view s, size_type pos=npos) const noexcept
Definition: StringView.h:471
+
size_type find_first_not_of(basic_string_view s, size_type pos=0) const noexcept
Definition: StringView.h:414
+
basic_string_view substr(size_type pos=0, size_type n=npos) const noexcept(false)
Definition: StringView.h:155
+
size_type rfind(basic_string_view s, size_type pos=npos) const noexcept
Definition: StringView.h:278
+
int compare(const basic_string_view &s) const noexcept
Definition: StringView.h:162
+
constexpr bool ends_with(CharT c) const noexcept
Definition: StringView.h:220
+
constexpr int compare(size_type pos1, size_type n1, const basic_string_view &s, size_type pos2, size_type n2) const
Definition: StringView.h:178
+
const_iterator iterator
Definition: StringView.h:43
+
constexpr size_type find_last_of(const CharT *s, size_type pos=npos) const noexcept
Definition: StringView.h:409
+
constexpr const_reverse_iterator rbegin() const noexcept
Definition: StringView.h:85
+
constexpr size_type max_size() const noexcept
Definition: StringView.h:97
+
constexpr size_type find_last_of(CharT c, size_type pos=npos) const noexcept
Definition: StringView.h:376
+
constexpr size_type find_first_of(const CharT *s, size_type pos=0) const noexcept
Definition: StringView.h:366
+
size_type rfind(CharT c, size_type pos=npos) const noexcept
Definition: StringView.h:287
+
const value_type & const_reference
Definition: StringView.h:41
+
constexpr bool starts_with(CharT c) const noexcept
Definition: StringView.h:205
+
const value_type * const_pointer
Definition: StringView.h:39
+
constexpr size_type find_last_not_of(const CharT *s, size_type pos=npos) const noexcept
Definition: StringView.h:527
+
const value_type * const_iterator
Definition: StringView.h:42
+
constexpr basic_string_view() noexcept
Definition: StringView.h:52
+
CharT value_type
Definition: StringView.h:37
+
basic_string_view & operator=(const basic_string_view &) noexcept=default
+
constexpr size_type find_first_of(CharT c, size_type pos=0) const noexcept
Definition: StringView.h:347
+
const_reference back() const noexcept
Definition: StringView.h:121
+
constexpr const_pointer data() const noexcept
Definition: StringView.h:127
+
constexpr size_type length() const noexcept
Definition: StringView.h:95
+
constexpr int compare(const CharT *s) const noexcept
Definition: StringView.h:188
+
void swap(basic_string_view &other) noexcept
Definition: StringView.h:139
+
constexpr bool starts_with(const basic_string_view &other) const noexcept
Definition: StringView.h:200
+
size_type find_first_of(const CharT *s, size_type pos, size_type n) const noexcept
Definition: StringView.h:349
+
basic_string_view< char32_t > u32string_view
Definition: StringView.h:816
+
basic_string_view< char > string_view
Definition: StringView.h:814
+
constexpr bool operator<=(const basic_string_view< CharT, Traits > &lhs, const basic_string_view< CharT, Traits > &rhs) noexcept
Definition: StringView.h:766
+
bool operator<(const basic_string_view< CharT, Traits > &lhs, const basic_string_view< CharT, Traits > &rhs) noexcept
Definition: StringView.h:716
+
constexpr bool operator>=(const basic_string_view< CharT, Traits > &lhs, const basic_string_view< CharT, Traits > &rhs) noexcept
Definition: StringView.h:791
+
constexpr bool operator>(const basic_string_view< CharT, Traits > &lhs, const basic_string_view< CharT, Traits > &rhs) noexcept
Definition: StringView.h:741
+
basic_string_view< wchar_t > wstring_view
Definition: StringView.h:817
+
basic_string_view< char16_t > u16string_view
Definition: StringView.h:815
+
bool operator==(const basic_string_view< CharT, Traits > &lhs, const basic_string_view< CharT, Traits > &rhs) noexcept
Definition: StringView.h:666
+
bool operator!=(const basic_string_view< CharT, Traits > &lhs, const basic_string_view< CharT, Traits > &rhs) noexcept
Definition: StringView.h:691
+
Definition: Allocator.h:11
+
Definition: StringView.h:852
+
+
+
+
+
diff --git a/docs/_symmetric_cipher_8cpp.html b/docs/_symmetric_cipher_8cpp.html
new file mode 100644
index 000000000..f5c68d8b9
--- /dev/null
+++ b/docs/_symmetric_cipher_8cpp.html
@@ -0,0 +1,93 @@
+
+
+
+
+
+
+
+aws-crt-cpp: source/crypto/SymmetricCipher.cpp File Reference
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ aws-crt-cpp
+
+ C++ wrapper around the aws-c-* libraries. Provides Cross-Platform Transport Protocols and SSL/TLS implementations for C++.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/docs/_symmetric_cipher_8h.html b/docs/_symmetric_cipher_8h.html
new file mode 100644
index 000000000..8a345544d
--- /dev/null
+++ b/docs/_symmetric_cipher_8h.html
@@ -0,0 +1,119 @@
+
+
+
+
+
+
+
+aws-crt-cpp: include/aws/crt/crypto/SymmetricCipher.h File Reference
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ aws-crt-cpp
+
+ C++ wrapper around the aws-c-* libraries. Provides Cross-Platform Transport Protocols and SSL/TLS implementations for C++.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
#include <aws/cal/symmetric_cipher.h>
+
#include <aws/crt/Exports.h >
+
#include <aws/crt/Types.h >
+
+
Go to the source code of this file.
+
+
+
+
+
+
diff --git a/docs/_symmetric_cipher_8h_source.html b/docs/_symmetric_cipher_8h_source.html
new file mode 100644
index 000000000..e46f44599
--- /dev/null
+++ b/docs/_symmetric_cipher_8h_source.html
@@ -0,0 +1,183 @@
+
+
+
+
+
+
+
+aws-crt-cpp: include/aws/crt/crypto/SymmetricCipher.h Source File
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ aws-crt-cpp
+
+ C++ wrapper around the aws-c-* libraries. Provides Cross-Platform Transport Protocols and SSL/TLS implementations for C++.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
Go to the documentation of this file.
+
6 #include <aws/cal/symmetric_cipher.h>
+
+
+
+
10 struct aws_symmetric_cipher;
+
+
+
+
+
+
+
+
+
+
+
+
+
23 Ready = AWS_SYMMETRIC_CIPHER_READY,
+
24 Finalized = AWS_SYMMETRIC_CIPHER_FINALIZED,
+
25 Error = AWS_SYMMETRIC_CIPHER_ERROR,
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
77 operator
bool () const noexcept;
+
+
+
+
88 inline
int LastError () const noexcept {
return m_lastError; }
+
+
+
+
108 bool FinalizeEncryption(
ByteBuf &out) noexcept;
+
+
+
+
126 bool FinalizeDecryption(
ByteBuf &out) noexcept;
+
+
131 bool Reset() noexcept;
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
#define AWS_CRT_CPP_API
Definition: Exports.h:37
+
+
Definition: SymmetricCipher.h:29
+
SymmetricCipher(const SymmetricCipher &)=delete
+
SymmetricCipher & operator=(const SymmetricCipher &)=delete
+
SymmetricCipher(SymmetricCipher &&) noexcept=default
+
Definition: Optional.h:18
+
static const size_t AES_256_CIPHER_BLOCK_SIZE
Definition: SymmetricCipher.h:18
+
SymmetricCipherState
Definition: SymmetricCipher.h:22
+
+
+
+
static const size_t AES_256_KEY_SIZE_BYTES
Definition: SymmetricCipher.h:19
+
aws_byte_cursor ByteCursor
Definition: Types.h:31
+
aws_allocator Allocator
Definition: Allocator.h:14
+
AWS_CRT_CPP_API Allocator * ApiAllocator() noexcept
Definition: Allocator.cpp:24
+
aws_byte_buf ByteBuf
Definition: Types.h:30
+
std::unique_ptr< T, std::function< void(T *)> > ScopedResource
Definition: Types.h:163
+
AWS_CRT_CPP_API int LastError() noexcept
Definition: Api.cpp:422
+
Definition: Allocator.h:11
+
+
+
+
+
diff --git a/docs/_tls_options_8cpp.html b/docs/_tls_options_8cpp.html
new file mode 100644
index 000000000..9a971db6b
--- /dev/null
+++ b/docs/_tls_options_8cpp.html
@@ -0,0 +1,96 @@
+
+
+
+
+
+
+
+aws-crt-cpp: source/io/TlsOptions.cpp File Reference
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ 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>
+
+
+
+
+
+
diff --git a/docs/_tls_options_8h.html b/docs/_tls_options_8h.html
new file mode 100644
index 000000000..4fdd40820
--- /dev/null
+++ b/docs/_tls_options_8h.html
@@ -0,0 +1,134 @@
+
+
+
+
+
+
+
+aws-crt-cpp: include/aws/crt/io/TlsOptions.h File Reference
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ 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.
+
+
+
+
+
+
diff --git a/docs/_tls_options_8h_source.html b/docs/_tls_options_8h_source.html
new file mode 100644
index 000000000..0ce5d250a
--- /dev/null
+++ b/docs/_tls_options_8h_source.html
@@ -0,0 +1,339 @@
+
+
+
+
+
+
+
+aws-crt-cpp: include/aws/crt/io/TlsOptions.h Source File
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ aws-crt-cpp
+
+ C++ wrapper around the aws-c-* libraries. Provides Cross-Platform Transport Protocols and SSL/TLS implementations for C++.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
Go to the documentation of this file.
+
+
+
9 #include <aws/io/tls_channel_handler.h>
+
+
+
+
+
14 struct aws_tls_ctx_options;
+
+
+
+
+
+
+
+
+
23 class TlsContextPkcs11Options;
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
50 explicit operator
bool () const noexcept {
return m_isInit; }
+
+
+
+
+
+
+
75 const
char *cert_path,
+
76 const
char *pkey_path,
+
+
+
+
+
+
+
+
+
+
+
+
+
121 const
char *pkcs12_path,
+
122 const
char *pkcs12_pwd,
+
+
+
135 bool SetKeychainPath(
ByteCursor &keychain_path) noexcept;
+
+
+
149 const
char *windowsCertStorePath,
+
+
+
156 static
bool IsAlpnSupported() noexcept;
+
+
163 bool SetAlpnList(const
char *alpnList) noexcept;
+
+
173 void SetVerifyPeer(
bool verifyPeer) noexcept;
+
+
179 void SetMinimumTlsVersion(aws_tls_versions minimumTlsVersion);
+
+
185 void SetTlsCipherPreference(aws_tls_cipher_pref cipher_pref);
+
+
195 bool OverrideDefaultTrustStore(const
char *caPath, const
char *caFile) noexcept;
+
+
201 bool OverrideDefaultTrustStore(const
ByteCursor &ca) noexcept;
+
+
204 const aws_tls_ctx_options *GetUnderlyingHandle() const noexcept {
return &m_options; }
+
+
+
207 aws_tls_ctx_options m_options;
+
+
+
+
+
+
+
+
224 const std::shared_ptr<Pkcs11Lib> &pkcs11Lib,
+
+
+
233 void SetUserPin(
const String &pin) noexcept;
+
+
241 void SetSlotId(
const uint64_t
id ) noexcept;
+
+
249 void SetTokenLabel(
const String &label) noexcept;
+
+
258 void SetPrivateKeyObjectLabel(
const String &label) noexcept;
+
+
266 void SetCertificateFilePath(
const String &path) noexcept;
+
+
274 void SetCertificateFileContents(
const String &contents) noexcept;
+
+
277 aws_tls_ctx_pkcs11_options GetUnderlyingHandle()
const noexcept;
+
+
+
280 std::shared_ptr<Pkcs11Lib> m_pkcs11Lib;
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
307 bool SetServerName(
ByteCursor &serverName) noexcept;
+
+
315 bool SetAlpnList(
const char *alpnList) noexcept;
+
+
320 explicit operator bool() const noexcept {
return isValid(); }
+
+
+
+
328 const aws_tls_connection_options *GetUnderlyingHandle() const noexcept
+
+
330 return &m_tls_connection_options;
+
+
+
+
334 bool isValid() const noexcept {
return m_isInit; }
+
+
336 TlsConnectionOptions(aws_tls_ctx *ctx,
Allocator *allocator) noexcept;
+
337 aws_tls_connection_options m_tls_connection_options;
+
338 aws_allocator *m_allocator;
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
369 explicit operator
bool () const noexcept {
return isValid(); }
+
+
+
+
377 aws_tls_ctx *GetUnderlyingHandle() const noexcept {
return m_ctx.get(); }
+
+
+
380 bool isValid() const noexcept {
return m_ctx && m_initializationError == AWS_ERROR_SUCCESS; }
+
+
382 std::shared_ptr<aws_tls_ctx> m_ctx;
+
383 int m_initializationError;
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
405 struct aws_channel_slot *slot,
+
406 const struct aws_tls_connection_options &options,
+
+
+
414 void CompleteTlsNegotiation(
int errorCode);
+
+
+
417 aws_tls_on_negotiation_result_fn *m_OnNegotiationResult;
+
+
+
420 aws_byte_buf m_protocolByteBuf;
+
421 friend aws_byte_buf(::aws_tls_handler_protocol)(aws_channel_handler *);
+
+
+
+
+
+
+
+
+
+
441 struct aws_channel_slot *slot,
+
442 const struct aws_tls_connection_options &options,
+
+
+
+
+
447 struct aws_channel_slot *slot,
+
448 const struct aws_tls_connection_options &options,
+
+
+
+
+
+
+
#define AWS_CRT_CPP_API
Definition: Exports.h:37
+
+
Definition: ChannelHandler.h:47
+
Definition: TlsOptions.h:431
+
virtual void StartNegotiation()=0
+
Definition: TlsOptions.h:394
+
virtual String GetProtocol() const =0
+
Definition: TlsOptions.h:293
+
int LastError() const noexcept
Definition: TlsOptions.h:325
+
Definition: TlsOptions.h:350
+
TlsContext(TlsContext &&) noexcept=default
+
+
int GetInitializationError() const noexcept
Definition: TlsOptions.h:374
+
TlsContext & operator=(const TlsContext &) noexcept=default
+
TlsContext(const TlsContext &) noexcept=default
+
Definition: TlsOptions.h:36
+
Definition: TlsOptions.h:217
+
+
std::function< void *(TlsContextOptions &, TlsMode, Allocator *)> NewTlsContextImplCallback
Definition: TlsOptions.h:386
+
TlsMode
Definition: TlsOptions.h:26
+
+
+
std::function< bool()> IsTlsAlpnSupportedCallback
Definition: TlsOptions.h:388
+
std::function< std::shared_ptr< ClientTlsChannelHandler >(struct aws_channel_slot *slot, const struct aws_tls_connection_options &options, Allocator *allocator)> NewClientTlsHandlerCallback
Definition: TlsOptions.h:449
+
std::function< void(void *)> DeleteTlsContextImplCallback
Definition: TlsOptions.h:387
+
aws_byte_cursor ByteCursor
Definition: Types.h:31
+
aws_allocator Allocator
Definition: Allocator.h:14
+
AWS_CRT_CPP_API Allocator * ApiAllocator() noexcept
Definition: Allocator.cpp:24
+
std::basic_string< char, std::char_traits< char >, StlAllocator< char > > String
Definition: Types.h:45
+
AWS_CRT_CPP_API int LastError() noexcept
Definition: Api.cpp:422
+
Definition: Allocator.h:11
+
+
+
+
+
diff --git a/docs/_types_8cpp.html b/docs/_types_8cpp.html
new file mode 100644
index 000000000..ec83e7d41
--- /dev/null
+++ b/docs/_types_8cpp.html
@@ -0,0 +1,121 @@
+
+
+
+
+
+
+
+aws-crt-cpp: source/Types.cpp File Reference
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ 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/common/encoding.h>
+
+
+
+
+
+
diff --git a/docs/_types_8h.html b/docs/_types_8h.html
new file mode 100644
index 000000000..e1f5e6b93
--- /dev/null
+++ b/docs/_types_8h.html
@@ -0,0 +1,201 @@
+
+
+
+
+
+
+
+aws-crt-cpp: include/aws/crt/Types.h File Reference
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ 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.
+
+
+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 *)> >
+
+
+
+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 ByteBuf Aws::Crt::ByteBufInit (Allocator *alloc, 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) noexcept
+
+AWS_CRT_CPP_API String Aws::Crt::Base64Encode (const Vector< uint8_t > &encode) noexcept
+
+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)
+
+
+
+
+
+
+
diff --git a/docs/_types_8h_source.html b/docs/_types_8h_source.html
new file mode 100644
index 000000000..67dbed1f2
--- /dev/null
+++ b/docs/_types_8h_source.html
@@ -0,0 +1,275 @@
+
+
+
+
+
+
+
+aws-crt-cpp: include/aws/crt/Types.h Source File
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ aws-crt-cpp
+
+ C++ wrapper around the aws-c-* libraries. Provides Cross-Platform Transport Protocols and SSL/TLS implementations for C++.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
Go to the documentation of this file.
+
6 #include <aws/common/common.h>
+
+
+
+
+
11 #include <aws/io/socket.h>
+
12 #include <aws/mqtt/mqtt.h>
+
+
+
+
+
+
18 #include <unordered_map>
+
+
+
+
+
23 struct aws_byte_cursor;
+
24 struct aws_socket_options;
+
+
+
+
+
+
+
+
+
+
+
35 using IStream = std::basic_istream<char, std::char_traits<char>>;
+
+
+
+
+
40 using QOS = aws_mqtt_qos;
+
+
+
+
+
+
+
+
48 template <
typename K,
typename V>
+
+
+
51 template <
typename K,
typename V>
+
+
53 template <
typename T>
using Vector = std::vector<T, StlAllocator<T>>;
+
54 template <
typename T>
using List = std::list<T, StlAllocator<T>>;
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
72 template <
typename RawType,
typename TargetType>
using TypeConvertor = std::function<TargetType(RawType)>;
+
+
78 template <
typename RawType,
typename TargetType>
+
+
+
+
82 size_t cnt = aws_array_list_length(array);
+
83 for (
size_t i = 0; i < cnt; i++)
+
+
+
86 aws_array_list_get_at(array, &t, i);
+
87 v.emplace_back(conv(t));
+
+
+
+
+
96 template <
typename RawType,
typename TargetType>
+
+
+
+
100 size_t cnt = aws_array_list_length(array);
+
101 for (
size_t i = 0; i < cnt; i++)
+
+
+
104 aws_array_list_get_at(array, &t, i);
+
105 v.emplace_back(TargetType(t));
+
+
+
+
+
+
+
+
116 size_t cnt = aws_array_list_length(array);
+
117 for (
size_t i = 0; i < cnt; i++)
+
+
+
120 aws_array_list_get_at(array, &t, i);
+
+
+
+
+
+
+
+
128 return StringView (
reinterpret_cast< char *
> (bc.ptr), bc.len);
+
+
+
+
+
+
134 bc.ptr = (uint8_t *)(sv.
data ());
+
+
+
+
+
+
+
+
142 aws_mem_release(allocator, t);
+
+
+
145 template <
typename T,
typename ... Args> T *
New (
Allocator *allocator, Args &&...args)
+
+
147 T *t =
reinterpret_cast< T *
> (aws_mem_acquire(allocator,
sizeof (T)));
+
+
+
150 return new (t) T(std::forward<Args>(args)...);
+
+
+
153 template <
typename T,
typename ... Args> std::shared_ptr<T>
MakeShared (
Allocator *allocator, Args &&...args)
+
+
155 T *t =
reinterpret_cast< T *
> (aws_mem_acquire(allocator,
sizeof (T)));
+
+
+
158 new (t) T(std::forward<Args>(args)...);
+
+
160 return std::shared_ptr<T>(t, [allocator](T *obj) {
Delete (obj, allocator); });
+
+
+
163 template <
typename T>
using ScopedResource = std::unique_ptr<T, std::function<void(T *)>>;
+
+
+
+
+
#define AWS_CRT_CPP_API
Definition: Exports.h:37
+
+
+
+
Definition: StlAllocator.h:21
+
Definition: StringView.h:33
+
constexpr size_type size() const noexcept
Definition: StringView.h:93
+
constexpr const_pointer data() const noexcept
Definition: StringView.h:127
+
std::basic_istream< char, std::char_traits< char > > IStream
Definition: Types.h:35
+
aws_mqtt_qos QOS
Definition: Types.h:40
+
aws_mqtt_connect_return_code ReturnCode
Definition: Types.h:41
+
AWS_CRT_CPP_API ByteCursor ByteCursorFromStringView(const Crt::StringView &str) noexcept
Definition: Types.cpp:58
+
AWS_CRT_CPP_API ByteCursor StringViewToByteCursor(const StringView &sv)
Definition: Types.h:131
+
aws_byte_cursor ByteCursor
Definition: Types.h:31
+
AWS_CRT_CPP_API ByteBuf ByteBufNewCopy(Allocator *alloc, const uint8_t *array, size_t len)
Definition: Types.cpp:28
+
std::map< K, V, std::less< K >, StlAllocator< std::pair< const K, V > >> Map
Definition: Types.h:47
+
AWS_CRT_CPP_API ByteCursor ByteCursorFromCString(const char *str) noexcept
Definition: Types.cpp:48
+
aws_allocator Allocator
Definition: Allocator.h:14
+
std::basic_stringstream< char, std::char_traits< char >, StlAllocator< char > > StringStream
Definition: Types.h:46
+
AWS_CRT_CPP_API ByteCursor ByteCursorFromArray(const uint8_t *array, size_t len) noexcept
Definition: Types.cpp:68
+
void Delete(T *t, Allocator *allocator)
Definition: Types.h:139
+
std::unordered_map< K, V, std::hash< K >, std::equal_to< K >, StlAllocator< std::pair< const K, V > >> UnorderedMap
Definition: Types.h:50
+
Vector< TargetType > ArrayListToVector(const aws_array_list *array, TypeConvertor< RawType, TargetType > conv)
Definition: Types.h:79
+
std::list< T, StlAllocator< T > > List
Definition: Types.h:54
+
AWS_CRT_CPP_API ByteBuf ByteBufFromEmptyArray(const uint8_t *array, size_t len) noexcept
Definition: Types.cpp:18
+
std::function< TargetType(RawType)> TypeConvertor
Definition: Types.h:72
+
std::basic_string< char, std::char_traits< char >, StlAllocator< char > > String
Definition: Types.h:45
+
AWS_CRT_CPP_API String Base64Encode(const Vector< uint8_t > &encode) noexcept
Definition: Types.cpp:95
+
AWS_CRT_CPP_API StringView ByteCursorToStringView(const ByteCursor &bc)
Definition: Types.h:126
+
string_view StringView
Definition: StringView.h:846
+
AWS_CRT_CPP_API ByteCursor ByteCursorFromString(const Crt::String &str) noexcept
Definition: Types.cpp:53
+
AWS_CRT_CPP_API ByteBuf ByteBufInit(Allocator *alloc, size_t len)
Definition: Types.cpp:36
+
aws_byte_buf ByteBuf
Definition: Types.h:30
+
std::unique_ptr< T, std::function< void(T *)> > ScopedResource
Definition: Types.h:163
+
AWS_CRT_CPP_API ByteBuf ByteBufFromCString(const char *str) noexcept
Definition: Types.cpp:13
+
AWS_CRT_CPP_API Vector< uint8_t > Base64Decode(const String &decode) noexcept
Definition: Types.cpp:73
+
std::vector< T, StlAllocator< T > > Vector
Definition: Types.h:53
+
std::shared_ptr< T > MakeShared(Allocator *allocator, Args &&...args)
Definition: Types.h:153
+
AWS_CRT_CPP_API void ByteBufDelete(ByteBuf &)
Definition: Types.cpp:43
+
AWS_CRT_CPP_API ByteCursor ByteCursorFromByteBuf(const ByteBuf &) noexcept
Definition: Types.cpp:63
+
T * New(Allocator *allocator, Args &&...args)
Definition: Types.h:145
+
AWS_CRT_CPP_API ByteBuf ByteBufFromArray(const uint8_t *array, size_t capacity) noexcept
Definition: Types.cpp:23
+
std::multimap< K, V, std::less< K >, StlAllocator< std::pair< const K, V > >> MultiMap
Definition: Types.h:52
+
Definition: Allocator.h:11
+
+
+
+
+
diff --git a/docs/_u_u_i_d_8cpp.html b/docs/_u_u_i_d_8cpp.html
new file mode 100644
index 000000000..d9626bf36
--- /dev/null
+++ b/docs/_u_u_i_d_8cpp.html
@@ -0,0 +1,90 @@
+
+
+
+
+
+
+
+aws-crt-cpp: source/UUID.cpp File Reference
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ aws-crt-cpp
+
+ C++ wrapper around the aws-c-* libraries. Provides Cross-Platform Transport Protocols and SSL/TLS implementations for C++.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/docs/_u_u_i_d_8h.html b/docs/_u_u_i_d_8h.html
new file mode 100644
index 000000000..09bb7d7fa
--- /dev/null
+++ b/docs/_u_u_i_d_8h.html
@@ -0,0 +1,100 @@
+
+
+
+
+
+
+
+aws-crt-cpp: include/aws/crt/UUID.h File Reference
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ aws-crt-cpp
+
+ C++ wrapper around the aws-c-* libraries. Provides Cross-Platform Transport Protocols and SSL/TLS implementations for C++.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/docs/_u_u_i_d_8h_source.html b/docs/_u_u_i_d_8h_source.html
new file mode 100644
index 000000000..fad843704
--- /dev/null
+++ b/docs/_u_u_i_d_8h_source.html
@@ -0,0 +1,123 @@
+
+
+
+
+
+
+
+aws-crt-cpp: include/aws/crt/UUID.h Source File
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ aws-crt-cpp
+
+ C++ wrapper around the aws-c-* libraries. Provides Cross-Platform Transport Protocols and SSL/TLS implementations for C++.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
Go to the documentation of this file.
+
+
+
+
9 #include <aws/common/uuid.h>
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
29 operator ByteBuf ()
const noexcept;
+
+
31 inline operator bool() const noexcept {
return m_good; }
+
+
33 int GetLastError() const noexcept;
+
+
+
+
+
+
+
+
+
+
#define AWS_CRT_CPP_API
Definition: Exports.h:37
+
+
+
+
std::basic_string< char, std::char_traits< char >, StlAllocator< char > > String
Definition: Types.h:45
+
aws_byte_buf ByteBuf
Definition: Types.h:30
+
bool operator==(const basic_string_view< CharT, Traits > &lhs, const basic_string_view< CharT, Traits > &rhs) noexcept
Definition: StringView.h:666
+
bool operator!=(const basic_string_view< CharT, Traits > &lhs, const basic_string_view< CharT, Traits > &rhs) noexcept
Definition: StringView.h:691
+
Definition: Allocator.h:11
+
+
+
+
+
diff --git a/docs/_uri_8cpp.html b/docs/_uri_8cpp.html
new file mode 100644
index 000000000..ca69eb892
--- /dev/null
+++ b/docs/_uri_8cpp.html
@@ -0,0 +1,98 @@
+
+
+
+
+
+
+
+aws-crt-cpp: source/io/Uri.cpp File Reference
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ aws-crt-cpp
+
+ C++ wrapper around the aws-c-* libraries. Provides Cross-Platform Transport Protocols and SSL/TLS implementations for C++.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/docs/_uri_8h.html b/docs/_uri_8h.html
new file mode 100644
index 000000000..d8e56daa3
--- /dev/null
+++ b/docs/_uri_8h.html
@@ -0,0 +1,107 @@
+
+
+
+
+
+
+
+aws-crt-cpp: include/aws/crt/io/Uri.h File Reference
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ aws-crt-cpp
+
+ C++ wrapper around the aws-c-* libraries. Provides Cross-Platform Transport Protocols and SSL/TLS implementations for C++.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/docs/_uri_8h_source.html b/docs/_uri_8h_source.html
new file mode 100644
index 000000000..cb429f1dc
--- /dev/null
+++ b/docs/_uri_8h_source.html
@@ -0,0 +1,146 @@
+
+
+
+
+
+
+
+aws-crt-cpp: include/aws/crt/io/Uri.h Source File
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ aws-crt-cpp
+
+ C++ wrapper around the aws-c-* libraries. Provides Cross-Platform Transport Protocols and SSL/TLS implementations for C++.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
Go to the documentation of this file.
+
+
+
8 #include <aws/io/uri.h>
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
38 Uri &operator=(
const Uri &);
+
+
40 Uri &operator=(
Uri &&) noexcept;
+
+
45 operator bool() const noexcept {
return m_isInit; }
+
+
50 int LastError () const noexcept {
return m_lastError; }
+
+
+
+
+
+
+
+
+
+
+
+
83 uint32_t GetPort() const noexcept;
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
#define AWS_CRT_CPP_API
Definition: Exports.h:37
+
+
+
int LastError() const noexcept
Definition: Uri.h:50
+
AWS_CRT_CPP_API Aws::Crt::String EncodeQueryParameterValue(ByteCursor paramValue)
Definition: Uri.cpp:171
+
aws_byte_cursor ByteCursor
Definition: Types.h:31
+
aws_allocator Allocator
Definition: Allocator.h:14
+
AWS_CRT_CPP_API Allocator * ApiAllocator() noexcept
Definition: Allocator.cpp:24
+
std::basic_string< char, std::char_traits< char >, StlAllocator< char > > String
Definition: Types.h:45
+
Definition: Allocator.h:11
+
+
+
+
+
diff --git a/docs/_utility_8h.html b/docs/_utility_8h.html
new file mode 100644
index 000000000..c41d4d988
--- /dev/null
+++ b/docs/_utility_8h.html
@@ -0,0 +1,105 @@
+
+
+
+
+
+
+
+aws-crt-cpp: include/aws/crt/Utility.h File Reference
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ aws-crt-cpp
+
+ C++ wrapper around the aws-c-* libraries. Provides Cross-Platform Transport Protocols and SSL/TLS implementations for C++.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/docs/_utility_8h_source.html b/docs/_utility_8h_source.html
new file mode 100644
index 000000000..abcb28562
--- /dev/null
+++ b/docs/_utility_8h_source.html
@@ -0,0 +1,106 @@
+
+
+
+
+
+
+
+aws-crt-cpp: include/aws/crt/Utility.h Source File
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ aws-crt-cpp
+
+ C++ wrapper around the aws-c-* libraries. Provides Cross-Platform Transport Protocols and SSL/TLS implementations for C++.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
Go to the documentation of this file.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
26 #if defined(__cplusplus) && __cplusplus > 201103L
+
+
+
+
+
+
static constexpr InPlaceT InPlace
Definition: Utility.h:18
+
Definition: Allocator.h:11
+
+
+
+
+
+
+
+
+
diff --git a/docs/_variant_8h.html b/docs/_variant_8h.html
new file mode 100644
index 000000000..b2f71ab6d
--- /dev/null
+++ b/docs/_variant_8h.html
@@ -0,0 +1,156 @@
+
+
+
+
+
+
+
+aws-crt-cpp: include/aws/crt/Variant.h File Reference
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ 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 <aws/crt/Utility.h >
+
#include <algorithm>
+
#include <type_traits>
+
#include <utility>
+
+
Go to the source code of this file.
+
+
+template<typename T >
+constexpr const T & Aws::Crt::VariantDetail::ConstExprMax (const T &a, const T &b)
+
+template<typename Last >
+constexpr std::size_t Aws::Crt::VariantDetail::ParameterPackSize::GetMaxSizeOf (std::size_t curMax=0)
+
+template<typename First , typename Second , typename... Rest>
+constexpr std::size_t Aws::Crt::VariantDetail::ParameterPackSize::GetMaxSizeOf (std::size_t curMax=0)
+
+template<typename Last >
+constexpr std::size_t Aws::Crt::VariantDetail::ParameterPackSize::AlignAsPack (std::size_t curMax=0)
+
+template<typename First , typename Second , typename... Rest>
+constexpr std::size_t Aws::Crt::VariantDetail::ParameterPackSize::AlignAsPack (std::size_t curMax=0)
+
+template<typename T , typename Last >
+constexpr VariantIndex Aws::Crt::VariantDetail::Index::GetIndexOf (VariantIndex curIndex=0)
+
+template<typename T , typename First , typename Second , typename... Rest>
+constexpr VariantIndex Aws::Crt::VariantDetail::Index::GetIndexOf (VariantIndex curIndex=0)
+
+template<typename T , typename Last >
+constexpr bool Aws::Crt::VariantDetail::Checker::ContainsType ()
+
+template<typename T , typename First , typename Second , typename... Rest>
+constexpr bool Aws::Crt::VariantDetail::Checker::ContainsType ()
+
+template<typename T >
+constexpr bool Aws::Crt::VariantDetail::Checker::ContainsType ()
+
+
+
+
+
+
+
diff --git a/docs/_variant_8h_source.html b/docs/_variant_8h_source.html
new file mode 100644
index 000000000..07e9b1d4c
--- /dev/null
+++ b/docs/_variant_8h_source.html
@@ -0,0 +1,704 @@
+
+
+
+
+
+
+
+aws-crt-cpp: include/aws/crt/Variant.h Source File
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ aws-crt-cpp
+
+ C++ wrapper around the aws-c-* libraries. Provides Cross-Platform Transport Protocols and SSL/TLS implementations for C++.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
Go to the documentation of this file.
+
7 #include <aws/common/assert.h>
+
+
+
+
11 #include <type_traits>
+
+
+
+
+
+
+
18 namespace VariantDetail
+
+
20 template <
typename T> constexpr
const T &
ConstExprMax (
const T &a,
const T &b)
+
+
22 return (a < b) ? b : a;
+
+
+
25 namespace ParameterPackSize
+
+
+
28 template <
typename Last> constexpr std::size_t
GetMaxSizeOf (std::size_t curMax = 0)
+
+
+
+
+
33 template <
typename First,
typename Second,
typename ... Rest>
+
+
+
+
+
+
+
40 template <
typename Last> constexpr std::size_t
AlignAsPack (std::size_t curMax = 0)
+
+
+
+
+
45 template <
typename First,
typename Second,
typename ... Rest>
+
+
+
+
+
+
+
+
+
+
+
+
+
58 return std::is_same<T, Last>::value ? curIndex : -1;
+
+
+
61 template <
typename T,
typename First,
typename Second,
typename ... Rest>
+
+
+
64 return std::is_same<T, First>::value ? curIndex :
GetIndexOf <T, Second, Rest...>(++curIndex);
+
+
+
+
+
+
+
+
+
+
74 return std::is_same<T, Last>::value;
+
+
+
77 template <
typename T,
typename First,
typename Second,
typename ... Rest> constexpr
bool ContainsType ()
+
+
79 return std::is_same<T, First>::value ||
ContainsType <T, Second, Rest...>();
+
+
+
+
+
+
+
+
+
88 template <
typename T,
typename ... Ts>
struct HasType
+
+
+
+
+
93 #if defined(AWS_CRT_ENABLE_VARIANT_DEBUG)
+
94 namespace VariantDebug
+
+
96 template <
typename ... Ts>
class VariantDebugBrowser
+
+
+
99 VariantDebugBrowser(
char *storage) { InitTuple<0, Ts...>(storage); }
+
100 std::tuple<typename std::add_pointer<Ts>::type...> as_tuple;
+
+
+
103 template <IndexT Index,
typename First,
typename Second,
typename ... Rest>
+
104 void InitTuple(
char *storage)
+
+
106 First *value =
reinterpret_cast< First *
> (storage);
+
107 std::get<Index>(as_tuple) = value;
+
108 InitTuple<Index + 1, Second, Rest...>(storage);
+
+
+
111 template <IndexT Index,
typename Last>
void InitTuple(
char *storage)
+
+
113 Last *value =
reinterpret_cast< Last *
> (storage);
+
114 std::get<Index>(as_tuple) = value;
+
+
+
+
+
+
+
121 template <std::size_t Index,
typename ... Ts>
class VariantAlternative;
+
+
+
+
+
+
+
132 template <
typename OtherT>
+
133 using EnableIfOtherIsThisVariantAlternative =
typename std::
+
134 enable_if<VariantDetail::Checker::HasType<typename std::decay<OtherT>::type, Ts...>::value,
int >::type;
+
+
+
+
+
+
+
+
+
143 new (m_storage) FirstAlternative();
+
+
+
+
+
+
149 AWS_FATAL_ASSERT(other.m_index != -1);
+
150 m_index = other.m_index;
+
151 VisitorUtil<0, Ts...>::VisitBinary(
this , other, CopyMoveConstructor());
+
+
+
+
+
156 AWS_FATAL_ASSERT(other.m_index != -1);
+
157 m_index = other.m_index;
+
158 VisitorUtil<0, Ts...>::VisitBinary(
this , std::move(other), CopyMoveConstructor());
+
+
+
161 template <
typename T, EnableIfOtherIsThisVariantAlternative<T> = 1>
Variant (
const T &val)
+
+
+
+
165 "This variant does not have such alternative T." );
+
+
167 sizeof (T) <= STORAGE_SIZE,
+
168 "Attempting to instantiate a Variant with a type bigger than all alternatives." );
+
+
170 using PlainT =
typename std::decay<T>::type;
+
171 new (m_storage) PlainT(val);
+
+
173 AWS_ASSERT(m_index != -1);
+
+
+
176 template <
typename T, EnableIfOtherIsThisVariantAlternative<T> = 1>
Variant (T &&val)
+
+
+
+
180 "This variant does not have such alternative T." );
+
+
182 sizeof (T) <= STORAGE_SIZE,
+
183 "Attempting to instantiate a Variant with a type bigger than all alternatives." );
+
+
185 using PlainT =
typename std::decay<T>::type;
+
186 new (m_storage) PlainT(std::forward<T>(val));
+
+
188 AWS_ASSERT(m_index != -1);
+
+
+
+
+
+
+
+
196 "This variant does not have such alternative T." );
+
+
198 sizeof (T) <= STORAGE_SIZE,
+
199 "Attempting to instantiate a Variant with a type bigger than all alternatives." );
+
+
201 using PlainT =
typename std::decay<T>::type;
+
202 new (m_storage) PlainT(std::forward<Args>(args)...);
+
+
204 AWS_ASSERT(m_index != -1);
+
+
+
+
+
+
+
211 AWS_FATAL_ASSERT(other.m_index != -1);
+
212 if (m_index != other.m_index)
+
+
+
215 m_index = other.m_index;
+
216 VisitorUtil<0, Ts...>::VisitBinary(
this , other, CopyMoveConstructor());
+
+
+
+
220 VisitorUtil<0, Ts...>::VisitBinary(
this , other, CopyMoveAssigner());
+
+
+
+
+
+
+
+
+
+
230 AWS_FATAL_ASSERT(other.m_index != -1);
+
231 if (m_index != other.m_index)
+
+
+
234 m_index = other.m_index;
+
235 VisitorUtil<0, Ts...>::VisitBinary(
this , std::move(other), CopyMoveConstructor());
+
+
+
+
239 VisitorUtil<0, Ts...>::VisitBinary(
this , std::move(other), CopyMoveAssigner());
+
+
+
+
+
+
+
246 template <
typename T,
typename ... Args, EnableIfOtherIsThisVariantAlternative<T> = 1>
+
+
+
+
+
251 "This variant does not have such alternative T." );
+
+
253 sizeof (T) <= STORAGE_SIZE,
+
254 "Attempting to instantiate a Variant with a type bigger than all alternatives." );
+
+
+
+
258 using PlainT =
typename std::decay<T>::type;
+
259 new (m_storage) PlainT(std::forward<Args>(args)...);
+
+
261 AWS_ASSERT(m_index != -1);
+
+
263 T *value =
reinterpret_cast< T *
> (m_storage);
+
+
+
+
267 template <std::size_t Index,
typename ... Args>
+
+
+
270 static_assert(Index <
AlternativeCount ,
"Unknown alternative index to emplace" );
+
+
+
273 return emplace <AlternativeT, Args...>(std::forward<Args>(args)...);
+
+
+
276 template <
typename T, EnableIfOtherIsThisVariantAlternative<T> = 1>
bool holds_alternative ()
const
+
+
278 AWS_ASSERT(m_index != -1);
+
+
+
+
+
283 template <
typename T, EnableIfOtherIsThisVariantAlternative<T> = 1> T &
get ()
+
+
285 AWS_FATAL_ASSERT(holds_alternative<T>());
+
286 T *value =
reinterpret_cast< T *
> (m_storage);
+
+
+
+
290 template <
typename T, EnableIfOtherIsThisVariantAlternative<T> = 1> T *
get_if ()
+
+
292 if (holds_alternative<T>())
+
+
294 T *value =
reinterpret_cast< T *
> (m_storage);
+
+
+
+
+
+
+
+
+
+
+
305 static_assert(Index <
AlternativeCount ,
"Unknown alternative index to get" );
+
306 AWS_FATAL_ASSERT(holds_alternative<Index>());
+
+
308 AlternativeT *ret =
reinterpret_cast< AlternativeT *
> (m_storage);
+
+
+
+
+
313 template <
typename T, EnableIfOtherIsThisVariantAlternative<T> = 1>
const T &
get ()
const
+
+
315 AWS_FATAL_ASSERT(holds_alternative<T>());
+
316 const T *value =
reinterpret_cast< const T *
> (m_storage);
+
+
+
+
320 template <
typename T, EnableIfOtherIsThisVariantAlternative<T> = 1>
const T *
get_if ()
const
+
+
322 if (holds_alternative<T>())
+
+
324 T *value =
reinterpret_cast< T *
> (m_storage);
+
+
+
+
+
+
+
+
+
+
+
335 static_assert(Index <
AlternativeCount ,
"Unknown alternative index to get" );
+
336 AWS_ASSERT(Index == m_index);
+
+
338 const AlternativeT *ret =
reinterpret_cast< const AlternativeT *
> (m_storage);
+
+
+
+
+
+
+
345 template <std::
size_t Index>
+
+
347 typename std::add_pointer<typename ThisVariantAlternative<Index>::type>::type;
+
+
+
+
351 static_assert(Index <
AlternativeCount ,
"Unknown alternative index to get" );
+
352 if (holds_alternative<Index>())
+
+
+
355 AlternativePtrT value =
reinterpret_cast< AlternativePtrT
> (m_storage);
+
+
+
+
+
+
+
+
+
364 template <std::
size_t Index>
+
+
366 typename std::add_const<typename ThisVariantAlternative<Index>::type>::type>::type;
+
+
+
+
370 static_assert(Index <
AlternativeCount ,
"Unknown alternative index to get" );
+
371 if (holds_alternative<Index>())
+
+
+
374 AlternativePtrT value =
reinterpret_cast< AlternativePtrT
> (m_storage);
+
+
+
+
+
+
+
+
+
383 std::size_t
index ()
const {
return m_index; }
+
+
+
+
387 template <
typename VisitorT>
void Visit (VisitorT &&visitor)
+
+
389 return VisitorUtil<0, Ts...>::Visit(
this , std::forward<VisitorT>(visitor));
+
+
+
+
+
+
+
+
397 #if defined(AWS_CRT_ENABLE_VARIANT_DEBUG)
+
398 VariantDetail::VariantDebug::VariantDebugBrowser<Ts...> browser = m_storage;
+
+
+
401 template <
size_t Index> constexpr
bool holds_alternative ()
const {
return Index == m_index; }
+
+
+
+
405 template <
typename AlternativeT>
void operator()(AlternativeT &&value)
const
+
+
407 using PlaintT =
typename std::remove_reference<AlternativeT>::type;
+
+
+
+
+
+
+
414 AWS_FATAL_ASSERT(m_index != -1);
+
+
+
+
+
+
420 struct CopyMoveConstructor
+
+
422 template <
typename AlternativeT>
void operator()(AlternativeT &&value, AlternativeT &&other)
const
+
+
424 using PlaintT =
typename std::remove_reference<AlternativeT>::type;
+
425 new (&value) PlaintT(std::move<AlternativeT>(other));
+
+
+
428 template <
typename AlternativeT,
typename ConstAlternativeT>
+
429 void operator()(AlternativeT &&value, ConstAlternativeT &other)
const
+
+
431 using PlaintT =
typename std::remove_reference<AlternativeT>::type;
+
+
433 typename std::remove_const<typename std::remove_reference<AlternativeT>::type>::type;
+
434 static_assert(std::is_same<PlaintT, PlaintOtherT>::value,
"Incompatible types" );
+
+
436 new (&value) PlaintT(other);
+
+
+
+
440 struct CopyMoveAssigner
+
+
442 template <
typename AlternativeT>
void operator()(AlternativeT &&value, AlternativeT &&other)
const
+
+
444 value = std::move(other);
+
+
+
447 template <
typename AlternativeT,
typename ConstAlternativeT>
+
448 void operator()(AlternativeT &&value, ConstAlternativeT &other)
const
+
+
450 using PlaintT =
typename std::remove_reference<AlternativeT>::type;
+
+
452 typename std::remove_const<typename std::remove_reference<AlternativeT>::type>::type;
+
453 static_assert(std::is_same<PlaintT, PlaintOtherT>::value,
"Incompatible types" );
+
+
+
+
+
+
459 template <
IndexT Index,
typename ... Args>
struct VisitorUtil;
+
+
461 template <
IndexT Index,
typename First,
typename Second,
typename ... Rest>
+
462 struct VisitorUtil<Index, First, Second, Rest...>
+
+
464 template <
typename VisitorStruct>
static void Visit (
Variant *pThis, VisitorStruct &&visitor)
+
+
466 static_assert(Index <
AlternativeCount ,
"Attempting to visit unknown Index Type" );
+
+
468 if (Index == pThis->m_index)
+
+
+
471 AlternativeT *value =
reinterpret_cast< AlternativeT *
> (pThis->m_storage);
+
+
+
+
+
476 VisitorUtil<static_cast<IndexT>(Index + 1), Second, Rest...>
::Visit (
+
477 pThis, std::forward<VisitorStruct>(visitor));
+
+
+
+
481 template <
typename VisitorStruct>
+
482 static void VisitBinary(Variant<Ts...> *pThis, Variant<Ts...> &&other, VisitorStruct &&visitor)
+
+
484 static_assert(Index <
AlternativeCount ,
"Attempting to visit unknown Index Type" );
+
+
486 if (Index == pThis->m_index)
+
+
+
489 AlternativeT *value =
reinterpret_cast< AlternativeT *
> (pThis->m_storage);
+
490 visitor(*value, other.get<AlternativeT>());
+
+
+
+
494 VisitorUtil<static_cast<IndexT>(Index + 1), Second, Rest...>::VisitBinary(
+
495 pThis, std::forward<Variant<Ts...>>(other), std::forward<VisitorStruct>(visitor));
+
+
+
+
499 template <
typename VisitorStruct>
+
500 static void VisitBinary(Variant<Ts...> *pThis,
const Variant<Ts...> &other, VisitorStruct &&visitor)
+
+
502 static_assert(Index <
AlternativeCount ,
"Attempting to visit unknown Index Type" );
+
+
504 if (Index == pThis->m_index)
+
+
+
507 AlternativeT *value =
reinterpret_cast< AlternativeT *
> (pThis->m_storage);
+
508 const AlternativeT &otherValue = other.get<AlternativeT>();
+
509 visitor(*value, otherValue);
+
+
+
+
513 VisitorUtil<static_cast<IndexT>(Index + 1), Second, Rest...>::VisitBinary(
+
514 pThis, other, std::forward<VisitorStruct>(visitor));
+
+
+
+
+
519 template <IndexT Index,
typename Last>
struct VisitorUtil<Index, Last>
+
+
521 template <
typename VisitorStruct>
static void Visit (
Variant *pThis, VisitorStruct &&visitor)
+
+
523 static_assert(Index <
AlternativeCount ,
"Attempting to visit unknown Index Type" );
+
+
525 if (Index == pThis->m_index)
+
+
+
528 AlternativeT *value =
reinterpret_cast< AlternativeT *
> (pThis->m_storage);
+
+
+
+
+
533 AWS_FATAL_ASSERT(!
"Unknown variant alternative to visit!" );
+
+
+
+
537 template <
typename VisitorStruct>
+
538 static void VisitBinary(Variant<Ts...> *pThis, Variant<Ts...> &&other, VisitorStruct &&visitor)
+
+
540 static_assert(Index <
AlternativeCount ,
"Attempting to visit unknown Index Type" );
+
+
542 if (Index == pThis->m_index)
+
+
+
545 AlternativeT *value =
reinterpret_cast< AlternativeT *
> (pThis->m_storage);
+
546 visitor(*value, other.get<AlternativeT>());
+
+
+
+
550 AWS_FATAL_ASSERT(!
"Unknown variant alternative to visit!" );
+
+
+
+
554 template <
typename VisitorStruct>
+
555 static void VisitBinary(Variant<Ts...> *pThis,
const Variant<Ts...> &other, VisitorStruct &&visitor)
+
+
557 static_assert(Index <
AlternativeCount ,
"Attempting to visit unknown Index Type" );
+
+
559 if (Index == pThis->m_index)
+
+
+
562 AlternativeT *value =
reinterpret_cast< AlternativeT *
> (pThis->m_storage);
+
563 const AlternativeT &otherValue = other.get<AlternativeT>();
+
564 visitor(*value, otherValue);
+
+
+
+
568 AWS_FATAL_ASSERT(!
"Unknown variant alternative to visit!" );
+
+
+
+
+
+
+
+
+
+
+
579 using type =
typename std::tuple_element<Index, std::tuple<Ts...>>
::type ;
+
+
+
+
+
+
+
+
+
588 constexpr
static const std::size_t Value = T::AlternativeCount;
+
+
+
+
+
Definition: Variant.h:576
+
VariantAlternative(const Variant< Ts... > &)
Definition: Variant.h:581
+
typename std::tuple_element< Index, std::tuple< Ts... > >::type type
Definition: Variant.h:579
+
VariantAlternative(const Variant< Ts... > *)
Definition: Variant.h:583
+
Definition: Variant.h:128
+
const T * get_if() const
Definition: Variant.h:320
+
const T & get() const
Definition: Variant.h:313
+
Variant(Aws::Crt::InPlaceTypeT< T >, Args &&...args)
Definition: Variant.h:192
+
~Variant()
Definition: Variant.h:385
+
void Visit(VisitorT &&visitor)
Definition: Variant.h:387
+
auto get() const -> const typename ThisVariantAlternative< Index >::type &
Definition: Variant.h:333
+
T & emplace(Args &&...args)
Definition: Variant.h:247
+
T * get_if()
Definition: Variant.h:290
+
auto emplace(Args &&...args) -> typename ThisVariantAlternative< Index >::type &
Definition: Variant.h:268
+
auto get_if() const -> ConstRawAlternativePointerT< Index >
Definition: Variant.h:368
+
auto get() -> typename ThisVariantAlternative< Index >::type &
Definition: Variant.h:303
+
Variant & operator=(Variant &&other)
Definition: Variant.h:226
+
typename std::add_pointer< typename ThisVariantAlternative< Index >::type >::type RawAlternativePointerT
Definition: Variant.h:347
+
Variant & operator=(const Variant &other)
Definition: Variant.h:207
+
Variant(Variant &&other)
Definition: Variant.h:154
+
Variant(const Variant &other)
Definition: Variant.h:147
+
Variant(const T &val)
Definition: Variant.h:161
+
std::size_t index() const
Definition: Variant.h:383
+
auto get_if() -> RawAlternativePointerT< Index >
Definition: Variant.h:349
+
static constexpr std::size_t AlternativeCount
Definition: Variant.h:138
+
typename std::add_pointer< typename std::add_const< typename ThisVariantAlternative< Index >::type >::type >::type ConstRawAlternativePointerT
Definition: Variant.h:366
+
T & get()
Definition: Variant.h:283
+
Variant(T &&val)
Definition: Variant.h:176
+
bool holds_alternative() const
Definition: Variant.h:276
+
Variant()
Definition: Variant.h:140
+
VariantDetail::Index::VariantIndex IndexT
Definition: Variant.h:137
+
Definition: Variant.h:587
+
constexpr bool ContainsType()
Definition: Variant.h:72
+
constexpr VariantIndex GetIndexOf(VariantIndex curIndex=0)
Definition: Variant.h:56
+
short VariantIndex
Definition: Variant.h:54
+
constexpr std::size_t AlignAsPack(std::size_t curMax=0)
Definition: Variant.h:40
+
constexpr std::size_t GetMaxSizeOf(std::size_t curMax=0)
Definition: Variant.h:28
+
constexpr const T & ConstExprMax(const T &a, const T &b)
Definition: Variant.h:20
+
Definition: Allocator.h:11
+
+
+
static const bool value
Definition: Variant.h:90
+
+
+
+
+
diff --git a/docs/annotated.html b/docs/annotated.html
new file mode 100644
index 000000000..efa0f6e82
--- /dev/null
+++ b/docs/annotated.html
@@ -0,0 +1,227 @@
+
+
+
+
+
+
+
+aws-crt-cpp: Class List
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ aws-crt-cpp
+
+ C++ wrapper around the aws-c-* libraries. Provides Cross-Platform Transport Protocols and SSL/TLS implementations for C++.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
Here are the classes, structs, unions and interfaces with brief descriptions:
+
+
+
+
+
diff --git a/docs/bc_s.png b/docs/bc_s.png
new file mode 100644
index 000000000..224b29aa9
Binary files /dev/null and b/docs/bc_s.png differ
diff --git a/docs/bdwn.png b/docs/bdwn.png
new file mode 100644
index 000000000..940a0b950
Binary files /dev/null and b/docs/bdwn.png differ
diff --git a/docs/class_aws_1_1_crt_1_1_api_handle-members.html b/docs/class_aws_1_1_crt_1_1_api_handle-members.html
new file mode 100644
index 000000000..3caa8be05
--- /dev/null
+++ b/docs/class_aws_1_1_crt_1_1_api_handle-members.html
@@ -0,0 +1,102 @@
+
+
+
+
+
+
+
+aws-crt-cpp: Member List
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ 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.
+
+
+
+
+
diff --git a/docs/class_aws_1_1_crt_1_1_api_handle.html b/docs/class_aws_1_1_crt_1_1_api_handle.html
new file mode 100644
index 000000000..298fab4c2
--- /dev/null
+++ b/docs/class_aws_1_1_crt_1_1_api_handle.html
@@ -0,0 +1,658 @@
+
+
+
+
+
+
+
+aws-crt-cpp: Aws::Crt::ApiHandle Class Reference
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ aws-crt-cpp
+
+ C++ wrapper around the aws-c-* libraries. Provides Cross-Platform Transport Protocols and SSL/TLS implementations for C++.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
#include <Api.h >
+
+
+
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.
+
+
+
◆ ApiHandle() [1/4]
+
+
+
+
+
+
+
+
+ Aws::Crt::ApiHandle::ApiHandle
+ (
+ Allocator *
+ allocator )
+
+
+
+
+
+noexcept
+
+
+
+
Customize the ApiAllocator() , which is be used by any objects constructed without an explicit allocator.
+
+
+
+
+
◆ ApiHandle() [2/4]
+
+
+
+
+
+
+
+
+ Aws::Crt::ApiHandle::ApiHandle
+ (
+ )
+
+
+
+
+
+noexcept
+
+
+
+
+
+
+
+
◆ ~ApiHandle()
+
+
+
+
+
+ Aws::Crt::ApiHandle::~ApiHandle
+ (
+ )
+
+
+
+
+
+
+
+
+
◆ ApiHandle() [3/4]
+
+
+
+
+
+
+
+
+ Aws::Crt::ApiHandle::ApiHandle
+ (
+ const ApiHandle &
+ )
+
+
+
+
+
+delete
+
+
+
+
+
+
+
+
◆ ApiHandle() [4/4]
+
+
+
+
+
+
+
+
+ Aws::Crt::ApiHandle::ApiHandle
+ (
+ ApiHandle &&
+ )
+
+
+
+
+
+delete
+
+
+
+
+
+
+
+
+
◆ GetCrtVersion()
+
+
+
+
Gets the version of the AWS-CRT-CPP library
Returns Version representing the library version
+
+
+
+
+
◆ GetOrCreateStaticDefaultClientBootstrap()
+
+
+
+
+
+
+
+
+ Io::ClientBootstrap * Aws::Crt::ApiHandle::GetOrCreateStaticDefaultClientBootstrap
+ (
+ )
+
+
+
+
+
+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.
+
Returns ClientBootstrap* A pointer to the static default ClientBootstrap
+
+
+
+
+
◆ GetOrCreateStaticDefaultEventLoopGroup()
+
+
+
+
+
+
+
+
+ Io::EventLoopGroup * Aws::Crt::ApiHandle::GetOrCreateStaticDefaultEventLoopGroup
+ (
+ )
+
+
+
+
+
+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.
+
Returns EventLoopGroup* A pointer to the static default EventLoopGroup
+
+
+
+
+
◆ GetOrCreateStaticDefaultHostResolver()
+
+
+
+
+
+
+
+
+ Io::HostResolver * Aws::Crt::ApiHandle::GetOrCreateStaticDefaultHostResolver
+ (
+ )
+
+
+
+
+
+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.
+
Returns HostResolver* A pointer to the static default HostResolver
+
+
+
+
+
◆ InitializeLogging() [1/2]
+
+
+
+
+
+ void Aws::Crt::ApiHandle::InitializeLogging
+ (
+ LogLevel
+ level ,
+
+
+
+
+ const char *
+ filename
+
+
+
+ )
+
+
+
+
+
Initialize logging in awscrt.
Parameters
+
+ level Display messages of this importance and higher. LogLevel.NoLogs will disable logging.
+ filename Logging destination, a file path from the disk.
+
+
+
+
+
+
+
+
◆ InitializeLogging() [2/2]
+
+
+
+
+
+ void Aws::Crt::ApiHandle::InitializeLogging
+ (
+ LogLevel
+ level ,
+
+
+
+
+ FILE *
+ fp
+
+
+
+ )
+
+
+
+
+
Initialize logging in awscrt.
Parameters
+
+ level Display messages of this importance and higher. LogLevel.NoLogs will disable logging.
+ fp The FILE object for logging destination.
+
+
+
+
+
+
+
+
◆ operator=() [1/2]
+
+
+
+
◆ operator=() [2/2]
+
+
+
+
◆ SetBYOCryptoClientTlsCallback()
+
+
+
+
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.
+
+
+
+
+
◆ SetBYOCryptoNewMD5Callback()
+
+
+
+
BYO_CRYPTO: set callback for creating MD5 hashes. If using BYO_CRYPTO, you must call this.
+
+
+
+
+
◆ SetBYOCryptoNewSHA1Callback()
+
+
+
+
BYO_CRYPTO: set callback for creating SHA1 hashes. If using BYO_CRYPTO, you must call this.
+
+
+
+
+
◆ SetBYOCryptoNewSHA256Callback()
+
+
+
+
BYO_CRYPTO: set callback for creating SHA256 hashes. If using BYO_CRYPTO, you must call this.
+
+
+
+
+
◆ SetBYOCryptoNewSHA256HMACCallback()
+
+
+
+
BYO_CRYPTO: set callback for creating Streaming SHA256 HMAC objects. If using BYO_CRYPTO, you must call this.
+
+
+
+
+
◆ SetBYOCryptoTlsContextCallbacks()
+
+
+
+
BYO_CRYPTO: set callbacks for the TlsContext. If using BYO_CRYPTO, you need to call this function prior to creating a TlsContext.
+
Parameters
+
+ 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.
+
+
+
+
+
+
+
+
◆ SetShutdownBehavior()
+
+
+
+
Configures the shutdown behavior of the api handle instance
Parameters
+
+ behavior desired shutdown behavior
+
+
+
+
+
+
+
The documentation for this class was generated from the following files:
+
+
+
+
+
diff --git a/docs/class_aws_1_1_crt_1_1_auth_1_1_aws_signing_config-members.html b/docs/class_aws_1_1_crt_1_1_auth_1_1_aws_signing_config-members.html
new file mode 100644
index 000000000..81a616817
--- /dev/null
+++ b/docs/class_aws_1_1_crt_1_1_auth_1_1_aws_signing_config-members.html
@@ -0,0 +1,121 @@
+
+
+
+
+
+
+
+aws-crt-cpp: Member List
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ 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.
+
+
+
+
+
diff --git a/docs/class_aws_1_1_crt_1_1_auth_1_1_aws_signing_config.html b/docs/class_aws_1_1_crt_1_1_auth_1_1_aws_signing_config.html
new file mode 100644
index 000000000..fb32f053a
--- /dev/null
+++ b/docs/class_aws_1_1_crt_1_1_auth_1_1_aws_signing_config.html
@@ -0,0 +1,1050 @@
+
+
+
+
+
+
+
+aws-crt-cpp: Aws::Crt::Auth::AwsSigningConfig Class Reference
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ aws-crt-cpp
+
+ C++ wrapper around the aws-c-* libraries. Provides Cross-Platform Transport Protocols and SSL/TLS implementations for C++.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
#include <Sigv4Signing.h >
+
+
+
+
+
+
+
+
+
+
+
Wrapper around the configuration structure specific to the AWS Sigv4 signing process
+
+
+
◆ AwsSigningConfig()
+
+
+
+
+
+ Aws::Crt::Auth::AwsSigningConfig::AwsSigningConfig
+ (
+ Allocator *
+ allocator = ApiAllocator ()
)
+
+
+
+
+
+
+
+
+
◆ ~AwsSigningConfig()
+
+
+
+
+
+
+
+
+ Aws::Crt::Auth::AwsSigningConfig::~AwsSigningConfig
+ (
+ )
+
+
+
+
+
+virtual
+
+
+
+
+
+
+
+
+
◆ GetCredentials()
+
+
+
+
+
+
+
+
+ const std::shared_ptr< Credentials > & Aws::Crt::Auth::AwsSigningConfig::GetCredentials
+ (
+ )
+ const
+
+
+
+
+noexcept
+
+
+
+
Returns the credentials to use for signing.
+
+
+
+
+
◆ GetCredentialsProvider()
+
+
+
+
+
+
+
+
+ const std::shared_ptr< ICredentialsProvider > & Aws::Crt::Auth::AwsSigningConfig::GetCredentialsProvider
+ (
+ )
+ const
+
+
+
+
+noexcept
+
+
+
+
Returns the credentials provider to use for signing.
+
+
+
+
+
◆ GetExpirationInSeconds()
+
+
+
+
+
+
+
+
+ uint64_t Aws::Crt::Auth::AwsSigningConfig::GetExpirationInSeconds
+ (
+ )
+ const
+
+
+
+
+noexcept
+
+
+
+
Returns (Query param signing only) Gets the amount of time, in seconds, the (pre)signed URI will be good for
+
+
+
+
+
◆ GetOmitSessionToken()
+
+
+
+
+
+
+
+
+ bool Aws::Crt::Auth::AwsSigningConfig::GetOmitSessionToken
+ (
+ )
+ const
+
+
+
+
+noexcept
+
+
+
+
Returns whether or not to omit the session token during signing. Only set to true when performing a websocket handshake with IoT Core.
+
+
+
+
+
◆ GetRegion()
+
+
+
+
+
+
+
+
+ const Crt::String & Aws::Crt::Auth::AwsSigningConfig::GetRegion
+ (
+ )
+ const
+
+
+
+
+noexcept
+
+
+
+
Returns the AWS region to sign against
+
+
+
+
+
◆ GetService()
+
+
+
+
+
+
+
+
+ const Crt::String & Aws::Crt::Auth::AwsSigningConfig::GetService
+ (
+ )
+ const
+
+
+
+
+noexcept
+
+
+
+
Returns the (signing) name of the AWS service to sign a request for
+
+
+
+
+
◆ GetShouldNormalizeUriPath()
+
+
+
+
+
+
+
+
+ bool Aws::Crt::Auth::AwsSigningConfig::GetShouldNormalizeUriPath
+ (
+ )
+ const
+
+
+
+
+noexcept
+
+
+
+
Returns whether or not the uri paths should be normalized when building the canonical request
+
+
+
+
+
◆ GetShouldSignHeaderCallback()
+
+
+
+
+
+
+
+
+ ShouldSignHeaderCb Aws::Crt::Auth::AwsSigningConfig::GetShouldSignHeaderCallback
+ (
+ )
+ const
+
+
+
+
+noexcept
+
+
+
+
Returns the ShouldSignHeadersCb from the underlying config.
+
+
+
+
+
◆ GetShouldSignHeaderUserData()
+
+
+
+
+
+
+
+
+ void * Aws::Crt::Auth::AwsSigningConfig::GetShouldSignHeaderUserData
+ (
+ )
+ const
+
+
+
+
+noexcept
+
+
+
+
Returns the should_sign_header_ud from the underlying config.
+
+
+
+
+
◆ GetSignatureType()
+
+
+
+
+
+
+
+
+ SignatureType Aws::Crt::Auth::AwsSigningConfig::GetSignatureType
+ (
+ )
+ const
+
+
+
+
+noexcept
+
+
+
+
Returns the type of signature we want to calculate
+
+
+
+
+
◆ GetSignedBodyHeader()
+
+
+
+
Returns the name of the header to add that stores the signed body value
+
+
+
+
+
◆ GetSignedBodyValue()
+
+
+
+
+
+
+
+
+ const Crt::String & Aws::Crt::Auth::AwsSigningConfig::GetSignedBodyValue
+ (
+ )
+ const
+
+
+
+
+noexcept
+
+
+
+
Returns the string used as the canonical request's body value. If string is empty, a value is be calculated from the payload during signing.
+
+
+
+
+
◆ GetSigningAlgorithm()
+
+
+
+
+
+
+
+
+ SigningAlgorithm Aws::Crt::Auth::AwsSigningConfig::GetSigningAlgorithm
+ (
+ )
+ const
+
+
+
+
+noexcept
+
+
+
+
Returns the signing process we want to invoke
+
+
+
+
+
◆ GetSigningTimepoint()
+
+
+
+
+
+
+
+
+ DateTime Aws::Crt::Auth::AwsSigningConfig::GetSigningTimepoint
+ (
+ )
+ const
+
+
+
+
+noexcept
+
+
+
+
Returns the timestamp to use during the signing process.
+
+
+
+
+
◆ GetType()
+
+
+
+
+
+
+
+
+ virtual SigningConfigType Aws::Crt::Auth::AwsSigningConfig::GetType
+ (
+ )
+ const
+
+
+
+
+inline override virtual noexcept
+
+
+
+
+
+
◆ GetUseDoubleUriEncode()
+
+
+
+
+
+
+
+
+ bool Aws::Crt::Auth::AwsSigningConfig::GetUseDoubleUriEncode
+ (
+ )
+ const
+
+
+
+
+noexcept
+
+
+
+
Returns whether or not the signing process should perform a uri encode step before creating the canonical request.
+
+
+
+
+
◆ SetCredentials()
+
+
+
+
+
+
+
+
+ void Aws::Crt::Auth::AwsSigningConfig::SetCredentials
+ (
+ const std::shared_ptr< Credentials > &
+ credentials )
+
+
+
+
+
+noexcept
+
+
+
+
Set the credentials to use for signing.
+
+
+
+
+
◆ SetCredentialsProvider()
+
+
+
+
+
+
+
+
+ void Aws::Crt::Auth::AwsSigningConfig::SetCredentialsProvider
+ (
+ const std::shared_ptr< ICredentialsProvider > &
+ credsProvider )
+
+
+
+
+
+noexcept
+
+
+
+
Set the credentials provider to use for signing.
+
+
+
+
+
◆ SetExpirationInSeconds()
+
+
+
+
+
+
+
+
+ void Aws::Crt::Auth::AwsSigningConfig::SetExpirationInSeconds
+ (
+ uint64_t
+ expirationInSeconds )
+
+
+
+
+
+noexcept
+
+
+
+
(Query param signing only) Sets the amount of time, in seconds, the (pre)signed URI will be good for
+
+
+
+
+
◆ SetOmitSessionToken()
+
+
+
+
+
+
+
+
+ void Aws::Crt::Auth::AwsSigningConfig::SetOmitSessionToken
+ (
+ bool
+ omitSessionToken )
+
+
+
+
+
+noexcept
+
+
+
+
Sets whether or not to omit the session token during signing. Only set to true when performing a websocket handshake with IoT Core.
+
+
+
+
+
◆ SetRegion()
+
+
+
+
+
+
+
+
+ void Aws::Crt::Auth::AwsSigningConfig::SetRegion
+ (
+ const Crt::String &
+ region )
+
+
+
+
+
+noexcept
+
+
+
+
Sets the AWS region to sign against
+
+
+
+
+
◆ SetService()
+
+
+
+
+
+
+
+
+ void Aws::Crt::Auth::AwsSigningConfig::SetService
+ (
+ const Crt::String &
+ service )
+
+
+
+
+
+noexcept
+
+
+
+
Sets the (signing) name of the AWS service to sign a request for
+
+
+
+
+
◆ SetShouldNormalizeUriPath()
+
+
+
+
+
+
+
+
+ void Aws::Crt::Auth::AwsSigningConfig::SetShouldNormalizeUriPath
+ (
+ bool
+ shouldNormalizeUriPath )
+
+
+
+
+
+noexcept
+
+
+
+
Sets whether or not the uri paths should be normalized when building the canonical request
+
+
+
+
+
◆ SetShouldSignHeaderCallback()
+
+
+
+
+
+
+
+
+ void Aws::Crt::Auth::AwsSigningConfig::SetShouldSignHeaderCallback
+ (
+ ShouldSignHeaderCb
+ shouldSignHeaderCb )
+
+
+
+
+
+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.
+
+
+
+
+
◆ SetShouldSignHeaderUserData()
+
+
+
+
+
+
+
+
+ void Aws::Crt::Auth::AwsSigningConfig::SetShouldSignHeaderUserData
+ (
+ void *
+ userData )
+
+
+
+
+
+noexcept
+
+
+
+
Sets the userData you could get from the ShouldSignHeaderCb callback function.
+
+
+
+
+
◆ SetSignatureType()
+
+
+
+
+
+
+
+
+ void Aws::Crt::Auth::AwsSigningConfig::SetSignatureType
+ (
+ SignatureType
+ signatureType )
+
+
+
+
+
+noexcept
+
+
+
+
Sets the type of signature we want to calculate
+
+
+
+
+
◆ SetSignedBodyHeader()
+
+
+
+
+
+
+
+
+ void Aws::Crt::Auth::AwsSigningConfig::SetSignedBodyHeader
+ (
+ SignedBodyHeaderType
+ signedBodyHeader )
+
+
+
+
+
+noexcept
+
+
+
+
Sets the name of the header to add that stores the signed body value
+
+
+
+
+
◆ SetSignedBodyValue()
+
+
+
+
+
+
+
+
+ void Aws::Crt::Auth::AwsSigningConfig::SetSignedBodyValue
+ (
+ const Crt::String &
+ signedBodyValue )
+
+
+
+
+
+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 ).
+
+
+
+
+
◆ SetSigningAlgorithm()
+
+
+
+
+
+
+
+
+ void Aws::Crt::Auth::AwsSigningConfig::SetSigningAlgorithm
+ (
+ SigningAlgorithm
+ algorithm )
+
+
+
+
+
+noexcept
+
+
+
+
Sets the signing process we want to invoke
+
+
+
+
+
◆ SetSigningTimepoint()
+
+
+
+
+
+
+
+
+ void Aws::Crt::Auth::AwsSigningConfig::SetSigningTimepoint
+ (
+ const DateTime &
+ date )
+
+
+
+
+
+noexcept
+
+
+
+
Sets the timestamp to use during the signing process.
+
+
+
+
+
◆ SetUseDoubleUriEncode()
+
+
+
+
+
+
+
+
+ void Aws::Crt::Auth::AwsSigningConfig::SetUseDoubleUriEncode
+ (
+ bool
+ useDoubleUriEncode )
+
+
+
+
+
+noexcept
+
+
+
+
Sets whether or not the signing process should perform a uri encode step before creating the canonical request.
+
+
+
+
The documentation for this class was generated from the following files:
+
+
+
+
+
diff --git a/docs/class_aws_1_1_crt_1_1_auth_1_1_aws_signing_config.png b/docs/class_aws_1_1_crt_1_1_auth_1_1_aws_signing_config.png
new file mode 100644
index 000000000..70d126f05
Binary files /dev/null and b/docs/class_aws_1_1_crt_1_1_auth_1_1_aws_signing_config.png differ
diff --git a/docs/class_aws_1_1_crt_1_1_auth_1_1_credentials-members.html b/docs/class_aws_1_1_crt_1_1_auth_1_1_credentials-members.html
new file mode 100644
index 000000000..8a9a7cc8d
--- /dev/null
+++ b/docs/class_aws_1_1_crt_1_1_auth_1_1_credentials-members.html
@@ -0,0 +1,96 @@
+
+
+
+
+
+
+
+aws-crt-cpp: Member List
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ 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.
+
+
+
+
+
diff --git a/docs/class_aws_1_1_crt_1_1_auth_1_1_credentials.html b/docs/class_aws_1_1_crt_1_1_auth_1_1_credentials.html
new file mode 100644
index 000000000..5343d3868
--- /dev/null
+++ b/docs/class_aws_1_1_crt_1_1_auth_1_1_credentials.html
@@ -0,0 +1,513 @@
+
+
+
+
+
+
+
+aws-crt-cpp: Aws::Crt::Auth::Credentials Class Reference
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ aws-crt-cpp
+
+ C++ wrapper around the aws-c-* libraries. Provides Cross-Platform Transport Protocols and SSL/TLS implementations for C++.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
#include <Credentials.h >
+
+
+
A class to hold the basic components necessary for various AWS authentication protocols.
+
+
+
◆ Credentials() [1/5]
+
+
+
+
+
+
+
+
+ Aws::Crt::Auth::Credentials::Credentials
+ (
+ const aws_credentials *
+ credentials )
+
+
+
+
+
+noexcept
+
+
+
+
+
+
+
+
◆ Credentials() [2/5]
+
+
+
+
+
+
+
+
+ Aws::Crt::Auth::Credentials::Credentials
+ (
+ ByteCursor
+ access_key_id ,
+
+
+
+
+ ByteCursor
+ secret_access_key ,
+
+
+
+
+ ByteCursor
+ session_token ,
+
+
+
+
+ uint64_t
+ expiration_timepoint_in_seconds ,
+
+
+
+
+ Allocator *
+ allocator = ApiAllocator ()
+
+
+
+ )
+
+
+
+
+
+noexcept
+
+
+
+
+
+
+
+
◆ Credentials() [3/5]
+
+
+
+
Create new anonymous Credentials . Use anonymous Credentials when you want to skip signing.
Parameters
+
+
+
+
+
+
+
+
◆ ~Credentials()
+
+
+
+
+
+ Aws::Crt::Auth::Credentials::~Credentials
+ (
+ )
+
+
+
+
+
+
+
+
+
◆ Credentials() [4/5]
+
+
+
+
+
+
+
+
+ Aws::Crt::Auth::Credentials::Credentials
+ (
+ const Credentials &
+ )
+
+
+
+
+
+delete
+
+
+
+
+
+
+
+
◆ Credentials() [5/5]
+
+
+
+
+
+
+
+
+ Aws::Crt::Auth::Credentials::Credentials
+ (
+ Credentials &&
+ )
+
+
+
+
+
+delete
+
+
+
+
+
+
+
+
+
◆ GetAccessKeyId()
+
+
+
+
+
+
+
+
+ ByteCursor Aws::Crt::Auth::Credentials::GetAccessKeyId
+ (
+ )
+ const
+
+
+
+
+noexcept
+
+
+
+
Gets the value of the access key component of aws credentials
+
+
+
+
+
◆ GetExpirationTimepointInSeconds()
+
+
+
+
+
+
+
+
+ uint64_t Aws::Crt::Auth::Credentials::GetExpirationTimepointInSeconds
+ (
+ )
+ const
+
+
+
+
+noexcept
+
+
+
+
Gets the expiration timestamp for the credentials, or UINT64_MAX if no expiration
+
+
+
+
+
◆ GetSecretAccessKey()
+
+
+
+
+
+
+
+
+ ByteCursor Aws::Crt::Auth::Credentials::GetSecretAccessKey
+ (
+ )
+ const
+
+
+
+
+noexcept
+
+
+
+
Gets the value of the secret access key component of aws credentials
+
+
+
+
+
◆ GetSessionToken()
+
+
+
+
+
+
+
+
+ ByteCursor Aws::Crt::Auth::Credentials::GetSessionToken
+ (
+ )
+ const
+
+
+
+
+noexcept
+
+
+
+
Gets the value of the session token of aws credentials
+
+
+
+
+
◆ GetUnderlyingHandle()
+
+
+
+
+
+
+
+
+ const aws_credentials* Aws::Crt::Auth::Credentials::GetUnderlyingHandle
+ (
+ )
+ const
+
+
+
+
+inline noexcept
+
+
+
+
Returns the underlying credentials implementation.
+
+
+
+
+
◆ operator bool()
+
+
+
+
+
+
+
+
+ Aws::Crt::Auth::Credentials::operator bool
+ (
+ )
+ const
+
+
+
+
+explicit noexcept
+
+
+
+
Validity check - returns true if the instance is valid, false otherwise
+
+
+
+
+
◆ operator=() [1/2]
+
+
+
+
◆ operator=() [2/2]
+
+
+
The documentation for this class was generated from the following files:
+
+
+
+
+
diff --git a/docs/class_aws_1_1_crt_1_1_auth_1_1_credentials_provider-members.html b/docs/class_aws_1_1_crt_1_1_auth_1_1_credentials_provider-members.html
new file mode 100644
index 000000000..cec48e33e
--- /dev/null
+++ b/docs/class_aws_1_1_crt_1_1_auth_1_1_credentials_provider-members.html
@@ -0,0 +1,104 @@
+
+
+
+
+
+
+
+aws-crt-cpp: Member List
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ 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()) noexceptAws::Crt::Auth::CredentialsProvider
+ CredentialsProvider (const CredentialsProvider &)=deleteAws::Crt::Auth::CredentialsProvider
+ CredentialsProvider (CredentialsProvider &&)=deleteAws::Crt::Auth::CredentialsProvider
+ GetCredentials (const OnCredentialsResolved &onCredentialsResolved) const overrideAws::Crt::Auth::CredentialsProvider virtual
+ GetUnderlyingHandle () const noexcept overrideAws::Crt::Auth::CredentialsProvider inline virtual
+ IsValid () const noexcept overrideAws::Crt::Auth::CredentialsProvider inline virtual
+ operator= (const CredentialsProvider &)=deleteAws::Crt::Auth::CredentialsProvider
+ operator= (CredentialsProvider &&)=deleteAws::Crt::Auth::CredentialsProvider
+ ~CredentialsProvider ()Aws::Crt::Auth::CredentialsProvider virtual
+ ~ICredentialsProvider ()=defaultAws::Crt::Auth::ICredentialsProvider virtual
+
+
+
+
+
diff --git a/docs/class_aws_1_1_crt_1_1_auth_1_1_credentials_provider.html b/docs/class_aws_1_1_crt_1_1_auth_1_1_credentials_provider.html
new file mode 100644
index 000000000..e41597b36
--- /dev/null
+++ b/docs/class_aws_1_1_crt_1_1_auth_1_1_credentials_provider.html
@@ -0,0 +1,829 @@
+
+
+
+
+
+
+
+aws-crt-cpp: Aws::Crt::Auth::CredentialsProvider Class Reference
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ aws-crt-cpp
+
+ C++ wrapper around the aws-c-* libraries. Provides Cross-Platform Transport Protocols and SSL/TLS implementations for C++.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
#include <Credentials.h >
+
+
+
+
+
+
+
+
+
+
+static std::shared_ptr< ICredentialsProvider > CreateCredentialsProviderStatic (const CredentialsProviderStaticConfig &config, Allocator *allocator=ApiAllocator ())
+
+static std::shared_ptr< ICredentialsProvider > CreateCredentialsProviderAnonymous (Allocator *allocator=ApiAllocator ())
+
+static std::shared_ptr< ICredentialsProvider > CreateCredentialsProviderEnvironment (Allocator *allocator=ApiAllocator ())
+
+static std::shared_ptr< ICredentialsProvider > CreateCredentialsProviderProfile (const CredentialsProviderProfileConfig &config, Allocator *allocator=ApiAllocator ())
+
+static std::shared_ptr< ICredentialsProvider > CreateCredentialsProviderImds (const CredentialsProviderImdsConfig &config, Allocator *allocator=ApiAllocator ())
+
+static std::shared_ptr< ICredentialsProvider > CreateCredentialsProviderChain (const CredentialsProviderChainConfig &config, Allocator *allocator=ApiAllocator ())
+
+static std::shared_ptr< ICredentialsProvider > CreateCredentialsProviderCached (const CredentialsProviderCachedConfig &config, Allocator *allocator=ApiAllocator ())
+
+static std::shared_ptr< ICredentialsProvider > CreateCredentialsProviderChainDefault (const CredentialsProviderChainDefaultConfig &config, Allocator *allocator=ApiAllocator ())
+
+static std::shared_ptr< ICredentialsProvider > CreateCredentialsProviderX509 (const CredentialsProviderX509Config &config, Allocator *allocator=ApiAllocator ())
+
+static std::shared_ptr< ICredentialsProvider > CreateCredentialsProviderDelegate (const CredentialsProviderDelegateConfig &config, Allocator *allocator=ApiAllocator ())
+
+static std::shared_ptr< ICredentialsProvider > CreateCredentialsProviderCognito (const CredentialsProviderCognitoConfig &config, Allocator *allocator=ApiAllocator ())
+
+static std::shared_ptr< ICredentialsProvider > CreateCredentialsProviderSTS (const CredentialsProviderSTSConfig &config, Allocator *allocator=ApiAllocator ())
+
+
+
+
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.
+
+
+
◆ CredentialsProvider() [1/3]
+
+
+
+
+
+
+
+
+ Aws::Crt::Auth::CredentialsProvider::CredentialsProvider
+ (
+ aws_credentials_provider *
+ provider ,
+
+
+
+
+ Allocator *
+ allocator = ApiAllocator ()
+
+
+
+ )
+
+
+
+
+
+noexcept
+
+
+
+
+
+
+
+
◆ ~CredentialsProvider()
+
+
+
+
+
+
+
+
+ Aws::Crt::Auth::CredentialsProvider::~CredentialsProvider
+ (
+ )
+
+
+
+
+
+virtual
+
+
+
+
+
+
+
+
◆ CredentialsProvider() [2/3]
+
+
+
+
+
+
+
+
+ Aws::Crt::Auth::CredentialsProvider::CredentialsProvider
+ (
+ const CredentialsProvider &
+ )
+
+
+
+
+
+delete
+
+
+
+
+
+
+
+
◆ CredentialsProvider() [3/3]
+
+
+
+
+
+
+
+
+ Aws::Crt::Auth::CredentialsProvider::CredentialsProvider
+ (
+ CredentialsProvider &&
+ )
+
+
+
+
+
+delete
+
+
+
+
+
+
+
+
+
◆ CreateCredentialsProviderAnonymous()
+
+
+
+
Creates an anonymous provider that have anonymous credentials Use anonymous credentials when you want to skip signing
+
+
+
+
+
◆ CreateCredentialsProviderCached()
+
+
+
+
◆ CreateCredentialsProviderChain()
+
+
+
+
Creates a provider that sources credentials by querying a series of providers and returning the first valid credential set encountered
+
+
+
+
+
◆ CreateCredentialsProviderChainDefault()
+
+
+
+
Creates the SDK-standard default credentials provider which is a cache-fronted chain of:
+
Environment -> Profile -> IMDS/ECS
+
+
+
+
+
◆ CreateCredentialsProviderCognito()
+
+
+
+
Creates a provider that sources credentials from the Cognito Identity service
+
+
+
+
+
◆ CreateCredentialsProviderDelegate()
+
+
+
+
Creates a provider that sources credentials from the provided function.
+
+
+
+
+
◆ CreateCredentialsProviderEnvironment()
+
+
+
+
Creates a provider that returns credentials sourced from environment variables
+
+
+
+
+
◆ CreateCredentialsProviderImds()
+
+
+
+
Creates a provider that returns credentials sourced from Ec2 instance metadata service
+
+
+
+
+
◆ CreateCredentialsProviderProfile()
+
+
+
+
Creates a provider that returns credentials sourced from config files
+
+
+
+
+
◆ CreateCredentialsProviderStatic()
+
+
+
+
Creates a provider that returns a fixed set of credentials
+
+
+
+
+
◆ CreateCredentialsProviderSTS()
+
+
+
+
Creates a provider that sources credentials from STS
+
+
+
+
+
◆ CreateCredentialsProviderX509()
+
+
+
+
Creates a provider that sources credentials from the IoT X509 provider service
+
+
+
+
+
◆ GetCredentials()
+
+
+
+
+
+
+
+
+ bool Aws::Crt::Auth::CredentialsProvider::GetCredentials
+ (
+ const OnCredentialsResolved &
+ onCredentialsResolved )
+ const
+
+
+
+
+override virtual
+
+
+
+
+
+
◆ GetUnderlyingHandle()
+
+
+
+
+
+
+
+
+ virtual aws_credentials_provider* Aws::Crt::Auth::CredentialsProvider::GetUnderlyingHandle
+ (
+ )
+ const
+
+
+
+
+inline override virtual noexcept
+
+
+
+
+
+
◆ IsValid()
+
+
+
+
+
+
+
+
+ virtual bool Aws::Crt::Auth::CredentialsProvider::IsValid
+ (
+ )
+ const
+
+
+
+
+inline override virtual noexcept
+
+
+
+
+
+
◆ operator=() [1/2]
+
+
+
+
◆ operator=() [2/2]
+
+
+
The documentation for this class was generated from the following files:
+
+
+
+
+
diff --git a/docs/class_aws_1_1_crt_1_1_auth_1_1_credentials_provider.png b/docs/class_aws_1_1_crt_1_1_auth_1_1_credentials_provider.png
new file mode 100644
index 000000000..6b2275911
Binary files /dev/null and b/docs/class_aws_1_1_crt_1_1_auth_1_1_credentials_provider.png differ
diff --git a/docs/class_aws_1_1_crt_1_1_auth_1_1_i_credentials_provider-members.html b/docs/class_aws_1_1_crt_1_1_auth_1_1_i_credentials_provider-members.html
new file mode 100644
index 000000000..5c37904d3
--- /dev/null
+++ b/docs/class_aws_1_1_crt_1_1_auth_1_1_i_credentials_provider-members.html
@@ -0,0 +1,86 @@
+
+
+
+
+
+
+
+aws-crt-cpp: Member List
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ 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.
+
+
+
+
+
diff --git a/docs/class_aws_1_1_crt_1_1_auth_1_1_i_credentials_provider.html b/docs/class_aws_1_1_crt_1_1_auth_1_1_i_credentials_provider.html
new file mode 100644
index 000000000..76d6bfe57
--- /dev/null
+++ b/docs/class_aws_1_1_crt_1_1_auth_1_1_i_credentials_provider.html
@@ -0,0 +1,222 @@
+
+
+
+
+
+
+
+aws-crt-cpp: Aws::Crt::Auth::ICredentialsProvider Class Reference
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ aws-crt-cpp
+
+ C++ wrapper around the aws-c-* libraries. Provides Cross-Platform Transport Protocols and SSL/TLS implementations for C++.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
#include <Credentials.h >
+
+
+
+
+
+
+
+
+
+
+
Base interface for all credentials providers. Credentials providers are objects that retrieve AWS credentials from some source.
+
+
+
◆ ~ICredentialsProvider()
+
+
+
+
+
+
+
+
+ virtual Aws::Crt::Auth::ICredentialsProvider::~ICredentialsProvider
+ (
+ )
+
+
+
+
+
+virtual default
+
+
+
+
+
+
+
+
+
◆ GetCredentials()
+
+
+
+
+
+
+
+
+ virtual bool Aws::Crt::Auth::ICredentialsProvider::GetCredentials
+ (
+ const OnCredentialsResolved &
+ onCredentialsResolved )
+ const
+
+
+
+
+pure virtual
+
+
+
+
+
+
◆ GetUnderlyingHandle()
+
+
+
+
+
+
+
+
+ virtual aws_credentials_provider* Aws::Crt::Auth::ICredentialsProvider::GetUnderlyingHandle
+ (
+ )
+ const
+
+
+
+
+pure virtual noexcept
+
+
+
+
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 .
+
+
+
+
+
◆ IsValid()
+
+
+
+
+
+
+
+
+ virtual bool Aws::Crt::Auth::ICredentialsProvider::IsValid
+ (
+ )
+ const
+
+
+
+
+pure virtual noexcept
+
+
+
+
+
The documentation for this class was generated from the following file:
+
+
+
+
+
diff --git a/docs/class_aws_1_1_crt_1_1_auth_1_1_i_credentials_provider.png b/docs/class_aws_1_1_crt_1_1_auth_1_1_i_credentials_provider.png
new file mode 100644
index 000000000..d1b376004
Binary files /dev/null and b/docs/class_aws_1_1_crt_1_1_auth_1_1_i_credentials_provider.png differ
diff --git a/docs/class_aws_1_1_crt_1_1_auth_1_1_i_http_request_signer-members.html b/docs/class_aws_1_1_crt_1_1_auth_1_1_i_http_request_signer-members.html
new file mode 100644
index 000000000..524d31dee
--- /dev/null
+++ b/docs/class_aws_1_1_crt_1_1_auth_1_1_i_http_request_signer-members.html
@@ -0,0 +1,90 @@
+
+
+
+
+
+
+
+aws-crt-cpp: Member List
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ 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.
+
+
+
+
+
diff --git a/docs/class_aws_1_1_crt_1_1_auth_1_1_i_http_request_signer.html b/docs/class_aws_1_1_crt_1_1_auth_1_1_i_http_request_signer.html
new file mode 100644
index 000000000..2ac4f60d8
--- /dev/null
+++ b/docs/class_aws_1_1_crt_1_1_auth_1_1_i_http_request_signer.html
@@ -0,0 +1,355 @@
+
+
+
+
+
+
+
+aws-crt-cpp: Aws::Crt::Auth::IHttpRequestSigner Class Reference
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ aws-crt-cpp
+
+ C++ wrapper around the aws-c-* libraries. Provides Cross-Platform Transport Protocols and SSL/TLS implementations for C++.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
#include <Signing.h >
+
+
+
+
+
+
+
+
+
+
+
Abstract base for all http request signers. Asynchronous interface. Intended to be a tight wrapper around aws-c-* signer implementations.
+
+
+
◆ IHttpRequestSigner() [1/3]
+
+
+
+
+
+
+
+
+ Aws::Crt::Auth::IHttpRequestSigner::IHttpRequestSigner
+ (
+ )
+
+
+
+
+
+default
+
+
+
+
+
+
+
+
◆ IHttpRequestSigner() [2/3]
+
+
+
+
+
+
+
+
+ Aws::Crt::Auth::IHttpRequestSigner::IHttpRequestSigner
+ (
+ const IHttpRequestSigner &
+ )
+
+
+
+
+
+delete
+
+
+
+
+
+
+
+
◆ IHttpRequestSigner() [3/3]
+
+
+
+
+
+
+
+
+ Aws::Crt::Auth::IHttpRequestSigner::IHttpRequestSigner
+ (
+ IHttpRequestSigner &&
+ )
+
+
+
+
+
+delete
+
+
+
+
+
+
+
+
◆ ~IHttpRequestSigner()
+
+
+
+
+
+
+
+
+ virtual Aws::Crt::Auth::IHttpRequestSigner::~IHttpRequestSigner
+ (
+ )
+
+
+
+
+
+virtual default
+
+
+
+
+
+
+
+
+
◆ IsValid()
+
+
+
+
+
+
+
+
+ virtual bool Aws::Crt::Auth::IHttpRequestSigner::IsValid
+ (
+ )
+ const
+
+
+
+
+pure virtual
+
+
+
+
+
+
◆ operator=() [1/2]
+
+
+
+
◆ operator=() [2/2]
+
+
+
+
◆ SignRequest()
+
+
+
+
+
+
+
+
+
+pure virtual
+
+
+
+
Signs an http request based on the signing implementation and supplied configuration
Parameters
+
+ 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
+
+
+
+
Returns true if the signing process was kicked off, false if there was a synchronous failure.
+
+
Implemented in Aws::Crt::Auth::Sigv4HttpRequestSigner .
+
+
+
+
The documentation for this class was generated from the following file:
+
+
+
+
+
diff --git a/docs/class_aws_1_1_crt_1_1_auth_1_1_i_http_request_signer.png b/docs/class_aws_1_1_crt_1_1_auth_1_1_i_http_request_signer.png
new file mode 100644
index 000000000..cc199cdba
Binary files /dev/null and b/docs/class_aws_1_1_crt_1_1_auth_1_1_i_http_request_signer.png differ
diff --git a/docs/class_aws_1_1_crt_1_1_auth_1_1_i_signing_config-members.html b/docs/class_aws_1_1_crt_1_1_auth_1_1_i_signing_config-members.html
new file mode 100644
index 000000000..3ed550bc5
--- /dev/null
+++ b/docs/class_aws_1_1_crt_1_1_auth_1_1_i_signing_config-members.html
@@ -0,0 +1,89 @@
+
+
+
+
+
+
+
+aws-crt-cpp: Member List
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ 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.
+
+
+
+
+
diff --git a/docs/class_aws_1_1_crt_1_1_auth_1_1_i_signing_config.html b/docs/class_aws_1_1_crt_1_1_auth_1_1_i_signing_config.html
new file mode 100644
index 000000000..7a4f8b43a
--- /dev/null
+++ b/docs/class_aws_1_1_crt_1_1_auth_1_1_i_signing_config.html
@@ -0,0 +1,301 @@
+
+
+
+
+
+
+
+aws-crt-cpp: Aws::Crt::Auth::ISigningConfig Class Reference
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ aws-crt-cpp
+
+ C++ wrapper around the aws-c-* libraries. Provides Cross-Platform Transport Protocols and SSL/TLS implementations for C++.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
#include <Signing.h >
+
+
+
+
+
+
+
+
+
+
+
Base class for all different signing configurations. Type functions as a primitive RTTI for downcasting.
+
+
+
◆ ISigningConfig() [1/3]
+
+
+
+
+
+
+
+
+ Aws::Crt::Auth::ISigningConfig::ISigningConfig
+ (
+ )
+
+
+
+
+
+default
+
+
+
+
+
+
+
+
◆ ISigningConfig() [2/3]
+
+
+
+
+
+
+
+
+ Aws::Crt::Auth::ISigningConfig::ISigningConfig
+ (
+ const ISigningConfig &
+ )
+
+
+
+
+
+delete
+
+
+
+
+
+
+
+
◆ ISigningConfig() [3/3]
+
+
+
+
+
+
+
+
+ Aws::Crt::Auth::ISigningConfig::ISigningConfig
+ (
+ ISigningConfig &&
+ )
+
+
+
+
+
+delete
+
+
+
+
+
+
+
+
◆ ~ISigningConfig()
+
+
+
+
+
+
+
+
+ virtual Aws::Crt::Auth::ISigningConfig::~ISigningConfig
+ (
+ )
+
+
+
+
+
+virtual default
+
+
+
+
+
+
+
+
+
◆ GetType()
+
+
+
+
+
+
+
+
+ virtual SigningConfigType Aws::Crt::Auth::ISigningConfig::GetType
+ (
+ void
+ )
+ const
+
+
+
+
+pure virtual
+
+
+
+
+
+
◆ operator=() [1/2]
+
+
+
+
◆ operator=() [2/2]
+
+
+
The documentation for this class was generated from the following file:
+
+
+
+
+
diff --git a/docs/class_aws_1_1_crt_1_1_auth_1_1_i_signing_config.png b/docs/class_aws_1_1_crt_1_1_auth_1_1_i_signing_config.png
new file mode 100644
index 000000000..b32b24eee
Binary files /dev/null and b/docs/class_aws_1_1_crt_1_1_auth_1_1_i_signing_config.png differ
diff --git a/docs/class_aws_1_1_crt_1_1_auth_1_1_sigv4_http_request_signer-members.html b/docs/class_aws_1_1_crt_1_1_auth_1_1_sigv4_http_request_signer-members.html
new file mode 100644
index 000000000..f56b5c5c1
--- /dev/null
+++ b/docs/class_aws_1_1_crt_1_1_auth_1_1_sigv4_http_request_signer-members.html
@@ -0,0 +1,92 @@
+
+
+
+
+
+
+
+aws-crt-cpp: Member List
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ 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.
+
+
+
+
+
diff --git a/docs/class_aws_1_1_crt_1_1_auth_1_1_sigv4_http_request_signer.html b/docs/class_aws_1_1_crt_1_1_auth_1_1_sigv4_http_request_signer.html
new file mode 100644
index 000000000..1da1e838d
--- /dev/null
+++ b/docs/class_aws_1_1_crt_1_1_auth_1_1_sigv4_http_request_signer.html
@@ -0,0 +1,242 @@
+
+
+
+
+
+
+
+aws-crt-cpp: Aws::Crt::Auth::Sigv4HttpRequestSigner Class Reference
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ aws-crt-cpp
+
+ C++ wrapper around the aws-c-* libraries. Provides Cross-Platform Transport Protocols and SSL/TLS implementations for C++.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
#include <Sigv4Signing.h >
+
+
+
+
+
+
+
+
+
+
+
Http request signer that performs Aws Sigv4 signing. Expects the signing configuration to be and instance of AwsSigningConfig
+
+
+
◆ Sigv4HttpRequestSigner()
+
+
+
+
+
+ Aws::Crt::Auth::Sigv4HttpRequestSigner::Sigv4HttpRequestSigner
+ (
+ Allocator *
+ allocator = ApiAllocator ()
)
+
+
+
+
+
+
+
+
+
◆ ~Sigv4HttpRequestSigner()
+
+
+
+
+
+
+
+
+ virtual Aws::Crt::Auth::Sigv4HttpRequestSigner::~Sigv4HttpRequestSigner
+ (
+ )
+
+
+
+
+
+virtual default
+
+
+
+
+
+
+
+
+
◆ IsValid()
+
+
+
+
+
+
+
+
+ bool Aws::Crt::Auth::Sigv4HttpRequestSigner::IsValid
+ (
+ )
+ const
+
+
+
+
+inline override virtual
+
+
+
+
+
+
◆ SignRequest()
+
+
+
+
+
+
+
+
+
+override virtual
+
+
+
+
+
The documentation for this class was generated from the following files:
+
+
+
+
+
diff --git a/docs/class_aws_1_1_crt_1_1_auth_1_1_sigv4_http_request_signer.png b/docs/class_aws_1_1_crt_1_1_auth_1_1_sigv4_http_request_signer.png
new file mode 100644
index 000000000..4791e8c7c
Binary files /dev/null and b/docs/class_aws_1_1_crt_1_1_auth_1_1_sigv4_http_request_signer.png differ
diff --git a/docs/class_aws_1_1_crt_1_1_cbor_1_1_cbor_decoder-members.html b/docs/class_aws_1_1_crt_1_1_cbor_1_1_cbor_decoder-members.html
new file mode 100644
index 000000000..5bf564d28
--- /dev/null
+++ b/docs/class_aws_1_1_crt_1_1_cbor_1_1_cbor_decoder-members.html
@@ -0,0 +1,102 @@
+
+
+
+
+
+
+
+aws-crt-cpp: Member List
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ 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::Cbor::CborDecoder , including all inherited members.
+
+
+
+
+
diff --git a/docs/class_aws_1_1_crt_1_1_cbor_1_1_cbor_decoder.html b/docs/class_aws_1_1_crt_1_1_cbor_1_1_cbor_decoder.html
new file mode 100644
index 000000000..4c15e7b86
--- /dev/null
+++ b/docs/class_aws_1_1_crt_1_1_cbor_1_1_cbor_decoder.html
@@ -0,0 +1,693 @@
+
+
+
+
+
+
+
+aws-crt-cpp: Aws::Crt::Cbor::CborDecoder Class Reference
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ aws-crt-cpp
+
+ C++ wrapper around the aws-c-* libraries. Provides Cross-Platform Transport Protocols and SSL/TLS implementations for C++.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
#include <Cbor.h >
+
+
+
+
◆ CborDecoder() [1/3]
+
+
+
+
+
+
+
+
+ Aws::Crt::Cbor::CborDecoder::CborDecoder
+ (
+ const CborDecoder &
+ )
+
+
+
+
+
+delete
+
+
+
+
+
+
+
+
◆ CborDecoder() [2/3]
+
+
+
+
+
+
+
+
+ Aws::Crt::Cbor::CborDecoder::CborDecoder
+ (
+ CborDecoder &&
+ )
+
+
+
+
+
+delete
+
+
+
+
+
+
+
+
◆ CborDecoder() [3/3]
+
+
+
+
Construct a new Cbor Decoder object
+
Parameters
+
+ allocator
+ src The src data to decode from.
+
+
+
+
+
+
+
+
◆ ~CborDecoder()
+
+
+
+
+
+
+
+
+ Aws::Crt::Cbor::CborDecoder::~CborDecoder
+ (
+ )
+
+
+
+
+
+noexcept
+
+
+
+
+
+
+
+
+
◆ ConsumeNextSingleElement()
+
+
+
+
+
+
+
+
+ bool Aws::Crt::Cbor::CborDecoder::ConsumeNextSingleElement
+ (
+ )
+
+
+
+
+
+noexcept
+
+
+
+
Consume the next single element, without the content followed by the element.
+
As an example for the following CBOR, this function will only consume the 0xBF, "Start indefinite-length map", not any content of the map represented. The next element to decode will start from 0x63. 0xbf6346756ef563416d7421ff BF – Start indefinite-length map 63 – First key, UTF-8 string length 3 46756e – "Fun" F5 – First value, true 63 – Second key, UTF-8 string length 3 416d74 – "Amt" 21 – Second value, -2 FF – "break"
+
Returns true if the operation succeed, false otherwise and LastError() will contain the errorCode.
+
+
+
+
+
◆ ConsumeNextWholeDataItem()
+
+
+
+
+
+
+
+
+ bool Aws::Crt::Cbor::CborDecoder::ConsumeNextWholeDataItem
+ (
+ )
+
+
+
+
+
+noexcept
+
+
+
+
Consume the next data item, includes all the content within the data item.
+
As an example for the following CBOR, this function will consume all the data as it's only one CBOR data item, an indefinite map with 2 key, value pair: 0xbf6346756ef563416d7421ff BF – Start indefinite-length map 63 – First key, UTF-8 string length 3 46756e – "Fun" F5 – First value, true 63 – Second key, UTF-8 string length 3 416d74 – "Amt" 21 – Second value, -2 FF – "break"
+
Notes: this function will not ensure the data item is well-formed.
+
Returns true if the operation succeed, false otherwise and LastError() will contain the errorCode.
+
+
+
+
+
◆ GetRemainingLength()
+
+
+
+
+
+
+
+
+ size_t Aws::Crt::Cbor::CborDecoder::GetRemainingLength
+ (
+ )
+
+
+
+
+
+noexcept
+
+
+
+
Get the length of the remaining bytes of the source. Once the source was decoded, it will be consumed, and result in decrease of the remaining length of bytes.
+
Returns The length of bytes remaining of the decoder source.
+
+
+
+
+
◆ LastError()
+
+
+
+
+
+
+
+
+ int Aws::Crt::Cbor::CborDecoder::LastError
+ (
+ )
+ const
+
+
+
+
+inline noexcept
+
+
+
+
Returns the value of the last aws error encountered by operations on this instance.
+
+
+
+
+
◆ operator=() [1/2]
+
+
+
+
◆ operator=() [2/2]
+
+
+
+
◆ PeekType()
+
+
+
+
Decode the next element and store it in the decoder cache if there was no element cached. If there was an element cached, just return the type of the cached element.
+
Returns If successful, return the type of next element If not, return will be none and LastError() can be used to retrieve CRT error code.
+
+
+
+
+
◆ PopNextArrayStart()
+
+
+
+
+
+
+
+
+ Optional < uint64_t > Aws::Crt::Cbor::CborDecoder::PopNextArrayStart
+ (
+ )
+
+
+
+
+
+noexcept
+
+
+
+
Get the next ArrayStart element. Only consume the ArrayStart element and set the size of array to &out_size, not the content of the array. The next &out_size CBOR data items will be the content of the array for a valid CBOR data.
+
Notes: For indefinite-length, this function will fail with "AWS_ERROR_CBOR_UNEXPECTED_TYPE". The designed way to handle indefinite-length is:
+Get IndefArrayStart from PeekType
+Call ConsumeNextSingleElement to pop the indefinite-length start.
+Decode the next data item until Break is read.
+
+
Returns If successful, return the size of array If not, return will be none and LastError() can be used to retrieve CRT error code.
+
+
+
+
+
◆ PopNextBooleanVal()
+
+
+
+
+
+
+
+
+ Optional < bool > Aws::Crt::Cbor::CborDecoder::PopNextBooleanVal
+ (
+ )
+
+
+
+
+
+noexcept
+
+
+
+
+
+
+
+
◆ PopNextBytesVal()
+
+
+
+
◆ PopNextFloatVal()
+
+
+
+
+
+
+
+
+ Optional < double > Aws::Crt::Cbor::CborDecoder::PopNextFloatVal
+ (
+ )
+
+
+
+
+
+noexcept
+
+
+
+
+
+
+
+
◆ PopNextMapStart()
+
+
+
+
+
+
+
+
+ Optional < uint64_t > Aws::Crt::Cbor::CborDecoder::PopNextMapStart
+ (
+ )
+
+
+
+
+
+noexcept
+
+
+
+
Get the next MapStart element. Only consume the MapStart element and set the size of array to &out_size, not the content of the map. The next &out_size pair of CBOR data items as key and value will be the content of the array for a valid CBOR data.
+
Notes: For indefinite-length, this function will fail with "AWS_ERROR_CBOR_UNEXPECTED_TYPE". The designed way to handle indefinite-length is:
+Get IndefMapStart from PeekType
+Call ConsumeNextSingleElement to pop the indefinite-length start.
+Decode the next data item until Break is read.
+
+
Returns If successful, return the size of map If not, return will be none and LastError() can be used to retrieve CRT error code.
+
+
+
+
+
◆ PopNextNegativeIntVal()
+
+
+
+
+
+
+
+
+ Optional < uint64_t > Aws::Crt::Cbor::CborDecoder::PopNextNegativeIntVal
+ (
+ )
+
+
+
+
+
+noexcept
+
+
+
+
+
+
+
+
◆ PopNextTagVal()
+
+
+
+
+
+
+
+
+ Optional < uint64_t > Aws::Crt::Cbor::CborDecoder::PopNextTagVal
+ (
+ )
+
+
+
+
+
+noexcept
+
+
+
+
Get the next Tag element. Only consume the Tag element and set the tag value to out_tag_val, not the content of the tagged value. The next CBOR data item will be the content of the tagged value for a valid CBOR data.
+
Returns If successful, return the tag value If not, return will be none and LastError() can be used to retrieve CRT error code.
+
+
+
+
+
◆ PopNextTextVal()
+
+
+
+
◆ PopNextUnsignedIntVal()
+
+
+
+
+
+
+
+
+ Optional < uint64_t > Aws::Crt::Cbor::CborDecoder::PopNextUnsignedIntVal
+ (
+ )
+
+
+
+
+
+noexcept
+
+
+
+
Get the next element based on the type. If the next element doesn't match the expected type, an error will be raised. If the next element has already been cached, it will consume the cached item when no error was returned. Specifically:
+UInt - PopNextUnsignedIntVal
+NegInt - PopNextNegativeIntVal, it represents (-1 - &out)
+Float - PopNextFloatVal
+Bytes - PopNextBytesVal
+Text - PopNextTextVal
+
+
Returns If successful, return the next element If not, return will be none and LastError() can be used to retrieve CRT error code.
+
+
+
+
The documentation for this class was generated from the following files:
+
+
+
+
+
diff --git a/docs/class_aws_1_1_crt_1_1_cbor_1_1_cbor_encoder-members.html b/docs/class_aws_1_1_crt_1_1_cbor_1_1_cbor_encoder-members.html
new file mode 100644
index 000000000..2705fbcfb
--- /dev/null
+++ b/docs/class_aws_1_1_crt_1_1_cbor_1_1_cbor_encoder-members.html
@@ -0,0 +1,106 @@
+
+
+
+
+
+
+
+aws-crt-cpp: Member List
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ 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::Cbor::CborEncoder , including all inherited members.
+
+
+
+
+
diff --git a/docs/class_aws_1_1_crt_1_1_cbor_1_1_cbor_encoder.html b/docs/class_aws_1_1_crt_1_1_cbor_1_1_cbor_encoder.html
new file mode 100644
index 000000000..6d65deb5d
--- /dev/null
+++ b/docs/class_aws_1_1_crt_1_1_cbor_1_1_cbor_encoder.html
@@ -0,0 +1,825 @@
+
+
+
+
+
+
+
+aws-crt-cpp: Aws::Crt::Cbor::CborEncoder Class Reference
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ aws-crt-cpp
+
+ C++ wrapper around the aws-c-* libraries. Provides Cross-Platform Transport Protocols and SSL/TLS implementations for C++.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
#include <Cbor.h >
+
+
+
+
◆ CborEncoder() [1/3]
+
+
+
+
+
+
+
+
+ Aws::Crt::Cbor::CborEncoder::CborEncoder
+ (
+ const CborEncoder &
+ )
+
+
+
+
+
+delete
+
+
+
+
+
+
+
+
◆ CborEncoder() [2/3]
+
+
+
+
+
+
+
+
+ Aws::Crt::Cbor::CborEncoder::CborEncoder
+ (
+ CborEncoder &&
+ )
+
+
+
+
+
+delete
+
+
+
+
+
+
+
+
◆ CborEncoder() [3/3]
+
+
+
+
◆ ~CborEncoder()
+
+
+
+
+
+
+
+
+ Aws::Crt::Cbor::CborEncoder::~CborEncoder
+ (
+ )
+
+
+
+
+
+noexcept
+
+
+
+
+
+
+
+
+
◆ GetEncodedData()
+
+
+
+
+
+
+
+
+ ByteCursor Aws::Crt::Cbor::CborEncoder::GetEncodedData
+ (
+ )
+
+
+
+
+
+noexcept
+
+
+
+
Get the current encoded data from encoder. The encoded data has the same lifetime as the encoder, and once any other function call invoked for the encoder, the encoded data is no longer valid.
+
Returns the current encoded data
+
+
+
+
+
◆ operator=() [1/2]
+
+
+
+
◆ operator=() [2/2]
+
+
+
+
◆ Reset()
+
+
+
+
+
+
+
+
+ void Aws::Crt::Cbor::CborEncoder::Reset
+ (
+ )
+
+
+
+
+
+noexcept
+
+
+
+
Clear the current encoded buffer from encoder.
+
+
+
+
+
◆ WriteArrayStart()
+
+
+
+
+
+
+
+
+ void Aws::Crt::Cbor::CborEncoder::WriteArrayStart
+ (
+ size_t
+ number_entries )
+
+
+
+
+
+noexcept
+
+
+
+
Encode an ArrayStart value to "smallest possible" in encoder's buffer. Referring to RFC8949 section 4.2.1 Notes: it's user's responsibility to keep the integrity of the array to be encoded.
+
Parameters
+
+ number_entries the number of CBOR data items to be followed as the content of the array.
+
+
+
+
+
+
+
+
◆ WriteBool()
+
+
+
+
+
+
+
+
+ void Aws::Crt::Cbor::CborEncoder::WriteBool
+ (
+ bool
+ value )
+
+
+
+
+
+noexcept
+
+
+
+
Encode a simple value Bool
+
+
+
+
+
◆ WriteBreak()
+
+
+
+
+
+
+
+
+ void Aws::Crt::Cbor::CborEncoder::WriteBreak
+ (
+ )
+
+
+
+
+
+noexcept
+
+
+
+
Encode a simple value Break Notes: no error checking, it's user's responsibility to track the break to close the corresponding indef_start
+
+
+
+
+
◆ WriteBytes()
+
+
+
+
+
+
+
+
+ void Aws::Crt::Cbor::CborEncoder::WriteBytes
+ (
+ ByteCursor
+ value )
+
+
+
+
+
+noexcept
+
+
+
+
Encode a Bytes value to "smallest possible" in encoder's buffer. Referring to RFC8949 section 4.2.1, the length of "value" will be encoded first and then the value of "value" will be followed.
+
Parameters
+
+ value value to encode.
+
+
+
+
+
+
+
+
◆ WriteFloat()
+
+
+
+
+
+
+
+
+ void Aws::Crt::Cbor::CborEncoder::WriteFloat
+ (
+ double
+ value )
+
+
+
+
+
+noexcept
+
+
+
+
Encode a AWS_CBOR_TYPE_FLOAT value to "smallest possible", but will not be encoded into half-precision float, as it's not well supported cross languages.
+
To be more specific, it will be encoded into integer/negative/float (Order with priority) when the conversion will not cause precision loss.
+
Parameters
+
+ value value to encode.
+
+
+
+
+
+
+
+
◆ WriteIndefArrayStart()
+
+
+
+
+
+
+
+
+ void Aws::Crt::Cbor::CborEncoder::WriteIndefArrayStart
+ (
+ )
+
+
+
+
+
+noexcept
+
+
+
+
Encode an IndefArrayStart Notes: no error checking, it's user's responsibility to add corresponding data and the break to close the indef_start
+
+
+
+
+
◆ WriteIndefBytesStart()
+
+
+
+
+
+
+
+
+ void Aws::Crt::Cbor::CborEncoder::WriteIndefBytesStart
+ (
+ )
+
+
+
+
+
+noexcept
+
+
+
+
Encode an IndefBytesStart Notes: no error checking, it's user's responsibility to add corresponding data and the break to close the indef_start
+
+
+
+
+
◆ WriteIndefMapStart()
+
+
+
+
+
+
+
+
+ void Aws::Crt::Cbor::CborEncoder::WriteIndefMapStart
+ (
+ )
+
+
+
+
+
+noexcept
+
+
+
+
Encode an IndefMapStart Notes: no error checking, it's user's responsibility to add corresponding data and the break to close the indef_start
+
+
+
+
+
◆ WriteIndefTextStart()
+
+
+
+
+
+
+
+
+ void Aws::Crt::Cbor::CborEncoder::WriteIndefTextStart
+ (
+ )
+
+
+
+
+
+noexcept
+
+
+
+
Encode an IndefTextStart Notes: no error checking, it's user's responsibility to add corresponding data and the break to close the indef_start
+
+
+
+
+
◆ WriteMapStart()
+
+
+
+
+
+
+
+
+ void Aws::Crt::Cbor::CborEncoder::WriteMapStart
+ (
+ size_t
+ number_entries )
+
+
+
+
+
+noexcept
+
+
+
+
Encode a MapStart value to "smallest possible" in encoder's buffer. Referring to RFC8949 section 4.2.1
+
Notes: it's user's responsibility to keep the integrity of the map to be encoded.
+
Parameters
+
+ number_entries the number of pair of CBOR data items as key and value to be followed as the content of the map.
+
+
+
+
+
+
+
+
◆ WriteNegInt()
+
+
+
+
+
+
+
+
+ void Aws::Crt::Cbor::CborEncoder::WriteNegInt
+ (
+ uint64_t
+ value )
+
+
+
+
+
+noexcept
+
+
+
+
Encode a AWS_CBOR_TYPE_NEGINT value to "smallest possible" in encoder's buffer. It represents (-1 - value). Referring to RFC8949 section 4.2.1
+
Parameters
+
+ value value to encode, which is (-1 - represented value)
+
+
+
+
+
+
+
+
◆ WriteNull()
+
+
+
+
+
+
+
+
+ void Aws::Crt::Cbor::CborEncoder::WriteNull
+ (
+ )
+
+
+
+
+
+noexcept
+
+
+
+
Encode a simple value Null
+
+
+
+
+
◆ WriteTag()
+
+
+
+
+
+
+
+
+ void Aws::Crt::Cbor::CborEncoder::WriteTag
+ (
+ uint64_t
+ tag_number )
+
+
+
+
+
+noexcept
+
+
+
+
Encode a Tag value to "smallest possible" in encoder's buffer. Referring to RFC8949 section 4.2.1 The following CBOR data item will be the content of the tagged value. Notes: it's user's responsibility to keep the integrity of the tagged value to follow the RFC8949 section 3.4
+
Parameters
+
+ tag_number The tag value to encode.
+
+
+
+
+
+
+
+
◆ WriteText()
+
+
+
+
+
+
+
+
+ void Aws::Crt::Cbor::CborEncoder::WriteText
+ (
+ ByteCursor
+ value )
+
+
+
+
+
+noexcept
+
+
+
+
Encode a Text value to "smallest possible" in encoder's buffer. Referring to RFC8949 section 4.2.1, the length of "value" will be encoded first and then the value of "value" will be followed.
+
Parameters
+
+ value value to encode.
+
+
+
+
+
+
+
+
◆ WriteUInt()
+
+
+
+
+
+
+
+
+ void Aws::Crt::Cbor::CborEncoder::WriteUInt
+ (
+ uint64_t
+ value )
+
+
+
+
+
+noexcept
+
+
+
+
Encode a AWS_CBOR_TYPE_UINT value to "smallest possible" in encoder's buffer. Referring to RFC8949 section 4.2.1
+
Parameters
+
+ value value to encode.
+
+
+
+
+
+
+
+
◆ WriteUndefined()
+
+
+
+
+
+
+
+
+ void Aws::Crt::Cbor::CborEncoder::WriteUndefined
+ (
+ )
+
+
+
+
+
+noexcept
+
+
+
+
Encode a simple value Undefined
+
+
+
+
The documentation for this class was generated from the following files:
+
+
+
+
+
diff --git a/docs/class_aws_1_1_crt_1_1_crypto_1_1_byo_h_m_a_c-members.html b/docs/class_aws_1_1_crt_1_1_crypto_1_1_byo_h_m_a_c-members.html
new file mode 100644
index 000000000..cf2f90359
--- /dev/null
+++ b/docs/class_aws_1_1_crt_1_1_crypto_1_1_byo_h_m_a_c-members.html
@@ -0,0 +1,86 @@
+
+
+
+
+
+
+
+aws-crt-cpp: Member List
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ 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.
+
+
+
+
+
diff --git a/docs/class_aws_1_1_crt_1_1_crypto_1_1_byo_h_m_a_c.html b/docs/class_aws_1_1_crt_1_1_crypto_1_1_byo_h_m_a_c.html
new file mode 100644
index 000000000..7167891b2
--- /dev/null
+++ b/docs/class_aws_1_1_crt_1_1_crypto_1_1_byo_h_m_a_c.html
@@ -0,0 +1,240 @@
+
+
+
+
+
+
+
+aws-crt-cpp: Aws::Crt::Crypto::ByoHMAC Class Reference
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ aws-crt-cpp
+
+ C++ wrapper around the aws-c-* libraries. Provides Cross-Platform Transport Protocols and SSL/TLS implementations for C++.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
#include <HMAC.h >
+
+
+
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() .
+
+
+
◆ ~ByoHMAC()
+
+
+
+
+
+
+
+
+ virtual Aws::Crt::Crypto::ByoHMAC::~ByoHMAC
+ (
+ )
+
+
+
+
+
+virtual default
+
+
+
+
+
+
+
+
◆ ByoHMAC()
+
+
+
+
+
+
+
+
+ Aws::Crt::Crypto::ByoHMAC::ByoHMAC
+ (
+ size_t
+ digestSize ,
+
+
+
+
+ const ByteCursor &
+ secret ,
+
+
+
+
+ Allocator *
+ allocator = ApiAllocator ()
+
+
+
+ )
+
+
+
+
+
+protected
+
+
+
+
+
+
+
+
+
◆ DigestInternal()
+
+
+
+
+
+
+
+
+ virtual bool Aws::Crt::Crypto::ByoHMAC::DigestInternal
+ (
+ ByteBuf &
+ output ,
+
+
+
+
+ size_t
+ truncateTo = 0
+
+
+
+ )
+
+
+
+
+
+protected pure virtual noexcept
+
+
+
+
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.
+
+
+
+
+
◆ UpdateInternal()
+
+
+
+
+
+
+
+
+ virtual bool Aws::Crt::Crypto::ByoHMAC::UpdateInternal
+ (
+ const ByteCursor &
+ toHash )
+
+
+
+
+
+protected pure virtual noexcept
+
+
+
+
Updates the running HMAC with to_hash. This can be called multiple times. Raise an AWS error and return false to indicate failure.
+
+
+
+
The documentation for this class was generated from the following files:
+
+
+
+
+
diff --git a/docs/class_aws_1_1_crt_1_1_crypto_1_1_byo_hash-members.html b/docs/class_aws_1_1_crt_1_1_crypto_1_1_byo_hash-members.html
new file mode 100644
index 000000000..af22ab793
--- /dev/null
+++ b/docs/class_aws_1_1_crt_1_1_crypto_1_1_byo_hash-members.html
@@ -0,0 +1,86 @@
+
+
+
+
+
+
+
+aws-crt-cpp: Member List
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ 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.
+
+
+
+
+
diff --git a/docs/class_aws_1_1_crt_1_1_crypto_1_1_byo_hash.html b/docs/class_aws_1_1_crt_1_1_crypto_1_1_byo_hash.html
new file mode 100644
index 000000000..704cba675
--- /dev/null
+++ b/docs/class_aws_1_1_crt_1_1_crypto_1_1_byo_hash.html
@@ -0,0 +1,234 @@
+
+
+
+
+
+
+
+aws-crt-cpp: Aws::Crt::Crypto::ByoHash Class Reference
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ aws-crt-cpp
+
+ C++ wrapper around the aws-c-* libraries. Provides Cross-Platform Transport Protocols and SSL/TLS implementations for C++.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
#include <Hash.h >
+
+
+
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() .
+
+
+
◆ ~ByoHash()
+
+
+
+
+
+
+
+
+ Aws::Crt::Crypto::ByoHash::~ByoHash
+ (
+ )
+
+
+
+
+
+virtual
+
+
+
+
+
+
+
+
◆ ByoHash()
+
+
+
+
+
+
+
+
+ Aws::Crt::Crypto::ByoHash::ByoHash
+ (
+ size_t
+ digestSize ,
+
+
+
+
+ Allocator *
+ allocator = ApiAllocator ()
+
+
+
+ )
+
+
+
+
+
+protected
+
+
+
+
+
+
+
+
+
◆ DigestInternal()
+
+
+
+
+
+
+
+
+ virtual bool Aws::Crt::Crypto::ByoHash::DigestInternal
+ (
+ ByteBuf &
+ output ,
+
+
+
+
+ size_t
+ truncateTo = 0
+
+
+
+ )
+
+
+
+
+
+protected pure virtual noexcept
+
+
+
+
Complete the hash computation and write the final digest to output. This cannot 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.
+
+
+
+
+
◆ UpdateInternal()
+
+
+
+
+
+
+
+
+ virtual bool Aws::Crt::Crypto::ByoHash::UpdateInternal
+ (
+ const ByteCursor &
+ toHash )
+
+
+
+
+
+protected pure virtual noexcept
+
+
+
+
Update the running hash with to_hash. This can be called multiple times. Raise an AWS error and return false to indicate failure.
+
+
+
+
The documentation for this class was generated from the following files:
+
+
+
+
+
diff --git a/docs/class_aws_1_1_crt_1_1_crypto_1_1_h_m_a_c-members.html b/docs/class_aws_1_1_crt_1_1_crypto_1_1_h_m_a_c-members.html
new file mode 100644
index 000000000..27d0f7896
--- /dev/null
+++ b/docs/class_aws_1_1_crt_1_1_crypto_1_1_h_m_a_c-members.html
@@ -0,0 +1,95 @@
+
+
+
+
+
+
+
+aws-crt-cpp: Member List
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ 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.
+
+
+
+
+
diff --git a/docs/class_aws_1_1_crt_1_1_crypto_1_1_h_m_a_c.html b/docs/class_aws_1_1_crt_1_1_crypto_1_1_h_m_a_c.html
new file mode 100644
index 000000000..b4aed5a1a
--- /dev/null
+++ b/docs/class_aws_1_1_crt_1_1_crypto_1_1_h_m_a_c.html
@@ -0,0 +1,481 @@
+
+
+
+
+
+
+
+aws-crt-cpp: Aws::Crt::Crypto::HMAC Class Reference
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ aws-crt-cpp
+
+ C++ wrapper around the aws-c-* libraries. Provides Cross-Platform Transport Protocols and SSL/TLS implementations for C++.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
#include <HMAC.h >
+
+
+
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.
+
+
+
◆ ~HMAC()
+
+
+
+
+
+ Aws::Crt::Crypto::HMAC::~HMAC
+ (
+ )
+
+
+
+
+
+
+
+
+
◆ HMAC() [1/2]
+
+
+
+
+
+
+
+
+ Aws::Crt::Crypto::HMAC::HMAC
+ (
+ const HMAC &
+ )
+
+
+
+
+
+delete
+
+
+
+
+
+
+
+
◆ HMAC() [2/2]
+
+
+
+
+
+ Aws::Crt::Crypto::HMAC::HMAC
+ (
+ HMAC &&
+ toMove )
+
+
+
+
+
+
+
+
+
+
◆ ComputeOneShot()
+
+
+
+
+
+
+
+
+ bool Aws::Crt::Crypto::HMAC::ComputeOneShot
+ (
+ const ByteCursor &
+ input ,
+
+
+
+
+ ByteBuf &
+ output ,
+
+
+
+
+ size_t
+ truncateTo = 0
+
+
+
+ )
+
+
+
+
+
+noexcept
+
+
+
+
Computes the running HMAC and 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 HMAC digest. Returns true on success. Call LastError() for the reason this call failed.
+
This is an API a user would use for smaller size inputs. For larger, streaming inputs, use multiple calls to Update() for each buffer, followed by a single call to Digest() .
+
+
+
+
+
◆ CreateSHA256HMAC() [1/2]
+
+
+
+
+
+
+
+
+ HMAC Aws::Crt::Crypto::HMAC::CreateSHA256HMAC
+ (
+ Allocator *
+ allocator ,
+
+
+
+
+ const ByteCursor &
+ secret
+
+
+
+ )
+
+
+
+
+
+static noexcept
+
+
+
+
Creates an instance of a Streaming SHA256 HMAC .
+
+
+
+
+
◆ CreateSHA256HMAC() [2/2]
+
+
+
+
+
+
+
+
+ HMAC Aws::Crt::Crypto::HMAC::CreateSHA256HMAC
+ (
+ const ByteCursor &
+ secret )
+
+
+
+
+
+static noexcept
+
+
+
+
Creates an instance of a Streaming SHA256 HMAC using the Default Allocator.
+
+
+
+
+
◆ Digest()
+
+
+
+
+
+
+
+
+ bool Aws::Crt::Crypto::HMAC::Digest
+ (
+ ByteBuf &
+ output ,
+
+
+
+
+ size_t
+ truncateTo = 0
+
+
+
+ )
+
+
+
+
+
+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.
+
+
+
+
+
◆ DigestSize()
+
+
+
+
+
+
+
+
+ size_t Aws::Crt::Crypto::HMAC::DigestSize
+ (
+ )
+ const
+
+
+
+
+noexcept
+
+
+
+
Returns the size of the digest for this hmac algorithm. If this object is not valid, it will return 0 instead.
+
+
+
+
+
◆ LastError()
+
+
+
+
+
+
+
+
+ int Aws::Crt::Crypto::HMAC::LastError
+ (
+ )
+ const
+
+
+
+
+inline noexcept
+
+
+
+
Returns the value of the last aws error encountered by operations on this instance.
+
+
+
+
+
◆ operator bool()
+
+
+
+
+
+
+
+
+ Aws::Crt::Crypto::HMAC::operator bool
+ (
+ )
+ const
+
+
+
+
+inline noexcept
+
+
+
+
Returns true if the instance is in a valid state, false otherwise.
+
+
+
+
+
◆ operator=() [1/2]
+
+
+
+
+
+
+
+
+ HMAC & Aws::Crt::Crypto::HMAC::operator=
+ (
+ const HMAC &
+ )
+
+
+
+
+
+delete
+
+
+
+
+
+
+
+
◆ operator=() [2/2]
+
+
+
+
+
+ HMAC & Aws::Crt::Crypto::HMAC::operator=
+ (
+ HMAC &&
+ toMove )
+
+
+
+
+
+
+
+
+
◆ Update()
+
+
+
+
+
+
+
+
+ bool Aws::Crt::Crypto::HMAC::Update
+ (
+ const ByteCursor &
+ toHMAC )
+
+
+
+
+
+noexcept
+
+
+
+
Updates the running HMAC object with data in toHMAC. Returns true on success. Call LastError() for the reason this call failed.
+
+
+
+
The documentation for this class was generated from the following files:
+
+
+
+
+
diff --git a/docs/class_aws_1_1_crt_1_1_crypto_1_1_hash-members.html b/docs/class_aws_1_1_crt_1_1_crypto_1_1_hash-members.html
new file mode 100644
index 000000000..2bd273923
--- /dev/null
+++ b/docs/class_aws_1_1_crt_1_1_crypto_1_1_hash-members.html
@@ -0,0 +1,96 @@
+
+
+
+
+
+
+
+aws-crt-cpp: Member List
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ 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.
+
+
+
+
+
diff --git a/docs/class_aws_1_1_crt_1_1_crypto_1_1_hash.html b/docs/class_aws_1_1_crt_1_1_crypto_1_1_hash.html
new file mode 100644
index 000000000..7f4502617
--- /dev/null
+++ b/docs/class_aws_1_1_crt_1_1_crypto_1_1_hash.html
@@ -0,0 +1,500 @@
+
+
+
+
+
+
+
+aws-crt-cpp: Aws::Crt::Crypto::Hash Class Reference
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ aws-crt-cpp
+
+ C++ wrapper around the aws-c-* libraries. Provides Cross-Platform Transport Protocols and SSL/TLS implementations for C++.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
#include <Hash.h >
+
+
+
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.
+
+
+
◆ ~Hash()
+
+
+
+
+
+ Aws::Crt::Crypto::Hash::~Hash
+ (
+ )
+
+
+
+
+
+
+
+
+
◆ Hash() [1/2]
+
+
+
+
+
+
+
+
+ Aws::Crt::Crypto::Hash::Hash
+ (
+ const Hash &
+ )
+
+
+
+
+
+delete
+
+
+
+
+
+
+
+
◆ Hash() [2/2]
+
+
+
+
+
+ Aws::Crt::Crypto::Hash::Hash
+ (
+ Hash &&
+ toMove )
+
+
+
+
+
+
+
+
+
+
◆ ComputeOneShot()
+
+
+
+
+
+
+
+
+ bool Aws::Crt::Crypto::Hash::ComputeOneShot
+ (
+ const ByteCursor &
+ input ,
+
+
+
+
+ ByteBuf &
+ output ,
+
+
+
+
+ size_t
+ truncateTo = 0
+
+
+
+ )
+
+
+
+
+
+noexcept
+
+
+
+
Computes the hash of input and writes the digest into output. The available capacity of output must be large enough for the digest. See: SHA1_DIGEST_SIZE, 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.
+
This is an API a user would use for smaller size inputs. For larger, streaming inputs, use multiple calls to Update() for each buffer, followed by a single call to Digest() .
+
+
+
+
+
◆ CreateMD5()
+
+
+
+
+
+
+
+
+
+static noexcept
+
+
+
+
Creates an instance of a Streaming MD5 Hash .
+
+
+
+
+
◆ CreateSHA1()
+
+
+
+
+
+
+
+
+
+static noexcept
+
+
+
+
Creates an instance of a Stream SHA1 Hash .
+
+
+
+
+
◆ CreateSHA256()
+
+
+
+
+
+
+
+
+
+static noexcept
+
+
+
+
Creates an instance of a Streaming SHA256 Hash .
+
+
+
+
+
◆ Digest()
+
+
+
+
+
+
+
+
+ bool Aws::Crt::Crypto::Hash::Digest
+ (
+ ByteBuf &
+ output ,
+
+
+
+
+ size_t
+ truncateTo = 0
+
+
+
+ )
+
+
+
+
+
+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: SHA1_DIGEST_SIZE, 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.
+
+
+
+
+
◆ DigestSize()
+
+
+
+
+
+
+
+
+ size_t Aws::Crt::Crypto::Hash::DigestSize
+ (
+ )
+ const
+
+
+
+
+noexcept
+
+
+
+
Returns the size of the digest for this hash algorithm. If this object is not valid, it will return 0 instead.
+
+
+
+
+
◆ LastError()
+
+
+
+
+
+
+
+
+ int Aws::Crt::Crypto::Hash::LastError
+ (
+ )
+ const
+
+
+
+
+inline noexcept
+
+
+
+
Returns the value of the last aws error encountered by operations on this instance.
+
+
+
+
+
◆ operator bool()
+
+
+
+
+
+
+
+
+ Aws::Crt::Crypto::Hash::operator bool
+ (
+ )
+ const
+
+
+
+
+noexcept
+
+
+
+
Returns true if the instance is in a valid state, false otherwise.
+
+
+
+
+
◆ operator=() [1/2]
+
+
+
+
+
+
+
+
+ Hash & Aws::Crt::Crypto::Hash::operator=
+ (
+ const Hash &
+ )
+
+
+
+
+
+delete
+
+
+
+
+
+
+
+
◆ operator=() [2/2]
+
+
+
+
+
+ Hash & Aws::Crt::Crypto::Hash::operator=
+ (
+ Hash &&
+ toMove )
+
+
+
+
+
+
+
+
+
◆ Update()
+
+
+
+
+
+
+
+
+ bool Aws::Crt::Crypto::Hash::Update
+ (
+ const ByteCursor &
+ toHash )
+
+
+
+
+
+noexcept
+
+
+
+
Updates the running hash object with data in toHash. Returns true on success. Call LastError() for the reason this call failed.
+
+
+
+
The documentation for this class was generated from the following files:
+
+
+
+
+
diff --git a/docs/class_aws_1_1_crt_1_1_crypto_1_1_symmetric_cipher-members.html b/docs/class_aws_1_1_crt_1_1_crypto_1_1_symmetric_cipher-members.html
new file mode 100644
index 000000000..a843f90d4
--- /dev/null
+++ b/docs/class_aws_1_1_crt_1_1_crypto_1_1_symmetric_cipher-members.html
@@ -0,0 +1,102 @@
+
+
+
+
+
+
+
+aws-crt-cpp: Member List
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ 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::SymmetricCipher , including all inherited members.
+
+ CreateAES_256_CBC_Cipher (const Optional< ByteCursor > &key=Optional< ByteCursor >(), const Optional< ByteCursor > &iv=Optional< ByteCursor >(), Allocator *allocator=ApiAllocator()) noexceptAws::Crt::Crypto::SymmetricCipher static
+ CreateAES_256_CTR_Cipher (const Optional< ByteCursor > &key=Optional< ByteCursor >(), const Optional< ByteCursor > &iv=Optional< ByteCursor >(), Allocator *allocator=ApiAllocator()) noexceptAws::Crt::Crypto::SymmetricCipher static
+ CreateAES_256_GCM_Cipher (const Optional< ByteCursor > &key=Optional< ByteCursor >(), const Optional< ByteCursor > &iv=Optional< ByteCursor >(), const Optional< ByteCursor > &aad=Optional< ByteCursor >(), Allocator *allocator=ApiAllocator()) noexceptAws::Crt::Crypto::SymmetricCipher static
+ CreateAES_256_KeyWrap_Cipher (const Optional< ByteCursor > &key=Optional< ByteCursor >(), Allocator *allocator=ApiAllocator()) noexceptAws::Crt::Crypto::SymmetricCipher static
+ Decrypt (const ByteCursor &toDecrypt, ByteBuf &out) noexceptAws::Crt::Crypto::SymmetricCipher
+ Encrypt (const ByteCursor &toEncrypt, ByteBuf &out) noexceptAws::Crt::Crypto::SymmetricCipher
+ FinalizeDecryption (ByteBuf &out) noexceptAws::Crt::Crypto::SymmetricCipher
+ FinalizeEncryption (ByteBuf &out) noexceptAws::Crt::Crypto::SymmetricCipher
+ GetIV () const noexceptAws::Crt::Crypto::SymmetricCipher
+ GetKey () const noexceptAws::Crt::Crypto::SymmetricCipher
+ GetState () const noexceptAws::Crt::Crypto::SymmetricCipher
+ GetTag () const noexceptAws::Crt::Crypto::SymmetricCipher
+ LastError () const noexceptAws::Crt::Crypto::SymmetricCipher inline
+ operator bool () const noexceptAws::Crt::Crypto::SymmetricCipher
+ operator= (const SymmetricCipher &)=deleteAws::Crt::Crypto::SymmetricCipher
+ operator= (SymmetricCipher &&) noexcept=defaultAws::Crt::Crypto::SymmetricCipher
+ Reset () noexceptAws::Crt::Crypto::SymmetricCipher
+ SetTag (ByteCursor tag) const noexceptAws::Crt::Crypto::SymmetricCipher
+ SymmetricCipher (const SymmetricCipher &)=deleteAws::Crt::Crypto::SymmetricCipher
+ SymmetricCipher (SymmetricCipher &&) noexcept=defaultAws::Crt::Crypto::SymmetricCipher
+
+
+
+
+
diff --git a/docs/class_aws_1_1_crt_1_1_crypto_1_1_symmetric_cipher.html b/docs/class_aws_1_1_crt_1_1_crypto_1_1_symmetric_cipher.html
new file mode 100644
index 000000000..289d17880
--- /dev/null
+++ b/docs/class_aws_1_1_crt_1_1_crypto_1_1_symmetric_cipher.html
@@ -0,0 +1,754 @@
+
+
+
+
+
+
+
+aws-crt-cpp: Aws::Crt::Crypto::SymmetricCipher Class Reference
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ aws-crt-cpp
+
+ C++ wrapper around the aws-c-* libraries. Provides Cross-Platform Transport Protocols and SSL/TLS implementations for C++.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
#include <SymmetricCipher.h >
+
+
+
+
◆ SymmetricCipher() [1/2]
+
+
+
+
+
+
+
+
+ Aws::Crt::Crypto::SymmetricCipher::SymmetricCipher
+ (
+ const SymmetricCipher &
+ )
+
+
+
+
+
+delete
+
+
+
+
+
+
+
+
◆ SymmetricCipher() [2/2]
+
+
+
+
+
+
+
+
+ Aws::Crt::Crypto::SymmetricCipher::SymmetricCipher
+ (
+ SymmetricCipher &&
+ )
+
+
+
+
+
+default noexcept
+
+
+
+
+
+
+
+
+
◆ CreateAES_256_CBC_Cipher()
+
+
+
+
+
+
+
+
+
+static noexcept
+
+
+
+
Creates an AES 256 CBC mode cipher using a provided key and iv. Key must be 32 bytes. If key or iv are not provided, they will be generated.
+
+
+
+
+
◆ CreateAES_256_CTR_Cipher()
+
+
+
+
+
+
+
+
+
+static noexcept
+
+
+
+
Creates an AES 256 CTR mode cipher using a provided key and iv. If key and iv are not provided, they will be generated.
+
+
+
+
+
◆ CreateAES_256_GCM_Cipher()
+
+
+
+
+
+
+
+
+
+static noexcept
+
+
+
+
Creates an AES 256 GCM mode cipher using a provided key, iv, tag, and aad if provided. Key and iv will be generated if not provided. AAD values are not generated. Provide AAD if you need to provide additional auth info.
+
+
+
+
+
◆ CreateAES_256_KeyWrap_Cipher()
+
+
+
+
+
+
+
+
+
+static noexcept
+
+
+
+
Creates an AES 256 Keywrap mode cipher using key if provided. If a key is not provided, one will be generated.
+
+
+
+
+
◆ Decrypt()
+
+
+
+
+
+
+
+
+ bool Aws::Crt::Crypto::SymmetricCipher::Decrypt
+ (
+ const ByteCursor &
+ toDecrypt ,
+
+
+
+
+ ByteBuf &
+ out
+
+
+
+ )
+
+
+
+
+
+noexcept
+
+
+
+
Decrypts the value in toEncrypt and stores any immediate results in out. Out can be dynamically re-sized if out is a dynamic byte buf. Otherwise, make sure the size of out is at least 1 block larger than the input to allow for padding. Returns true on success. Call LastError() for the reason this call failed.
+
+
+
+
+
◆ Encrypt()
+
+
+
+
+
+
+
+
+ bool Aws::Crt::Crypto::SymmetricCipher::Encrypt
+ (
+ const ByteCursor &
+ toEncrypt ,
+
+
+
+
+ ByteBuf &
+ out
+
+
+
+ )
+
+
+
+
+
+noexcept
+
+
+
+
Encrypts the value in toEncrypt and stores any immediate results in out. Out can be dynamically re-sized if out is a dynamic byte buf. Otherwise, make sure the size of out is at least 2 blocks larger than the input to allow for padding.
+
Returns true on success. Call LastError() for the reason this call failed.
+
+
+
+
+
◆ FinalizeDecryption()
+
+
+
+
+
+
+
+
+ bool Aws::Crt::Crypto::SymmetricCipher::FinalizeDecryption
+ (
+ ByteBuf &
+ out )
+
+
+
+
+
+noexcept
+
+
+
+
Decrypts any remaining data on the cipher and stores the output in out. Out can be dynamically re-sized if out is a dynamic byte buf. Otherwise, make sure the size of out is at least 2 blocks for CBC, CTR, GCM, and Keywrap modes.
+
Returns true on success. Call LastError() for the reason this call failed.
+
+
+
+
+
◆ FinalizeEncryption()
+
+
+
+
+
+
+
+
+ bool Aws::Crt::Crypto::SymmetricCipher::FinalizeEncryption
+ (
+ ByteBuf &
+ out )
+
+
+
+
+
+noexcept
+
+
+
+
Encrypts any remaining data on the cipher and stores the output in out. Out can be dynamically re-sized if out is a dynamic byte buf. Otherwise, make sure the size of out is at least 2 blocks for CBC, CTR, and GCM modes and 40 bytes for KeyWrap.
+
Returns true on success. Call LastError() for the reason this call failed.
+
+
+
+
+
◆ GetIV()
+
+
+
+
+
+
+
+
+ ByteCursor Aws::Crt::Crypto::SymmetricCipher::GetIV
+ (
+ )
+ const
+
+
+
+
+noexcept
+
+
+
+
Returns the initialization vector used for this cipher. This IV is not copied from the cipher so do not mutate this data. Copy if you need to pass it around anywhere.
+
+
+
+
+
◆ GetKey()
+
+
+
+
+
+
+
+
+ ByteCursor Aws::Crt::Crypto::SymmetricCipher::GetKey
+ (
+ )
+ const
+
+
+
+
+noexcept
+
+
+
+
Returns the key used for this cipher. This key is not copied from the cipher so do not mutate this data. Copy if you need to pass it around anywhere.
+
+
+
+
+
◆ GetState()
+
+
+
+
Returns current state of the cipher instance. ready to be used, finalized, or in a error state. If the cipher is in a finalized or error state it may not be used anymore
+
+
+
+
+
◆ GetTag()
+
+
+
+
+
+
+
+
+ ByteCursor Aws::Crt::Crypto::SymmetricCipher::GetTag
+ (
+ )
+ const
+
+
+
+
+noexcept
+
+
+
+
Returns the encryption tag generated during encryption operations for this cipher in GCM mode. This tag is not copied from the cipher so do not mutate this data. Copy if you need to pass it around anywhere.
+
+
+
+
+
◆ LastError()
+
+
+
+
+
+
+
+
+ int Aws::Crt::Crypto::SymmetricCipher::LastError
+ (
+ )
+ const
+
+
+
+
+inline noexcept
+
+
+
+
Returns the value of the last aws error encountered by operations on this instance.
+
+
+
+
+
◆ operator bool()
+
+
+
+
+
+
+
+
+ Aws::Crt::Crypto::SymmetricCipher::operator bool
+ (
+ )
+ const
+
+
+
+
+noexcept
+
+
+
+
Returns true if the instance is in a valid state, false otherwise.
+
+
+
+
+
◆ operator=() [1/2]
+
+
+
+
◆ operator=() [2/2]
+
+
+
+
+
+
+
+
+
+default noexcept
+
+
+
+
+
+
+
+
◆ Reset()
+
+
+
+
+
+
+
+
+ bool Aws::Crt::Crypto::SymmetricCipher::Reset
+ (
+ )
+
+
+
+
+
+noexcept
+
+
+
+
Reset to cipher to new state.
+
+
+
+
+
◆ SetTag()
+
+
+
+
+
+
+
+
+ void Aws::Crt::Crypto::SymmetricCipher::SetTag
+ (
+ ByteCursor
+ tag )
+ const
+
+
+
+
+noexcept
+
+
+
+
Sets the tag used during decryption operations for this cipher in GCM mode. No-op outside of GCM mode. In GCM mode, encrypt operation overrides the value of the tag.
+
+
+
+
The documentation for this class was generated from the following files:
+
+
+
+
+
diff --git a/docs/class_aws_1_1_crt_1_1_date_time-members.html b/docs/class_aws_1_1_crt_1_1_date_time-members.html
new file mode 100644
index 000000000..072dbcf90
--- /dev/null
+++ b/docs/class_aws_1_1_crt_1_1_date_time-members.html
@@ -0,0 +1,116 @@
+
+
+
+
+
+
+
+aws-crt-cpp: Member List
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ 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.
+
+
+
+
+
diff --git a/docs/class_aws_1_1_crt_1_1_date_time.html b/docs/class_aws_1_1_crt_1_1_date_time.html
new file mode 100644
index 000000000..4aabf379a
--- /dev/null
+++ b/docs/class_aws_1_1_crt_1_1_date_time.html
@@ -0,0 +1,1097 @@
+
+
+
+
+
+
+
+aws-crt-cpp: Aws::Crt::DateTime Class Reference
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ aws-crt-cpp
+
+ C++ wrapper around the aws-c-* libraries. Provides Cross-Platform Transport Protocols and SSL/TLS implementations for C++.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
#include <DateTime.h >
+
+
+
+
◆ DateTime() [1/5]
+
+
+
+
+
+
+
+
+ Aws::Crt::DateTime::DateTime
+ (
+ )
+
+
+
+
+
+noexcept
+
+
+
+
Initializes time point to epoch
+
+
+
+
+
◆ DateTime() [2/5]
+
+
+
+
+
+
+
+
+ Aws::Crt::DateTime::DateTime
+ (
+ const std::chrono::system_clock::time_point &
+ timepointToAssign )
+
+
+
+
+
+noexcept
+
+
+
+
Initializes time point to any other arbitrary timepoint
+
+
+
+
+
◆ DateTime() [3/5]
+
+
+
+
+
+
+
+
+ Aws::Crt::DateTime::DateTime
+ (
+ uint64_t
+ millisSinceEpoch )
+
+
+
+
+
+noexcept
+
+
+
+
Initializes time point to millis Since epoch
+
+
+
+
+
◆ DateTime() [4/5]
+
+
+
+
+
+
+
+
+ Aws::Crt::DateTime::DateTime
+ (
+ double
+ epoch_millis )
+
+
+
+
+
+noexcept
+
+
+
+
Initializes time point to epoch time in seconds.millis
+
+
+
+
+
◆ DateTime() [5/5]
+
+
+
+
+
+
+
+
+ Aws::Crt::DateTime::DateTime
+ (
+ const char *
+ timestamp ,
+
+
+
+
+ DateFormat
+ format
+
+
+
+ )
+
+
+
+
+
+noexcept
+
+
+
+
Initializes time point to value represented by timestamp and format.
+
+
+
+
+
+
◆ GetDay()
+
+
+
+
+
+
+
+
+ uint8_t Aws::Crt::DateTime::GetDay
+ (
+ bool
+ localTime = false
)
+ const
+
+
+
+
+noexcept
+
+
+
+
Get the Day of the Month portion of this dateTime. localTime if true, return local time, otherwise return UTC
+
+
+
+
+
◆ GetDayOfWeek()
+
+
+
+
+
+
+
+
+ DayOfWeek Aws::Crt::DateTime::GetDayOfWeek
+ (
+ bool
+ localTime = false
)
+ const
+
+
+
+
+noexcept
+
+
+
+
Get the Day of the Week portion of this dateTime. localTime if true, return local time, otherwise return UTC
+
+
+
+
+
◆ GetHour()
+
+
+
+
+
+
+
+
+ uint8_t Aws::Crt::DateTime::GetHour
+ (
+ bool
+ localTime = false
)
+ const
+
+
+
+
+noexcept
+
+
+
+
Get the Hour portion of this dateTime. localTime if true, return local time, otherwise return UTC
+
+
+
+
+
◆ GetLastError()
+
+
+
+
+
+
+
+
+ int Aws::Crt::DateTime::GetLastError
+ (
+ )
+ const
+
+
+
+
+noexcept
+
+
+
+
+
+
+
+
◆ GetMinute()
+
+
+
+
+
+
+
+
+ uint8_t Aws::Crt::DateTime::GetMinute
+ (
+ bool
+ localTime = false
)
+ const
+
+
+
+
+noexcept
+
+
+
+
Get the Minute portion of this dateTime. localTime if true, return local time, otherwise return UTC
+
+
+
+
+
◆ GetMonth()
+
+
+
+
+
+
+
+
+ Month Aws::Crt::DateTime::GetMonth
+ (
+ bool
+ localTime = false
)
+ const
+
+
+
+
+noexcept
+
+
+
+
Get the Month portion of this dateTime. localTime if true, return local time, otherwise return UTC
+
+
+
+
+
◆ GetSecond()
+
+
+
+
+
+
+
+
+ uint8_t Aws::Crt::DateTime::GetSecond
+ (
+ bool
+ localTime = false
)
+ const
+
+
+
+
+noexcept
+
+
+
+
Get the Second portion of this dateTime. localTime if true, return local time, otherwise return UTC
+
+
+
+
+
◆ GetYear()
+
+
+
+
+
+
+
+
+ uint16_t Aws::Crt::DateTime::GetYear
+ (
+ bool
+ localTime = false
)
+ const
+
+
+
+
+noexcept
+
+
+
+
Get the Year portion of this dateTime. localTime if true, return local time, otherwise return UTC
+
+
+
+
+
◆ IsDST()
+
+
+
+
+
+
+
+
+ bool Aws::Crt::DateTime::IsDST
+ (
+ bool
+ localTime = false
)
+ const
+
+
+
+
+noexcept
+
+
+
+
Get whether or not this dateTime is in Daylight savings time. localTime if true, return local time, otherwise return UTC
+
+
+
+
+
◆ Millis()
+
+
+
+
+
+
+
+
+ uint64_t Aws::Crt::DateTime::Millis
+ (
+ )
+ const
+
+
+
+
+noexcept
+
+
+
+
Milliseconds since epoch of this datetime.
+
+
+
+
+
◆ Now()
+
+
+
+
+
+
+
+
+ DateTime Aws::Crt::DateTime::Now
+ (
+ )
+
+
+
+
+
+static noexcept
+
+
+
+
Get an instance of DateTime representing this very instant.
+
+
+
+
+
◆ operator bool()
+
+
+
+
+
+
+
+
+ Aws::Crt::DateTime::operator bool
+ (
+ )
+ const
+
+
+
+
+explicit noexcept
+
+
+
+
+
+
+
+
◆ operator!=()
+
+
+
+
+
+
+
+
+ bool Aws::Crt::DateTime::operator!=
+ (
+ const DateTime &
+ other )
+ const
+
+
+
+
+noexcept
+
+
+
+
+
+
+
+
◆ operator+()
+
+
+
+
+
+
+
+
+ DateTime Aws::Crt::DateTime::operator+
+ (
+ const std::chrono::milliseconds &
+ a )
+ const
+
+
+
+
+noexcept
+
+
+
+
+
+
+
+
◆ operator-() [1/2]
+
+
+
+
+
+
+
+
+ std::chrono::milliseconds Aws::Crt::DateTime::operator-
+ (
+ const DateTime &
+ other )
+ const
+
+
+
+
+noexcept
+
+
+
+
Computes the difference between two DateTime instances and returns the difference in milliseconds.
+
+
+
+
+
◆ operator-() [2/2]
+
+
+
+
+
+
+
+
+ DateTime Aws::Crt::DateTime::operator-
+ (
+ const std::chrono::milliseconds &
+ a )
+ const
+
+
+
+
+noexcept
+
+
+
+
+
+
+
+
◆ operator<()
+
+
+
+
+
+
+
+
+ bool Aws::Crt::DateTime::operator<
+ (
+ const DateTime &
+ other )
+ const
+
+
+
+
+noexcept
+
+
+
+
+
+
+
+
◆ operator<=()
+
+
+
+
+
+
+
+
+ bool Aws::Crt::DateTime::operator<=
+ (
+ const DateTime &
+ other )
+ const
+
+
+
+
+noexcept
+
+
+
+
+
+
+
+
◆ operator=() [1/4]
+
+
+
+
+
+
+
+
+ DateTime & Aws::Crt::DateTime::operator=
+ (
+ const char *
+ timestamp )
+
+
+
+
+
+noexcept
+
+
+
+
Assign from an ISO8601 or RFC822 formatted string
+
+
+
+
+
◆ operator=() [2/4]
+
+
+
+
+
+
+
+
+ DateTime & Aws::Crt::DateTime::operator=
+ (
+ const std::chrono::system_clock::time_point &
+ timepointToAssign )
+
+
+
+
+
+noexcept
+
+
+
+
Assign from another time_point
+
+
+
+
+
◆ operator=() [3/4]
+
+
+
+
+
+
+
+
+ DateTime & Aws::Crt::DateTime::operator=
+ (
+ double
+ secondsSinceEpoch )
+
+
+
+
+
+noexcept
+
+
+
+
Assign from seconds.millis since epoch.
+
+
+
+
+
◆ operator=() [4/4]
+
+
+
+
+
+
+
+
+ DateTime & Aws::Crt::DateTime::operator=
+ (
+ uint64_t
+ millisSinceEpoch )
+
+
+
+
+
+noexcept
+
+
+
+
Assign from millis since epoch.
+
+
+
+
+
◆ operator==()
+
+
+
+
+
+
+
+
+ bool Aws::Crt::DateTime::operator==
+ (
+ const DateTime &
+ other )
+ const
+
+
+
+
+noexcept
+
+
+
+
+
+
+
+
◆ operator>()
+
+
+
+
+
+
+
+
+ bool Aws::Crt::DateTime::operator>
+ (
+ const DateTime &
+ other )
+ const
+
+
+
+
+noexcept
+
+
+
+
+
+
+
+
◆ operator>=()
+
+
+
+
+
+
+
+
+ bool Aws::Crt::DateTime::operator>=
+ (
+ const DateTime &
+ other )
+ const
+
+
+
+
+noexcept
+
+
+
+
+
+
+
+
◆ SecondsWithMSPrecision()
+
+
+
+
+
+
+
+
+ double Aws::Crt::DateTime::SecondsWithMSPrecision
+ (
+ )
+ const
+
+
+
+
+noexcept
+
+
+
+
Get the representation of this datetime as seconds.milliseconds since epoch
+
+
+
+
+
◆ ToGmtString()
+
+
+
+
+
+
+
+
+ bool Aws::Crt::DateTime::ToGmtString
+ (
+ DateFormat
+ format ,
+
+
+
+
+ ByteBuf &
+ outputBuf
+
+
+
+ )
+ const
+
+
+
+
+noexcept
+
+
+
+
Convert dateTime to GMT time string using predefined format.
+
+
+
+
+
◆ ToLocalTimeString()
+
+
+
+
+
+
+
+
+ bool Aws::Crt::DateTime::ToLocalTimeString
+ (
+ DateFormat
+ format ,
+
+
+
+
+ ByteBuf &
+ outputBuf
+
+
+
+ )
+ const
+
+
+
+
+noexcept
+
+
+
+
Convert dateTime to local time string using predefined format.
+
+
+
+
+
◆ UnderlyingTimestamp()
+
+
+
+
+
+
+
+
+ std::chrono::system_clock::time_point Aws::Crt::DateTime::UnderlyingTimestamp
+ (
+ )
+ const
+
+
+
+
+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.
+
+
+
+
The documentation for this class was generated from the following files:
+
+
+
+
+
diff --git a/docs/class_aws_1_1_crt_1_1_endpoints_1_1_request_context-members.html b/docs/class_aws_1_1_crt_1_1_endpoints_1_1_request_context-members.html
new file mode 100644
index 000000000..cdac3f7b3
--- /dev/null
+++ b/docs/class_aws_1_1_crt_1_1_endpoints_1_1_request_context-members.html
@@ -0,0 +1,92 @@
+
+
+
+
+
+
+
+aws-crt-cpp: Member List
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ 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.
+
+
+
+
+
diff --git a/docs/class_aws_1_1_crt_1_1_endpoints_1_1_request_context.html b/docs/class_aws_1_1_crt_1_1_endpoints_1_1_request_context.html
new file mode 100644
index 000000000..322759f7e
--- /dev/null
+++ b/docs/class_aws_1_1_crt_1_1_endpoints_1_1_request_context.html
@@ -0,0 +1,371 @@
+
+
+
+
+
+
+
+aws-crt-cpp: Aws::Crt::Endpoints::RequestContext Class Reference
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ aws-crt-cpp
+
+ C++ wrapper around the aws-c-* libraries. Provides Cross-Platform Transport Protocols and SSL/TLS implementations for C++.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
#include <RuleEngine.h >
+
+
+
+
◆ RequestContext() [1/3]
+
+
+
+
+
+
+
+
+ Aws::Crt::Endpoints::RequestContext::RequestContext
+ (
+ Allocator *
+ allocator = ApiAllocator ()
)
+
+
+
+
+
+noexcept
+
+
+
+
+
+
+
+
◆ ~RequestContext()
+
+
+
+
+
+ Aws::Crt::Endpoints::RequestContext::~RequestContext
+ (
+ )
+
+
+
+
+
+
+
+
+
◆ RequestContext() [2/3]
+
+
+
+
+
+
+
+
+ Aws::Crt::Endpoints::RequestContext::RequestContext
+ (
+ const RequestContext &
+ )
+
+
+
+
+
+delete
+
+
+
+
+
+
+
+
◆ RequestContext() [3/3]
+
+
+
+
+
+
+
+
+ Aws::Crt::Endpoints::RequestContext::RequestContext
+ (
+ RequestContext &&
+ )
+
+
+
+
+
+delete
+
+
+
+
+
+
+
+
+
◆ AddBoolean()
+
+
+
+
+
+ bool Aws::Crt::Endpoints::RequestContext::AddBoolean
+ (
+ const ByteCursor &
+ name ,
+
+
+
+
+ bool
+ value
+
+
+
+ )
+
+
+
+
+
+
+
+
+
◆ AddString()
+
+
+
+
+
+ bool Aws::Crt::Endpoints::RequestContext::AddString
+ (
+ const ByteCursor &
+ name ,
+
+
+
+
+ const ByteCursor &
+ value
+
+
+
+ )
+
+
+
+
+
+
+
+
+
◆ AddStringArray()
+
+
+
+
+
+ bool Aws::Crt::Endpoints::RequestContext::AddStringArray
+ (
+ const ByteCursor &
+ name ,
+
+
+
+
+ const Vector < ByteCursor > &
+ value
+
+
+
+ )
+
+
+
+
+
+
+
+
+
◆ operator bool()
+
+
+
+
+
+
+
+
+ Aws::Crt::Endpoints::RequestContext::operator bool
+ (
+ )
+ const
+
+
+
+
+inline noexcept
+
+
+
+
Returns true if the instance is in a valid state, false otherwise.
+
+
+
+
+
◆ operator=() [1/2]
+
+
+
+
◆ operator=() [2/2]
+
+
+
The documentation for this class was generated from the following files:
+
+
+
+
+
diff --git a/docs/class_aws_1_1_crt_1_1_endpoints_1_1_resolution_outcome-members.html b/docs/class_aws_1_1_crt_1_1_endpoints_1_1_resolution_outcome-members.html
new file mode 100644
index 000000000..0822eddaa
--- /dev/null
+++ b/docs/class_aws_1_1_crt_1_1_endpoints_1_1_resolution_outcome-members.html
@@ -0,0 +1,94 @@
+
+
+
+
+
+
+
+aws-crt-cpp: Member List
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ 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.
+
+
+
+
+
diff --git a/docs/class_aws_1_1_crt_1_1_endpoints_1_1_resolution_outcome.html b/docs/class_aws_1_1_crt_1_1_endpoints_1_1_resolution_outcome.html
new file mode 100644
index 000000000..0ad366c65
--- /dev/null
+++ b/docs/class_aws_1_1_crt_1_1_endpoints_1_1_resolution_outcome.html
@@ -0,0 +1,375 @@
+
+
+
+
+
+
+
+aws-crt-cpp: Aws::Crt::Endpoints::ResolutionOutcome Class Reference
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ aws-crt-cpp
+
+ C++ wrapper around the aws-c-* libraries. Provides Cross-Platform Transport Protocols and SSL/TLS implementations for C++.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
#include <RuleEngine.h >
+
+
+
+
◆ ~ResolutionOutcome()
+
+
+
+
+
+ Aws::Crt::Endpoints::ResolutionOutcome::~ResolutionOutcome
+ (
+ )
+
+
+
+
+
+
+
+
+
◆ ResolutionOutcome() [1/2]
+
+
+
+
+
+
+
+
+ Aws::Crt::Endpoints::ResolutionOutcome::ResolutionOutcome
+ (
+ const ResolutionOutcome &
+ )
+
+
+
+
+
+delete
+
+
+
+
+
+
+
+
◆ ResolutionOutcome() [2/2]
+
+
+
+
+
+
+
+
+ Aws::Crt::Endpoints::ResolutionOutcome::ResolutionOutcome
+ (
+ ResolutionOutcome &&
+ toMove )
+
+
+
+
+
+noexcept
+
+
+
+
+
+
+
+
+
◆ GetError()
+
+
+
+
+
+ Optional < StringView > Aws::Crt::Endpoints::ResolutionOutcome::GetError
+ (
+ )
+ const
+
+
+
+
+
+
+
+
◆ GetHeaders()
+
+
+
+
◆ GetProperties()
+
+
+
+
+
+ Optional < StringView > Aws::Crt::Endpoints::ResolutionOutcome::GetProperties
+ (
+ )
+ const
+
+
+
+
+
+
+
+
◆ GetUrl()
+
+
+
+
+
+ Optional < StringView > Aws::Crt::Endpoints::ResolutionOutcome::GetUrl
+ (
+ )
+ const
+
+
+
+
+
+
+
+
◆ IsEndpoint()
+
+
+
+
+
+
+
+
+ bool Aws::Crt::Endpoints::ResolutionOutcome::IsEndpoint
+ (
+ )
+ const
+
+
+
+
+noexcept
+
+
+
+
+
+
+
+
◆ IsError()
+
+
+
+
+
+
+
+
+ bool Aws::Crt::Endpoints::ResolutionOutcome::IsError
+ (
+ )
+ const
+
+
+
+
+noexcept
+
+
+
+
+
+
+
+
◆ operator bool()
+
+
+
+
+
+
+
+
+ Aws::Crt::Endpoints::ResolutionOutcome::operator bool
+ (
+ )
+ const
+
+
+
+
+inline noexcept
+
+
+
+
Returns true if the instance is in a valid state, false otherwise.
+
+
+
+
+
◆ operator=() [1/2]
+
+
+
+
◆ operator=() [2/2]
+
+
+
The documentation for this class was generated from the following files:
+
+
+
+
+
diff --git a/docs/class_aws_1_1_crt_1_1_endpoints_1_1_rule_engine-members.html b/docs/class_aws_1_1_crt_1_1_endpoints_1_1_rule_engine-members.html
new file mode 100644
index 000000000..250fa5c5e
--- /dev/null
+++ b/docs/class_aws_1_1_crt_1_1_endpoints_1_1_rule_engine-members.html
@@ -0,0 +1,90 @@
+
+
+
+
+
+
+
+aws-crt-cpp: Member List
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ 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.
+
+
+
+
+
diff --git a/docs/class_aws_1_1_crt_1_1_endpoints_1_1_rule_engine.html b/docs/class_aws_1_1_crt_1_1_endpoints_1_1_rule_engine.html
new file mode 100644
index 000000000..2a790ca08
--- /dev/null
+++ b/docs/class_aws_1_1_crt_1_1_endpoints_1_1_rule_engine.html
@@ -0,0 +1,319 @@
+
+
+
+
+
+
+
+aws-crt-cpp: Aws::Crt::Endpoints::RuleEngine Class Reference
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ aws-crt-cpp
+
+ C++ wrapper around the aws-c-* libraries. Provides Cross-Platform Transport Protocols and SSL/TLS implementations for C++.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
#include <RuleEngine.h >
+
+
+
+
+
◆ RuleEngine() [1/3]
+
+
+
+
+
+
+
+
+ Aws::Crt::Endpoints::RuleEngine::RuleEngine
+ (
+ const ByteCursor &
+ rulesetCursor ,
+
+
+
+
+ const ByteCursor &
+ partitionsCursor ,
+
+
+
+
+ Allocator *
+ allocator = ApiAllocator ()
+
+
+
+ )
+
+
+
+
+
+noexcept
+
+
+
+
+
+
+
+
◆ ~RuleEngine()
+
+
+
+
+
+ Aws::Crt::Endpoints::RuleEngine::~RuleEngine
+ (
+ )
+
+
+
+
+
+
+
+
+
◆ RuleEngine() [2/3]
+
+
+
+
+
+
+
+
+ Aws::Crt::Endpoints::RuleEngine::RuleEngine
+ (
+ const RuleEngine &
+ )
+
+
+
+
+
+delete
+
+
+
+
+
+
+
+
◆ RuleEngine() [3/3]
+
+
+
+
+
+
+
+
+ Aws::Crt::Endpoints::RuleEngine::RuleEngine
+ (
+ RuleEngine &&
+ )
+
+
+
+
+
+delete
+
+
+
+
+
+
+
+
+
◆ operator bool()
+
+
+
+
+
+
+
+
+ Aws::Crt::Endpoints::RuleEngine::operator bool
+ (
+ )
+ const
+
+
+
+
+inline noexcept
+
+
+
+
Returns true if the instance is in a valid state, false otherwise.
+
+
+
+
+
◆ operator=() [1/2]
+
+
+
+
◆ operator=() [2/2]
+
+
+
+
◆ Resolve()
+
+
+
The documentation for this class was generated from the following files:
+
+
+
+
+
diff --git a/docs/class_aws_1_1_crt_1_1_http_1_1_adaptive_http_proxy_strategy-members.html b/docs/class_aws_1_1_crt_1_1_http_1_1_adaptive_http_proxy_strategy-members.html
new file mode 100644
index 000000000..b4aeef61f
--- /dev/null
+++ b/docs/class_aws_1_1_crt_1_1_http_1_1_adaptive_http_proxy_strategy-members.html
@@ -0,0 +1,92 @@
+
+
+
+
+
+
+
+aws-crt-cpp: Member List
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ 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.
+
+
+
+
+
diff --git a/docs/class_aws_1_1_crt_1_1_http_1_1_adaptive_http_proxy_strategy.html b/docs/class_aws_1_1_crt_1_1_http_1_1_adaptive_http_proxy_strategy.html
new file mode 100644
index 000000000..8e9d77a4d
--- /dev/null
+++ b/docs/class_aws_1_1_crt_1_1_http_1_1_adaptive_http_proxy_strategy.html
@@ -0,0 +1,318 @@
+
+
+
+
+
+
+
+aws-crt-cpp: Aws::Crt::Http::AdaptiveHttpProxyStrategy Class Reference
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ aws-crt-cpp
+
+ C++ wrapper around the aws-c-* libraries. Provides Cross-Platform Transport Protocols and SSL/TLS implementations for C++.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+struct aws_http_proxy_strategy * m_strategy
+
+
+
+
+
◆ AdaptiveHttpProxyStrategy()
+
+
+
+
+
◆ KerberosGetToken()
+
+
+
+
+
+
+
+
+ static struct aws_string* Aws::Crt::Http::AdaptiveHttpProxyStrategy::KerberosGetToken
+ (
+ void *
+ user_data ,
+
+
+
+
+ int *
+ error_code
+
+
+
+ )
+
+
+
+
+
+inline static
+
+
+
+
+
+
+
+
◆ NtlmGetCredential()
+
+
+
+
+
+
+
+
+ static struct aws_string* Aws::Crt::Http::AdaptiveHttpProxyStrategy::NtlmGetCredential
+ (
+ void *
+ user_data ,
+
+
+
+
+ int *
+ error_code
+
+
+
+ )
+
+
+
+
+
+inline static
+
+
+
+
+
+
+
+
◆ NtlmGetToken()
+
+
+
+
+
+
+
+
+ static struct aws_string* Aws::Crt::Http::AdaptiveHttpProxyStrategy::NtlmGetToken
+ (
+ void *
+ user_data ,
+
+
+
+
+ const struct aws_byte_cursor *
+ challenge_cursor ,
+
+
+
+
+ int *
+ error_code
+
+
+
+ )
+
+
+
+
+
+inline static
+
+
+
+
+
+
+
+
◆ SetStrategy()
+
+
+
+
+
+
+
+
+ void Aws::Crt::Http::AdaptiveHttpProxyStrategy::SetStrategy
+ (
+ struct aws_http_proxy_strategy *
+ strategy )
+
+
+
+
+
+inline
+
+
+
+
+
+
+
The documentation for this class was generated from the following file:
+
+
+
+
+
diff --git a/docs/class_aws_1_1_crt_1_1_http_1_1_adaptive_http_proxy_strategy.png b/docs/class_aws_1_1_crt_1_1_http_1_1_adaptive_http_proxy_strategy.png
new file mode 100644
index 000000000..3a2212105
Binary files /dev/null and b/docs/class_aws_1_1_crt_1_1_http_1_1_adaptive_http_proxy_strategy.png differ
diff --git a/docs/class_aws_1_1_crt_1_1_http_1_1_http_client_connection-members.html b/docs/class_aws_1_1_crt_1_1_http_1_1_http_client_connection-members.html
new file mode 100644
index 000000000..9a653f089
--- /dev/null
+++ b/docs/class_aws_1_1_crt_1_1_http_1_1_http_client_connection-members.html
@@ -0,0 +1,95 @@
+
+
+
+
+
+
+
+aws-crt-cpp: Member List
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ 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.
+
+
+
+
+
diff --git a/docs/class_aws_1_1_crt_1_1_http_1_1_http_client_connection.html b/docs/class_aws_1_1_crt_1_1_http_1_1_http_client_connection.html
new file mode 100644
index 000000000..3c26ae9f3
--- /dev/null
+++ b/docs/class_aws_1_1_crt_1_1_http_1_1_http_client_connection.html
@@ -0,0 +1,505 @@
+
+
+
+
+
+
+
+aws-crt-cpp: Aws::Crt::Http::HttpClientConnection Class Reference
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ aws-crt-cpp
+
+ C++ wrapper around the aws-c-* libraries. Provides Cross-Platform Transport Protocols and SSL/TLS implementations for C++.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
#include <HttpConnection.h >
+
+
+
+
+
+
+
+
+
+
+
+
Represents a connection from a Http Client to a Server.
+
+
+
◆ ~HttpClientConnection()
+
+
+
+
+
+
+
+
+ virtual Aws::Crt::Http::HttpClientConnection::~HttpClientConnection
+ (
+ )
+
+
+
+
+
+virtual default
+
+
+
+
+
+
+
+
◆ HttpClientConnection() [1/3]
+
+
+
+
+
+
+
+
+ Aws::Crt::Http::HttpClientConnection::HttpClientConnection
+ (
+ const HttpClientConnection &
+ )
+
+
+
+
+
+delete
+
+
+
+
+
+
+
+
◆ HttpClientConnection() [2/3]
+
+
+
+
+
+
+
+
+ Aws::Crt::Http::HttpClientConnection::HttpClientConnection
+ (
+ HttpClientConnection &&
+ )
+
+
+
+
+
+delete
+
+
+
+
+
+
+
+
◆ HttpClientConnection() [3/3]
+
+
+
+
+
+
+
+
+ Aws::Crt::Http::HttpClientConnection::HttpClientConnection
+ (
+ aws_http_connection *
+ m_connection ,
+
+
+
+
+ Allocator *
+ allocator
+
+
+
+ )
+
+
+
+
+
+protected noexcept
+
+
+
+
+
+
+
+
+
◆ Close()
+
+
+
+
+
+
+
+
+ void Aws::Crt::Http::HttpClientConnection::Close
+ (
+ )
+
+
+
+
+
+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.
+
+
+
+
+
◆ CreateConnection()
+
+
+
+
+
+
+
+
+
+static noexcept
+
+
+
+
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.
+
+
+
+
+
◆ GetVersion()
+
+
+
+
+
+
+
+
+ HttpVersion Aws::Crt::Http::HttpClientConnection::GetVersion
+ (
+ )
+
+
+
+
+
+noexcept
+
+
+
+
Returns protocol version the connection used
+
+
+
+
+
◆ IsOpen()
+
+
+
+
+
+
+
+
+ bool Aws::Crt::Http::HttpClientConnection::IsOpen
+ (
+ )
+ const
+
+
+
+
+noexcept
+
+
+
+
Returns true unless the connection is closed or closing.
+
+
+
+
+
◆ LastError()
+
+
+
+
+
+
+
+
+ int Aws::Crt::Http::HttpClientConnection::LastError
+ (
+ )
+ const
+
+
+
+
+inline noexcept
+
+
+
+
Returns the value of the last aws error encountered by operations on this instance.
+
+
+
+
+
◆ NewClientStream()
+
+
+
+
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.
+
+
+
+
+
◆ operator=() [1/2]
+
+
+
+
◆ operator=() [2/2]
+
+
+
+
+
◆ m_connection
+
+
+
+
+
+
+
+
+ aws_http_connection* Aws::Crt::Http::HttpClientConnection::m_connection
+
+
+
+
+protected
+
+
+
+
+
+
+
The documentation for this class was generated from the following files:
+
+
+
+
+
diff --git a/docs/class_aws_1_1_crt_1_1_http_1_1_http_client_connection.png b/docs/class_aws_1_1_crt_1_1_http_1_1_http_client_connection.png
new file mode 100644
index 000000000..3781ac092
Binary files /dev/null and b/docs/class_aws_1_1_crt_1_1_http_1_1_http_client_connection.png differ
diff --git a/docs/class_aws_1_1_crt_1_1_http_1_1_http_client_connection_manager-members.html b/docs/class_aws_1_1_crt_1_1_http_1_1_http_client_connection_manager-members.html
new file mode 100644
index 000000000..b63fe9b75
--- /dev/null
+++ b/docs/class_aws_1_1_crt_1_1_http_1_1_http_client_connection_manager-members.html
@@ -0,0 +1,87 @@
+
+
+
+
+
+
+
+aws-crt-cpp: Member List
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ 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.
+
+
+
+
+
diff --git a/docs/class_aws_1_1_crt_1_1_http_1_1_http_client_connection_manager.html b/docs/class_aws_1_1_crt_1_1_http_1_1_http_client_connection_manager.html
new file mode 100644
index 000000000..97d27c51b
--- /dev/null
+++ b/docs/class_aws_1_1_crt_1_1_http_1_1_http_client_connection_manager.html
@@ -0,0 +1,265 @@
+
+
+
+
+
+
+
+aws-crt-cpp: Aws::Crt::Http::HttpClientConnectionManager Class Reference
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ aws-crt-cpp
+
+ C++ wrapper around the aws-c-* libraries. Provides Cross-Platform Transport Protocols and SSL/TLS implementations for C++.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
#include <HttpConnectionManager.h >
+
+
+
+
+
+
+
+
Manages a pool of connections to a specific endpoint using the same socket and tls options.
+
+
+
◆ ~HttpClientConnectionManager()
+
+
+
+
+
+ Aws::Crt::Http::HttpClientConnectionManager::~HttpClientConnectionManager
+ (
+ )
+
+
+
+
+
+
+
+
+
+
◆ AcquireConnection()
+
+
+
+
+
+
+
+
+ bool Aws::Crt::Http::HttpClientConnectionManager::AcquireConnection
+ (
+ const OnClientConnectionAvailable &
+ onClientConnectionAvailable )
+
+
+
+
+
+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.
+
Parameters
+
+ onClientConnectionAvailable callback to invoke when a connection becomes available or the acquisition attempt terminates
+
+
+
+
Returns true if the acquisition was successfully kicked off, false otherwise (no callback)
+
+
+
+
+
◆ InitiateShutdown()
+
+
+
+
+
+
+
+
+ std::future< void > Aws::Crt::Http::HttpClientConnectionManager::InitiateShutdown
+ (
+ )
+
+
+
+
+
+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.
Returns future which will complete when shutdown has completed
+
+
+
+
+
◆ NewClientConnectionManager()
+
+
+
+
+
+
+
+
+
+static noexcept
+
+
+
+
Factory function for connection managers
+
Parameters
+
+ connectionManagerOptions connection manager configuration data
+ allocator allocator to use
+
+
+
+
Returns a new connection manager instance
+
+
+
+
+
+
◆ ManagedConnection
+
+
+
The documentation for this class was generated from the following files:
+
+
+
+
+
diff --git a/docs/class_aws_1_1_crt_1_1_http_1_1_http_client_connection_manager.png b/docs/class_aws_1_1_crt_1_1_http_1_1_http_client_connection_manager.png
new file mode 100644
index 000000000..6f717a310
Binary files /dev/null and b/docs/class_aws_1_1_crt_1_1_http_1_1_http_client_connection_manager.png differ
diff --git a/docs/class_aws_1_1_crt_1_1_http_1_1_http_client_connection_manager_options-members.html b/docs/class_aws_1_1_crt_1_1_http_1_1_http_client_connection_manager_options-members.html
new file mode 100644
index 000000000..b5d8b08df
--- /dev/null
+++ b/docs/class_aws_1_1_crt_1_1_http_1_1_http_client_connection_manager_options-members.html
@@ -0,0 +1,90 @@
+
+
+
+
+
+
+
+aws-crt-cpp: Member List
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ 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.
+
+
+
+
+
diff --git a/docs/class_aws_1_1_crt_1_1_http_1_1_http_client_connection_manager_options.html b/docs/class_aws_1_1_crt_1_1_http_1_1_http_client_connection_manager_options.html
new file mode 100644
index 000000000..f1a3baae0
--- /dev/null
+++ b/docs/class_aws_1_1_crt_1_1_http_1_1_http_client_connection_manager_options.html
@@ -0,0 +1,291 @@
+
+
+
+
+
+
+
+aws-crt-cpp: Aws::Crt::Http::HttpClientConnectionManagerOptions Class Reference
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ aws-crt-cpp
+
+ C++ wrapper around the aws-c-* libraries. Provides Cross-Platform Transport Protocols and SSL/TLS implementations for C++.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
#include <HttpConnectionManager.h >
+
+
+
Configuration struct containing all options related to connection manager behavior
+
+
+
◆ HttpClientConnectionManagerOptions() [1/3]
+
+
+
+
+
+
+
+
+ Aws::Crt::Http::HttpClientConnectionManagerOptions::HttpClientConnectionManagerOptions
+ (
+ )
+
+
+
+
+
+noexcept
+
+
+
+
+
+
+
+
◆ HttpClientConnectionManagerOptions() [2/3]
+
+
+
+
◆ HttpClientConnectionManagerOptions() [3/3]
+
+
+
+
+
◆ operator=() [1/2]
+
+
+
+
◆ operator=() [2/2]
+
+
+
+
+
◆ ConnectionOptions
+
+
+
+
The http connection options to use for each connection created by the manager
+
+
+
+
+
◆ EnableBlockingShutdown
+
+
+
+
+
+ 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.
+
+
+
+
+
◆ MaxConnections
+
+
+
+
+
+ size_t Aws::Crt::Http::HttpClientConnectionManagerOptions::MaxConnections
+
+
+
+
The maximum number of connections the manager is allowed to create/manage
+
+
+
+
The documentation for this class was generated from the following files:
+
+
+
+
+
diff --git a/docs/class_aws_1_1_crt_1_1_http_1_1_http_client_connection_options-members.html b/docs/class_aws_1_1_crt_1_1_http_1_1_http_client_connection_options-members.html
new file mode 100644
index 000000000..6937a0595
--- /dev/null
+++ b/docs/class_aws_1_1_crt_1_1_http_1_1_http_client_connection_options-members.html
@@ -0,0 +1,98 @@
+
+
+
+
+
+
+
+aws-crt-cpp: Member List
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ 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.
+
+
+
+
+
diff --git a/docs/class_aws_1_1_crt_1_1_http_1_1_http_client_connection_options.html b/docs/class_aws_1_1_crt_1_1_http_1_1_http_client_connection_options.html
new file mode 100644
index 000000000..0e896a1d7
--- /dev/null
+++ b/docs/class_aws_1_1_crt_1_1_http_1_1_http_client_connection_options.html
@@ -0,0 +1,429 @@
+
+
+
+
+
+
+
+aws-crt-cpp: Aws::Crt::Http::HttpClientConnectionOptions Class Reference
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ aws-crt-cpp
+
+ C++ wrapper around the aws-c-* libraries. Provides Cross-Platform Transport Protocols and SSL/TLS implementations for C++.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
#include <HttpConnection.h >
+
+
+
Configuration structure holding all options relating to http connection establishment
+
+
+
◆ HttpClientConnectionOptions() [1/3]
+
+
+
+
+
+ Aws::Crt::Http::HttpClientConnectionOptions::HttpClientConnectionOptions
+ (
+ )
+
+
+
+
+
+
+
+
+
◆ HttpClientConnectionOptions() [2/3]
+
+
+
+
◆ HttpClientConnectionOptions() [3/3]
+
+
+
+
◆ ~HttpClientConnectionOptions()
+
+
+
+
+
+
+
+
+ Aws::Crt::Http::HttpClientConnectionOptions::~HttpClientConnectionOptions
+ (
+ )
+
+
+
+
+
+default
+
+
+
+
+
+
+
+
+
◆ operator=() [1/2]
+
+
+
+
◆ operator=() [2/2]
+
+
+
+
+
◆ Bootstrap
+
+
+
+
◆ HostName
+
+
+
+
+
+ String Aws::Crt::Http::HttpClientConnectionOptions::HostName
+
+
+
+
The name of the http server to connect to. Required.
+
+
+
+
+
◆ InitialWindowSize
+
+
+
+
+
+ size_t Aws::Crt::Http::HttpClientConnectionOptions::InitialWindowSize
+
+
+
+
The TCP read window allowed for Http 1.1 connections and Initial Windows for H2 connections.
+
+
+
+
+
◆ ManualWindowManagement
+
+
+
+
+
+ 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.
+
+
+
+
+
◆ OnConnectionSetupCallback
+
+
+
+
+
+ OnConnectionSetup Aws::Crt::Http::HttpClientConnectionOptions::OnConnectionSetupCallback
+
+
+
+
The callback invoked on connection establishment, whether success or failure. See OnConnectionSetup
for more info. Required.
+
+
+
+
+
◆ OnConnectionShutdownCallback
+
+
+
+
+
+ OnConnectionShutdown Aws::Crt::Http::HttpClientConnectionOptions::OnConnectionShutdownCallback
+
+
+
+
The callback invoked on connection shutdown. See OnConnectionShutdown
for more info. Required.
+
+
+
+
+
◆ Port
+
+
+
+
+
+ uint32_t Aws::Crt::Http::HttpClientConnectionOptions::Port
+
+
+
+
The port of the http server to connect to. Required.
+
+
+
+
+
◆ ProxyOptions
+
+
+
+
The proxy options for the http connection. Optional .
+
+
+
+
+
◆ SocketOptions
+
+
+
+
The socket options of the connection. Required.
+
+
+
+
+
◆ TlsOptions
+
+
+
+
The TLS options for the http connection. Optional .
+
+
+
+
The documentation for this class was generated from the following files:
+
+
+
+
+
diff --git a/docs/class_aws_1_1_crt_1_1_http_1_1_http_client_connection_proxy_options-members.html b/docs/class_aws_1_1_crt_1_1_http_1_1_http_client_connection_proxy_options-members.html
new file mode 100644
index 000000000..102fc0efa
--- /dev/null
+++ b/docs/class_aws_1_1_crt_1_1_http_1_1_http_client_connection_proxy_options-members.html
@@ -0,0 +1,97 @@
+
+
+
+
+
+
+
+aws-crt-cpp: Member List
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ 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.
+
+
+
+
+
diff --git a/docs/class_aws_1_1_crt_1_1_http_1_1_http_client_connection_proxy_options.html b/docs/class_aws_1_1_crt_1_1_http_1_1_http_client_connection_proxy_options.html
new file mode 100644
index 000000000..cb831df93
--- /dev/null
+++ b/docs/class_aws_1_1_crt_1_1_http_1_1_http_client_connection_proxy_options.html
@@ -0,0 +1,423 @@
+
+
+
+
+
+
+
+aws-crt-cpp: Aws::Crt::Http::HttpClientConnectionProxyOptions Class Reference
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ aws-crt-cpp
+
+ C++ wrapper around the aws-c-* libraries. Provides Cross-Platform Transport Protocols and SSL/TLS implementations for C++.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
#include <HttpConnection.h >
+
+
+
Configuration structure that holds all proxy-related http connection options
+
+
+
◆ HttpClientConnectionProxyOptions() [1/3]
+
+
+
+
+
+ Aws::Crt::Http::HttpClientConnectionProxyOptions::HttpClientConnectionProxyOptions
+ (
+ )
+
+
+
+
+
+
+
+
+
◆ HttpClientConnectionProxyOptions() [2/3]
+
+
+
+
◆ HttpClientConnectionProxyOptions() [3/3]
+
+
+
+
◆ ~HttpClientConnectionProxyOptions()
+
+
+
+
+
+
+
+
+ Aws::Crt::Http::HttpClientConnectionProxyOptions::~HttpClientConnectionProxyOptions
+ (
+ )
+
+
+
+
+
+default
+
+
+
+
+
+
+
+
+
◆ InitializeRawProxyOptions()
+
+
+
+
+
+ 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.
+
Parameters
+
+ raw_options - output parameter containing low level proxy options to be passed to the C interface
+
+
+
+
+
+
+
+
◆ operator=() [1/2]
+
+
+
+
◆ operator=() [2/2]
+
+
+
+
+
◆ AuthType
+
+
+
+
Deprecated: What kind of authentication approach to use when connecting to the proxy Replaced by proxy strategy
+
Backwards compatibility achieved by invoking CreateBasicHttpProxyStrategy if (1) ProxyStrategy is null (2) AuthType is AwsHttpProxyAuthenticationType::Basic
+
+
+
+
+
◆ BasicAuthPassword
+
+
+
+
+
+ String Aws::Crt::Http::HttpClientConnectionProxyOptions::BasicAuthPassword
+
+
+
+
Deprecated: The password to use if connecting to the proxy via basic authentication Replaced by using the result of CreateBasicHttpProxyStrategy()
+
+
+
+
+
◆ BasicAuthUsername
+
+
+
+
+
+ String Aws::Crt::Http::HttpClientConnectionProxyOptions::BasicAuthUsername
+
+
+
+
Deprecated: The username to use if connecting to the proxy via basic authentication Replaced by using the result of CreateBasicHttpProxyStrategy()
+
+
+
+
+
◆ HostName
+
+
+
+
+
+ String Aws::Crt::Http::HttpClientConnectionProxyOptions::HostName
+
+
+
+
The name of the proxy server to connect through. Required.
+
+
+
+
+
◆ Port
+
+
+
+
+
+ uint32_t Aws::Crt::Http::HttpClientConnectionProxyOptions::Port
+
+
+
+
The port of the proxy server to connect to. Required.
+
+
+
+
+
◆ ProxyConnectionType
+
+
+
+
What kind of proxy connection to make
+
+
+
+
+
◆ ProxyStrategy
+
+
+
+
+
+ std::shared_ptr<HttpProxyStrategy > Aws::Crt::Http::HttpClientConnectionProxyOptions::ProxyStrategy
+
+
+
+
Proxy strategy to use while negotiating the connection. Use null for no additional steps.
+
+
+
+
+
◆ TlsOptions
+
+
+
+
Sets the TLS options for the connection to the proxy. Optional .
+
+
+
+
The documentation for this class was generated from the following files:
+
+
+
+
+
diff --git a/docs/class_aws_1_1_crt_1_1_http_1_1_http_client_stream-members.html b/docs/class_aws_1_1_crt_1_1_http_1_1_http_client_stream-members.html
new file mode 100644
index 000000000..9d5fc8601
--- /dev/null
+++ b/docs/class_aws_1_1_crt_1_1_http_1_1_http_client_stream-members.html
@@ -0,0 +1,100 @@
+
+
+
+
+
+
+
+aws-crt-cpp: Member List
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ 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.
+
+
+
+
+
diff --git a/docs/class_aws_1_1_crt_1_1_http_1_1_http_client_stream.html b/docs/class_aws_1_1_crt_1_1_http_1_1_http_client_stream.html
new file mode 100644
index 000000000..12e114fe5
--- /dev/null
+++ b/docs/class_aws_1_1_crt_1_1_http_1_1_http_client_stream.html
@@ -0,0 +1,350 @@
+
+
+
+
+
+
+
+aws-crt-cpp: Aws::Crt::Http::HttpClientStream Class Reference
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ aws-crt-cpp
+
+ C++ wrapper around the aws-c-* libraries. Provides Cross-Platform Transport Protocols and SSL/TLS implementations for C++.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
#include <HttpConnection.h >
+
+
+
+
+
+
+
+
+
+
+
Subclass that represents an http client's view of an HttpStream .
+
+
+
◆ ~HttpClientStream()
+
+
+
+
+
+ Aws::Crt::Http::HttpClientStream::~HttpClientStream
+ (
+ )
+
+
+
+
+
+
+
+
+
◆ HttpClientStream() [1/2]
+
+
+
+
+
+
+
+
+ Aws::Crt::Http::HttpClientStream::HttpClientStream
+ (
+ const HttpClientStream &
+ )
+
+
+
+
+
+delete
+
+
+
+
+
+
+
+
◆ HttpClientStream() [2/2]
+
+
+
+
+
+
+
+
+ Aws::Crt::Http::HttpClientStream::HttpClientStream
+ (
+ HttpClientStream &&
+ )
+
+
+
+
+
+delete
+
+
+
+
+
+
+
+
+
◆ Activate()
+
+
+
+
+
+
+
+
+ bool Aws::Crt::Http::HttpClientStream::Activate
+ (
+ )
+
+
+
+
+
+noexcept
+
+
+
+
Activates the request's outgoing stream processing.
+
Returns true on success, false otherwise.
+
+
+
+
+
◆ GetResponseStatusCode()
+
+
+
+
+
+
+
+
+ int Aws::Crt::Http::HttpClientStream::GetResponseStatusCode
+ (
+ )
+ const
+
+
+
+
+override virtual noexcept
+
+
+
+
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 .
+
+
+
+
+
◆ operator=() [1/2]
+
+
+
+
◆ operator=() [2/2]
+
+
+
+
+
◆ HttpClientConnection
+
+
+
The documentation for this class was generated from the following files:
+
+
+
+
+
diff --git a/docs/class_aws_1_1_crt_1_1_http_1_1_http_client_stream.png b/docs/class_aws_1_1_crt_1_1_http_1_1_http_client_stream.png
new file mode 100644
index 000000000..90e921900
Binary files /dev/null and b/docs/class_aws_1_1_crt_1_1_http_1_1_http_client_stream.png differ
diff --git a/docs/class_aws_1_1_crt_1_1_http_1_1_http_message-members.html b/docs/class_aws_1_1_crt_1_1_http_1_1_http_message-members.html
new file mode 100644
index 000000000..491bce833
--- /dev/null
+++ b/docs/class_aws_1_1_crt_1_1_http_1_1_http_message-members.html
@@ -0,0 +1,99 @@
+
+
+
+
+
+
+
+aws-crt-cpp: Member List
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ 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.
+
+
+
+
+
diff --git a/docs/class_aws_1_1_crt_1_1_http_1_1_http_message.html b/docs/class_aws_1_1_crt_1_1_http_1_1_http_message.html
new file mode 100644
index 000000000..8c963affb
--- /dev/null
+++ b/docs/class_aws_1_1_crt_1_1_http_1_1_http_message.html
@@ -0,0 +1,623 @@
+
+
+
+
+
+
+
+aws-crt-cpp: Aws::Crt::Http::HttpMessage Class Reference
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ aws-crt-cpp
+
+ C++ wrapper around the aws-c-* libraries. Provides Cross-Platform Transport Protocols and SSL/TLS implementations for C++.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
#include <HttpRequestResponse.h >
+
+
+
+
+
+
+
+
+
+
+
+
Base class representing a mutable http request or response.
+
+
+
◆ ~HttpMessage()
+
+
+
+
+
+
+
+
+ Aws::Crt::Http::HttpMessage::~HttpMessage
+ (
+ )
+
+
+
+
+
+virtual
+
+
+
+
+
+
+
+
◆ HttpMessage() [1/3]
+
+
+
+
+
+
+
+
+ Aws::Crt::Http::HttpMessage::HttpMessage
+ (
+ const HttpMessage &
+ )
+
+
+
+
+
+delete
+
+
+
+
+
+
+
+
◆ HttpMessage() [2/3]
+
+
+
+
+
+
+
+
+ Aws::Crt::Http::HttpMessage::HttpMessage
+ (
+ HttpMessage &&
+ )
+
+
+
+
+
+delete
+
+
+
+
+
+
+
+
◆ HttpMessage() [3/3]
+
+
+
+
+
+
+
+
+ Aws::Crt::Http::HttpMessage::HttpMessage
+ (
+ Allocator *
+ allocator ,
+
+
+
+
+ struct aws_http_message *
+ message
+
+
+
+ )
+
+
+
+
+
+protected noexcept
+
+
+
+
+
+
+
+
+
◆ AddHeader()
+
+
+
+
+
+
+
+
+ bool Aws::Crt::Http::HttpMessage::AddHeader
+ (
+ const HttpHeader &
+ header )
+
+
+
+
+
+noexcept
+
+
+
+
Adds a header to the request
Parameters
+
+
+
+
Returns success/failure
+
+
+
+
+
◆ EraseHeader()
+
+
+
+
+
+
+
+
+ bool Aws::Crt::Http::HttpMessage::EraseHeader
+ (
+ size_t
+ index )
+
+
+
+
+
+noexcept
+
+
+
+
Removes a header from the request
Parameters
+
+ index index of the header to remove
+
+
+
+
Returns success/failure
+
+
+
+
+
◆ GetBody()
+
+
+
+
Gets the input stream representing the message body
+
+
+
+
+
◆ GetHeader()
+
+
+
+
+
+
+
+
+ Optional < HttpHeader > Aws::Crt::Http::HttpMessage::GetHeader
+ (
+ size_t
+ index )
+ const
+
+
+
+
+noexcept
+
+
+
+
Gets a particular header in the request
Parameters
+
+ index index of the header to fetch
+
+
+
+
Returns an option containing the requested header if the index is in bounds
+
+
+
+
+
◆ GetHeaderCount()
+
+
+
+
+
+
+
+
+ size_t Aws::Crt::Http::HttpMessage::GetHeaderCount
+ (
+ )
+ const
+
+
+
+
+noexcept
+
+
+
+
Gets the number of headers contained in this request
Returns the number of headers contained in this request
+
+
+
+
+
◆ operator bool()
+
+
+
+
+
+
+
+
+ Aws::Crt::Http::HttpMessage::operator bool
+ (
+ )
+ const
+
+
+
+
+inline noexcept
+
+
+
+
Returns true/false if the underlying object is valid
+
+
+
+
+
◆ operator=() [1/2]
+
+
+
+
◆ operator=() [2/2]
+
+
+
+
◆ SetBody() [1/2]
+
+
+
+
Sets the input stream representing the message body
Parameters
+
+ body the input stream representing the message body
+
+
+
+
Returns success/failure
+
+
+
+
+
◆ SetBody() [2/2]
+
+
+
+
+
+
+
+
+ bool Aws::Crt::Http::HttpMessage::SetBody
+ (
+ const std::shared_ptr< Aws::Crt::Io::IStream > &
+ body )
+
+
+
+
+
+noexcept
+
+
+
+
Sets the input stream representing the message body
Parameters
+
+ body the input stream representing the message body
+
+
+
+
Returns success/failure
+
+
+
+
+
+
◆ m_allocator
+
+
+
+
+
+
+
+
+ Allocator * Aws::Crt::Http::HttpMessage::m_allocator
+
+
+
+
+protected
+
+
+
+
+
+
+
+
◆ m_bodyStream
+
+
+
+
◆ m_message
+
+
+
+
+
+
+
+
+ struct aws_http_message* Aws::Crt::Http::HttpMessage::m_message
+
+
+
+
+protected
+
+
+
+
+
+
+
The documentation for this class was generated from the following files:
+
+
+
+
+
diff --git a/docs/class_aws_1_1_crt_1_1_http_1_1_http_message.png b/docs/class_aws_1_1_crt_1_1_http_1_1_http_message.png
new file mode 100644
index 000000000..3ebc41590
Binary files /dev/null and b/docs/class_aws_1_1_crt_1_1_http_1_1_http_message.png differ
diff --git a/docs/class_aws_1_1_crt_1_1_http_1_1_http_proxy_strategy-members.html b/docs/class_aws_1_1_crt_1_1_http_1_1_http_proxy_strategy-members.html
new file mode 100644
index 000000000..15de5f50d
--- /dev/null
+++ b/docs/class_aws_1_1_crt_1_1_http_1_1_http_proxy_strategy-members.html
@@ -0,0 +1,87 @@
+
+
+
+
+
+
+
+aws-crt-cpp: Member List
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ 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.
+
+
+
+
+
diff --git a/docs/class_aws_1_1_crt_1_1_http_1_1_http_proxy_strategy.html b/docs/class_aws_1_1_crt_1_1_http_1_1_http_proxy_strategy.html
new file mode 100644
index 000000000..a7736628b
--- /dev/null
+++ b/docs/class_aws_1_1_crt_1_1_http_1_1_http_proxy_strategy.html
@@ -0,0 +1,277 @@
+
+
+
+
+
+
+
+aws-crt-cpp: Aws::Crt::Http::HttpProxyStrategy Class Reference
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ aws-crt-cpp
+
+ C++ wrapper around the aws-c-* libraries. Provides Cross-Platform Transport Protocols and SSL/TLS implementations for C++.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
#include <HttpProxyStrategy.h >
+
+
+
+
+
+
+
+
+
+
+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.
+
+
+
◆ HttpProxyStrategy()
+
+
+
+
+
+ Aws::Crt::Http::HttpProxyStrategy::HttpProxyStrategy
+ (
+ struct aws_http_proxy_strategy *
+ strategy )
+
+
+
+
+
+
+
+
+
◆ ~HttpProxyStrategy()
+
+
+
+
+
+
+
+
+ Aws::Crt::Http::HttpProxyStrategy::~HttpProxyStrategy
+ (
+ )
+
+
+
+
+
+virtual
+
+
+
+
+
+
+
+
+
◆ CreateAdaptiveHttpProxyStrategy()
+
+
+
+
Creates a proxy strategy that, depending on configuration, can attempt kerberos and/or ntlm authentication when connecting to the proxy
Parameters
+
+ config the adaptive strategy configuration options
+ allocator allocator to use
+
+
+
+
Returns a new adaptive proxy strategy
+
+
+
+
+
◆ CreateBasicHttpProxyStrategy()
+
+
+
+
Creates a proxy strategy that performs basic authentication
Parameters
+
+ config basic authentication configuration options
+ allocator allocator to use
+
+
+
+
Returns a new basic authentication proxy strategy
+
+
+
+
+
+
◆ m_strategy
+
+
+
+
+
+
+
+
+ struct aws_http_proxy_strategy* Aws::Crt::Http::HttpProxyStrategy::m_strategy
+
+
+
+
+protected
+
+
+
+
+
+
+
The documentation for this class was generated from the following files:
+
+
+
+
+
diff --git a/docs/class_aws_1_1_crt_1_1_http_1_1_http_proxy_strategy.png b/docs/class_aws_1_1_crt_1_1_http_1_1_http_proxy_strategy.png
new file mode 100644
index 000000000..775e9cb3f
Binary files /dev/null and b/docs/class_aws_1_1_crt_1_1_http_1_1_http_proxy_strategy.png differ
diff --git a/docs/class_aws_1_1_crt_1_1_http_1_1_http_request-members.html b/docs/class_aws_1_1_crt_1_1_http_1_1_http_request-members.html
new file mode 100644
index 000000000..7f1a7f1ea
--- /dev/null
+++ b/docs/class_aws_1_1_crt_1_1_http_1_1_http_request-members.html
@@ -0,0 +1,107 @@
+
+
+
+
+
+
+
+aws-crt-cpp: Member List
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ 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.
+
+
+
+
+
diff --git a/docs/class_aws_1_1_crt_1_1_http_1_1_http_request.html b/docs/class_aws_1_1_crt_1_1_http_1_1_http_request.html
new file mode 100644
index 000000000..02dbb8bfb
--- /dev/null
+++ b/docs/class_aws_1_1_crt_1_1_http_1_1_http_request.html
@@ -0,0 +1,374 @@
+
+
+
+
+
+
+
+aws-crt-cpp: Aws::Crt::Http::HttpRequest Class Reference
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ aws-crt-cpp
+
+ C++ wrapper around the aws-c-* libraries. Provides Cross-Platform Transport Protocols and SSL/TLS implementations for C++.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
#include <HttpRequestResponse.h >
+
+
+
+
+
+
+
+
+
+
+
Class representing a mutable http request.
+
+
+
◆ HttpRequest() [1/2]
+
+
+
+
◆ HttpRequest() [2/2]
+
+
+
+
+
+
+
+
+ Aws::Crt::Http::HttpRequest::HttpRequest
+ (
+ Allocator *
+ allocator ,
+
+
+
+
+ struct aws_http_message *
+ message
+
+
+
+ )
+
+
+
+
+
+protected
+
+
+
+
+
+
+
+
+
◆ GetMethod()
+
+
+
+
Returns the value of the Http method associated with this request
+
+
+
+
+
◆ GetPath()
+
+
+
+
Returns the value of the URI-path associated with this request
+
+
+
+
+
◆ SetMethod()
+
+
+
+
+
+
+
+
+ bool Aws::Crt::Http::HttpRequest::SetMethod
+ (
+ ByteCursor
+ method )
+
+
+
+
+
+noexcept
+
+
+
+
Sets the value of the Http method associated with this request
+
+
+
+
+
◆ SetPath()
+
+
+
+
+
+
+
+
+ bool Aws::Crt::Http::HttpRequest::SetPath
+ (
+ ByteCursor
+ path )
+
+
+
+
+
+noexcept
+
+
+
+
Sets the value of the URI-path associated with this request
+
+
+
+
+
+
◆ Mqtt5::Mqtt5ClientCore
+
+
+
+
+
+
+
+
+ friend class Mqtt5::Mqtt5ClientCore
+
+
+
+
+friend
+
+
+
+
+
+
+
+
◆ Mqtt::MqttConnectionCore
+
+
+
+
+
+
+
+
+ friend class Mqtt::MqttConnectionCore
+
+
+
+
+friend
+
+
+
+
+
+
+
The documentation for this class was generated from the following files:
+
+
+
+
+
diff --git a/docs/class_aws_1_1_crt_1_1_http_1_1_http_request.png b/docs/class_aws_1_1_crt_1_1_http_1_1_http_request.png
new file mode 100644
index 000000000..2589134eb
Binary files /dev/null and b/docs/class_aws_1_1_crt_1_1_http_1_1_http_request.png differ
diff --git a/docs/class_aws_1_1_crt_1_1_http_1_1_http_response-members.html b/docs/class_aws_1_1_crt_1_1_http_1_1_http_response-members.html
new file mode 100644
index 000000000..ea5083f1f
--- /dev/null
+++ b/docs/class_aws_1_1_crt_1_1_http_1_1_http_response-members.html
@@ -0,0 +1,102 @@
+
+
+
+
+
+
+
+aws-crt-cpp: Member List
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ 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.
+
+
+
+
+
diff --git a/docs/class_aws_1_1_crt_1_1_http_1_1_http_response.html b/docs/class_aws_1_1_crt_1_1_http_1_1_http_response.html
new file mode 100644
index 000000000..9d5c8a2b0
--- /dev/null
+++ b/docs/class_aws_1_1_crt_1_1_http_1_1_http_response.html
@@ -0,0 +1,222 @@
+
+
+
+
+
+
+
+aws-crt-cpp: Aws::Crt::Http::HttpResponse Class Reference
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ aws-crt-cpp
+
+ C++ wrapper around the aws-c-* libraries. Provides Cross-Platform Transport Protocols and SSL/TLS implementations for C++.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
#include <HttpRequestResponse.h >
+
+
+
+
+
+
+
+
+
+
+
Class representing a mutable http response.
+
+
+
◆ HttpResponse()
+
+
+
+
+
◆ GetResponseCode()
+
+
+
+
+
+
+
+
+ Optional < int > Aws::Crt::Http::HttpResponse::GetResponseCode
+ (
+ )
+ const
+
+
+
+
+noexcept
+
+
+
+
Returns the integral Http response code associated with this response
+
+
+
+
+
◆ SetResponseCode()
+
+
+
+
+
+
+
+
+ bool Aws::Crt::Http::HttpResponse::SetResponseCode
+ (
+ int
+ response )
+
+
+
+
+
+noexcept
+
+
+
+
Sets the integral Http response code associated with this response
+
+
+
+
The documentation for this class was generated from the following files:
+
+
+
+
+
diff --git a/docs/class_aws_1_1_crt_1_1_http_1_1_http_response.png b/docs/class_aws_1_1_crt_1_1_http_1_1_http_response.png
new file mode 100644
index 000000000..fe7143b0c
Binary files /dev/null and b/docs/class_aws_1_1_crt_1_1_http_1_1_http_response.png differ
diff --git a/docs/class_aws_1_1_crt_1_1_http_1_1_http_stream-members.html b/docs/class_aws_1_1_crt_1_1_http_1_1_http_stream-members.html
new file mode 100644
index 000000000..a019a7845
--- /dev/null
+++ b/docs/class_aws_1_1_crt_1_1_http_1_1_http_stream-members.html
@@ -0,0 +1,94 @@
+
+
+
+
+
+
+
+aws-crt-cpp: Member List
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ 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.
+
+
+
+
+
diff --git a/docs/class_aws_1_1_crt_1_1_http_1_1_http_stream.html b/docs/class_aws_1_1_crt_1_1_http_1_1_http_stream.html
new file mode 100644
index 000000000..db400a00b
--- /dev/null
+++ b/docs/class_aws_1_1_crt_1_1_http_1_1_http_stream.html
@@ -0,0 +1,447 @@
+
+
+
+
+
+
+
+aws-crt-cpp: Aws::Crt::Http::HttpStream Class Reference
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ aws-crt-cpp
+
+ C++ wrapper around the aws-c-* libraries. Provides Cross-Platform Transport Protocols and SSL/TLS implementations for C++.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
#include <HttpConnection.h >
+
+
+
+
+
+
+
+
+
+
+
Represents a single http message exchange (request/response) or in H2, it can also represent a PUSH_PROMISE followed by the accompanying Response.
+
+
+
◆ ~HttpStream()
+
+
+
+
+
+
+
+
+ Aws::Crt::Http::HttpStream::~HttpStream
+ (
+ )
+
+
+
+
+
+virtual
+
+
+
+
+
+
+
+
◆ HttpStream() [1/3]
+
+
+
+
+
+
+
+
+ Aws::Crt::Http::HttpStream::HttpStream
+ (
+ const HttpStream &
+ )
+
+
+
+
+
+delete
+
+
+
+
+
+
+
+
◆ HttpStream() [2/3]
+
+
+
+
+
+
+
+
+ Aws::Crt::Http::HttpStream::HttpStream
+ (
+ HttpStream &&
+ )
+
+
+
+
+
+delete
+
+
+
+
+
+
+
+
◆ HttpStream() [3/3]
+
+
+
+
+
+
+
+
+ Aws::Crt::Http::HttpStream::HttpStream
+ (
+ const std::shared_ptr< HttpClientConnection > &
+ connection )
+
+
+
+
+
+protected noexcept
+
+
+
+
+
+
+
+
+
◆ GetConnection()
+
+
+
+
Get the underlying connection for the stream.
+
+
+
+
+
◆ GetResponseStatusCode()
+
+
+
+
+
+
+
+
+ virtual int Aws::Crt::Http::HttpStream::GetResponseStatusCode
+ (
+ )
+ const
+
+
+
+
+pure virtual noexcept
+
+
+
+
+
+
◆ operator=() [1/2]
+
+
+
+
◆ operator=() [2/2]
+
+
+
+
◆ UpdateWindow()
+
+
+
+
+
+
+
+
+ void Aws::Crt::Http::HttpStream::UpdateWindow
+ (
+ std::size_t
+ incrementSize )
+
+
+
+
+
+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.
+
+
+
+
+
+
◆ HttpClientConnection
+
+
+
+
+
◆ m_connection
+
+
+
+
◆ m_stream
+
+
+
+
+
+
+
+
+ aws_http_stream* Aws::Crt::Http::HttpStream::m_stream
+
+
+
+
+protected
+
+
+
+
+
+
+
The documentation for this class was generated from the following files:
+
+
+
+
+
diff --git a/docs/class_aws_1_1_crt_1_1_http_1_1_http_stream.png b/docs/class_aws_1_1_crt_1_1_http_1_1_http_stream.png
new file mode 100644
index 000000000..0a0662709
Binary files /dev/null and b/docs/class_aws_1_1_crt_1_1_http_1_1_http_stream.png differ
diff --git a/docs/class_aws_1_1_crt_1_1_http_1_1_managed_connection-members.html b/docs/class_aws_1_1_crt_1_1_http_1_1_managed_connection-members.html
new file mode 100644
index 000000000..5272dc092
--- /dev/null
+++ b/docs/class_aws_1_1_crt_1_1_http_1_1_managed_connection-members.html
@@ -0,0 +1,97 @@
+
+
+
+
+
+
+
+aws-crt-cpp: Member List
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ 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.
+
+
+
+
+
diff --git a/docs/class_aws_1_1_crt_1_1_http_1_1_managed_connection.html b/docs/class_aws_1_1_crt_1_1_http_1_1_managed_connection.html
new file mode 100644
index 000000000..61bef2fe1
--- /dev/null
+++ b/docs/class_aws_1_1_crt_1_1_http_1_1_managed_connection.html
@@ -0,0 +1,197 @@
+
+
+
+
+
+
+
+aws-crt-cpp: Aws::Crt::Http::ManagedConnection Class Reference
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ aws-crt-cpp
+
+ C++ wrapper around the aws-c-* libraries. Provides Cross-Platform Transport Protocols and SSL/TLS implementations for C++.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
◆ ManagedConnection()
+
+
+
+
+
+
+
+
+ Aws::Crt::Http::ManagedConnection::ManagedConnection
+ (
+ aws_http_connection *
+ connection ,
+
+
+
+
+ std::shared_ptr< HttpClientConnectionManager >
+ connectionManager
+
+
+
+ )
+
+
+
+
+
+inline
+
+
+
+
+
+
+
+
◆ ~ManagedConnection()
+
+
+
+
+
+
+
+
+ Aws::Crt::Http::ManagedConnection::~ManagedConnection
+ (
+ )
+
+
+
+
+
+inline override
+
+
+
+
+
+
+
The documentation for this class was generated from the following file:
+
+
+
+
+
diff --git a/docs/class_aws_1_1_crt_1_1_http_1_1_managed_connection.png b/docs/class_aws_1_1_crt_1_1_http_1_1_managed_connection.png
new file mode 100644
index 000000000..fcbe76d67
Binary files /dev/null and b/docs/class_aws_1_1_crt_1_1_http_1_1_managed_connection.png differ
diff --git a/docs/class_aws_1_1_crt_1_1_http_1_1_unmanaged_connection-members.html b/docs/class_aws_1_1_crt_1_1_http_1_1_unmanaged_connection-members.html
new file mode 100644
index 000000000..9f34021d0
--- /dev/null
+++ b/docs/class_aws_1_1_crt_1_1_http_1_1_unmanaged_connection-members.html
@@ -0,0 +1,97 @@
+
+
+
+
+
+
+
+aws-crt-cpp: Member List
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ 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.
+
+
+
+
+
diff --git a/docs/class_aws_1_1_crt_1_1_http_1_1_unmanaged_connection.html b/docs/class_aws_1_1_crt_1_1_http_1_1_unmanaged_connection.html
new file mode 100644
index 000000000..364516c76
--- /dev/null
+++ b/docs/class_aws_1_1_crt_1_1_http_1_1_unmanaged_connection.html
@@ -0,0 +1,197 @@
+
+
+
+
+
+
+
+aws-crt-cpp: Aws::Crt::Http::UnmanagedConnection Class Reference
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ aws-crt-cpp
+
+ C++ wrapper around the aws-c-* libraries. Provides Cross-Platform Transport Protocols and SSL/TLS implementations for C++.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
◆ UnmanagedConnection()
+
+
+
+
+
+
+
+
+ Aws::Crt::Http::UnmanagedConnection::UnmanagedConnection
+ (
+ aws_http_connection *
+ connection ,
+
+
+
+
+ Aws::Crt::Allocator *
+ allocator
+
+
+
+ )
+
+
+
+
+
+inline
+
+
+
+
+
+
+
+
◆ ~UnmanagedConnection()
+
+
+
+
+
+
+
+
+ Aws::Crt::Http::UnmanagedConnection::~UnmanagedConnection
+ (
+ )
+
+
+
+
+
+inline override
+
+
+
+
+
+
+
The documentation for this class was generated from the following file:
+
+
+
+
+
diff --git a/docs/class_aws_1_1_crt_1_1_http_1_1_unmanaged_connection.png b/docs/class_aws_1_1_crt_1_1_http_1_1_unmanaged_connection.png
new file mode 100644
index 000000000..856523763
Binary files /dev/null and b/docs/class_aws_1_1_crt_1_1_http_1_1_unmanaged_connection.png differ
diff --git a/docs/class_aws_1_1_crt_1_1_imds_1_1_imds_client-members.html b/docs/class_aws_1_1_crt_1_1_imds_1_1_imds_client-members.html
new file mode 100644
index 000000000..c16443b6b
--- /dev/null
+++ b/docs/class_aws_1_1_crt_1_1_imds_1_1_imds_client-members.html
@@ -0,0 +1,112 @@
+
+
+
+
+
+
+
+aws-crt-cpp: Member List
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ 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()) noexceptAws::Crt::Imds::ImdsClient
+ ImdsClient (const ImdsClient &)=deleteAws::Crt::Imds::ImdsClient
+ ImdsClient (ImdsClient &&)=deleteAws::Crt::Imds::ImdsClient
+ operator= (const ImdsClient &)=deleteAws::Crt::Imds::ImdsClient
+ operator= (ImdsClient &&)=deleteAws::Crt::Imds::ImdsClient
+ ~ImdsClient ()Aws::Crt::Imds::ImdsClient
+
+
+
+
+
diff --git a/docs/class_aws_1_1_crt_1_1_imds_1_1_imds_client.html b/docs/class_aws_1_1_crt_1_1_imds_1_1_imds_client.html
new file mode 100644
index 000000000..365736969
--- /dev/null
+++ b/docs/class_aws_1_1_crt_1_1_imds_1_1_imds_client.html
@@ -0,0 +1,1201 @@
+
+
+
+
+
+
+
+aws-crt-cpp: Aws::Crt::Imds::ImdsClient Class Reference
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ aws-crt-cpp
+
+ C++ wrapper around the aws-c-* libraries. Provides Cross-Platform Transport Protocols and SSL/TLS implementations for C++.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
#include <ImdsClient.h >
+
+
+ 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)
+
+
+
+
+
◆ ImdsClient() [1/3]
+
+
+
+
◆ ~ImdsClient()
+
+
+
+
+
+ Aws::Crt::Imds::ImdsClient::~ImdsClient
+ (
+ )
+
+
+
+
+
+
+
+
+
◆ ImdsClient() [2/3]
+
+
+
+
+
+
+
+
+ Aws::Crt::Imds::ImdsClient::ImdsClient
+ (
+ const ImdsClient &
+ )
+
+
+
+
+
+delete
+
+
+
+
+
+
+
+
◆ ImdsClient() [3/3]
+
+
+
+
+
+
+
+
+ Aws::Crt::Imds::ImdsClient::ImdsClient
+ (
+ ImdsClient &&
+ )
+
+
+
+
+
+delete
+
+
+
+
+
+
+
+
+
◆ GetAmiId()
+
+
+
+
+
+ int Aws::Crt::Imds::ImdsClient::GetAmiId
+ (
+ OnResourceAcquired
+ callback ,
+
+
+
+
+ void *
+ userData
+
+
+
+ )
+
+
+
+
+
Gets the ami id of the ec2 instance from the instance metadata document
+
Parameters
+
+ callback callback function to invoke on query success or failure
+ userData opaque data to invoke the completion callback with
+
+
+
+
Returns AWS_OP_SUCCESS if the query was successfully started, AWS_OP_ERR otherwise
+
+
+
+
+
◆ GetAmiLaunchIndex()
+
+
+
+
+
+ int Aws::Crt::Imds::ImdsClient::GetAmiLaunchIndex
+ (
+ OnResourceAcquired
+ callback ,
+
+
+
+
+ void *
+ userData
+
+
+
+ )
+
+
+
+
+
Gets the ami launch index of the ec2 instance from the instance metadata document
+
Parameters
+
+ callback callback function to invoke on query success or failure
+ userData opaque data to invoke the completion callback with
+
+
+
+
Returns AWS_OP_SUCCESS if the query was successfully started, AWS_OP_ERR otherwise
+
+
+
+
+
◆ GetAmiManifestPath()
+
+
+
+
+
+ int Aws::Crt::Imds::ImdsClient::GetAmiManifestPath
+ (
+ OnResourceAcquired
+ callback ,
+
+
+
+
+ void *
+ userData
+
+
+
+ )
+
+
+
+
+
Gets the ami manifest path of the ec2 instance from the instance metadata document
+
Parameters
+
+ callback callback function to invoke on query success or failure
+ userData opaque data to invoke the completion callback with
+
+
+
+
Returns AWS_OP_SUCCESS if the query was successfully started, AWS_OP_ERR otherwise
+
+
+
+
+
◆ GetAncestorAmiIds()
+
+
+
+
+
+ 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
+
Parameters
+
+ callback callback function to invoke on query success or failure
+ userData opaque data to invoke the completion callback with
+
+
+
+
Returns AWS_OP_SUCCESS if the query was successfully started, AWS_OP_ERR otherwise
+
+
+
+
+
◆ GetAttachedIamRole()
+
+
+
+
+
+ int Aws::Crt::Imds::ImdsClient::GetAttachedIamRole
+ (
+ OnResourceAcquired
+ callback ,
+
+
+
+
+ void *
+ userData
+
+
+
+ )
+
+
+
+
+
Gets the attached iam role of the ec2 instance from the instance metadata document
+
Parameters
+
+ callback callback function to invoke on query success or failure
+ userData opaque data to invoke the completion callback with
+
+
+
+
Returns AWS_OP_SUCCESS if the query was successfully started, AWS_OP_ERR otherwise
+
+
+
+
+
◆ GetAvailabilityZone()
+
+
+
+
+
+ int Aws::Crt::Imds::ImdsClient::GetAvailabilityZone
+ (
+ OnResourceAcquired
+ callback ,
+
+
+
+
+ void *
+ userData
+
+
+
+ )
+
+
+
+
+
Gets the availability zone of the ec2 instance from the instance metadata document
+
Parameters
+
+ callback callback function to invoke on query success or failure
+ userData opaque data to invoke the completion callback with
+
+
+
+
Returns AWS_OP_SUCCESS if the query was successfully started, AWS_OP_ERR otherwise
+
+
+
+
+
◆ GetBlockDeviceMapping()
+
+
+
+
+
+ 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
+
Parameters
+
+ callback callback function to invoke on query success or failure
+ userData opaque data to invoke the completion callback with
+
+
+
+
Returns AWS_OP_SUCCESS if the query was successfully started, AWS_OP_ERR otherwise
+
+
+
+
+
◆ GetCredentials()
+
+
+
+
+
+ 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
+
Parameters
+
+ 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
+
+
+
+
Returns AWS_OP_SUCCESS if the query was successfully started, AWS_OP_ERR otherwise
+
+
+
+
+
◆ GetIamProfile()
+
+
+
+
+
+ int Aws::Crt::Imds::ImdsClient::GetIamProfile
+ (
+ OnIamProfileAcquired
+ callback ,
+
+
+
+
+ void *
+ userData
+
+
+
+ )
+
+
+
+
+
Gets the iam profile information of the ec2 instance from the instance metadata document
+
Parameters
+
+ callback callback function to invoke on query success or failure
+ userData opaque data to invoke the completion callback with
+
+
+
+
Returns AWS_OP_SUCCESS if the query was successfully started, AWS_OP_ERR otherwise
+
+
+
+
+
◆ GetInstanceAction()
+
+
+
+
+
+ int Aws::Crt::Imds::ImdsClient::GetInstanceAction
+ (
+ OnResourceAcquired
+ callback ,
+
+
+
+
+ void *
+ userData
+
+
+
+ )
+
+
+
+
+
Gets the instance-action of the ec2 instance from the instance metadata document
+
Parameters
+
+ callback callback function to invoke on query success or failure
+ userData opaque data to invoke the completion callback with
+
+
+
+
Returns AWS_OP_SUCCESS if the query was successfully started, AWS_OP_ERR otherwise
+
+
+
+
+
◆ GetInstanceId()
+
+
+
+
+
+ int Aws::Crt::Imds::ImdsClient::GetInstanceId
+ (
+ OnResourceAcquired
+ callback ,
+
+
+
+
+ void *
+ userData
+
+
+
+ )
+
+
+
+
+
Gets the instance id of the ec2 instance from the instance metadata document
+
Parameters
+
+ callback callback function to invoke on query success or failure
+ userData opaque data to invoke the completion callback with
+
+
+
+
Returns AWS_OP_SUCCESS if the query was successfully started, AWS_OP_ERR otherwise
+
+
+
+
+
◆ GetInstanceInfo()
+
+
+
+
+
+ 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
+
Parameters
+
+ callback callback function to invoke on query success or failure
+ userData opaque data to invoke the completion callback with
+
+
+
+
Returns AWS_OP_SUCCESS if the query was successfully started, AWS_OP_ERR otherwise
+
+
+
+
+
◆ GetInstanceSignature()
+
+
+
+
+
+ int Aws::Crt::Imds::ImdsClient::GetInstanceSignature
+ (
+ OnResourceAcquired
+ callback ,
+
+
+
+
+ void *
+ userData
+
+
+
+ )
+
+
+
+
+
Gets the signature of the ec2 instance from the instance metadata document
+
Parameters
+
+ callback callback function to invoke on query success or failure
+ userData opaque data to invoke the completion callback with
+
+
+
+
Returns AWS_OP_SUCCESS if the query was successfully started, AWS_OP_ERR otherwise
+
+
+
+
+
◆ GetInstanceType()
+
+
+
+
+
+ int Aws::Crt::Imds::ImdsClient::GetInstanceType
+ (
+ OnResourceAcquired
+ callback ,
+
+
+
+
+ void *
+ userData
+
+
+
+ )
+
+
+
+
+
Gets the instance type of the ec2 instance from the instance metadata document
+
Parameters
+
+ callback callback function to invoke on query success or failure
+ userData opaque data to invoke the completion callback with
+
+
+
+
Returns AWS_OP_SUCCESS if the query was successfully started, AWS_OP_ERR otherwise
+
+
+
+
+
◆ GetMacAddress()
+
+
+
+
+
+ int Aws::Crt::Imds::ImdsClient::GetMacAddress
+ (
+ OnResourceAcquired
+ callback ,
+
+
+
+
+ void *
+ userData
+
+
+
+ )
+
+
+
+
+
Gets the mac address of the ec2 instance from the instance metadata document
+
Parameters
+
+ callback callback function to invoke on query success or failure
+ userData opaque data to invoke the completion callback with
+
+
+
+
Returns AWS_OP_SUCCESS if the query was successfully started, AWS_OP_ERR otherwise
+
+
+
+
+
◆ GetPrivateIpAddress()
+
+
+
+
+
+ int Aws::Crt::Imds::ImdsClient::GetPrivateIpAddress
+ (
+ OnResourceAcquired
+ callback ,
+
+
+
+
+ void *
+ userData
+
+
+
+ )
+
+
+
+
+
Gets the private ip address of the ec2 instance from the instance metadata document
+
Parameters
+
+ callback callback function to invoke on query success or failure
+ userData opaque data to invoke the completion callback with
+
+
+
+
Returns AWS_OP_SUCCESS if the query was successfully started, AWS_OP_ERR otherwise
+
+
+
+
+
◆ GetProductCodes()
+
+
+
+
+
+ int Aws::Crt::Imds::ImdsClient::GetProductCodes
+ (
+ OnResourceAcquired
+ callback ,
+
+
+
+
+ void *
+ userData
+
+
+
+ )
+
+
+
+
+
Gets the product codes of the ec2 instance from the instance metadata document
+
Parameters
+
+ callback callback function to invoke on query success or failure
+ userData opaque data to invoke the completion callback with
+
+
+
+
Returns AWS_OP_SUCCESS if the query was successfully started, AWS_OP_ERR otherwise
+
+
+
+
+
◆ GetPublicKey()
+
+
+
+
+
+ int Aws::Crt::Imds::ImdsClient::GetPublicKey
+ (
+ OnResourceAcquired
+ callback ,
+
+
+
+
+ void *
+ userData
+
+
+
+ )
+
+
+
+
+
Gets the public key of the ec2 instance from the instance metadata document
+
Parameters
+
+ callback callback function to invoke on query success or failure
+ userData opaque data to invoke the completion callback with
+
+
+
+
Returns AWS_OP_SUCCESS if the query was successfully started, AWS_OP_ERR otherwise
+
+
+
+
+
◆ GetRamDiskId()
+
+
+
+
+
+ int Aws::Crt::Imds::ImdsClient::GetRamDiskId
+ (
+ OnResourceAcquired
+ callback ,
+
+
+
+
+ void *
+ userData
+
+
+
+ )
+
+
+
+
+
Gets the ramdisk id of the ec2 instance from the instance metadata document
+
Parameters
+
+ callback callback function to invoke on query success or failure
+ userData opaque data to invoke the completion callback with
+
+
+
+
Returns AWS_OP_SUCCESS if the query was successfully started, AWS_OP_ERR otherwise
+
+
+
+
+
◆ GetReservationId()
+
+
+
+
+
+ int Aws::Crt::Imds::ImdsClient::GetReservationId
+ (
+ OnResourceAcquired
+ callback ,
+
+
+
+
+ void *
+ userData
+
+
+
+ )
+
+
+
+
+
Gets the reservation id of the ec2 instance from the instance metadata document
+
Parameters
+
+ callback callback function to invoke on query success or failure
+ userData opaque data to invoke the completion callback with
+
+
+
+
Returns AWS_OP_SUCCESS if the query was successfully started, AWS_OP_ERR otherwise
+
+
+
+
+
◆ GetResource()
+
+
+
+
+
+ int Aws::Crt::Imds::ImdsClient::GetResource
+ (
+ const StringView &
+ resourcePath ,
+
+
+
+
+ OnResourceAcquired
+ callback ,
+
+
+
+
+ void *
+ userData
+
+
+
+ )
+
+
+
+
+
Queries a generic resource (string) from the ec2 instance metadata document
+
Parameters
+
+ 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
+
+
+
+
Returns AWS_OP_SUCCESS if the query was successfully started, AWS_OP_ERR otherwise
+
+
+
+
+
◆ GetSecurityGroups()
+
+
+
+
+
+ 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
+
Parameters
+
+ callback callback function to invoke on query success or failure
+ userData opaque data to invoke the completion callback with
+
+
+
+
Returns AWS_OP_SUCCESS if the query was successfully started, AWS_OP_ERR otherwise
+
+
+
+
+
◆ GetUnderlyingHandle()
+
+
+
+
+
+
+
+
+ aws_imds_client* Aws::Crt::Imds::ImdsClient::GetUnderlyingHandle
+ (
+ )
+
+
+
+
+
+inline
+
+
+
+
+
+
+
+
◆ GetUserData()
+
+
+
+
+
+ int Aws::Crt::Imds::ImdsClient::GetUserData
+ (
+ OnResourceAcquired
+ callback ,
+
+
+
+
+ void *
+ userData
+
+
+
+ )
+
+
+
+
+
Gets the user data of the ec2 instance from the instance metadata document
+
Parameters
+
+ callback callback function to invoke on query success or failure
+ userData opaque data to invoke the completion callback with
+
+
+
+
Returns AWS_OP_SUCCESS if the query was successfully started, AWS_OP_ERR otherwise
+
+
+
+
+
◆ operator=() [1/2]
+
+
+
+
◆ operator=() [2/2]
+
+
+
The documentation for this class was generated from the following files:
+
+
+
+
+
diff --git a/docs/class_aws_1_1_crt_1_1_io_1_1_channel_handler-members.html b/docs/class_aws_1_1_crt_1_1_io_1_1_channel_handler-members.html
new file mode 100644
index 000000000..50816d286
--- /dev/null
+++ b/docs/class_aws_1_1_crt_1_1_io_1_1_channel_handler-members.html
@@ -0,0 +1,116 @@
+
+
+
+
+
+
+
+aws-crt-cpp: Member List
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ 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.
+
+
+
+
+
diff --git a/docs/class_aws_1_1_crt_1_1_io_1_1_channel_handler.html b/docs/class_aws_1_1_crt_1_1_io_1_1_channel_handler.html
new file mode 100644
index 000000000..53b2647c5
--- /dev/null
+++ b/docs/class_aws_1_1_crt_1_1_io_1_1_channel_handler.html
@@ -0,0 +1,1014 @@
+
+
+
+
+
+
+
+aws-crt-cpp: Aws::Crt::Io::ChannelHandler Struct Reference
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ aws-crt-cpp
+
+ C++ wrapper around the aws-c-* libraries. Provides Cross-Platform Transport Protocols and SSL/TLS implementations for C++.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
#include <ChannelHandler.h >
+
+
+
+
+
+
+
+
+
+
+
+
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).
+
+
+
◆ ~ChannelHandler()
+
+
+
+
+
+
+
+
+ virtual Aws::Crt::Io::ChannelHandler::~ChannelHandler
+ (
+ )
+
+
+
+
+
+virtual default
+
+
+
+
+
+
+
+
◆ ChannelHandler() [1/2]
+
+
+
+
+
+
+
+
+ Aws::Crt::Io::ChannelHandler::ChannelHandler
+ (
+ const ChannelHandler &
+ )
+
+
+
+
+
+delete
+
+
+
+
+
+
+
+
◆ ChannelHandler() [2/2]
+
+
+
+
+
◆ AcquireMaxSizeMessageForWrite()
+
+
+
+
+
+
+
+
+ struct aws_io_message * Aws::Crt::Io::ChannelHandler::AcquireMaxSizeMessageForWrite
+ (
+ )
+
+
+
+
+
+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.
+
+
+
+
+
◆ AcquireMessageFromPool()
+
+
+
+
+
+
+
+
+ struct aws_io_message * Aws::Crt::Io::ChannelHandler::AcquireMessageFromPool
+ (
+ MessageType
+ messageType ,
+
+
+
+
+ size_t
+ sizeHint
+
+
+
+ )
+
+
+
+
+
+protected
+
+
+
+
Acquire an aws_io_message from the channel's pool.
+
+
+
+
+
◆ ChannelsThreadIsCallersThread()
+
+
+
+
+
+ bool Aws::Crt::Io::ChannelHandler::ChannelsThreadIsCallersThread
+ (
+ )
+ const
+
+
+
+
Return whether the caller is on the same thread as the handler's channel.
+
+
+
+
+
◆ DownstreamReadWindow()
+
+
+
+
+
+
+
+
+ size_t Aws::Crt::Io::ChannelHandler::DownstreamReadWindow
+ (
+ )
+ const
+
+
+
+
+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.
+
+
+
+
+
◆ GatherStatistics()
+
+
+
+
+
+
+
+
+ virtual void Aws::Crt::Io::ChannelHandler::GatherStatistics
+ (
+ struct aws_array_list *
+ )
+
+
+
+
+
+inline protected virtual
+
+
+
+
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.
+
+
+
+
+
◆ GetSlot()
+
+
+
+
+
+
+
+
+ struct aws_channel_slot * Aws::Crt::Io::ChannelHandler::GetSlot
+ (
+ )
+ const
+
+
+
+
+protected
+
+
+
+
+
+
+
+
◆ IncrementReadWindow()
+
+
+
+
+
+
+
+
+ virtual int Aws::Crt::Io::ChannelHandler::IncrementReadWindow
+ (
+ size_t
+ size )
+
+
+
+
+
+protected pure 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()
+
Returns AWS_OP_SUCCESS if successful. Otherwise, raise an error and return AWS_OP_ERR.
+
+
+
+
+
◆ IncrementUpstreamReadWindow()
+
+
+
+
+
+
+
+
+ bool Aws::Crt::Io::ChannelHandler::IncrementUpstreamReadWindow
+ (
+ size_t
+ windowUpdateSize )
+
+
+
+
+
+protected
+
+
+
+
Issue a window update notification upstream. Returns true if successful.
+
+
+
+
+
◆ InitialWindowSize()
+
+
+
+
+
+
+
+
+ virtual size_t Aws::Crt::Io::ChannelHandler::InitialWindowSize
+ (
+ )
+
+
+
+
+
+protected pure virtual
+
+
+
+
Called by the channel when the handler is added to a slot, to get the initial window size.
+
+
+
+
+
◆ MessageOverhead()
+
+
+
+
+
+
+
+
+ virtual size_t Aws::Crt::Io::ChannelHandler::MessageOverhead
+ (
+ )
+
+
+
+
+
+protected pure 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.
+
+
+
+
+
◆ OnShutdownComplete()
+
+
+
+
+
+
+
+
+ void Aws::Crt::Io::ChannelHandler::OnShutdownComplete
+ (
+ ChannelDirection
+ direction ,
+
+
+
+
+ int
+ errorCode ,
+
+
+
+
+ bool
+ freeScarceResourcesImmediately
+
+
+
+ )
+
+
+
+
+
+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.
+
+
+
+
+
◆ operator=()
+
+
+
+
◆ ProcessReadMessage()
+
+
+
+
+
+
+
+
+ virtual int Aws::Crt::Io::ChannelHandler::ProcessReadMessage
+ (
+ struct aws_io_message *
+ message )
+
+
+
+
+
+protected pure 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.
+
Returns AWS_OP_SUCCESS if the message is being processed. If the message cannot be processed raise an error and return AWS_OP_ERR and do NOT release the message, it will be released by the caller.
+
+
+
+
+
◆ ProcessShutdown()
+
+
+
+
+
+
+
+
+ virtual void Aws::Crt::Io::ChannelHandler::ProcessShutdown
+ (
+ ChannelDirection
+ dir ,
+
+
+
+
+ int
+ errorCode ,
+
+
+
+
+ bool
+ freeScarceResourcesImmediately
+
+
+
+ )
+
+
+
+
+
+protected pure 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.
+
+
+
+
+
◆ ProcessWriteMessage()
+
+
+
+
+
+
+
+
+ virtual int Aws::Crt::Io::ChannelHandler::ProcessWriteMessage
+ (
+ struct aws_io_message *
+ message )
+
+
+
+
+
+protected pure 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.
+
Returns AWS_OP_SUCCESS if the message is being processed. If the message cannot be processed raise an error and return AWS_OP_ERR and do NOT release the message, it will be released by the caller.
+
+
+
+
+
◆ ResetStatistics()
+
+
+
+
+
+
+
+
+ virtual void Aws::Crt::Io::ChannelHandler::ResetStatistics
+ (
+ )
+
+
+
+
+
+inline protected virtual
+
+
+
+
Directs the channel handler to reset all of the internal statistics it tracks about itself.
+
+
+
+
+
◆ ScheduleTask() [1/2]
+
+
+
+
+
+ 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.
+
+
+
+
+
◆ ScheduleTask() [2/2]
+
+
+
+
+
+ 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.
+
+
+
+
+
◆ SendMessage()
+
+
+
+
+
+
+
+
+ bool Aws::Crt::Io::ChannelHandler::SendMessage
+ (
+ struct aws_io_message *
+ message ,
+
+
+
+
+ ChannelDirection
+ direction
+
+
+
+ )
+
+
+
+
+
+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.
+
+
+
+
+
◆ ShutDownChannel()
+
+
+
+
+
+ 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.
+
+
+
+
+
◆ UpstreamMessageOverhead()
+
+
+
+
+
+
+
+
+ size_t Aws::Crt::Io::ChannelHandler::UpstreamMessageOverhead
+ (
+ )
+ const
+
+
+
+
+protected
+
+
+
+
Fetches the current overhead of upstream handlers. This provides a hint to avoid fragmentation if you care.
+
+
+
+
+
+
◆ m_allocator
+
+
+
+
+
+
+
+
+ Allocator * Aws::Crt::Io::ChannelHandler::m_allocator
+
+
+
+
+protected
+
+
+
+
+
+
+
+
◆ m_handler
+
+
+
+
+
+
+
+
+ struct aws_channel_handler Aws::Crt::Io::ChannelHandler::m_handler
+
+
+
+
+protected
+
+
+
+
+
+
+
+
◆ s_GatherStatistics
+
+
+
+
+
+ void Aws::Crt::Io::ChannelHandler::s_GatherStatistics
+
+
+
+
+
+
+
+
◆ s_IncrementReadWindow
+
+
+
+
+
+ int Aws::Crt::Io::ChannelHandler::s_IncrementReadWindow
+
+
+
+
+
+
+
+
◆ s_InitialWindowSize
+
+
+
+
+
+ size_t Aws::Crt::Io::ChannelHandler::s_InitialWindowSize
+
+
+
+
+
+
+
+
◆ s_MessageOverhead
+
+
+
+
+
+ size_t Aws::Crt::Io::ChannelHandler::s_MessageOverhead
+
+
+
+
+
+
+
+
◆ s_ProcessReadMessage
+
+
+
+
+
+ int Aws::Crt::Io::ChannelHandler::s_ProcessReadMessage
+
+
+
+
+
+
+
+
◆ s_ProcessShutdown
+
+
+
+
+
+ int Aws::Crt::Io::ChannelHandler::s_ProcessShutdown
+
+
+
+
+
+
+
+
◆ s_ProcessWriteMessage
+
+
+
+
+
+ int Aws::Crt::Io::ChannelHandler::s_ProcessWriteMessage
+
+
+
+
+
+
+
+
◆ s_ResetStatistics
+
+
+
+
+
+ void Aws::Crt::Io::ChannelHandler::s_ResetStatistics
+
+
+
+
+
+
+
The documentation for this struct was generated from the following files:
+
+
+
+
+
diff --git a/docs/class_aws_1_1_crt_1_1_io_1_1_channel_handler.png b/docs/class_aws_1_1_crt_1_1_io_1_1_channel_handler.png
new file mode 100644
index 000000000..f526c774a
Binary files /dev/null and b/docs/class_aws_1_1_crt_1_1_io_1_1_channel_handler.png differ
diff --git a/docs/class_aws_1_1_crt_1_1_io_1_1_client_bootstrap-members.html b/docs/class_aws_1_1_crt_1_1_io_1_1_client_bootstrap-members.html
new file mode 100644
index 000000000..0e18ef48c
--- /dev/null
+++ b/docs/class_aws_1_1_crt_1_1_io_1_1_client_bootstrap-members.html
@@ -0,0 +1,93 @@
+
+
+
+
+
+
+
+aws-crt-cpp: Member List
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ 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.
+
+
+
+
+
diff --git a/docs/class_aws_1_1_crt_1_1_io_1_1_client_bootstrap.html b/docs/class_aws_1_1_crt_1_1_io_1_1_client_bootstrap.html
new file mode 100644
index 000000000..768786556
--- /dev/null
+++ b/docs/class_aws_1_1_crt_1_1_io_1_1_client_bootstrap.html
@@ -0,0 +1,416 @@
+
+
+
+
+
+
+
+aws-crt-cpp: Aws::Crt::Io::ClientBootstrap Class Reference
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ aws-crt-cpp
+
+ C++ wrapper around the aws-c-* libraries. Provides Cross-Platform Transport Protocols and SSL/TLS implementations for C++.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
#include <Bootstrap.h >
+
+
+
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).
+
+
+
◆ ClientBootstrap() [1/4]
+
+
+
+
Parameters
+
+ elGroup EventLoopGroup to use.
+ resolver DNS host resolver to use.
+ allocator memory allocator to use
+
+
+
+
+
+
+
+
◆ ClientBootstrap() [2/4]
+
+
+
+
◆ ~ClientBootstrap()
+
+
+
+
+
+ Aws::Crt::Io::ClientBootstrap::~ClientBootstrap
+ (
+ )
+
+
+
+
+
+
+
+
+
◆ ClientBootstrap() [3/4]
+
+
+
+
+
+
+
+
+ Aws::Crt::Io::ClientBootstrap::ClientBootstrap
+ (
+ const ClientBootstrap &
+ )
+
+
+
+
+
+delete
+
+
+
+
+
+
+
+
◆ ClientBootstrap() [4/4]
+
+
+
+
+
+
+
+
+ Aws::Crt::Io::ClientBootstrap::ClientBootstrap
+ (
+ ClientBootstrap &&
+ )
+
+
+
+
+
+delete
+
+
+
+
+
+
+
+
+
◆ EnableBlockingShutdown()
+
+
+
+
+
+
+
+
+ void Aws::Crt::Io::ClientBootstrap::EnableBlockingShutdown
+ (
+ )
+
+
+
+
+
+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.
+
+
+
+
+
◆ LastError()
+
+
+
+
+
+
+
+
+ int Aws::Crt::Io::ClientBootstrap::LastError
+ (
+ )
+ const
+
+
+
+
+noexcept
+
+
+
+
Returns the value of the last aws error encountered by operations on this instance.
+
+
+
+
+
◆ operator bool()
+
+
+
+
+
+
+
+
+ Aws::Crt::Io::ClientBootstrap::operator bool
+ (
+ )
+ const
+
+
+
+
+noexcept
+
+
+
+
Returns true if the instance is in a valid state, false otherwise.
+
+
+
+
+
◆ operator=() [1/2]
+
+
+
+
◆ operator=() [2/2]
+
+
+
+
◆ SetShutdownCompleteCallback()
+
+
+
+
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.
+
+
+
+
The documentation for this class was generated from the following files:
+
+
+
+
+
diff --git a/docs/class_aws_1_1_crt_1_1_io_1_1_client_tls_channel_handler-members.html b/docs/class_aws_1_1_crt_1_1_io_1_1_client_tls_channel_handler-members.html
new file mode 100644
index 000000000..f61b8edb9
--- /dev/null
+++ b/docs/class_aws_1_1_crt_1_1_io_1_1_client_tls_channel_handler-members.html
@@ -0,0 +1,122 @@
+
+
+
+
+
+
+
+aws-crt-cpp: Member List
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ 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.
+
+ AcquireMaxSizeMessageForWrite ()Aws::Crt::Io::ChannelHandler protected
+ AcquireMessageFromPool (MessageType messageType, size_t sizeHint)Aws::Crt::Io::ChannelHandler protected
+ ChannelHandler (const ChannelHandler &)=deleteAws::Crt::Io::ChannelHandler
+ ChannelHandler (Allocator *allocator=ApiAllocator())Aws::Crt::Io::ChannelHandler protected
+ ChannelsThreadIsCallersThread () constAws::Crt::Io::ChannelHandler
+ ClientTlsChannelHandler (struct aws_channel_slot *slot, const struct aws_tls_connection_options &options, Allocator *allocator=ApiAllocator())Aws::Crt::Io::ClientTlsChannelHandler protected
+ CompleteTlsNegotiation (int errorCode)Aws::Crt::Io::TlsChannelHandler protected
+ DownstreamReadWindow () constAws::Crt::Io::ChannelHandler protected
+ GatherStatistics (struct aws_array_list *)Aws::Crt::Io::ChannelHandler inline protected virtual
+ GetProtocol () const =0Aws::Crt::Io::TlsChannelHandler pure virtual
+ GetSlot () constAws::Crt::Io::ChannelHandler protected
+ IncrementReadWindow (size_t size)=0Aws::Crt::Io::ChannelHandler protected pure virtual
+ IncrementUpstreamReadWindow (size_t windowUpdateSize)Aws::Crt::Io::ChannelHandler protected
+ InitialWindowSize ()=0Aws::Crt::Io::ChannelHandler protected pure virtual
+ m_allocator Aws::Crt::Io::ChannelHandler protected
+ m_handler Aws::Crt::Io::ChannelHandler protected
+ MessageOverhead ()=0Aws::Crt::Io::ChannelHandler protected pure virtual
+ OnShutdownComplete (ChannelDirection direction, int errorCode, bool freeScarceResourcesImmediately)Aws::Crt::Io::ChannelHandler protected
+ operator= (const ChannelHandler &)=deleteAws::Crt::Io::ChannelHandler
+ ProcessReadMessage (struct aws_io_message *message)=0Aws::Crt::Io::ChannelHandler protected pure virtual
+ ProcessShutdown (ChannelDirection dir, int errorCode, bool freeScarceResourcesImmediately)=0Aws::Crt::Io::ChannelHandler protected pure virtual
+ ProcessWriteMessage (struct aws_io_message *message)=0Aws::Crt::Io::ChannelHandler protected pure virtual
+ ResetStatistics ()Aws::Crt::Io::ChannelHandler inline protected virtual
+ s_GatherStatistics Aws::Crt::Io::ChannelHandler
+ s_IncrementReadWindow Aws::Crt::Io::ChannelHandler
+ s_InitialWindowSize Aws::Crt::Io::ChannelHandler
+ s_MessageOverhead Aws::Crt::Io::ChannelHandler
+ s_ProcessReadMessage Aws::Crt::Io::ChannelHandler
+ s_ProcessShutdown Aws::Crt::Io::ChannelHandler
+ s_ProcessWriteMessage Aws::Crt::Io::ChannelHandler
+ s_ResetStatistics Aws::Crt::Io::ChannelHandler
+ ScheduleTask (std::function< void(TaskStatus)> &&task)Aws::Crt::Io::ChannelHandler
+ ScheduleTask (std::function< void(TaskStatus)> &&task, std::chrono::nanoseconds run_in)Aws::Crt::Io::ChannelHandler
+ SendMessage (struct aws_io_message *message, ChannelDirection direction)Aws::Crt::Io::ChannelHandler protected
+ ShutDownChannel (int errorCode)Aws::Crt::Io::ChannelHandler
+ StartNegotiation ()=0Aws::Crt::Io::ClientTlsChannelHandler pure virtual
+ TlsChannelHandler (struct aws_channel_slot *slot, const struct aws_tls_connection_options &options, Allocator *allocator=ApiAllocator())Aws::Crt::Io::TlsChannelHandler protected
+ UpstreamMessageOverhead () constAws::Crt::Io::ChannelHandler protected
+ ~ChannelHandler ()=defaultAws::Crt::Io::ChannelHandler virtual
+ ~TlsChannelHandler ()Aws::Crt::Io::TlsChannelHandler virtual
+
+
+
+
+
diff --git a/docs/class_aws_1_1_crt_1_1_io_1_1_client_tls_channel_handler.html b/docs/class_aws_1_1_crt_1_1_io_1_1_client_tls_channel_handler.html
new file mode 100644
index 000000000..7fff1e471
--- /dev/null
+++ b/docs/class_aws_1_1_crt_1_1_io_1_1_client_tls_channel_handler.html
@@ -0,0 +1,268 @@
+
+
+
+
+
+
+
+aws-crt-cpp: Aws::Crt::Io::ClientTlsChannelHandler Class Reference
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ aws-crt-cpp
+
+ C++ wrapper around the aws-c-* libraries. Provides Cross-Platform Transport Protocols and SSL/TLS implementations for C++.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
#include <TlsOptions.h >
+
+
+
+
+
+
+
+
+
+
+
+ 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
+
+
+
+
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() .
+
+
+
◆ ClientTlsChannelHandler()
+
+
+
+
+
+
+
+
+ Aws::Crt::Io::ClientTlsChannelHandler::ClientTlsChannelHandler
+ (
+ struct aws_channel_slot *
+ slot ,
+
+
+
+
+ const struct aws_tls_connection_options &
+ options ,
+
+
+
+
+ Allocator *
+ allocator = ApiAllocator ()
+
+
+
+ )
+
+
+
+
+
+protected
+
+
+
+
+
+
+
+
+
◆ StartNegotiation()
+
+
+
+
+
+
+
+
+ virtual void Aws::Crt::Io::ClientTlsChannelHandler::StartNegotiation
+ (
+ )
+
+
+
+
+
+pure virtual
+
+
+
+
Initiates the TLS session negotiation. This is called by the common runtime when it's time to start a new session.
+
+
+
+
The documentation for this class was generated from the following files:
+
+
+
+
+
diff --git a/docs/class_aws_1_1_crt_1_1_io_1_1_client_tls_channel_handler.png b/docs/class_aws_1_1_crt_1_1_io_1_1_client_tls_channel_handler.png
new file mode 100644
index 000000000..c05cc1640
Binary files /dev/null and b/docs/class_aws_1_1_crt_1_1_io_1_1_client_tls_channel_handler.png differ
diff --git a/docs/class_aws_1_1_crt_1_1_io_1_1_default_host_resolver-members.html b/docs/class_aws_1_1_crt_1_1_io_1_1_default_host_resolver-members.html
new file mode 100644
index 000000000..3fa174f46
--- /dev/null
+++ b/docs/class_aws_1_1_crt_1_1_io_1_1_default_host_resolver-members.html
@@ -0,0 +1,93 @@
+
+
+
+
+
+
+
+aws-crt-cpp: Member List
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ 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.
+
+
+
+
+
diff --git a/docs/class_aws_1_1_crt_1_1_io_1_1_default_host_resolver.html b/docs/class_aws_1_1_crt_1_1_io_1_1_default_host_resolver.html
new file mode 100644
index 000000000..1c4ab6cf3
--- /dev/null
+++ b/docs/class_aws_1_1_crt_1_1_io_1_1_default_host_resolver.html
@@ -0,0 +1,450 @@
+
+
+
+
+
+
+
+aws-crt-cpp: Aws::Crt::Io::DefaultHostResolver Class Reference
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ aws-crt-cpp
+
+ C++ wrapper around the aws-c-* libraries. Provides Cross-Platform Transport Protocols and SSL/TLS implementations for C++.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
#include <HostResolver.h >
+
+
+
+
+
+
+
+
+
+
+
A wrapper around the CRT default host resolution system that uses getaddrinfo() farmed off to separate threads in order to resolve names.
+
+
+
◆ DefaultHostResolver() [1/4]
+
+
+
+
+
+
+
+
+ Aws::Crt::Io::DefaultHostResolver::DefaultHostResolver
+ (
+ EventLoopGroup &
+ elGroup ,
+
+
+
+
+ size_t
+ maxHosts ,
+
+
+
+
+ size_t
+ maxTTL ,
+
+
+
+
+ Allocator *
+ allocator = ApiAllocator ()
+
+
+
+ )
+
+
+
+
+
+noexcept
+
+
+
+
Resolves DNS addresses.
+
Parameters
+
+ 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.
+
+
+
+
+
+
+
+
◆ DefaultHostResolver() [2/4]
+
+
+
+
+
+
+
+
+ Aws::Crt::Io::DefaultHostResolver::DefaultHostResolver
+ (
+ size_t
+ maxHosts ,
+
+
+
+
+ size_t
+ maxTTL ,
+
+
+
+
+ Allocator *
+ allocator = ApiAllocator ()
+
+
+
+ )
+
+
+
+
+
+noexcept
+
+
+
+
+
+
◆ ~DefaultHostResolver()
+
+
+
+
+
+ Aws::Crt::Io::DefaultHostResolver::~DefaultHostResolver
+ (
+ )
+
+
+
+
+
+
+
+
+
◆ DefaultHostResolver() [3/4]
+
+
+
+
+
+
+
+
+ Aws::Crt::Io::DefaultHostResolver::DefaultHostResolver
+ (
+ const DefaultHostResolver &
+ )
+
+
+
+
+
+delete
+
+
+
+
+
+
+
+
◆ DefaultHostResolver() [4/4]
+
+
+
+
+
+
+
+
+ Aws::Crt::Io::DefaultHostResolver::DefaultHostResolver
+ (
+ DefaultHostResolver &&
+ )
+
+
+
+
+
+delete
+
+
+
+
+
+
+
+
+
◆ LastError()
+
+
+
+
+
+
+
+
+ int Aws::Crt::Io::DefaultHostResolver::LastError
+ (
+ )
+ const
+
+
+
+
+inline noexcept
+
+
+
+
Returns the value of the last aws error encountered by operations on this instance.
+
+
+
+
+
◆ operator bool()
+
+
+
+
+
+
+
+
+ Aws::Crt::Io::DefaultHostResolver::operator bool
+ (
+ )
+ const
+
+
+
+
+inline noexcept
+
+
+
+
Returns true if the instance is in a valid state, false otherwise.
+
+
+
+
+
◆ operator=() [1/2]
+
+
+
+
◆ operator=() [2/2]
+
+
+
+
◆ ResolveHost()
+
+
+
+
+
+
+
+
+ bool Aws::Crt::Io::DefaultHostResolver::ResolveHost
+ (
+ const String &
+ host ,
+
+
+
+
+ const OnHostResolved &
+ onResolved
+
+
+
+ )
+
+
+
+
+
+override virtual noexcept
+
+
+
+
Kicks off an asynchronous resolution of host. onResolved will be invoked upon completion of the resolution.
Returns False, the resolution was not attempted. True, onResolved will be called with the result.
+
+
Implements Aws::Crt::Io::HostResolver .
+
+
+
+
The documentation for this class was generated from the following files:
+
+
+
+
+
diff --git a/docs/class_aws_1_1_crt_1_1_io_1_1_default_host_resolver.png b/docs/class_aws_1_1_crt_1_1_io_1_1_default_host_resolver.png
new file mode 100644
index 000000000..4d6f3f834
Binary files /dev/null and b/docs/class_aws_1_1_crt_1_1_io_1_1_default_host_resolver.png differ
diff --git a/docs/class_aws_1_1_crt_1_1_io_1_1_event_loop_group-members.html b/docs/class_aws_1_1_crt_1_1_io_1_1_event_loop_group-members.html
new file mode 100644
index 000000000..c4c9d8074
--- /dev/null
+++ b/docs/class_aws_1_1_crt_1_1_io_1_1_event_loop_group-members.html
@@ -0,0 +1,91 @@
+
+
+
+
+
+
+
+aws-crt-cpp: Member List
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ 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.
+
+
+
+
+
diff --git a/docs/class_aws_1_1_crt_1_1_io_1_1_event_loop_group.html b/docs/class_aws_1_1_crt_1_1_io_1_1_event_loop_group.html
new file mode 100644
index 000000000..116ac8452
--- /dev/null
+++ b/docs/class_aws_1_1_crt_1_1_io_1_1_event_loop_group.html
@@ -0,0 +1,367 @@
+
+
+
+
+
+
+
+aws-crt-cpp: Aws::Crt::Io::EventLoopGroup Class Reference
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ aws-crt-cpp
+
+ C++ wrapper around the aws-c-* libraries. Provides Cross-Platform Transport Protocols and SSL/TLS implementations for C++.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
#include <EventLoopGroup.h >
+
+
+
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.
+
+
+
◆ EventLoopGroup() [1/4]
+
+
+
+
+
+
+
+
+ Aws::Crt::Io::EventLoopGroup::EventLoopGroup
+ (
+ uint16_t
+ threadCount = 0
,
+
+
+
+
+ Allocator *
+ allocator = ApiAllocator ()
+
+
+
+ )
+
+
+
+
+
+noexcept
+
+
+
+
Parameters
+
+ 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.
+
+
+
+
+
+
+
+
◆ EventLoopGroup() [2/4]
+
+
+
+
+
+
+
+
+ Aws::Crt::Io::EventLoopGroup::EventLoopGroup
+ (
+ uint16_t
+ cpuGroup ,
+
+
+
+
+ uint16_t
+ threadCount ,
+
+
+
+
+ Allocator *
+ allocator = ApiAllocator ()
+
+
+
+ )
+
+
+
+
+
+noexcept
+
+
+
+
Parameters
+
+ 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.
+
+
+
+
+
+
+
+
◆ ~EventLoopGroup()
+
+
+
+
+
+ Aws::Crt::Io::EventLoopGroup::~EventLoopGroup
+ (
+ )
+
+
+
+
+
+
+
+
+
◆ EventLoopGroup() [3/4]
+
+
+
+
+
+
+
+
+ Aws::Crt::Io::EventLoopGroup::EventLoopGroup
+ (
+ const EventLoopGroup &
+ )
+
+
+
+
+
+delete
+
+
+
+
+
+
+
+
◆ EventLoopGroup() [4/4]
+
+
+
+
+
+
+
+
+ Aws::Crt::Io::EventLoopGroup::EventLoopGroup
+ (
+ EventLoopGroup &&
+ toMove )
+
+
+
+
+
+noexcept
+
+
+
+
+
+
+
+
+
◆ LastError()
+
+
+
+
+
+ int Aws::Crt::Io::EventLoopGroup::LastError
+ (
+ )
+ const
+
+
+
+
Returns the value of the last aws error encountered by operations on this instance.
+
+
+
+
+
◆ operator bool()
+
+
+
+
+
+ Aws::Crt::Io::EventLoopGroup::operator bool
+ (
+ )
+ const
+
+
+
+
Returns true if the instance is in a valid state, false otherwise.
+
+
+
+
+
◆ operator=() [1/2]
+
+
+
+
◆ operator=() [2/2]
+
+
+
The documentation for this class was generated from the following files:
+
+
+
+
+
diff --git a/docs/class_aws_1_1_crt_1_1_io_1_1_host_resolver-members.html b/docs/class_aws_1_1_crt_1_1_io_1_1_host_resolver-members.html
new file mode 100644
index 000000000..278e951e0
--- /dev/null
+++ b/docs/class_aws_1_1_crt_1_1_io_1_1_host_resolver-members.html
@@ -0,0 +1,84 @@
+
+
+
+
+
+
+
+aws-crt-cpp: Member List
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ 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.
+
+
+
+
+
diff --git a/docs/class_aws_1_1_crt_1_1_io_1_1_host_resolver.html b/docs/class_aws_1_1_crt_1_1_io_1_1_host_resolver.html
new file mode 100644
index 000000000..1f520abcb
--- /dev/null
+++ b/docs/class_aws_1_1_crt_1_1_io_1_1_host_resolver.html
@@ -0,0 +1,172 @@
+
+
+
+
+
+
+
+aws-crt-cpp: Aws::Crt::Io::HostResolver Class Reference
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ aws-crt-cpp
+
+ C++ wrapper around the aws-c-* libraries. Provides Cross-Platform Transport Protocols and SSL/TLS implementations for C++.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
#include <HostResolver.h >
+
+
+
+
+
+
+
+
+
+
+
Simple interface for DNS name lookup implementations
+
+
+
◆ ~HostResolver()
+
+
+
+
+
+
+
+
+ Aws::Crt::Io::HostResolver::~HostResolver
+ (
+ )
+
+
+
+
+
+virtual
+
+
+
+
+
+
+
+
+
◆ ResolveHost()
+
+
+
+
+
+
+
+
+ virtual bool Aws::Crt::Io::HostResolver::ResolveHost
+ (
+ const String &
+ host ,
+
+
+
+
+ const OnHostResolved &
+ onResolved
+
+
+
+ )
+
+
+
+
+
+pure virtual noexcept
+
+
+
+
+
The documentation for this class was generated from the following files:
+
+
+
+
+
diff --git a/docs/class_aws_1_1_crt_1_1_io_1_1_host_resolver.png b/docs/class_aws_1_1_crt_1_1_io_1_1_host_resolver.png
new file mode 100644
index 000000000..28192bed2
Binary files /dev/null and b/docs/class_aws_1_1_crt_1_1_io_1_1_host_resolver.png differ
diff --git a/docs/class_aws_1_1_crt_1_1_io_1_1_input_stream-members.html b/docs/class_aws_1_1_crt_1_1_io_1_1_input_stream-members.html
new file mode 100644
index 000000000..58afc0420
--- /dev/null
+++ b/docs/class_aws_1_1_crt_1_1_io_1_1_input_stream-members.html
@@ -0,0 +1,106 @@
+
+
+
+
+
+
+
+aws-crt-cpp: Member List
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ 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.
+
+
+
+
+
diff --git a/docs/class_aws_1_1_crt_1_1_io_1_1_input_stream.html b/docs/class_aws_1_1_crt_1_1_io_1_1_input_stream.html
new file mode 100644
index 000000000..5f062b97a
--- /dev/null
+++ b/docs/class_aws_1_1_crt_1_1_io_1_1_input_stream.html
@@ -0,0 +1,740 @@
+
+
+
+
+
+
+
+aws-crt-cpp: Aws::Crt::Io::InputStream Class Reference
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ aws-crt-cpp
+
+ C++ wrapper around the aws-c-* libraries. Provides Cross-Platform Transport Protocols and SSL/TLS implementations for C++.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
#include <Stream.h >
+
+
+
+
+
+
+
+
+
+
+
+
+
◆ ~InputStream()
+
+
+
+
+
+
+
+
+ Aws::Crt::Io::InputStream::~InputStream
+ (
+ )
+
+
+
+
+
+virtual
+
+
+
+
+
+
+
+
◆ InputStream() [1/3]
+
+
+
+
+
+
+
+
+ Aws::Crt::Io::InputStream::InputStream
+ (
+ const InputStream &
+ )
+
+
+
+
+
+delete
+
+
+
+
+
+
+
+
◆ InputStream() [2/3]
+
+
+
+
+
+
+
+
+ Aws::Crt::Io::InputStream::InputStream
+ (
+ InputStream &&
+ )
+
+
+
+
+
+delete
+
+
+
+
+
+
+
+
◆ InputStream() [3/3]
+
+
+
+
+
◆ GetLength()
+
+
+
+
+
+
+
+
+ bool Aws::Crt::Io::InputStream::GetLength
+ (
+ int64_t &
+ length )
+
+
+
+
+
+inline
+
+
+
+
Gets the stream's length. Some streams may not be able to answer this.
Parameters
+
+ length output parameter for the length of the stream
+
+
+
+
Returns success/failure
+
+
+
+
+
◆ GetLengthImpl()
+
+
+
+
+
+
+
+
+ virtual int64_t Aws::Crt::Io::InputStream::GetLengthImpl
+ (
+ )
+ const
+
+
+
+
+protected pure virtual noexcept
+
+
+
+
+
+
◆ GetStatus()
+
+
+
+
+
+
+
+
+ bool Aws::Crt::Io::InputStream::GetStatus
+ (
+ StreamStatus &
+ status )
+
+
+
+
+
+inline
+
+
+
+
Gets the stream's current status
Parameters
+
+ status output parameter for the stream's status
+
+
+
+
Returns success/failure
+
+
+
+
+
◆ GetStatusImpl()
+
+
+
+
+
+
+
+
+ virtual StreamStatus Aws::Crt::Io::InputStream::GetStatusImpl
+ (
+ )
+ const
+
+
+
+
+protected pure virtual noexcept
+
+
+
+
+
+
◆ IsValid()
+
+
+
+
+
+
+
+
+ virtual bool Aws::Crt::Io::InputStream::IsValid
+ (
+ )
+ const
+
+
+
+
+pure virtual noexcept
+
+
+
+
+
+
◆ operator bool()
+
+
+
+
+
+
+
+
+ Aws::Crt::Io::InputStream::operator bool
+ (
+ )
+ const
+
+
+
+
+inline explicit noexcept
+
+
+
+
+
+
+
+
◆ operator=() [1/2]
+
+
+
+
◆ operator=() [2/2]
+
+
+
+
◆ PeekImpl()
+
+
+
+
+
+
+
+
+ virtual int64_t Aws::Crt::Io::InputStream::PeekImpl
+ (
+ )
+ const
+
+
+
+
+protected pure virtual noexcept
+
+
+
+
Peeks the stream
+
Essentially calls peek on the underlying istream
+
Returns return value of the underlying istream::peek
+
+
Implemented in Aws::Crt::Io::StdIOStreamInputStream .
+
+
+
+
+
◆ Read()
+
+
+
+
+
+
+
+
+ bool Aws::Crt::Io::InputStream::Read
+ (
+ ByteBuf &
+ dest )
+
+
+
+
+
+inline
+
+
+
+
Reads data from the stream into a buffer
Parameters
+
+ dest buffer to add the read data into
+
+
+
+
Returns success/failure
+
+
+
+
+
◆ ReadImpl()
+
+
+
+
+
+
+
+
+ virtual bool Aws::Crt::Io::InputStream::ReadImpl
+ (
+ ByteBuf &
+ buffer )
+
+
+
+
+
+protected pure virtual noexcept
+
+
+
+
+
+
◆ ReadSomeImpl()
+
+
+
+
+
+
+
+
+ virtual bool Aws::Crt::Io::InputStream::ReadSomeImpl
+ (
+ ByteBuf &
+ buffer )
+
+
+
+
+
+protected pure virtual noexcept
+
+
+
+
+
+
◆ Seek()
+
+
+
+
+
+
+
+
+ bool Aws::Crt::Io::InputStream::Seek
+ (
+ int64_t
+ offset ,
+
+
+
+
+ StreamSeekBasis
+ seekBasis
+
+
+
+ )
+
+
+
+
+
+inline
+
+
+
+
Moves the head of the stream to a new location
Parameters
+
+ offset how far to move, in bytes
+ seekBasis what direction to move the head of stream
+
+
+
+
Returns success/failure
+
+
+
+
+
◆ SeekImpl()
+
+
+
+
+
+
+
+
+ virtual bool Aws::Crt::Io::InputStream::SeekImpl
+ (
+ int64_t
+ offset ,
+
+
+
+
+ StreamSeekBasis
+ seekBasis
+
+
+
+ )
+
+
+
+
+
+protected pure virtual noexcept
+
+
+
+
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.
+
Returns true on success, false otherwise. You SHOULD raise an error via aws_raise_error() if a failure occurs.
+
+
+
+
+
+
◆ m_allocator
+
+
+
+
+
+
+
+
+ Allocator * Aws::Crt::Io::InputStream::m_allocator
+
+
+
+
+protected
+
+
+
+
+
+
+
+
◆ m_underlying_stream
+
+
+
+
+
+
+
+
+ aws_input_stream Aws::Crt::Io::InputStream::m_underlying_stream
+
+
+
+
+protected
+
+
+
+
+
+
+
The documentation for this class was generated from the following files:
+
+
+
+
+
diff --git a/docs/class_aws_1_1_crt_1_1_io_1_1_input_stream.png b/docs/class_aws_1_1_crt_1_1_io_1_1_input_stream.png
new file mode 100644
index 000000000..ee0019e24
Binary files /dev/null and b/docs/class_aws_1_1_crt_1_1_io_1_1_input_stream.png differ
diff --git a/docs/class_aws_1_1_crt_1_1_io_1_1_pkcs11_lib-members.html b/docs/class_aws_1_1_crt_1_1_io_1_1_pkcs11_lib-members.html
new file mode 100644
index 000000000..f5d765329
--- /dev/null
+++ b/docs/class_aws_1_1_crt_1_1_io_1_1_pkcs11_lib-members.html
@@ -0,0 +1,86 @@
+
+
+
+
+
+
+
+aws-crt-cpp: Member List
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ 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.
+
+
+
+
+
diff --git a/docs/class_aws_1_1_crt_1_1_io_1_1_pkcs11_lib.html b/docs/class_aws_1_1_crt_1_1_io_1_1_pkcs11_lib.html
new file mode 100644
index 000000000..6e802d947
--- /dev/null
+++ b/docs/class_aws_1_1_crt_1_1_io_1_1_pkcs11_lib.html
@@ -0,0 +1,266 @@
+
+
+
+
+
+
+
+aws-crt-cpp: Aws::Crt::Io::Pkcs11Lib Class Reference
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ aws-crt-cpp
+
+ C++ wrapper around the aws-c-* libraries. Provides Cross-Platform Transport Protocols and SSL/TLS implementations for C++.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
#include <Pkcs11.h >
+
+
+
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.
+
+
+
◆ InitializeFinalizeBehavior
+
+
+
+
Controls how Pkcs11Lib calls C_Initialize()
and C_Finalize()
on the PKCS#11 library.
+
+Enumerator Default Default behavior that accommodates most use cases.
+C_Initialize()
is called on creation, and "already-initialized" errors are ignored. C_Finalize()
is never called, just in case another part of your application is still using the PKCS#11 library.
+
+ Omit Skip calling C_Initialize()
and C_Finalize()
.
+Use this if your application has already initialized the PKCS#11 library, and you do not want C_Initialize()
called again.
+
+ Strict C_Initialize()
is called on creation and C_Finalize()
is called on cleanup.
+If C_Initialize()
reports that's it's already initialized, this is treated as an error. Use this if you need perfect cleanup (ex: running valgrind with –leak-check).
+
+
+
+
+
+
+
+
◆ ~Pkcs11Lib()
+
+
+
+
+
+ Aws::Crt::Io::Pkcs11Lib::~Pkcs11Lib
+ (
+ )
+
+
+
+
+
+
+
+
+
+
◆ Create() [1/2]
+
+
+
+
Load and initialize a PKCS#11 library.
+
C_Initialize()
and C_Finalize()
are called on the PKCS#11 library in the InitializeFinalizeBehavior::Default way.
+
Parameters
+
+ 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.
+
+
+
+
Returns If successful a 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.
+
+
+
+
+
◆ Create() [2/2]
+
+
+
+
Load a PKCS#11 library, specifying how C_Initialize()
and C_Finalize()
will be called.
+
Parameters
+
+ 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.
+
+
+
+
Returns If successful a 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.
+
+
+
+
The documentation for this class was generated from the following files:
+
+
+
+
+
diff --git a/docs/class_aws_1_1_crt_1_1_io_1_1_socket_options-members.html b/docs/class_aws_1_1_crt_1_1_io_1_1_socket_options-members.html
new file mode 100644
index 000000000..8db5fac2c
--- /dev/null
+++ b/docs/class_aws_1_1_crt_1_1_io_1_1_socket_options-members.html
@@ -0,0 +1,101 @@
+
+
+
+
+
+
+
+aws-crt-cpp: Member List
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ 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.
+
+
+
+
+
diff --git a/docs/class_aws_1_1_crt_1_1_io_1_1_socket_options.html b/docs/class_aws_1_1_crt_1_1_io_1_1_socket_options.html
new file mode 100644
index 000000000..7a8379abf
--- /dev/null
+++ b/docs/class_aws_1_1_crt_1_1_io_1_1_socket_options.html
@@ -0,0 +1,661 @@
+
+
+
+
+
+
+
+aws-crt-cpp: Aws::Crt::Io::SocketOptions Class Reference
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ aws-crt-cpp
+
+ C++ wrapper around the aws-c-* libraries. Provides Cross-Platform Transport Protocols and SSL/TLS implementations for C++.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
#include <SocketOptions.h >
+
+
+
Socket configuration options
+
+
+
◆ SocketOptions() [1/3]
+
+
+
+
+
+ Aws::Crt::Io::SocketOptions::SocketOptions
+ (
+ )
+
+
+
+
+
+
+
+
+
◆ SocketOptions() [2/3]
+
+
+
+
+
+
+
+
+ Aws::Crt::Io::SocketOptions::SocketOptions
+ (
+ const SocketOptions &
+ rhs )
+
+
+
+
+
+default
+
+
+
+
+
+
+
+
◆ SocketOptions() [3/3]
+
+
+
+
+
+
+
+
+ Aws::Crt::Io::SocketOptions::SocketOptions
+ (
+ SocketOptions &&
+ rhs )
+
+
+
+
+
+default
+
+
+
+
+
+
+
+
+
◆ GetConnectTimeoutMs()
+
+
+
+
+
+
+
+
+ uint32_t Aws::Crt::Io::SocketOptions::GetConnectTimeoutMs
+ (
+ )
+ const
+
+
+
+
+inline
+
+
+
+
Returns the connection timeout in milliseconds to use with the socket
+
+
+
+
+
◆ GetKeepAlive()
+
+
+
+
+
+
+
+
+ bool Aws::Crt::Io::SocketOptions::GetKeepAlive
+ (
+ )
+ const
+
+
+
+
+inline
+
+
+
+
Returns true/false if the socket implementation should use TCP keepalive
+
+
+
+
+
◆ GetKeepAliveIntervalSec()
+
+
+
+
+
+
+
+
+ uint16_t Aws::Crt::Io::SocketOptions::GetKeepAliveIntervalSec
+ (
+ )
+ const
+
+
+
+
+inline
+
+
+
+
Returns the (tcp) keep alive interval to use with the socket, in seconds
+
+
+
+
+
◆ GetKeepAliveMaxFailedProbes()
+
+
+
+
+
+
+
+
+ uint16_t Aws::Crt::Io::SocketOptions::GetKeepAliveMaxFailedProbes
+ (
+ )
+ const
+
+
+
+
+inline
+
+
+
+
Returns number of keepalive probes allowed to fail before a connection is considered lost.
+
+
+
+
+
◆ GetKeepAliveTimeoutSec()
+
+
+
+
+
+
+
+
+ uint16_t Aws::Crt::Io::SocketOptions::GetKeepAliveTimeoutSec
+ (
+ )
+ const
+
+
+
+
+inline
+
+
+
+
Returns interval, in seconds, that a connection must be idle for before keep alive probes begin to get sent out
+
+
+
+
+
◆ GetSocketDomain()
+
+
+
+
+
+
+
+
+ SocketDomain Aws::Crt::Io::SocketOptions::GetSocketDomain
+ (
+ )
+ const
+
+
+
+
+inline
+
+
+
+
Returns the domain type to use with the socket
+
+
+
+
+
◆ GetSocketType()
+
+
+
+
+
+
+
+
+ SocketType Aws::Crt::Io::SocketOptions::GetSocketType
+ (
+ )
+ const
+
+
+
+
+inline
+
+
+
+
Returns the type of socket to use
+
+
+
+
+
◆ operator=() [1/2]
+
+
+
+
◆ operator=() [2/2]
+
+
+
+
◆ SetConnectTimeoutMs()
+
+
+
+
+
+
+
+
+ void Aws::Crt::Io::SocketOptions::SetConnectTimeoutMs
+ (
+ uint32_t
+ timeout )
+
+
+
+
+
+inline
+
+
+
+
Set connection timeout
Parameters
+
+ timeout connection timeout in milliseconds.
+
+
+
+
+
+
+
+
◆ SetKeepAlive()
+
+
+
+
+
+
+
+
+ void Aws::Crt::Io::SocketOptions::SetKeepAlive
+ (
+ bool
+ keepAlive )
+
+
+
+
+
+inline
+
+
+
+
Set keep alive option.
Parameters
+
+ keepAlive True, periodically transmit keepalive messages for detecting a disconnected peer.
+
+
+
+
+
+
+
+
◆ SetKeepAliveIntervalSec()
+
+
+
+
+
+
+
+
+ void Aws::Crt::Io::SocketOptions::SetKeepAliveIntervalSec
+ (
+ uint16_t
+ keepAliveInterval )
+
+
+
+
+
+inline
+
+
+
+
Set keep alive interval seconds.
Parameters
+
+ keepAliveInterval Duration, in seconds, between keepalive probes. If 0, then a default value is used.
+
+
+
+
+
+
+
+
◆ SetKeepAliveMaxFailedProbes()
+
+
+
+
+
+
+
+
+ void Aws::Crt::Io::SocketOptions::SetKeepAliveMaxFailedProbes
+ (
+ uint16_t
+ maxProbes )
+
+
+
+
+
+inline
+
+
+
+
Set keep alive max failed probes.
Parameters
+
+ maxProbes The number of keepalive probes allowed to fail before a connection is considered lost.
+
+
+
+
+
+
+
+
◆ SetKeepAliveTimeoutSec()
+
+
+
+
+
+
+
+
+ void Aws::Crt::Io::SocketOptions::SetKeepAliveTimeoutSec
+ (
+ uint16_t
+ keepAliveTimeout )
+
+
+
+
+
+inline
+
+
+
+
Set keep alive time out seconds.
Parameters
+
+ keepAliveTimeout interval, in seconds, that a connection must be idle for before keep alive probes begin to get sent out
+
+
+
+
+
+
+
+
◆ SetSocketDomain()
+
+
+
+
+
+
+
+
+ void Aws::Crt::Io::SocketOptions::SetSocketDomain
+ (
+ SocketDomain
+ domain )
+
+
+
+
+
+inline
+
+
+
+
Set socket domain
Parameters
+
+ domain SocketDomain object.
+
+
+
+
+
+
+
+
◆ SetSocketType()
+
+
+
+
+
+
+
+
+ void Aws::Crt::Io::SocketOptions::SetSocketType
+ (
+ SocketType
+ type )
+
+
+
+
+
+inline
+
+
+
+
Set socket type
Parameters
+
+ type SocketType object.
+
+
+
+
+
+
+
The documentation for this class was generated from the following files:
+
+
+
+
+
diff --git a/docs/class_aws_1_1_crt_1_1_io_1_1_std_i_o_stream_input_stream-members.html b/docs/class_aws_1_1_crt_1_1_io_1_1_std_i_o_stream_input_stream-members.html
new file mode 100644
index 000000000..095aedbff
--- /dev/null
+++ b/docs/class_aws_1_1_crt_1_1_io_1_1_std_i_o_stream_input_stream-members.html
@@ -0,0 +1,108 @@
+
+
+
+
+
+
+
+aws-crt-cpp: Member List
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ 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.
+
+
+
+
+
diff --git a/docs/class_aws_1_1_crt_1_1_io_1_1_std_i_o_stream_input_stream.html b/docs/class_aws_1_1_crt_1_1_io_1_1_std_i_o_stream_input_stream.html
new file mode 100644
index 000000000..fbc668842
--- /dev/null
+++ b/docs/class_aws_1_1_crt_1_1_io_1_1_std_i_o_stream_input_stream.html
@@ -0,0 +1,411 @@
+
+
+
+
+
+
+
+aws-crt-cpp: Aws::Crt::Io::StdIOStreamInputStream Class Reference
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ aws-crt-cpp
+
+ C++ wrapper around the aws-c-* libraries. Provides Cross-Platform Transport Protocols and SSL/TLS implementations for C++.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
#include <Stream.h >
+
+
+
+
+
+
+
+
+
+
+
+
+
◆ StdIOStreamInputStream()
+
+
+
+
+
◆ GetLengthImpl()
+
+
+
+
+
+
+
+
+ int64_t Aws::Crt::Io::StdIOStreamInputStream::GetLengthImpl
+ (
+ )
+ const
+
+
+
+
+override protected virtual noexcept
+
+
+
+
Returns the total length of the available data for the stream.
+
+-1 if not available.
+
+
Implements Aws::Crt::Io::InputStream .
+
+
+
+
+
◆ GetStatusImpl()
+
+
+
+
+
+
+
+
+ StreamStatus Aws::Crt::Io::StdIOStreamInputStream::GetStatusImpl
+ (
+ )
+ const
+
+
+
+
+override protected virtual noexcept
+
+
+
+
+
+
◆ IsValid()
+
+
+
+
+
+
+
+
+ bool Aws::Crt::Io::StdIOStreamInputStream::IsValid
+ (
+ )
+ const
+
+
+
+
+override virtual noexcept
+
+
+
+
+
+
◆ PeekImpl()
+
+
+
+
+
+
+
+
+ int64_t Aws::Crt::Io::StdIOStreamInputStream::PeekImpl
+ (
+ )
+ const
+
+
+
+
+override protected virtual noexcept
+
+
+
+
Peeks the stream
+
Essentially calls peek on the underlying istream
+
Returns return value of the underlying istream::peek
+
+
Implements Aws::Crt::Io::InputStream .
+
+
+
+
+
◆ ReadImpl()
+
+
+
+
+
+
+
+
+ bool Aws::Crt::Io::StdIOStreamInputStream::ReadImpl
+ (
+ ByteBuf &
+ buffer )
+
+
+
+
+
+override protected virtual noexcept
+
+
+
+
+
+
◆ ReadSomeImpl()
+
+
+
+
+
+
+
+
+ bool Aws::Crt::Io::StdIOStreamInputStream::ReadSomeImpl
+ (
+ ByteBuf &
+ buffer )
+
+
+
+
+
+override protected virtual noexcept
+
+
+
+
+
+
◆ SeekImpl()
+
+
+
+
+
+
+
+
+ bool Aws::Crt::Io::StdIOStreamInputStream::SeekImpl
+ (
+ OffsetType
+ offsetType ,
+
+
+
+
+ StreamSeekBasis
+ seekBasis
+
+
+
+ )
+
+
+
+
+
+override protected noexcept
+
+
+
+
+
+
+
The documentation for this class was generated from the following files:
+
+
+
+
+
diff --git a/docs/class_aws_1_1_crt_1_1_io_1_1_std_i_o_stream_input_stream.png b/docs/class_aws_1_1_crt_1_1_io_1_1_std_i_o_stream_input_stream.png
new file mode 100644
index 000000000..972fc584b
Binary files /dev/null and b/docs/class_aws_1_1_crt_1_1_io_1_1_std_i_o_stream_input_stream.png differ
diff --git a/docs/class_aws_1_1_crt_1_1_io_1_1_tls_channel_handler-members.html b/docs/class_aws_1_1_crt_1_1_io_1_1_tls_channel_handler-members.html
new file mode 100644
index 000000000..623dd3f80
--- /dev/null
+++ b/docs/class_aws_1_1_crt_1_1_io_1_1_tls_channel_handler-members.html
@@ -0,0 +1,121 @@
+
+
+
+
+
+
+
+aws-crt-cpp: Member List
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ 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.
+
+
+
+
+
diff --git a/docs/class_aws_1_1_crt_1_1_io_1_1_tls_channel_handler.html b/docs/class_aws_1_1_crt_1_1_io_1_1_tls_channel_handler.html
new file mode 100644
index 000000000..d3a0967e6
--- /dev/null
+++ b/docs/class_aws_1_1_crt_1_1_io_1_1_tls_channel_handler.html
@@ -0,0 +1,346 @@
+
+
+
+
+
+
+
+aws-crt-cpp: Aws::Crt::Io::TlsChannelHandler Class Reference
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ aws-crt-cpp
+
+ C++ wrapper around the aws-c-* libraries. Provides Cross-Platform Transport Protocols and SSL/TLS implementations for C++.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
#include <TlsOptions.h >
+
+
+
+
+
+
+
+
+
+
+
+
BYO_CRYPTO: TLS channel-handler base class.
+
+
+
◆ ~TlsChannelHandler()
+
+
+
+
+
+
+
+
+ Aws::Crt::Io::TlsChannelHandler::~TlsChannelHandler
+ (
+ )
+
+
+
+
+
+virtual
+
+
+
+
+
+
+
+
◆ TlsChannelHandler()
+
+
+
+
+
+
+
+
+ Aws::Crt::Io::TlsChannelHandler::TlsChannelHandler
+ (
+ struct aws_channel_slot *
+ slot ,
+
+
+
+
+ const struct aws_tls_connection_options &
+ options ,
+
+
+
+
+ Allocator *
+ allocator = ApiAllocator ()
+
+
+
+ )
+
+
+
+
+
+protected
+
+
+
+
+
+
+
+
+
◆ CompleteTlsNegotiation()
+
+
+
+
+
+
+
+
+ void Aws::Crt::Io::TlsChannelHandler::CompleteTlsNegotiation
+ (
+ int
+ errorCode )
+
+
+
+
+
+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.
+
+
+
+
+
◆ GetProtocol()
+
+
+
+
+
+
+
+
+ virtual String Aws::Crt::Io::TlsChannelHandler::GetProtocol
+ (
+ )
+ const
+
+
+
+
+pure virtual
+
+
+
+
Returns negotiated protocol (or empty string if no agreed upon protocol)
+
+
+
+
+
+
◆ aws_tls_handler_protocol
+
+
+
+
+
+
+
+
+ aws_byte_buf() aws_tls_handler_protocol
+ (
+ aws_channel_handler *
+ )
+
+
+
+
+
+friend
+
+
+
+
+
+
+
The documentation for this class was generated from the following files:
+
+
+
+
+
diff --git a/docs/class_aws_1_1_crt_1_1_io_1_1_tls_channel_handler.png b/docs/class_aws_1_1_crt_1_1_io_1_1_tls_channel_handler.png
new file mode 100644
index 000000000..0cc4021b9
Binary files /dev/null and b/docs/class_aws_1_1_crt_1_1_io_1_1_tls_channel_handler.png differ
diff --git a/docs/class_aws_1_1_crt_1_1_io_1_1_tls_connection_options-members.html b/docs/class_aws_1_1_crt_1_1_io_1_1_tls_connection_options-members.html
new file mode 100644
index 000000000..58693d293
--- /dev/null
+++ b/docs/class_aws_1_1_crt_1_1_io_1_1_tls_connection_options-members.html
@@ -0,0 +1,93 @@
+
+
+
+
+
+
+
+aws-crt-cpp: Member List
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ 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.
+
+
+
+
+
diff --git a/docs/class_aws_1_1_crt_1_1_io_1_1_tls_connection_options.html b/docs/class_aws_1_1_crt_1_1_io_1_1_tls_connection_options.html
new file mode 100644
index 000000000..f0c2b52a1
--- /dev/null
+++ b/docs/class_aws_1_1_crt_1_1_io_1_1_tls_connection_options.html
@@ -0,0 +1,399 @@
+
+
+
+
+
+
+
+aws-crt-cpp: Aws::Crt::Io::TlsConnectionOptions Class Reference
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ aws-crt-cpp
+
+ C++ wrapper around the aws-c-* libraries. Provides Cross-Platform Transport Protocols and SSL/TLS implementations for C++.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
#include <TlsOptions.h >
+
+
+
Options specific to a single connection.
+
+
+
◆ TlsConnectionOptions() [1/3]
+
+
+
+
+
+
+
+
+ Aws::Crt::Io::TlsConnectionOptions::TlsConnectionOptions
+ (
+ )
+
+
+
+
+
+noexcept
+
+
+
+
+
+
+
+
◆ ~TlsConnectionOptions()
+
+
+
+
+
+ Aws::Crt::Io::TlsConnectionOptions::~TlsConnectionOptions
+ (
+ )
+
+
+
+
+
+
+
+
+
◆ TlsConnectionOptions() [2/3]
+
+
+
+
+
+
+
+
+ Aws::Crt::Io::TlsConnectionOptions::TlsConnectionOptions
+ (
+ const TlsConnectionOptions &
+ options )
+
+
+
+
+
+noexcept
+
+
+
+
+
+
+
+
◆ TlsConnectionOptions() [3/3]
+
+
+
+
+
+
+
+
+ Aws::Crt::Io::TlsConnectionOptions::TlsConnectionOptions
+ (
+ TlsConnectionOptions &&
+ options )
+
+
+
+
+
+noexcept
+
+
+
+
+
+
+
+
+
◆ LastError()
+
+
+
+
+
+
+
+
+ int Aws::Crt::Io::TlsConnectionOptions::LastError
+ (
+ )
+ const
+
+
+
+
+inline noexcept
+
+
+
+
Returns the value of the last aws error encountered by operations on this instance.
+
+
+
+
+
◆ operator bool()
+
+
+
+
+
+
+
+
+ Aws::Crt::Io::TlsConnectionOptions::operator bool
+ (
+ )
+ const
+
+
+
+
+inline explicit noexcept
+
+
+
+
Returns true if the instance is in a valid state, false otherwise.
+
+
+
+
+
◆ operator=() [1/2]
+
+
+
+
◆ operator=() [2/2]
+
+
+
+
◆ SetAlpnList()
+
+
+
+
+
+
+
+
+ bool Aws::Crt::Io::TlsConnectionOptions::SetAlpnList
+ (
+ const char *
+ alpnList )
+
+
+
+
+
+noexcept
+
+
+
+
Sets list of protocols (semi-colon delimited in priority order) used for ALPN extension. alpnList is copied.
+
Returns true if the copy succeeded, or false otherwise.
+
+
+
+
+
◆ SetServerName()
+
+
+
+
+
+
+
+
+ bool Aws::Crt::Io::TlsConnectionOptions::SetServerName
+ (
+ ByteCursor &
+ serverName )
+
+
+
+
+
+noexcept
+
+
+
+
Sets SNI extension, and also the name used for X.509 validation. serverName is copied.
+
Returns true if the copy succeeded, or false otherwise.
+
+
+
+
+
+
◆ TlsContext
+
+
+
The documentation for this class was generated from the following files:
+
+
+
+
+
diff --git a/docs/class_aws_1_1_crt_1_1_io_1_1_tls_context-members.html b/docs/class_aws_1_1_crt_1_1_io_1_1_tls_context-members.html
new file mode 100644
index 000000000..0c37037ff
--- /dev/null
+++ b/docs/class_aws_1_1_crt_1_1_io_1_1_tls_context-members.html
@@ -0,0 +1,92 @@
+
+
+
+
+
+
+
+aws-crt-cpp: Member List
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ 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.
+
+
+
+
+
diff --git a/docs/class_aws_1_1_crt_1_1_io_1_1_tls_context.html b/docs/class_aws_1_1_crt_1_1_io_1_1_tls_context.html
new file mode 100644
index 000000000..9f6df0436
--- /dev/null
+++ b/docs/class_aws_1_1_crt_1_1_io_1_1_tls_context.html
@@ -0,0 +1,390 @@
+
+
+
+
+
+
+
+aws-crt-cpp: Aws::Crt::Io::TlsContext Class Reference
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ aws-crt-cpp
+
+ C++ wrapper around the aws-c-* libraries. Provides Cross-Platform Transport Protocols and SSL/TLS implementations for C++.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
#include <TlsOptions.h >
+
+
+
Stateful context for TLS with a given configuration. Per-connection TLS "contexts" (TlsConnectionOptions ) are instantiated from this as needed.
+
+
+
◆ TlsContext() [1/4]
+
+
+
+
+
+
+
+
+ Aws::Crt::Io::TlsContext::TlsContext
+ (
+ )
+
+
+
+
+
+noexcept
+
+
+
+
+
+
+
+
◆ TlsContext() [2/4]
+
+
+
+
◆ ~TlsContext()
+
+
+
+
+
+
+
+
+ Aws::Crt::Io::TlsContext::~TlsContext
+ (
+ )
+
+
+
+
+
+default
+
+
+
+
+
+
+
+
◆ TlsContext() [3/4]
+
+
+
+
+
+
+
+
+ Aws::Crt::Io::TlsContext::TlsContext
+ (
+ const TlsContext &
+ )
+
+
+
+
+
+default noexcept
+
+
+
+
+
+
+
+
◆ TlsContext() [4/4]
+
+
+
+
+
+
+
+
+ Aws::Crt::Io::TlsContext::TlsContext
+ (
+ TlsContext &&
+ )
+
+
+
+
+
+default noexcept
+
+
+
+
+
+
+
+
+
◆ GetInitializationError()
+
+
+
+
+
+
+
+
+ int Aws::Crt::Io::TlsContext::GetInitializationError
+ (
+ )
+ const
+
+
+
+
+inline noexcept
+
+
+
+
Returns the value of the last aws error encountered by operations on this instance.
+
+
+
+
+
◆ NewConnectionOptions()
+
+
+
+
Returns a new connection-specific TLS context that can be configured with per-connection options (server name, peer verification, etc...)
+
+
+
+
+
◆ operator bool()
+
+
+
+
+
+
+
+
+ Aws::Crt::Io::TlsContext::operator bool
+ (
+ )
+ const
+
+
+
+
+inline explicit noexcept
+
+
+
+
Returns true if the instance is in a valid state, false otherwise.
+
+
+
+
+
◆ operator=() [1/2]
+
+
+
+
+
+
+
+
+
+default noexcept
+
+
+
+
+
+
+
+
◆ operator=() [2/2]
+
+
+
+
+
+
+
+
+
+default noexcept
+
+
+
+
+
+
+
The documentation for this class was generated from the following files:
+
+
+
+
+
diff --git a/docs/class_aws_1_1_crt_1_1_io_1_1_tls_context_options-members.html b/docs/class_aws_1_1_crt_1_1_io_1_1_tls_context_options-members.html
new file mode 100644
index 000000000..8b516a82e
--- /dev/null
+++ b/docs/class_aws_1_1_crt_1_1_io_1_1_tls_context_options-members.html
@@ -0,0 +1,105 @@
+
+
+
+
+
+
+
+aws-crt-cpp: Member List
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ 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.
+
+
+
+
+
diff --git a/docs/class_aws_1_1_crt_1_1_io_1_1_tls_context_options.html b/docs/class_aws_1_1_crt_1_1_io_1_1_tls_context_options.html
new file mode 100644
index 000000000..02cbff6fa
--- /dev/null
+++ b/docs/class_aws_1_1_crt_1_1_io_1_1_tls_context_options.html
@@ -0,0 +1,890 @@
+
+
+
+
+
+
+
+aws-crt-cpp: Aws::Crt::Io::TlsContextOptions Class Reference
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ aws-crt-cpp
+
+ C++ wrapper around the aws-c-* libraries. Provides Cross-Platform Transport Protocols and SSL/TLS implementations for C++.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
#include <TlsOptions.h >
+
+
+
Top-level tls configuration options. These options are used to create a context from which per-connection TLS contexts can be created.
+
+
+
◆ TlsContextOptions() [1/3]
+
+
+
+
+
+
+
+
+ Aws::Crt::Io::TlsContextOptions::TlsContextOptions
+ (
+ )
+
+
+
+
+
+noexcept
+
+
+
+
+
+
+
+
◆ ~TlsContextOptions()
+
+
+
+
+
+
+
+
+ Aws::Crt::Io::TlsContextOptions::~TlsContextOptions
+ (
+ )
+
+
+
+
+
+virtual
+
+
+
+
+
+
+
+
◆ TlsContextOptions() [2/3]
+
+
+
+
+
+
+
+
+ Aws::Crt::Io::TlsContextOptions::TlsContextOptions
+ (
+ const TlsContextOptions &
+ )
+
+
+
+
+
+delete noexcept
+
+
+
+
+
+
+
+
◆ TlsContextOptions() [3/3]
+
+
+
+
+
+
+
+
+ Aws::Crt::Io::TlsContextOptions::TlsContextOptions
+ (
+ TlsContextOptions &&
+ other )
+
+
+
+
+
+noexcept
+
+
+
+
+
+
+
+
+
◆ InitClientWithMtls() [1/2]
+
+
+
+
+
+
+
+
+
+static noexcept
+
+
+
+
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.
+
Parameters
+
+ cert Certificate contents in memory.
+ pkey Private key contents in memory.
+ allocator Memory allocator to use.
+
+
+
+
+
+
+
+
◆ InitClientWithMtls() [2/2]
+
+
+
+
+
+
+
+
+ TlsContextOptions Aws::Crt::Io::TlsContextOptions::InitClientWithMtls
+ (
+ const char *
+ cert_path ,
+
+
+
+
+ const char *
+ pkey_path ,
+
+
+
+
+ Allocator *
+ allocator = ApiAllocator ()
+
+
+
+ )
+
+
+
+
+
+static noexcept
+
+
+
+
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.
+
Parameters
+
+ cert_path Path to certificate file.
+ pkey_path Path to private key file.
+ allocator Memory allocator to use.
+
+
+
+
+
+
+
+
◆ InitClientWithMtlsPkcs11()
+
+
+
+
+
+
+
+
+
+static noexcept
+
+
+
+
Initializes TlsContextOptions for mutual TLS (mTLS), using a PKCS#11 library for private key operations.
+
NOTE: This only works on Unix devices.
+
Parameters
+
+ pkcs11Options PKCS#11 options
+ allocator Memory allocator to use.
+
+
+
+
+
+
+
+
◆ InitClientWithMtlsPkcs12()
+
+
+
+
+
+
+
+
+ TlsContextOptions Aws::Crt::Io::TlsContextOptions::InitClientWithMtlsPkcs12
+ (
+ const char *
+ pkcs12_path ,
+
+
+
+
+ const char *
+ pkcs12_pwd ,
+
+
+
+
+ Allocator *
+ allocator = ApiAllocator ()
+
+
+
+ )
+
+
+
+
+
+static noexcept
+
+
+
+
Initializes TlsContextOptions for mutual TLS (mTLS), with client certificate and private key in the PKCS#12 format.
+
NOTE: This only works on Apple devices.
+
Parameters
+
+ 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.
+
+
+
+
+
+
+
+
◆ InitClientWithMtlsSystemPath()
+
+
+
+
+
+
+
+
+ TlsContextOptions Aws::Crt::Io::TlsContextOptions::InitClientWithMtlsSystemPath
+ (
+ const char *
+ windowsCertStorePath ,
+
+
+
+
+ Allocator *
+ allocator = ApiAllocator ()
+
+
+
+ )
+
+
+
+
+
+static noexcept
+
+
+
+
Initializes TlsContextOptions for mutual TLS (mTLS), using a client certificate in a Windows certificate store.
+
NOTE: This only works on Windows.
+
Parameters
+
+ 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.
+
+
+
+
+
+
+
+
◆ InitDefaultClient()
+
+
+
+
+
+
+
+
+
+static noexcept
+
+
+
+
Initializes TlsContextOptions with secure by default options, with no client certificates.
+
+
+
+
+
◆ IsAlpnSupported()
+
+
+
+
+
+
+
+
+ bool Aws::Crt::Io::TlsContextOptions::IsAlpnSupported
+ (
+ )
+
+
+
+
+
+static noexcept
+
+
+
+
Returns true if alpn is supported by the underlying security provider, false otherwise.
+
+
+
+
+
◆ LastError()
+
+
+
+
+
+
+
+
+ int Aws::Crt::Io::TlsContextOptions::LastError
+ (
+ )
+ const
+
+
+
+
+noexcept
+
+
+
+
Returns the value of the last aws error encountered by operations on this instance.
+
+
+
+
+
◆ operator bool()
+
+
+
+
+
+
+
+
+ Aws::Crt::Io::TlsContextOptions::operator bool
+ (
+ )
+ const
+
+
+
+
+inline explicit noexcept
+
+
+
+
Returns true if the instance is in a valid state, false otherwise.
+
+
+
+
+
◆ operator=() [1/2]
+
+
+
+
+
+
+
+
+
+delete noexcept
+
+
+
+
+
+
+
+
◆ operator=() [2/2]
+
+
+
+
◆ OverrideDefaultTrustStore() [1/2]
+
+
+
+
+
+
+
+
+ bool Aws::Crt::Io::TlsContextOptions::OverrideDefaultTrustStore
+ (
+ const ByteCursor &
+ ca )
+
+
+
+
+
+noexcept
+
+
+
+
Overrides the default system trust store.
Parameters
+
+ ca PEM armored chain of trusted CA certificates.
+
+
+
+
+
+
+
+
◆ OverrideDefaultTrustStore() [2/2]
+
+
+
+
+
+
+
+
+ bool Aws::Crt::Io::TlsContextOptions::OverrideDefaultTrustStore
+ (
+ const char *
+ caPath ,
+
+
+
+
+ const char *
+ caFile
+
+
+
+ )
+
+
+
+
+
+noexcept
+
+
+
+
Overrides the default system trust store.
Parameters
+
+ 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.
+
+
+
+
+
+
+
+
◆ SetAlpnList()
+
+
+
+
+
+
+
+
+ bool Aws::Crt::Io::TlsContextOptions::SetAlpnList
+ (
+ const char *
+ alpnList )
+
+
+
+
+
+noexcept
+
+
+
+
Sets the list of alpn protocols.
Parameters
+
+ alpnList List of protocol names, delimited by ';'. This string must remain in memory for the lifetime of this object.
+
+
+
+
+
+
+
+
◆ SetKeychainPath()
+
+
+
+
+
+
+
+
+ bool Aws::Crt::Io::TlsContextOptions::SetKeychainPath
+ (
+ ByteCursor &
+ keychain_path )
+
+
+
+
+
+noexcept
+
+
+
+
Deprecated: Custom keychain management is deprecated.
+
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.
+
+
+
+
+
◆ SetMinimumTlsVersion()
+
+
+
+
+
+ void Aws::Crt::Io::TlsContextOptions::SetMinimumTlsVersion
+ (
+ aws_tls_versions
+ minimumTlsVersion )
+
+
+
+
+
Sets the minimum TLS version allowed.
Parameters
+
+ minimumTlsVersion The minimum TLS version.
+
+
+
+
+
+
+
+
◆ SetTlsCipherPreference()
+
+
+
+
+
+ void Aws::Crt::Io::TlsContextOptions::SetTlsCipherPreference
+ (
+ aws_tls_cipher_pref
+ cipher_pref )
+
+
+
+
+
Sets the preferred TLS Cipher List
Parameters
+
+ cipher_pref The preferred TLS cipher list.
+
+
+
+
+
+
+
+
◆ SetVerifyPeer()
+
+
+
+
+
+
+
+
+ void Aws::Crt::Io::TlsContextOptions::SetVerifyPeer
+ (
+ bool
+ verifyPeer )
+
+
+
+
+
+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.
+
+
+
+
+
+
◆ TlsContext
+
+
+
The documentation for this class was generated from the following files:
+
+
+
+
+
diff --git a/docs/class_aws_1_1_crt_1_1_io_1_1_tls_context_pkcs11_options-members.html b/docs/class_aws_1_1_crt_1_1_io_1_1_tls_context_pkcs11_options-members.html
new file mode 100644
index 000000000..da55af3b4
--- /dev/null
+++ b/docs/class_aws_1_1_crt_1_1_io_1_1_tls_context_pkcs11_options-members.html
@@ -0,0 +1,89 @@
+
+
+
+
+
+
+
+aws-crt-cpp: Member List
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ 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.
+
+
+
+
+
diff --git a/docs/class_aws_1_1_crt_1_1_io_1_1_tls_context_pkcs11_options.html b/docs/class_aws_1_1_crt_1_1_io_1_1_tls_context_pkcs11_options.html
new file mode 100644
index 000000000..1de9eed1b
--- /dev/null
+++ b/docs/class_aws_1_1_crt_1_1_io_1_1_tls_context_pkcs11_options.html
@@ -0,0 +1,352 @@
+
+
+
+
+
+
+
+aws-crt-cpp: Aws::Crt::Io::TlsContextPkcs11Options Class Reference
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ aws-crt-cpp
+
+ C++ wrapper around the aws-c-* libraries. Provides Cross-Platform Transport Protocols and SSL/TLS implementations for C++.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
#include <TlsOptions.h >
+
+
+
Options for TLS, when using a PKCS#11 library for private key operations.
+
See also TlsContextOptions::InitClientWithMtlsPkcs11()
+
+
+
◆ TlsContextPkcs11Options()
+
+
+
+
+
+
+
+
+ Aws::Crt::Io::TlsContextPkcs11Options::TlsContextPkcs11Options
+ (
+ const std::shared_ptr< Pkcs11Lib > &
+ pkcs11Lib ,
+
+
+
+
+ Allocator *
+ allocator = ApiAllocator ()
+
+
+
+ )
+
+
+
+
+
+noexcept
+
+
+
+
Parameters
+
+ pkcs11Lib use this PKCS#11 library
+ allocator Memory allocator to use.
+
+
+
+
+
+
+
+
+
◆ SetCertificateFileContents()
+
+
+
+
+
+
+
+
+ void Aws::Crt::Io::TlsContextPkcs11Options::SetCertificateFileContents
+ (
+ const String &
+ contents )
+
+
+
+
+
+noexcept
+
+
+
+
Use this X.509 certificate (contents in memory). The certificate may be specified by other means instead (ex: SetCertificateFilePath() )
+
Parameters
+
+ contents contents of PEM-formatted certificate file.
+
+
+
+
+
+
+
+
◆ SetCertificateFilePath()
+
+
+
+
+
+
+
+
+ void Aws::Crt::Io::TlsContextPkcs11Options::SetCertificateFilePath
+ (
+ const String &
+ path )
+
+
+
+
+
+noexcept
+
+
+
+
Use this X.509 certificate (file on disk). The certificate may be specified by other means instead (ex: SetCertificateFileContents() )
+
Parameters
+
+ path path to PEM-formatted certificate file on disk.
+
+
+
+
+
+
+
+
◆ SetPrivateKeyObjectLabel()
+
+
+
+
+
+
+
+
+ void Aws::Crt::Io::TlsContextPkcs11Options::SetPrivateKeyObjectLabel
+ (
+ const String &
+ label )
+
+
+
+
+
+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).
+
Parameters
+
+ label label of private key object
+
+
+
+
+
+
+
+
◆ SetSlotId()
+
+
+
+
+
+
+
+
+ void Aws::Crt::Io::TlsContextPkcs11Options::SetSlotId
+ (
+ const uint64_t
+ id )
+
+
+
+
+
+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).
+
Parameters
+
+
+
+
+
+
+
+
◆ SetTokenLabel()
+
+
+
+
+
+
+
+
+ void Aws::Crt::Io::TlsContextPkcs11Options::SetTokenLabel
+ (
+ const String &
+ label )
+
+
+
+
+
+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).
+
Parameters
+
+
+
+
+
+
+
+
◆ SetUserPin()
+
+
+
+
+
+
+
+
+ void Aws::Crt::Io::TlsContextPkcs11Options::SetUserPin
+ (
+ const String &
+ pin )
+
+
+
+
+
+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".
+
Parameters
+
+
+
+
+
+
+
The documentation for this class was generated from the following files:
+
+
+
+
+
diff --git a/docs/class_aws_1_1_crt_1_1_io_1_1_uri-members.html b/docs/class_aws_1_1_crt_1_1_io_1_1_uri-members.html
new file mode 100644
index 000000000..317fa2b6b
--- /dev/null
+++ b/docs/class_aws_1_1_crt_1_1_io_1_1_uri-members.html
@@ -0,0 +1,100 @@
+
+
+
+
+
+
+
+aws-crt-cpp: Member List
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ 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.
+
+
+
+
+
diff --git a/docs/class_aws_1_1_crt_1_1_io_1_1_uri.html b/docs/class_aws_1_1_crt_1_1_io_1_1_uri.html
new file mode 100644
index 000000000..a75ab6f69
--- /dev/null
+++ b/docs/class_aws_1_1_crt_1_1_io_1_1_uri.html
@@ -0,0 +1,596 @@
+
+
+
+
+
+
+
+aws-crt-cpp: Aws::Crt::Io::Uri Class Reference
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ aws-crt-cpp
+
+ C++ wrapper around the aws-c-* libraries. Provides Cross-Platform Transport Protocols and SSL/TLS implementations for C++.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
#include <Uri.h >
+
+
+
Contains a URI used for networking application protocols. This type is move-only.
+
+
+
◆ Uri() [1/5]
+
+
+
+
+
+
+
+
+ Aws::Crt::Io::Uri::Uri
+ (
+ )
+
+
+
+
+
+noexcept
+
+
+
+
+
+
+
+
◆ ~Uri()
+
+
+
+
+
+ Aws::Crt::Io::Uri::~Uri
+ (
+ )
+
+
+
+
+
+
+
+
+
◆ Uri() [2/5]
+
+
+
+
Parses cursor
as a URI. Upon failure the bool() operator will return false and LastError() will contain the errorCode.
+
+
+
+
+
◆ Uri() [3/5]
+
+
+
+
+
+
+
+
+ Aws::Crt::Io::Uri::Uri
+ (
+ aws_uri_builder_options &
+ builderOptions ,
+
+
+
+
+ Allocator *
+ allocator = ApiAllocator ()
+
+
+
+ )
+
+
+
+
+
+noexcept
+
+
+
+
Builds a URI from builderOptions
. Upon failure the bool() operator will return false and LastError() will contain the errorCode.
+
+
+
+
+
◆ Uri() [4/5]
+
+
+
+
+
+ Aws::Crt::Io::Uri::Uri
+ (
+ const Uri &
+ other )
+
+
+
+
+
+
+
+
+
◆ Uri() [5/5]
+
+
+
+
+
+
+
+
+ Aws::Crt::Io::Uri::Uri
+ (
+ Uri &&
+ uri )
+
+
+
+
+
+noexcept
+
+
+
+
+
+
+
+
+
◆ GetAuthority()
+
+
+
+
+
+
+
+
+ ByteCursor Aws::Crt::Io::Uri::GetAuthority
+ (
+ )
+ const
+
+
+
+
+noexcept
+
+
+
+
Returns the authority portion of the URI if present. This will contain host name and port if specified.
+
+
+
+
+
◆ GetFullUri()
+
+
+
+
+
+
+
+
+ ByteCursor Aws::Crt::Io::Uri::GetFullUri
+ (
+ )
+ const
+
+
+
+
+noexcept
+
+
+
+
Returns The full URI as it was passed to or parsed from the constructors.
+
+
+
+
+
◆ GetHostName()
+
+
+
+
+
+
+
+
+ ByteCursor Aws::Crt::Io::Uri::GetHostName
+ (
+ )
+ const
+
+
+
+
+noexcept
+
+
+
+
Returns the host name portion of the authority. (port will not be in this value).
+
+
+
+
+
◆ GetPath()
+
+
+
+
+
+
+
+
+ ByteCursor Aws::Crt::Io::Uri::GetPath
+ (
+ )
+ const
+
+
+
+
+noexcept
+
+
+
+
Returns the path portion of the URI. If no path was present, this will be set to '/'.
+
+
+
+
+
◆ GetPathAndQuery()
+
+
+
+
+
+
+
+
+ ByteCursor Aws::Crt::Io::Uri::GetPathAndQuery
+ (
+ )
+ const
+
+
+
+
+noexcept
+
+
+
+
Returns the Path and Query portion of the URI. In the case of Http , this likely the value for the URI parameter.
+
+
+
+
+
◆ GetPort()
+
+
+
+
+
+
+
+
+ uint32_t Aws::Crt::Io::Uri::GetPort
+ (
+ )
+ const
+
+
+
+
+noexcept
+
+
+
+
Returns the port portion of the authority if a port was specified. If it was not, this will be set to 0. In that case, it is your responsibility to determine the correct port based on the protocol you're using.
+
+
+
+
+
◆ GetQueryString()
+
+
+
+
+
+
+
+
+ ByteCursor Aws::Crt::Io::Uri::GetQueryString
+ (
+ )
+ const
+
+
+
+
+noexcept
+
+
+
+
Returns the query string portion of the URI if present.
+
+
+
+
+
◆ GetScheme()
+
+
+
+
+
+
+
+
+ ByteCursor Aws::Crt::Io::Uri::GetScheme
+ (
+ )
+ const
+
+
+
+
+noexcept
+
+
+
+
Returns the scheme portion of the URI if present (e.g. https, http, ftp etc....)
+
+
+
+
+
◆ LastError()
+
+
+
+
+
+
+
+
+ int Aws::Crt::Io::Uri::LastError
+ (
+ )
+ const
+
+
+
+
+inline noexcept
+
+
+
+
Returns the value of the last aws error encountered by operations on this instance.
+
+
+
+
+
◆ operator bool()
+
+
+
+
+
+
+
+
+ Aws::Crt::Io::Uri::operator bool
+ (
+ )
+ const
+
+
+
+
+inline noexcept
+
+
+
+
Returns true if the instance is in a valid state, false otherwise.
+
+
+
+
+
◆ operator=() [1/2]
+
+
+
+
+
+ Uri & Aws::Crt::Io::Uri::operator=
+ (
+ const Uri &
+ other )
+
+
+
+
+
+
+
+
+
◆ operator=() [2/2]
+
+
+
+
+
+
+
+
+ Uri & Aws::Crt::Io::Uri::operator=
+ (
+ Uri &&
+ uri )
+
+
+
+
+
+noexcept
+
+
+
+
+
+
+
The documentation for this class was generated from the following files:
+
+
+
+
+
diff --git a/docs/class_aws_1_1_crt_1_1_json_object-members.html b/docs/class_aws_1_1_crt_1_1_json_object-members.html
new file mode 100644
index 000000000..9226d74c8
--- /dev/null
+++ b/docs/class_aws_1_1_crt_1_1_json_object-members.html
@@ -0,0 +1,124 @@
+
+
+
+
+
+
+
+aws-crt-cpp: Member List
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ 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 classAws::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 () constAws::Crt::JsonObject
+ JsonObject ()Aws::Crt::JsonObject
+ JsonObject (const String &stringToParse)Aws::Crt::JsonObject
+ JsonObject (const JsonObject &other)Aws::Crt::JsonObject
+ JsonObject (JsonObject &&other) noexceptAws::Crt::JsonObject
+ JsonView classAws::Crt::JsonObject friend
+ operator!= (const JsonObject &other) constAws::Crt::JsonObject
+ operator= (const JsonObject &other)Aws::Crt::JsonObject
+ operator= (JsonObject &&other) noexceptAws::Crt::JsonObject
+ operator== (const JsonObject &other) constAws::Crt::JsonObject
+ View () constAws::Crt::JsonObject
+ WasParseSuccessful () constAws::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
+
+
+
+
+
diff --git a/docs/class_aws_1_1_crt_1_1_json_object.html b/docs/class_aws_1_1_crt_1_1_json_object.html
new file mode 100644
index 000000000..e1c8765cb
--- /dev/null
+++ b/docs/class_aws_1_1_crt_1_1_json_object.html
@@ -0,0 +1,1176 @@
+
+
+
+
+
+
+
+aws-crt-cpp: Aws::Crt::JsonObject Class Reference
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ aws-crt-cpp
+
+ C++ wrapper around the aws-c-* libraries. Provides Cross-Platform Transport Protocols and SSL/TLS implementations for C++.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
#include <JsonObject.h >
+
+
+ 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
+
+
+
+
JSON DOM manipulation class. To read or serialize use View function.
+
+
+
◆ JsonObject() [1/4]
+
+
+
+
+
+ Aws::Crt::JsonObject::JsonObject
+ (
+ )
+
+
+
+
+
Constructs empty JSON DOM.
+
+
+
+
+
◆ JsonObject() [2/4]
+
+
+
+
+
+ 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.
+
+
+
+
+
◆ JsonObject() [3/4]
+
+
+
+
+
+ Aws::Crt::JsonObject::JsonObject
+ (
+ const JsonObject &
+ other )
+
+
+
+
+
Construct a deep copy. Prefer using a JsonView if copying is not needed.
+
+
+
+
+
◆ JsonObject() [4/4]
+
+
+
+
+
+
+
+
+ Aws::Crt::JsonObject::JsonObject
+ (
+ JsonObject &&
+ other )
+
+
+
+
+
+noexcept
+
+
+
+
Move constructor. No copying is performed.
+
+
+
+
+
◆ ~JsonObject()
+
+
+
+
+
+ Aws::Crt::JsonObject::~JsonObject
+ (
+ )
+
+
+
+
+
+
+
+
+
+
◆ AsArray() [1/2]
+
+
+
+
Converts the current JSON node to an array whose values are deep-copied from the array parameter.
+
+
+
+
+
◆ AsArray() [2/2]
+
+
+
+
Converts the current JSON node to an array whose values are moved from the array parameter.
+
+
+
+
+
◆ AsBool()
+
+
+
+
+
+ JsonObject & Aws::Crt::JsonObject::AsBool
+ (
+ bool
+ value )
+
+
+
+
+
Converts the current JSON node to a bool.
+
+
+
+
+
◆ AsDouble()
+
+
+
+
+
+ JsonObject & Aws::Crt::JsonObject::AsDouble
+ (
+ double
+ value )
+
+
+
+
+
Converts the current JSON node to a number.
+
+
+
+
+
◆ AsInt64()
+
+
+
+
+
+ JsonObject & Aws::Crt::JsonObject::AsInt64
+ (
+ int64_t
+ value )
+
+
+
+
+
Converts the current JSON node to a number. Precision may be lost.
+
+
+
+
+
◆ AsInteger()
+
+
+
+
+
+ JsonObject & Aws::Crt::JsonObject::AsInteger
+ (
+ int
+ value )
+
+
+
+
+
Converts the current JSON node to a number. Precision may be lost.
+
+
+
+
+
◆ AsNull()
+
+
+
+
+
+ JsonObject & Aws::Crt::JsonObject::AsNull
+ (
+ )
+
+
+
+
+
Sets the current JSON node as null.
+
+
+
+
+
◆ AsObject() [1/2]
+
+
+
+
Converts the current JSON node to a JSON object by deep-copying the parameter.
+
+
+
+
+
◆ AsObject() [2/2]
+
+
+
+
Converts the current JSON node to a JSON object by moving from the parameter.
+
+
+
+
+
◆ AsString()
+
+
+
+
+
+ JsonObject & Aws::Crt::JsonObject::AsString
+ (
+ const String &
+ value )
+
+
+
+
+
Converts the current JSON node to a string.
+
+
+
+
+
◆ GetErrorMessage()
+
+
+
+
+
+ const String & Aws::Crt::JsonObject::GetErrorMessage
+ (
+ )
+ const
+
+
+
+
+
+
◆ operator!=()
+
+
+
+
+
+ bool Aws::Crt::JsonObject::operator!=
+ (
+ const JsonObject &
+ other )
+ const
+
+
+
+
+
+
+
+
◆ operator=() [1/2]
+
+
+
+
Performs a deep copy.
+
+
+
+
+
◆ operator=() [2/2]
+
+
+
+
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.
Warning This will result in invalidating any outstanding views of the current DOM. However, views to the moved-from DOM would still valid.
+
+
+
+
+
◆ operator==()
+
+
+
+
+
+ bool Aws::Crt::JsonObject::operator==
+ (
+ const JsonObject &
+ other )
+ const
+
+
+
+
+
+
+
+
◆ View()
+
+
+
+
+
+ JsonView Aws::Crt::JsonObject::View
+ (
+ )
+ const
+
+
+
+
Creates a view of this JSON node.
+
+
+
+
+
◆ WasParseSuccessful()
+
+
+
+
+
+
+
+
+ bool Aws::Crt::JsonObject::WasParseSuccessful
+ (
+ )
+ const
+
+
+
+
+inline
+
+
+
+
Returns true if the last parse request was successful.
+
+
+
+
+
◆ WithArray() [1/4]
+
+
+
+
+
+ JsonObject & Aws::Crt::JsonObject::WithArray
+ (
+ const char *
+ key ,
+
+
+
+
+ const Vector < String > &
+ array
+
+
+
+ )
+
+
+
+
+
+
+
+
+
◆ WithArray() [2/4]
+
+
+
+
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.
+
+
+
+
+
◆ WithArray() [3/4]
+
+
+
+
Adds an array of strings to the top level of this node at key.
+
+
+
+
+
◆ WithArray() [4/4]
+
+
+
+
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.
+
+
+
+
+
◆ WithBool() [1/2]
+
+
+
+
+
+ JsonObject & Aws::Crt::JsonObject::WithBool
+ (
+ const char *
+ key ,
+
+
+
+
+ bool
+ value
+
+
+
+ )
+
+
+
+
+
+
+
+
+
◆ WithBool() [2/2]
+
+
+
+
+
+ JsonObject & Aws::Crt::JsonObject::WithBool
+ (
+ const String &
+ key ,
+
+
+
+
+ bool
+ value
+
+
+
+ )
+
+
+
+
+
Adds a bool value with key to the top level of this node.
+
+
+
+
+
◆ WithDouble() [1/2]
+
+
+
+
+
+ JsonObject & Aws::Crt::JsonObject::WithDouble
+ (
+ const char *
+ key ,
+
+
+
+
+ double
+ value
+
+
+
+ )
+
+
+
+
+
+
+
+
+
◆ WithDouble() [2/2]
+
+
+
+
+
+ JsonObject & Aws::Crt::JsonObject::WithDouble
+ (
+ const String &
+ key ,
+
+
+
+
+ double
+ value
+
+
+
+ )
+
+
+
+
+
Adds a number value at key at the top level of this node.
+
+
+
+
+
◆ WithInt64() [1/2]
+
+
+
+
+
+ JsonObject & Aws::Crt::JsonObject::WithInt64
+ (
+ const char *
+ key ,
+
+
+
+
+ int64_t
+ value
+
+
+
+ )
+
+
+
+
+
+
+
+
+
◆ WithInt64() [2/2]
+
+
+
+
+
+ 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.
+
+
+
+
+
◆ WithInteger() [1/2]
+
+
+
+
+
+ JsonObject & Aws::Crt::JsonObject::WithInteger
+ (
+ const char *
+ key ,
+
+
+
+
+ int
+ value
+
+
+
+ )
+
+
+
+
+
+
+
+
+
◆ WithInteger() [2/2]
+
+
+
+
+
+ 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.
+
+
+
+
+
◆ WithObject() [1/4]
+
+
+
+
+
+ JsonObject & Aws::Crt::JsonObject::WithObject
+ (
+ const char *
+ key ,
+
+
+
+
+ const JsonObject &
+ value
+
+
+
+ )
+
+
+
+
+
+
+
+
+
◆ WithObject() [2/4]
+
+
+
+
+
+ JsonObject & Aws::Crt::JsonObject::WithObject
+ (
+ const char *
+ key ,
+
+
+
+
+ JsonObject &&
+ value
+
+
+
+ )
+
+
+
+
+
+
+
+
+
◆ WithObject() [3/4]
+
+
+
+
+
+ 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.
+
+
+
+
+
◆ WithObject() [4/4]
+
+
+
+
Adds a JSON object to the top level of this node at key.
+
+
+
+
+
◆ WithString() [1/2]
+
+
+
+
+
+ JsonObject & Aws::Crt::JsonObject::WithString
+ (
+ const char *
+ key ,
+
+
+
+
+ const String &
+ value
+
+
+
+ )
+
+
+
+
+
+
+
+
+
◆ WithString() [2/2]
+
+
+
+
+
+ JsonObject & Aws::Crt::JsonObject::WithString
+ (
+ const String &
+ key ,
+
+
+
+
+ const String &
+ value
+
+
+
+ )
+
+
+
+
+
Adds a string to the top level of this node with key.
+
+
+
+
+
+
◆ ApiHandle
+
+
+
+
◆ JsonView
+
+
+
The documentation for this class was generated from the following files:
+
+
+
+
+
diff --git a/docs/class_aws_1_1_crt_1_1_json_view-members.html b/docs/class_aws_1_1_crt_1_1_json_view-members.html
new file mode 100644
index 000000000..cf9f00d0c
--- /dev/null
+++ b/docs/class_aws_1_1_crt_1_1_json_view-members.html
@@ -0,0 +1,124 @@
+
+
+
+
+
+
+
+aws-crt-cpp: Member List
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ 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.
+
+
+
+
+
diff --git a/docs/class_aws_1_1_crt_1_1_json_view.html b/docs/class_aws_1_1_crt_1_1_json_view.html
new file mode 100644
index 000000000..8e94262bf
--- /dev/null
+++ b/docs/class_aws_1_1_crt_1_1_json_view.html
@@ -0,0 +1,965 @@
+
+
+
+
+
+
+
+aws-crt-cpp: Aws::Crt::JsonView Class Reference
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ aws-crt-cpp
+
+ C++ wrapper around the aws-c-* libraries. Provides Cross-Platform Transport Protocols and SSL/TLS implementations for C++.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
#include <JsonObject.h >
+
+
+
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.
+
+
+
◆ JsonView() [1/2]
+
+
+
+
+
+ Aws::Crt::JsonView::JsonView
+ (
+ )
+
+
+
+
+
+
+
+
+
◆ JsonView() [2/2]
+
+
+
+
+
+ Aws::Crt::JsonView::JsonView
+ (
+ const JsonObject &
+ val )
+
+
+
+
+
+
+
+
+
+
◆ AsArray()
+
+
+
+
+
+ Vector < JsonView > Aws::Crt::JsonView::AsArray
+ (
+ )
+ const
+
+
+
+
Returns the value of this node as an array of JsonView objects.
+
+
+
+
+
◆ AsBool()
+
+
+
+
+
+ bool Aws::Crt::JsonView::AsBool
+ (
+ )
+ const
+
+
+
+
Returns the value of this node as a boolean.
+
+
+
+
+
◆ AsDouble()
+
+
+
+
+
+ double Aws::Crt::JsonView::AsDouble
+ (
+ )
+ const
+
+
+
+
Returns the value of this node as a double precision floating-point.
+
+
+
+
+
◆ AsInt64()
+
+
+
+
+
+ int64_t Aws::Crt::JsonView::AsInt64
+ (
+ )
+ const
+
+
+
+
Returns the value of this node as 64-bit integer.
+
+
+
+
+
◆ AsInteger()
+
+
+
+
+
+ int Aws::Crt::JsonView::AsInteger
+ (
+ )
+ const
+
+
+
+
Returns the value of this node as an int.
+
+
+
+
+
◆ AsObject()
+
+
+
+
+
+ JsonView Aws::Crt::JsonView::AsObject
+ (
+ )
+ const
+
+
+
+
Returns the value of this node as a JsonView object.
+
+
+
+
+
◆ AsString()
+
+
+
+
+
+ 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.
+
+
+
+
+
◆ GetAllObjects()
+
+
+
+
Reads all json objects at the top level of this node (does not traverse the tree any further) along with their keys.
+
+
+
+
+
◆ GetArray() [1/2]
+
+
+
+
+
+ Vector < JsonView > Aws::Crt::JsonView::GetArray
+ (
+ const char *
+ key )
+ const
+
+
+
+
Gets an array of JsonView objects from this node by its key.
+
+
+
+
+
◆ GetArray() [2/2]
+
+
+
+
Gets an array of JsonView objects from this node by its key.
+
+
+
+
+
◆ GetBool() [1/2]
+
+
+
+
+
+ bool Aws::Crt::JsonView::GetBool
+ (
+ const char *
+ key )
+ const
+
+
+
+
Gets a boolean value from this node by its key.
+
+
+
+
+
◆ GetBool() [2/2]
+
+
+
+
+
+ bool Aws::Crt::JsonView::GetBool
+ (
+ const String &
+ key )
+ const
+
+
+
+
Gets a boolean value from this node by its key.
+
+
+
+
+
◆ GetDouble() [1/2]
+
+
+
+
+
+ double Aws::Crt::JsonView::GetDouble
+ (
+ const char *
+ key )
+ const
+
+
+
+
Gets a double precision floating-point value from this node by its key.
+
+
+
+
+
◆ GetDouble() [2/2]
+
+
+
+
+
+ double Aws::Crt::JsonView::GetDouble
+ (
+ const String &
+ key )
+ const
+
+
+
+
Gets a double precision floating-point value from this node by its key.
+
+
+
+
+
◆ GetInt64() [1/2]
+
+
+
+
+
+ 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.
+
+
+
+
+
◆ GetInt64() [2/2]
+
+
+
+
+
+ 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.
+
+
+
+
+
◆ GetInteger() [1/2]
+
+
+
+
+
+ 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.
+
+
+
+
+
◆ GetInteger() [2/2]
+
+
+
+
+
+ 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.
+
+
+
+
+
◆ GetJsonObject() [1/2]
+
+
+
+
+
+ JsonView Aws::Crt::JsonView::GetJsonObject
+ (
+ const char *
+ key )
+ const
+
+
+
+
Gets a JsonView object from this node by its key.
+
+
+
+
+
◆ GetJsonObject() [2/2]
+
+
+
+
+
+ JsonView Aws::Crt::JsonView::GetJsonObject
+ (
+ const String &
+ key )
+ const
+
+
+
+
Gets a JsonView object from this node by its key.
+
+
+
+
+
◆ GetJsonObjectCopy() [1/2]
+
+
+
+
+
+ JsonObject Aws::Crt::JsonView::GetJsonObjectCopy
+ (
+ const char *
+ key )
+ const
+
+
+
+
+
+
+
+
◆ GetJsonObjectCopy() [2/2]
+
+
+
+
+
+ JsonObject Aws::Crt::JsonView::GetJsonObjectCopy
+ (
+ const String &
+ key )
+ const
+
+
+
+
+
+
+
+
◆ GetString() [1/2]
+
+
+
+
+
+ String Aws::Crt::JsonView::GetString
+ (
+ const char *
+ key )
+ const
+
+
+
+
Gets a string from this node by its key.
+
+
+
+
+
◆ GetString() [2/2]
+
+
+
+
+
+ String Aws::Crt::JsonView::GetString
+ (
+ const String &
+ key )
+ const
+
+
+
+
Gets a string from this node by its key.
+
+
+
+
+
◆ IsBool()
+
+
+
+
+
+ bool Aws::Crt::JsonView::IsBool
+ (
+ )
+ const
+
+
+
+
Tests whether the current value is a boolean.
+
+
+
+
+
◆ IsFloatingPointType()
+
+
+
+
+
+ bool Aws::Crt::JsonView::IsFloatingPointType
+ (
+ )
+ const
+
+
+
+
Tests whether the current value is a number that will lose precision if converted to an int64_t.
+
+
+
+
+
◆ IsIntegerType()
+
+
+
+
+
+ bool Aws::Crt::JsonView::IsIntegerType
+ (
+ )
+ const
+
+
+
+
Tests whether the current value is a number that can convert to an int64_t without losing precision.
+
+
+
+
+
◆ IsListType()
+
+
+
+
+
+ bool Aws::Crt::JsonView::IsListType
+ (
+ )
+ const
+
+
+
+
Tests whether the current value is a JSON array.
+
+
+
+
+
◆ IsNull()
+
+
+
+
+
+ bool Aws::Crt::JsonView::IsNull
+ (
+ )
+ const
+
+
+
+
Tests whether the current value is a JSON null.
+
+
+
+
+
◆ IsNumber()
+
+
+
+
+
+ bool Aws::Crt::JsonView::IsNumber
+ (
+ )
+ const
+
+
+
+
Tests whether the current value is a number.
+
+
+
+
+
◆ IsObject()
+
+
+
+
+
+ bool Aws::Crt::JsonView::IsObject
+ (
+ )
+ const
+
+
+
+
Tests whether the current value is a JSON object.
+
+
+
+
+
◆ IsString()
+
+
+
+
+
+ bool Aws::Crt::JsonView::IsString
+ (
+ )
+ const
+
+
+
+
Tests whether the current value is a string.
+
+
+
+
+
◆ KeyExists() [1/2]
+
+
+
+
+
+ bool Aws::Crt::JsonView::KeyExists
+ (
+ const char *
+ key )
+ const
+
+
+
+
Tests whether a key exists at the current node level.
+
+
+
+
+
◆ KeyExists() [2/2]
+
+
+
+
+
+ bool Aws::Crt::JsonView::KeyExists
+ (
+ const String &
+ key )
+ const
+
+
+
+
Tests whether a key exists at the current node level.
+
+
+
+
+
◆ Materialize()
+
+
+
+
+
+ JsonObject Aws::Crt::JsonView::Materialize
+ (
+ )
+ const
+
+
+
+
Creates a deep copy of the JSON value rooted in the current JSON view.
+
+
+
+
+
◆ operator=()
+
+
+
+
◆ ValueExists() [1/2]
+
+
+
+
+
+ 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.
+
+
+
+
+
◆ ValueExists() [2/2]
+
+
+
+
+
+ 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.
+
+
+
+
+
◆ WriteCompact()
+
+
+
+
+
+ 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.
Parameters
+
+ treatAsObject if the current value is empty, writes out '{}' rather than an empty string.
+
+
+
+
+
+
+
+
◆ WriteReadable()
+
+
+
+
+
+ String Aws::Crt::JsonView::WriteReadable
+ (
+ bool
+ treatAsObject = true
)
+ const
+
+
+
+
Writes the current JSON view to a string in a human friendly format.
Parameters
+
+ treatAsObject if the current value is empty, writes out '{}' rather than an empty string.
+
+
+
+
+
+
+
The documentation for this class was generated from the following files:
+
+
+
+
+
diff --git a/docs/class_aws_1_1_crt_1_1_mqtt5_1_1_conn_ack_packet-members.html b/docs/class_aws_1_1_crt_1_1_mqtt5_1_1_conn_ack_packet-members.html
new file mode 100644
index 000000000..a558b4632
--- /dev/null
+++ b/docs/class_aws_1_1_crt_1_1_mqtt5_1_1_conn_ack_packet-members.html
@@ -0,0 +1,108 @@
+
+
+
+
+
+
+
+aws-crt-cpp: Member List
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ 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.
+
+
+
+
+
diff --git a/docs/class_aws_1_1_crt_1_1_mqtt5_1_1_conn_ack_packet.html b/docs/class_aws_1_1_crt_1_1_mqtt5_1_1_conn_ack_packet.html
new file mode 100644
index 000000000..8f4611f11
--- /dev/null
+++ b/docs/class_aws_1_1_crt_1_1_mqtt5_1_1_conn_ack_packet.html
@@ -0,0 +1,882 @@
+
+
+
+
+
+
+
+aws-crt-cpp: Aws::Crt::Mqtt5::ConnAckPacket Class Reference
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ 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 CONNACK packet.
+
+
+
◆ ConnAckPacket() [1/3]
+
+
+
+
+
+
+
+
+ Aws::Crt::Mqtt5::ConnAckPacket::ConnAckPacket
+ (
+ const aws_mqtt5_packet_connack_view &
+ packet ,
+
+
+
+
+ Allocator *
+ allocator = ApiAllocator ()
+
+
+
+ )
+
+
+
+
+
+noexcept
+
+
+
+
+
+
+
+
◆ ~ConnAckPacket()
+
+
+
+
+
+
+
+
+ virtual Aws::Crt::Mqtt5::ConnAckPacket::~ConnAckPacket
+ (
+ )
+
+
+
+
+
+inline virtual
+
+
+
+
+
+
+
+
◆ ConnAckPacket() [2/3]
+
+
+
+
+
+
+
+
+ Aws::Crt::Mqtt5::ConnAckPacket::ConnAckPacket
+ (
+ const ConnAckPacket &
+ )
+
+
+
+
+
+delete
+
+
+
+
+
+
+
+
◆ ConnAckPacket() [3/3]
+
+
+
+
+
+
+
+
+ Aws::Crt::Mqtt5::ConnAckPacket::ConnAckPacket
+ (
+ ConnAckPacket &&
+ )
+
+
+
+
+
+delete noexcept
+
+
+
+
+
+
+
+
+
◆ getAssignedClientIdentifier()
+
+
+
+
+
+
+
+
+ const Crt::Optional < String > & Aws::Crt::Mqtt5::ConnAckPacket::getAssignedClientIdentifier
+ (
+ )
+ const
+
+
+
+
+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
+
Returns Client identifier assigned to this connection by the server
+
+
+
+
+
◆ getMaximumPacketSize()
+
+
+
+
+
+
+
+
+ const Crt::Optional < uint32_t > & Aws::Crt::Mqtt5::ConnAckPacket::getMaximumPacketSize
+ (
+ )
+ const
+
+
+
+
+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.
+
See MQTT5 Maximum Packet Size
+
Returns The maximum packet size, in bytes, that the server is willing to accept.
+
+
+
+
+
◆ getMaximumQOS()
+
+
+
+
+
+
+
+
+ const Crt::Optional < QOS > & Aws::Crt::Mqtt5::ConnAckPacket::getMaximumQOS
+ (
+ )
+ const
+
+
+
+
+noexcept
+
+
+
+
The maximum message delivery quality of service that the server will allow on this connection.
+
See MQTT5 Maximum QoS
+
Returns The maximum message delivery quality of service that the server will allow on this connection.
+
+
+
+
+
◆ getReasonCode()
+
+
+
+
+
+
+
+
+ ConnectReasonCode Aws::Crt::Mqtt5::ConnAckPacket::getReasonCode
+ (
+ )
+ const
+
+
+
+
+noexcept
+
+
+
+
Indicates either success or the reason for failure for the connection attempt.
+
See MQTT5 Connect Reason Code
+
Returns Code indicating either success or the reason for failure for the connection attempt.
+
+
+
+
+
◆ getReasonString()
+
+
+
+
+
+
+
+
+ const Crt::Optional < String > & Aws::Crt::Mqtt5::ConnAckPacket::getReasonString
+ (
+ )
+ const
+
+
+
+
+noexcept
+
+
+
+
Additional diagnostic information about the result of the connection attempt.
+
See MQTT5 Reason String
+
Returns Additional diagnostic information about the result of the connection attempt.
+
+
+
+
+
◆ getReceiveMaximum()
+
+
+
+
+
+
+
+
+ const Crt::Optional < uint16_t > & Aws::Crt::Mqtt5::ConnAckPacket::getReceiveMaximum
+ (
+ )
+ const
+
+
+
+
+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).
+
See MQTT5 Receive Maximum
+
Returns The maximum amount of in-flight QoS 1 or 2 messages that the server is willing to handle at once.
+
+
+
+
+
◆ getResponseInformation()
+
+
+
+
+
+
+
+
+ const Crt::Optional < String > & Aws::Crt::Mqtt5::ConnAckPacket::getResponseInformation
+ (
+ )
+ const
+
+
+
+
+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
+
Returns A value that can be used in the creation of a response topic associated with this connection.
+
+
+
+
+
◆ getRetainAvailable()
+
+
+
+
+
+
+
+
+ const Crt::Optional < bool > & Aws::Crt::Mqtt5::ConnAckPacket::getRetainAvailable
+ (
+ )
+ const
+
+
+
+
+noexcept
+
+
+
+
Indicates whether the server supports retained messages. If null, retained messages are supported.
+
See MQTT5 Retain Available
+
Returns Whether the server supports retained messages
+
+
+
+
+
◆ getServerKeepAlive()
+
+
+
+
+
+
+
+
+ const Crt::Optional < uint16_t > & Aws::Crt::Mqtt5::ConnAckPacket::getServerKeepAlive
+ (
+ )
+ const
+
+
+
+
+noexcept
+
+
+
+
+
+
◆ getServerKeepAliveSec()
+
+
+
+
+
+
+
+
+ const Crt::Optional < uint16_t > & Aws::Crt::Mqtt5::ConnAckPacket::getServerKeepAliveSec
+ (
+ )
+ const
+
+
+
+
+noexcept
+
+
+
+
Server-requested override of the keep alive interval, in seconds. If null, the keep alive value sent by the client should be used.
+
See MQTT5 Server Keep Alive
+
Returns Server-requested override of the keep alive interval, in seconds
+
+
+
+
+
◆ getServerReference()
+
+
+
+
+
+
+
+
+ const Crt::Optional < String > & Aws::Crt::Mqtt5::ConnAckPacket::getServerReference
+ (
+ )
+ const
+
+
+
+
+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).
+
See MQTT5 Server Reference
+
Returns Property indicating an alternate server that the client may temporarily or permanently attempt to connect to instead of the configured endpoint.
+
+
+
+
+
◆ getSessionExpiryInterval()
+
+
+
+
+
+
+
+
+ const Crt::Optional < uint32_t > & Aws::Crt::Mqtt5::ConnAckPacket::getSessionExpiryInterval
+ (
+ )
+ const
+
+
+
+
+noexcept
+
+
+
+
Deprecated: The function is deprecated, please use 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
+
Returns A time interval, in seconds, that the server will persist this connection's MQTT session state for.
+
+
+
+
+
◆ getSessionExpiryIntervalSec()
+
+
+
+
+
+
+
+
+ const Crt::Optional < uint32_t > & Aws::Crt::Mqtt5::ConnAckPacket::getSessionExpiryIntervalSec
+ (
+ )
+ const
+
+
+
+
+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
+
Returns A time interval, in seconds, that the server will persist this connection's MQTT session state for.
+
+
+
+
+
◆ getSessionPresent()
+
+
+
+
+
+
+
+
+ bool Aws::Crt::Mqtt5::ConnAckPacket::getSessionPresent
+ (
+ )
+ const
+
+
+
+
+noexcept
+
+
+
+
True if the client rejoined an existing session on the server, false otherwise.
+
See MQTT5 Session Present
+
Returns True if the client rejoined an existing session on the server, false otherwise.
+
+
+
+
+
◆ getSharedSubscriptionsAvailable()
+
+
+
+
+
+
+
+
+ const Crt::Optional < bool > & Aws::Crt::Mqtt5::ConnAckPacket::getSharedSubscriptionsAvailable
+ (
+ )
+ const
+
+
+
+
+noexcept
+
+
+
+
Indicates whether the server supports shared subscription topic filters. If null, shared subscriptions are supported.
+
See MQTT5 Shared Subscriptions Available
+
Returns whether the server supports shared subscription topic filters.
+
+
+
+
+
◆ getSubscriptionIdentifiersAvailable()
+
+
+
+
+
+
+
+
+ const Crt::Optional < bool > & Aws::Crt::Mqtt5::ConnAckPacket::getSubscriptionIdentifiersAvailable
+ (
+ )
+ const
+
+
+
+
+noexcept
+
+
+
+
Indicates whether the server supports subscription identifiers. If null, subscription identifiers are supported.
+
See MQTT5 Subscription Identifiers Available
+
Returns whether the server supports subscription identifiers.
+
+
+
+
+
◆ getTopicAliasMaximum()
+
+
+
+
+
+
+
+
+ const Crt::Optional < uint16_t > Aws::Crt::Mqtt5::ConnAckPacket::getTopicAliasMaximum
+ (
+ )
+ const
+
+
+
+
+noexcept
+
+
+
+
Specifies the maximum topic alias value that the server will accept from the client.
+
See MQTT5 Topic Alias Maximum
+
Returns maximum topic alias
+
+
+
+
+
◆ getType()
+
+
+
+
+
+
+
+
+ PacketType Aws::Crt::Mqtt5::ConnAckPacket::getType
+ (
+ )
+
+
+
+
+
+inline override virtual
+
+
+
+
+
+
◆ getUserProperty()
+
+
+
+
+
+
+
+
+ const Vector < UserProperty > & Aws::Crt::Mqtt5::ConnAckPacket::getUserProperty
+ (
+ )
+ const
+
+
+
+
+noexcept
+
+
+
+
List of MQTT5 user properties included with the packet.
+
See MQTT5 User Property
+
Returns List of MQTT5 user properties included with the packet.
+
+
+
+
+
◆ getWildcardSubscriptionsAvailable()
+
+
+
+
+
+
+
+
+ const Crt::Optional < bool > & Aws::Crt::Mqtt5::ConnAckPacket::getWildcardSubscriptionsAvailable
+ (
+ )
+ const
+
+
+
+
+noexcept
+
+
+
+
Indicates whether the server supports wildcard subscriptions. If null, wildcard subscriptions are supported.
+
See MQTT5 Wildcard Subscriptions Available
+
Returns Whether the server supports wildcard subscriptions.
+
+
+
+
+
◆ operator=() [1/2]
+
+
+
+
+
+
+
+
+
+delete noexcept
+
+
+
+
+
+
+
+
◆ operator=() [2/2]
+
+
+
The documentation for this class was generated from the following files:
+
+
+
+
+
diff --git a/docs/class_aws_1_1_crt_1_1_mqtt5_1_1_conn_ack_packet.png b/docs/class_aws_1_1_crt_1_1_mqtt5_1_1_conn_ack_packet.png
new file mode 100644
index 000000000..0cae9f4ac
Binary files /dev/null and b/docs/class_aws_1_1_crt_1_1_mqtt5_1_1_conn_ack_packet.png differ
diff --git a/docs/class_aws_1_1_crt_1_1_mqtt5_1_1_connect_packet-members.html b/docs/class_aws_1_1_crt_1_1_mqtt5_1_1_connect_packet-members.html
new file mode 100644
index 000000000..368724993
--- /dev/null
+++ b/docs/class_aws_1_1_crt_1_1_mqtt5_1_1_connect_packet-members.html
@@ -0,0 +1,117 @@
+
+
+
+
+
+
+
+aws-crt-cpp: Member List
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ 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.
+
+
+
+
+
diff --git a/docs/class_aws_1_1_crt_1_1_mqtt5_1_1_connect_packet.html b/docs/class_aws_1_1_crt_1_1_mqtt5_1_1_connect_packet.html
new file mode 100644
index 000000000..555d819c6
--- /dev/null
+++ b/docs/class_aws_1_1_crt_1_1_mqtt5_1_1_connect_packet.html
@@ -0,0 +1,1263 @@
+
+
+
+
+
+
+
+aws-crt-cpp: Aws::Crt::Mqtt5::ConnectPacket Class Reference
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ 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 CONNECT packet.
+
+
+
◆ ConnectPacket() [1/3]
+
+
+
+
◆ ~ConnectPacket()
+
+
+
+
+
+
+
+
+ Aws::Crt::Mqtt5::ConnectPacket::~ConnectPacket
+ (
+ )
+
+
+
+
+
+virtual
+
+
+
+
+
+
+
+
◆ ConnectPacket() [2/3]
+
+
+
+
+
+
+
+
+ Aws::Crt::Mqtt5::ConnectPacket::ConnectPacket
+ (
+ const ConnectPacket &
+ )
+
+
+
+
+
+delete
+
+
+
+
+
+
+
+
◆ ConnectPacket() [3/3]
+
+
+
+
+
+
+
+
+ Aws::Crt::Mqtt5::ConnectPacket::ConnectPacket
+ (
+ ConnectPacket &&
+ )
+
+
+
+
+
+delete noexcept
+
+
+
+
+
+
+
+
+
◆ getClientId()
+
+
+
+
+
+
+
+
+ const Crt::String & Aws::Crt::Mqtt5::ConnectPacket::getClientId
+ (
+ )
+ const
+
+
+
+
+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.
+
See MQTT5 Client Identifier
+
Returns A unique string identifying the client to the server.
+
+
+
+
+
◆ getKeepAliveIntervalSec()
+
+
+
+
+
+
+
+
+ uint16_t Aws::Crt::Mqtt5::ConnectPacket::getKeepAliveIntervalSec
+ (
+ )
+ const
+
+
+
+
+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
+
Returns 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.
+
+
+
+
+
◆ getMaximumPacketSizeBytes()
+
+
+
+
+
+
+
+
+ const Crt::Optional < uint32_t > & Aws::Crt::Mqtt5::ConnectPacket::getMaximumPacketSizeBytes
+ (
+ )
+ const
+
+
+
+
+noexcept
+
+
+
+
+
+
◆ getMaximumPacketSizeToServer()
+
+
+
+
+
+
+
+
+ const Crt::Optional < uint32_t > & Aws::Crt::Mqtt5::ConnectPacket::getMaximumPacketSizeToServer
+ (
+ )
+ const
+
+
+
+
+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.
+
See MQTT5 Maximum Packet Size
+
Returns The maximum packet size the client is willing to handle
+
+
+
+
+
◆ getPassword()
+
+
+
+
Opaque binary data that the server may use for client authentication and authorization.
+
See MQTT5 Password
+
Returns Opaque binary data that the server may use for client authentication and authorization.
+
+
+
+
+
◆ getReceiveMaximum()
+
+
+
+
+
+
+
+
+ const Crt::Optional < uint16_t > & Aws::Crt::Mqtt5::ConnectPacket::getReceiveMaximum
+ (
+ )
+ const
+
+
+
+
+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.
+
See MQTT5 Receive Maximum
+
Returns The maximum number of in-flight QoS 1 and 2 messages the client is willing to handle.
+
+
+
+
+
◆ getRequestProblemInformation()
+
+
+
+
+
+
+
+
+ const Crt::Optional < bool > & Aws::Crt::Mqtt5::ConnectPacket::getRequestProblemInformation
+ (
+ )
+ const
+
+
+
+
+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
+
Returns If true, requests that the server send additional diagnostic information (via response string or user properties) in DISCONNECT or CONNACK packets from the server.
+
+
+
+
+
◆ getRequestResponseInformation()
+
+
+
+
+
+
+
+
+ const Crt::Optional < bool > & Aws::Crt::Mqtt5::ConnectPacket::getRequestResponseInformation
+ (
+ )
+ const
+
+
+
+
+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
+
Returns If true, requests that the server send response information in the subsequent CONNACK.
+
+
+
+
+
◆ getSessionExpiryIntervalSec()
+
+
+
+
+
+
+
+
+ const Crt::Optional < uint32_t > & Aws::Crt::Mqtt5::ConnectPacket::getSessionExpiryIntervalSec
+ (
+ )
+ const
+
+
+
+
+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
+
Returns A time interval, in seconds, that the client requests the server to persist this connection's MQTT session state for.
+
+
+
+
+
◆ getType()
+
+
+
+
+
+
+
+
+ PacketType Aws::Crt::Mqtt5::ConnectPacket::getType
+ (
+ )
+
+
+
+
+
+inline override virtual
+
+
+
+
+
+
◆ getUsername()
+
+
+
+
A string value that the server may use for client authentication and authorization.
+
See MQTT5 User Name
+
Returns A string value that the server may use for client authentication and authorization.
+
+
+
+
+
◆ getUserProperties()
+
+
+
+
List of MQTT5 user properties included with the packet.
+
See MQTT5 User Property
+
Returns List of MQTT5 user properties included with the packet.
+
+
+
+
+
◆ getWill()
+
+
+
+
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
+
Returns 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.
+
+
+
+
+
◆ getWillDelayIntervalSec()
+
+
+
+
+
+
+
+
+ const Crt::Optional < uint32_t > & Aws::Crt::Mqtt5::ConnectPacket::getWillDelayIntervalSec
+ (
+ )
+ const
+
+
+
+
+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.
+
See MQTT5 Will Delay Interval
+
Returns 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.
+
+
+
+
+
◆ initializeRawOptions()
+
+
+
+
+
+
+
+
+ bool Aws::Crt::Mqtt5::ConnectPacket::initializeRawOptions
+ (
+ aws_mqtt5_packet_connect_view &
+ raw_options ,
+
+
+
+
+ Allocator *
+ allocator
+
+
+
+ )
+
+
+
+
+
+noexcept
+
+
+
+
Intended for internal use only. Initializes the C aws_mqtt5_packet_connack_view from PacketConnect
+
Parameters
+
+ raw_options - output parameter containing low level client options to be passed to the C
+ allocator - memory Allocator
+
+
+
+
+
+
+
+
◆ operator=() [1/2]
+
+
+
+
+
+
+
+
+
+delete noexcept
+
+
+
+
+
+
+
+
◆ operator=() [2/2]
+
+
+
+
◆ WithClientId()
+
+
+
+
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.
+
See MQTT5 Client Identifier
+
Parameters
+
+ clientId A unique string identifying the client to the server.
+
+
+
+
Returns The ConnectPacket Object after setting the client ID.
+
+
+
+
+
◆ WithKeepAliveIntervalSec()
+
+
+
+
+
+
+
+
+ ConnectPacket & Aws::Crt::Mqtt5::ConnectPacket::WithKeepAliveIntervalSec
+ (
+ uint16_t
+ keepAliveInteralSeconds )
+
+
+
+
+
+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 .
+
Parameters
+
+ 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.
+
+
+
+
Returns The ConnectPacket Object after setting the keep alive interval.
+
+
+
+
+
◆ WithMaximumPacketSizeBytes()
+
+
+
+
+
+
+
+
+ ConnectPacket & Aws::Crt::Mqtt5::ConnectPacket::WithMaximumPacketSizeBytes
+ (
+ uint32_t
+ maximumPacketSizeBytes )
+
+
+
+
+
+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.
+
See MQTT5 Maximum Packet Size
+
Parameters
+
+ maximumPacketSizeBytes The maximum packet size the client is willing to handle
+
+
+
+
Returns The ConnectPacket Object after setting the maximum packet size.
+
+
+
+
+
◆ WithPassword()
+
+
+
+
Sets the opaque binary data that the server may use for client authentication and authorization.
+
See MQTT5 Password
+
Parameters
+
+ password Opaque binary data that the server may use for client authentication and authorization.
+
+
+
+
Returns The ConnectPacket Object after setting the password.
+
+
+
+
+
◆ WithReceiveMaximum()
+
+
+
+
+
+
+
+
+ ConnectPacket & Aws::Crt::Mqtt5::ConnectPacket::WithReceiveMaximum
+ (
+ uint16_t
+ receiveMaximum )
+
+
+
+
+
+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.
+
See MQTT5 Receive Maximum
+
Parameters
+
+ receiveMaximum The maximum number of in-flight QoS 1 and 2 messages the client is willing to handle.
+
+
+
+
Returns The ConnectPacket Object after setting the receive maximum.
+
+
+
+
+
◆ WithRequestProblemInformation()
+
+
+
+
+
+
+
+
+ ConnectPacket & Aws::Crt::Mqtt5::ConnectPacket::WithRequestProblemInformation
+ (
+ bool
+ requestProblemInformation )
+
+
+
+
+
+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
+
Parameters
+
+ 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.
+
+
+
+
Returns The ConnectPacket Object after setting the request problem information.
+
+
+
+
+
◆ WithRequestResponseInformation()
+
+
+
+
+
+
+
+
+ ConnectPacket & Aws::Crt::Mqtt5::ConnectPacket::WithRequestResponseInformation
+ (
+ bool
+ requestResponseInformation )
+
+
+
+
+
+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
+
Parameters
+
+ requestResponseInformation If true, requests that the server send response information in the subsequent CONNACK.
+
+
+
+
Returns The ConnectPacket Object after setting the request response information.
+
+
+
+
+
◆ WithSessionExpiryIntervalSec()
+
+
+
+
+
+
+
+
+ ConnectPacket & Aws::Crt::Mqtt5::ConnectPacket::WithSessionExpiryIntervalSec
+ (
+ uint32_t
+ sessionExpiryIntervalSeconds )
+
+
+
+
+
+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
+
Parameters
+
+ sessionExpiryIntervalSeconds A time interval, in seconds, that the client requests the server to persist this connection's MQTT session state for.
+
+
+
+
Returns The ConnectPacket Object after setting the session expiry interval.
+
+
+
+
+
◆ WithUserName()
+
+
+
+
Sets the string value that the server may use for client authentication and authorization.
+
See MQTT5 User Name
+
Parameters
+
+ username The string value that the server may use for client authentication and authorization.
+
+
+
+
Returns The ConnectPacket Object after setting the username.
+
+
+
+
+
◆ WithUserProperties() [1/2]
+
+
+
+
Sets the list of MQTT5 user properties included with the packet.
+
See MQTT5 User Property
+
Parameters
+
+ userProperties List of MQTT5 user properties included with the packet.
+
+
+
+
Returns The ConnectPacket Object after setting the user properties.
+
+
+
+
+
◆ WithUserProperties() [2/2]
+
+
+
+
Sets the list of MQTT5 user properties included with the packet.
+
See MQTT5 User Property
+
Parameters
+
+ userProperties List of MQTT5 user properties included with the packet.
+
+
+
+
Returns The ConnectPacket Object after setting the user properties.
+
+
+
+
+
◆ WithUserProperty()
+
+
+
+
Put a MQTT5 user property to the back of the packet user property vector/list
+
See MQTT5 User Property
+
Parameters
+
+ property set of userProperty of MQTT5 user properties included with the packet.
+
+
+
+
Returns The ConnectPacket Object after setting the user property
+
+
+
+
+
◆ WithWill()
+
+
+
+
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
+
Parameters
+
+ 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.
+
+
+
+
Returns The ConnectPacket Object after setting the will message.
+
+
+
+
+
◆ WithWillDelayIntervalSec()
+
+
+
+
+
+
+
+
+ ConnectPacket & Aws::Crt::Mqtt5::ConnectPacket::WithWillDelayIntervalSec
+ (
+ uint32_t
+ willDelayIntervalSeconds )
+
+
+
+
+
+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.
+
See MQTT5 Will Delay Interval
+
Parameters
+
+ 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.
+
+
+
+
Returns The ConnectPacket Object after setting the will message delay interval.
+
+
+
+
The documentation for this class was generated from the following files:
+
+
+
+
+
diff --git a/docs/class_aws_1_1_crt_1_1_mqtt5_1_1_connect_packet.png b/docs/class_aws_1_1_crt_1_1_mqtt5_1_1_connect_packet.png
new file mode 100644
index 000000000..f73cbace8
Binary files /dev/null and b/docs/class_aws_1_1_crt_1_1_mqtt5_1_1_connect_packet.png differ
diff --git a/docs/class_aws_1_1_crt_1_1_mqtt5_1_1_disconnect_packet-members.html b/docs/class_aws_1_1_crt_1_1_mqtt5_1_1_disconnect_packet-members.html
new file mode 100644
index 000000000..f1d519784
--- /dev/null
+++ b/docs/class_aws_1_1_crt_1_1_mqtt5_1_1_disconnect_packet-members.html
@@ -0,0 +1,103 @@
+
+
+
+
+
+
+
+aws-crt-cpp: Member List
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ 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.
+
+
+
+
+
diff --git a/docs/class_aws_1_1_crt_1_1_mqtt5_1_1_disconnect_packet.html b/docs/class_aws_1_1_crt_1_1_mqtt5_1_1_disconnect_packet.html
new file mode 100644
index 000000000..304c68064
--- /dev/null
+++ b/docs/class_aws_1_1_crt_1_1_mqtt5_1_1_disconnect_packet.html
@@ -0,0 +1,776 @@
+
+
+
+
+
+
+
+aws-crt-cpp: Aws::Crt::Mqtt5::DisconnectPacket Class Reference
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ 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.
+
+
+
◆ DisconnectPacket() [1/4]
+
+
+
+
+
+
+
+
+ Aws::Crt::Mqtt5::DisconnectPacket::DisconnectPacket
+ (
+ Allocator *
+ allocator = ApiAllocator ()
)
+
+
+
+
+
+noexcept
+
+
+
+
+
+
+
+
◆ DisconnectPacket() [2/4]
+
+
+
+
+
+
+
+
+ Aws::Crt::Mqtt5::DisconnectPacket::DisconnectPacket
+ (
+ const aws_mqtt5_packet_disconnect_view &
+ raw_options ,
+
+
+
+
+ Allocator *
+ allocator = ApiAllocator ()
+
+
+
+ )
+
+
+
+
+
+noexcept
+
+
+
+
+
+
+
+
◆ ~DisconnectPacket()
+
+
+
+
+
+
+
+
+ Aws::Crt::Mqtt5::DisconnectPacket::~DisconnectPacket
+ (
+ )
+
+
+
+
+
+virtual
+
+
+
+
+
+
+
+
◆ DisconnectPacket() [3/4]
+
+
+
+
+
+
+
+
+ Aws::Crt::Mqtt5::DisconnectPacket::DisconnectPacket
+ (
+ const DisconnectPacket &
+ )
+
+
+
+
+
+delete
+
+
+
+
+
+
+
+
◆ DisconnectPacket() [4/4]
+
+
+
+
+
+
+
+
+ Aws::Crt::Mqtt5::DisconnectPacket::DisconnectPacket
+ (
+ DisconnectPacket &&
+ )
+
+
+
+
+
+delete noexcept
+
+
+
+
+
+
+
+
+
◆ getReasonCode()
+
+
+
+
Value indicating the reason that the sender is closing the connection
+
See MQTT5 Disconnect Reason Code
+
Returns Value indicating the reason that the sender is closing the connection
+
+
+
+
+
◆ getReasonString()
+
+
+
+
Additional diagnostic information about the reason that the sender is closing the connection
+
See MQTT5 Reason String
+
Returns Additional diagnostic information about the reason that the sender is closing the connection
+
+
+
+
+
◆ getServerReference()
+
+
+
+
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).
+
See MQTT5 Server Reference
+
Returns Property indicating an alternate server that the client may temporarily or permanently attempt to connect to instead of the configured endpoint.
+
+
+
+
+
◆ getSessionExpiryIntervalSec()
+
+
+
+
+
+
+
+
+ const Crt::Optional < uint32_t > & Aws::Crt::Mqtt5::DisconnectPacket::getSessionExpiryIntervalSec
+ (
+ )
+ const
+
+
+
+
+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
+
Returns A change to the session expiry interval negotiated at connection time as part of the disconnect.
+
+
+
+
+
◆ getType()
+
+
+
+
+
+
+
+
+ PacketType Aws::Crt::Mqtt5::DisconnectPacket::getType
+ (
+ )
+
+
+
+
+
+inline override virtual
+
+
+
+
+
+
◆ getUserProperties()
+
+
+
+
List of MQTT5 user properties included with the packet.
+
See MQTT5 User Property
+
Returns List of MQTT5 user properties included with the packet.
+
+
+
+
+
◆ initializeRawOptions()
+
+
+
+
+
+
+
+
+ bool Aws::Crt::Mqtt5::DisconnectPacket::initializeRawOptions
+ (
+ aws_mqtt5_packet_disconnect_view &
+ raw_options )
+
+
+
+
+
+noexcept
+
+
+
+
+
+
+
+
◆ operator=() [1/2]
+
+
+
+
◆ operator=() [2/2]
+
+
+
+
+
+
+
+
+
+delete noexcept
+
+
+
+
+
+
+
+
◆ WithReasonCode()
+
+
+
+
Sets the value indicating the reason that the sender is closing the connection
+
See MQTT5 Disconnect Reason Code
+
Parameters
+
+ reasonCode Value indicating the reason that the sender is closing the connection
+
+
+
+
Returns The DisconnectPacket Object after setting the reason code.
+
+
+
+
+
◆ WithReasonString()
+
+
+
+
Sets the additional diagnostic information about the reason that the sender is closing the connection
+
See MQTT5 Reason String
+
Parameters
+
+ reasonString Additional diagnostic information about the reason that the sender is closing the connection
+
+
+
+
Returns The DisconnectPacket Object after setting the reason string.
+
+
+
+
+
◆ WithServerReference()
+
+
+
+
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).
+
See MQTT5 Server Reference
+
Parameters
+
+ serverReference Property indicating an alternate server that the client may temporarily or permanently attempt to connect to instead of the configured endpoint.
+
+
+
+
Returns The DisconnectPacket Object after setting the server reference.
+
+
+
+
+
◆ WithSessionExpiryIntervalSec()
+
+
+
+
+
+
+
+
+ DisconnectPacket & Aws::Crt::Mqtt5::DisconnectPacket::WithSessionExpiryIntervalSec
+ (
+ const uint32_t
+ sessionExpiryIntervalSeconds )
+
+
+
+
+
+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
+
Parameters
+
+ sessionExpiryIntervalSeconds
+
+
+
+
Returns The DisconnectPacket Object after setting the session expiry interval.
+
+
+
+
+
◆ WithUserProperties() [1/2]
+
+
+
+
Sets the list of MQTT5 user properties included with the packet.
+
See MQTT5 User Property
+
Parameters
+
+ userProperties List of MQTT5 user properties included with the packet.
+
+
+
+
Returns The DisconnectPacket Object after setting the user properties.
+
+
+
+
+
◆ WithUserProperties() [2/2]
+
+
+
+
Sets the list of MQTT5 user properties included with the packet.
+
See MQTT5 User Property
+
Parameters
+
+ userProperties List of MQTT5 user properties included with the packet.
+
+
+
+
Returns The DisconnectPacket Object after setting the user properties.
+
+
+
+
+
◆ WithUserProperty()
+
+
+
+
Put a MQTT5 user property to the back of the packet user property vector/list
+
See MQTT5 User Property
+
Parameters
+
+ property set of userProperty of MQTT5 user properties included with the packet.
+
+
+
+
Returns The ConnectPacket Object after setting the user property
+
+
+
+
The documentation for this class was generated from the following files:
+
+
+
+
+
diff --git a/docs/class_aws_1_1_crt_1_1_mqtt5_1_1_disconnect_packet.png b/docs/class_aws_1_1_crt_1_1_mqtt5_1_1_disconnect_packet.png
new file mode 100644
index 000000000..cb94ce67b
Binary files /dev/null and b/docs/class_aws_1_1_crt_1_1_mqtt5_1_1_disconnect_packet.png differ
diff --git a/docs/class_aws_1_1_crt_1_1_mqtt5_1_1_i_packet-members.html b/docs/class_aws_1_1_crt_1_1_mqtt5_1_1_i_packet-members.html
new file mode 100644
index 000000000..ac75e9378
--- /dev/null
+++ b/docs/class_aws_1_1_crt_1_1_mqtt5_1_1_i_packet-members.html
@@ -0,0 +1,83 @@
+
+
+
+
+
+
+
+aws-crt-cpp: Member List
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ 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.
+
+
+
+
+
diff --git a/docs/class_aws_1_1_crt_1_1_mqtt5_1_1_i_packet.html b/docs/class_aws_1_1_crt_1_1_mqtt5_1_1_i_packet.html
new file mode 100644
index 000000000..32ceb6e80
--- /dev/null
+++ b/docs/class_aws_1_1_crt_1_1_mqtt5_1_1_i_packet.html
@@ -0,0 +1,138 @@
+
+
+
+
+
+
+
+aws-crt-cpp: Aws::Crt::Mqtt5::IPacket Class Reference
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ aws-crt-cpp
+
+ C++ wrapper around the aws-c-* libraries. Provides Cross-Platform Transport Protocols and SSL/TLS implementations for C++.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
#include <Mqtt5Packets.h >
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
◆ getType()
+
+
+
+
+
+
+
+
+ virtual PacketType Aws::Crt::Mqtt5::IPacket::getType
+ (
+ )
+
+
+
+
+
+pure virtual
+
+
+
+
+
The documentation for this class was generated from the following file:
+
+
+
+
+
diff --git a/docs/class_aws_1_1_crt_1_1_mqtt5_1_1_i_packet.png b/docs/class_aws_1_1_crt_1_1_mqtt5_1_1_i_packet.png
new file mode 100644
index 000000000..304632c50
Binary files /dev/null and b/docs/class_aws_1_1_crt_1_1_mqtt5_1_1_i_packet.png differ
diff --git a/docs/class_aws_1_1_crt_1_1_mqtt5_1_1_mqtt5_client-members.html b/docs/class_aws_1_1_crt_1_1_mqtt5_1_1_mqtt5_client-members.html
new file mode 100644
index 000000000..0faf5f42a
--- /dev/null
+++ b/docs/class_aws_1_1_crt_1_1_mqtt5_1_1_mqtt5_client-members.html
@@ -0,0 +1,95 @@
+
+
+
+
+
+
+
+aws-crt-cpp: Member List
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ 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.
+
+
+
+
+
diff --git a/docs/class_aws_1_1_crt_1_1_mqtt5_1_1_mqtt5_client.html b/docs/class_aws_1_1_crt_1_1_mqtt5_1_1_mqtt5_client.html
new file mode 100644
index 000000000..a6bf32044
--- /dev/null
+++ b/docs/class_aws_1_1_crt_1_1_mqtt5_1_1_mqtt5_client.html
@@ -0,0 +1,558 @@
+
+
+
+
+
+
+
+aws-crt-cpp: Aws::Crt::Mqtt5::Mqtt5Client Class Reference
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ aws-crt-cpp
+
+ C++ wrapper around the aws-c-* libraries. Provides Cross-Platform Transport Protocols and SSL/TLS implementations for C++.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
#include <Mqtt5Client.h >
+
+
+
+
+
+
+
+
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.
+
+
+
◆ ~Mqtt5Client()
+
+
+
+
+
+
+
+
+ Aws::Crt::Mqtt5::Mqtt5Client::~Mqtt5Client
+ (
+ )
+
+
+
+
+
+virtual
+
+
+
+
+
+
+
+
+
◆ GetOperationStatistics()
+
+
+
+
◆ getptr()
+
+
+
+
+
+
+
+
+ std::shared_ptr<Mqtt5Client > Aws::Crt::Mqtt5::Mqtt5Client::getptr
+ (
+ )
+
+
+
+
+
+inline
+
+
+
+
+
+
◆ LastError()
+
+
+
+
+
+
+
+
+ int Aws::Crt::Mqtt5::Mqtt5Client::LastError
+ (
+ )
+ const
+
+
+
+
+noexcept
+
+
+
+
Returns the value of the last aws error encountered by operations on this instance.
+
+
+
+
+
◆ NewMqtt5Client()
+
+
+
+
+
+
+
+
+
+static noexcept
+
+
+
+
Factory function for mqtt5 client
+
Parameters
+
+ options Mqtt5 Client Options
+ allocator allocator to use
+
+
+
+
Returns a new mqtt5 client
+
+
+
+
+
◆ operator bool()
+
+
+
+
+
+
+
+
+ Aws::Crt::Mqtt5::Mqtt5Client::operator bool
+ (
+ )
+ const
+
+
+
+
+noexcept
+
+
+
+
Returns true if the instance is in a valid state, false otherwise.
+
+
+
+
+
◆ Publish()
+
+
+
+
Tells the client to attempt to send a PUBLISH packet
+
Parameters
+
+ publishPacket packet PUBLISH to send to the server
+ onPublishCompletionCallback callback on publish complete, default to NULL
+
+
+
+
Returns true if the publish operation succeed otherwise false
+
+
+
+
+
◆ Start()
+
+
+
+
+
+
+
+
+ bool Aws::Crt::Mqtt5::Mqtt5Client::Start
+ (
+ )
+ const
+
+
+
+
+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.
+
Returns bool: true if operation succeed, otherwise false.
+
+
+
+
+
◆ Stop() [1/2]
+
+
+
+
+
+
+
+
+ bool Aws::Crt::Mqtt5::Mqtt5Client::Stop
+ (
+ )
+
+
+
+
+
+noexcept
+
+
+
+
Notifies the MQTT5 client that you want it to transition to the stopped state, disconnecting any existing connection and stopping subsequent reconnect attempts.
+
Returns bool: true if operation succeed, otherwise false
+
+
+
+
+
◆ Stop() [2/2]
+
+
+
+
+
+
+
+
+ bool Aws::Crt::Mqtt5::Mqtt5Client::Stop
+ (
+ std::shared_ptr< DisconnectPacket >
+ disconnectPacket )
+
+
+
+
+
+noexcept
+
+
+
+
Notifies the MQTT5 client that you want it to transition to the stopped state, disconnecting any existing connection and stopping subsequent reconnect attempts.
+
Parameters
+
+ disconnectPacket (optional) properties of a DISCONNECT packet to send as part of the shutdown process
+
+
+
+
Returns bool: true if operation succeed, otherwise false
+
+
+
+
+
◆ Subscribe()
+
+
+
+
Tells the client to attempt to subscribe to one or more topic filters.
+
Parameters
+
+ subscribePacket SUBSCRIBE packet to send to the server
+ onSubscribeCompletionCallback callback on subscribe complete, default to NULL
+
+
+
+
Returns true if the subscription operation succeed otherwise false
+
+
+
+
+
◆ Unsubscribe()
+
+
+
+
Tells the client to attempt to unsubscribe to one or more topic filters.
+
Parameters
+
+ unsubscribePacket UNSUBSCRIBE packet to send to the server
+ onUnsubscribeCompletionCallback callback on unsubscribe complete, default to NULL
+
+
+
+
Returns true if the unsubscription operation succeed otherwise false
+
+
+
+
+
+
◆ Mqtt::MqttConnection
+
+
+
The documentation for this class was generated from the following files:
+
+
+
+
+
diff --git a/docs/class_aws_1_1_crt_1_1_mqtt5_1_1_mqtt5_client.png b/docs/class_aws_1_1_crt_1_1_mqtt5_1_1_mqtt5_client.png
new file mode 100644
index 000000000..bb9e80973
Binary files /dev/null and b/docs/class_aws_1_1_crt_1_1_mqtt5_1_1_mqtt5_client.png differ
diff --git a/docs/class_aws_1_1_crt_1_1_mqtt5_1_1_mqtt5_client_options-members.html b/docs/class_aws_1_1_crt_1_1_mqtt5_1_1_mqtt5_client_options-members.html
new file mode 100644
index 000000000..5ad5fdc07
--- /dev/null
+++ b/docs/class_aws_1_1_crt_1_1_mqtt5_1_1_mqtt5_client_options-members.html
@@ -0,0 +1,114 @@
+
+
+
+
+
+
+
+aws-crt-cpp: Member List
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ 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.
+
+
+
+
+
diff --git a/docs/class_aws_1_1_crt_1_1_mqtt5_1_1_mqtt5_client_options.html b/docs/class_aws_1_1_crt_1_1_mqtt5_1_1_mqtt5_client_options.html
new file mode 100644
index 000000000..47c73eac3
--- /dev/null
+++ b/docs/class_aws_1_1_crt_1_1_mqtt5_1_1_mqtt5_client_options.html
@@ -0,0 +1,1174 @@
+
+
+
+
+
+
+
+aws-crt-cpp: Aws::Crt::Mqtt5::Mqtt5ClientOptions Class Reference
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ aws-crt-cpp
+
+ C++ wrapper around the aws-c-* libraries. Provides Cross-Platform Transport Protocols and SSL/TLS implementations for C++.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
#include <Mqtt5Client.h >
+
+
+
Configuration interface for mqtt5 clients
+
+
+
◆ Mqtt5ClientOptions() [1/3]
+
+
+
+
◆ ~Mqtt5ClientOptions()
+
+
+
+
+
+
+
+
+ Aws::Crt::Mqtt5::Mqtt5ClientOptions::~Mqtt5ClientOptions
+ (
+ )
+
+
+
+
+
+virtual
+
+
+
+
+
+
+
+
◆ Mqtt5ClientOptions() [2/3]
+
+
+
+
+
+
+
+
+ Aws::Crt::Mqtt5::Mqtt5ClientOptions::Mqtt5ClientOptions
+ (
+ const Mqtt5ClientOptions &
+ )
+
+
+
+
+
+delete
+
+
+
+
+
+
+
+
◆ Mqtt5ClientOptions() [3/3]
+
+
+
+
+
+
+
+
+ Aws::Crt::Mqtt5::Mqtt5ClientOptions::Mqtt5ClientOptions
+ (
+ Mqtt5ClientOptions &&
+ )
+
+
+
+
+
+delete
+
+
+
+
+
+
+
+
+
◆ initializeRawOptions()
+
+
+
+
+
+
+
+
+ bool Aws::Crt::Mqtt5::Mqtt5ClientOptions::initializeRawOptions
+ (
+ aws_mqtt5_client_options &
+ raw_options )
+ const
+
+
+
+
+noexcept
+
+
+
+
Initializes the C aws_mqtt5_client_options from Mqtt5ClientOptions . For internal use
+
Parameters
+
+ raw_options - output parameter containing low level client options to be passed to the C interface
+
+
+
+
+
+
+
+
◆ operator=() [1/2]
+
+
+
+
◆ operator=() [2/2]
+
+
+
+
◆ WithAckTimeoutSec()
+
+
+
+
+
+
+
+
+ Mqtt5ClientOptions & Aws::Crt::Mqtt5::Mqtt5ClientOptions::WithAckTimeoutSec
+ (
+ uint32_t
+ ackTimeoutSec )
+
+
+
+
+
+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.
+
Parameters
+
+
+
+
Returns this option object
+
+
+
+
+
◆ WithAckTimeoutSeconds()
+
+
+
+
+
+
+
+
+ Mqtt5ClientOptions & Aws::Crt::Mqtt5::Mqtt5ClientOptions::WithAckTimeoutSeconds
+ (
+ uint32_t
+ ackTimeoutSec )
+
+
+
+
+
+noexcept
+
+
+
+
Deprecated: The function is deprecated, please use 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.
+
Parameters
+
+
+
+
Returns this option object
+
+
+
+
+
◆ WithBootstrap()
+
+
+
+
Set booststrap for mqtt5 client
+
Parameters
+
+
+
+
Returns this option object
+
+
+
+
+
◆ WithClientAttemptingConnectCallback()
+
+
+
+
Sets callback trigged when client begins an attempt to connect to the remote endpoint.
+
Parameters
+
+
+
+
Returns this option object
+
+
+
+
+
◆ WithClientConnectionFailureCallback()
+
+
+
+
Sets callback trigged when client fails to establish an MQTT connection
+
Parameters
+
+
+
+
Returns this option object
+
+
+
+
+
◆ WithClientConnectionSuccessCallback()
+
+
+
+
Sets callback trigged when client successfully establishes an MQTT connection
+
Parameters
+
+
+
+
Returns this option object
+
+
+
+
+
◆ WithClientDisconnectionCallback()
+
+
+
+
Sets callback trigged when client's current MQTT connection is closed
+
Parameters
+
+
+
+
Returns this option object
+
+
+
+
+
◆ WithClientExtendedValidationAndFlowControl()
+
+
+
+
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.
+
Parameters
+
+ clientExtendedValidationAndFlowControl
+
+
+
+
Returns this option object
+
+
+
+
+
◆ WithClientStoppedCallback()
+
+
+
+
Sets callback trigged when client reaches the "Stopped" state
+
Parameters
+
+
+
+
Returns this option object
+
+
+
+
+
◆ WithConnackTimeoutMs()
+
+
+
+
+
+
+
+
+ Mqtt5ClientOptions & Aws::Crt::Mqtt5::Mqtt5ClientOptions::WithConnackTimeoutMs
+ (
+ uint32_t
+ connackTimeoutMs )
+
+
+
+
+
+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.
+
Parameters
+
+
+
+
Returns this option object
+
+
+
+
+
◆ WithConnectOptions()
+
+
+
+
Sets mqtt5 connection options
+
Parameters
+
+ connectPacket package connection options
+
+
+
+
Returns this option object
+
+
+
+
+
◆ WithHostName()
+
+
+
+
Sets host to connect to.
+
Parameters
+
+ hostname endpoint to connect to
+
+
+
+
Returns this option object
+
+
+
+
+
◆ WithHttpProxyOptions()
+
+
+
+
Sets http proxy options.
+
Parameters
+
+ proxyOptions http proxy configuration for connection establishment
+
+
+
+
Returns this option object
+
+
+
+
+
◆ WithOfflineQueueBehavior()
+
+
+
+
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.
+
Parameters
+
+
+
+
Returns this option object
+
+
+
+
+
◆ WithPingTimeoutMs()
+
+
+
+
+
+
+
+
+ Mqtt5ClientOptions & Aws::Crt::Mqtt5::Mqtt5ClientOptions::WithPingTimeoutMs
+ (
+ uint32_t
+ pingTimeoutMs )
+
+
+
+
+
+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.
+
Parameters
+
+
+
+
Returns this option object
+
+
+
+
+
◆ WithPort()
+
+
+
+
+
+
+
+
+ Mqtt5ClientOptions & Aws::Crt::Mqtt5::Mqtt5ClientOptions::WithPort
+ (
+ uint32_t
+ port )
+
+
+
+
+
+noexcept
+
+
+
+
Set port to connect to
+
Parameters
+
+ port port to connect to
+
+
+
+
Returns this option object
+
+
+
+
+
◆ WithPublishReceivedCallback()
+
+
+
+
Sets callback trigged when a PUBLISH packet is received by the client
+
Parameters
+
+
+
+
Returns this option object
+
+
+
+
+
◆ WithReconnectOptions()
+
+
+
+
Sets ReconnectOptions . Reconnect options, includes retryJitterMode, min reconnect delay time and max reconnect delay time and reset reconnect delay time
+
Parameters
+
+
+
+
Returns this option object
+
+
+
+
+
◆ WithSessionBehavior()
+
+
+
+
Sets session behavior. Overrides how the MQTT5 client should behave with respect to MQTT sessions.
+
Parameters
+
+
+
+
Returns this option object
+
+
+
+
+
◆ WithSocketOptions()
+
+
+
+
Sets the aws socket options
+
Parameters
+
+
+
+
Returns this option object
+
+
+
+
+
◆ WithTlsConnectionOptions()
+
+
+
+
Sets the tls connection options
+
Parameters
+
+
+
+
Returns this option object
+
+
+
+
+
◆ WithTopicAliasingOptions()
+
+
+
+
Sets the topic aliasing behavior for the client.
+
Parameters
+
+ topicAliasingOptions topic aliasing behavior options to use
+
+
+
+
Returns this options object
+
+
+
+
+
◆ WithWebsocketHandshakeTransformCallback()
+
+
+
+
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.
+
Parameters
+
+
+
+
Returns this option object
+
+
+
+
+
+
◆ Mqtt5ClientCore
+
+
+
+
+
+
+
+
+ friend class Mqtt5ClientCore
+
+
+
+
+friend
+
+
+
+
+
+
+
+
◆ Mqtt5to3AdapterOptions
+
+
+
+
+
+
+
+
+ friend class Mqtt5to3AdapterOptions
+
+
+
+
+friend
+
+
+
+
+
+
+
The documentation for this class was generated from the following files:
+
+
+
+
+
diff --git a/docs/class_aws_1_1_crt_1_1_mqtt5_1_1_negotiated_settings-members.html b/docs/class_aws_1_1_crt_1_1_mqtt5_1_1_negotiated_settings-members.html
new file mode 100644
index 000000000..edf174ceb
--- /dev/null
+++ b/docs/class_aws_1_1_crt_1_1_mqtt5_1_1_negotiated_settings-members.html
@@ -0,0 +1,103 @@
+
+
+
+
+
+
+
+aws-crt-cpp: Member List
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ 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.
+
+
+
+
+
diff --git a/docs/class_aws_1_1_crt_1_1_mqtt5_1_1_negotiated_settings.html b/docs/class_aws_1_1_crt_1_1_mqtt5_1_1_negotiated_settings.html
new file mode 100644
index 000000000..7209b162e
--- /dev/null
+++ b/docs/class_aws_1_1_crt_1_1_mqtt5_1_1_negotiated_settings.html
@@ -0,0 +1,701 @@
+
+
+
+
+
+
+
+aws-crt-cpp: Aws::Crt::Mqtt5::NegotiatedSettings Class Reference
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ aws-crt-cpp
+
+ C++ wrapper around the aws-c-* libraries. Provides Cross-Platform Transport Protocols and SSL/TLS implementations for C++.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
#include <Mqtt5Packets.h >
+
+
+
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.
+
+
+
◆ NegotiatedSettings() [1/3]
+
+
+
+
+
+
+
+
+ Aws::Crt::Mqtt5::NegotiatedSettings::NegotiatedSettings
+ (
+ const aws_mqtt5_negotiated_settings &
+ negotiated_settings ,
+
+
+
+
+ Allocator *
+ allocator = ApiAllocator ()
+
+
+
+ )
+
+
+
+
+
+noexcept
+
+
+
+
+
+
+
+
◆ ~NegotiatedSettings()
+
+
+
+
+
+
+
+
+ virtual Aws::Crt::Mqtt5::NegotiatedSettings::~NegotiatedSettings
+ (
+ )
+
+
+
+
+
+inline virtual
+
+
+
+
+
+
+
+
◆ NegotiatedSettings() [2/3]
+
+
+
+
+
+
+
+
+ Aws::Crt::Mqtt5::NegotiatedSettings::NegotiatedSettings
+ (
+ const NegotiatedSettings &
+ )
+
+
+
+
+
+delete
+
+
+
+
+
+
+
+
◆ NegotiatedSettings() [3/3]
+
+
+
+
+
+
+
+
+ Aws::Crt::Mqtt5::NegotiatedSettings::NegotiatedSettings
+ (
+ NegotiatedSettings &&
+ )
+
+
+
+
+
+delete noexcept
+
+
+
+
+
+
+
+
+
◆ getClientId()
+
+
+
+
+
+
+
+
+ const Crt::String & Aws::Crt::Mqtt5::NegotiatedSettings::getClientId
+ (
+ )
+ const
+
+
+
+
+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.
+
Returns The final client id in use by the newly-established connection
+
+
+
+
+
◆ getMaximumPacketSizeBytes()
+
+
+
+
+
+
+
+
+ uint32_t Aws::Crt::Mqtt5::NegotiatedSettings::getMaximumPacketSizeBytes
+ (
+ )
+ const
+
+
+
+
+noexcept
+
+
+
+
+
+
◆ getMaximumPacketSizeToServer()
+
+
+
+
+
+
+
+
+ uint32_t Aws::Crt::Mqtt5::NegotiatedSettings::getMaximumPacketSizeToServer
+ (
+ )
+ const
+
+
+
+
+noexcept
+
+
+
+
Returns The maximum packet size the server is willing to accept.
+
+
+
+
+
◆ getMaximumQOS()
+
+
+
+
+
+
+
+
+ Mqtt5::QOS Aws::Crt::Mqtt5::NegotiatedSettings::getMaximumQOS
+ (
+ )
+ const
+
+
+
+
+noexcept
+
+
+
+
Returns The maximum QoS allowed for publishes on this connection instance
+
+
+
+
+
◆ getReceiveMaximumFromServer()
+
+
+
+
+
+
+
+
+ uint16_t Aws::Crt::Mqtt5::NegotiatedSettings::getReceiveMaximumFromServer
+ (
+ )
+ const
+
+
+
+
+noexcept
+
+
+
+
Returns The number of in-flight QoS 1 and QoS 2 publications the server is willing to process concurrently.
+
+
+
+
+
◆ getRejoinedSession()
+
+
+
+
+
+
+
+
+ bool Aws::Crt::Mqtt5::NegotiatedSettings::getRejoinedSession
+ (
+ )
+ const
+
+
+
+
+noexcept
+
+
+
+
Returns Whether the client has rejoined an existing session.
+
+
+
+
+
◆ getRetainAvailable()
+
+
+
+
+
+
+
+
+ bool Aws::Crt::Mqtt5::NegotiatedSettings::getRetainAvailable
+ (
+ )
+ const
+
+
+
+
+noexcept
+
+
+
+
Returns Whether the server supports retained messages.
+
+
+
+
+
◆ getServerKeepAlive()
+
+
+
+
+
+
+
+
+ uint16_t Aws::Crt::Mqtt5::NegotiatedSettings::getServerKeepAlive
+ (
+ )
+ const
+
+
+
+
+noexcept
+
+
+
+
Deprecated: The function is deprecated, please use 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.
+
Returns The maximum amount of time in seconds between client packets.
+
+
+
+
+
◆ getServerKeepAliveSec()
+
+
+
+
+
+
+
+
+ uint16_t Aws::Crt::Mqtt5::NegotiatedSettings::getServerKeepAliveSec
+ (
+ )
+ const
+
+
+
+
+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.
+
Returns The maximum amount of time in seconds between client packets.
+
+
+
+
+
◆ getSessionExpiryIntervalSec()
+
+
+
+
+
+
+
+
+ uint32_t Aws::Crt::Mqtt5::NegotiatedSettings::getSessionExpiryIntervalSec
+ (
+ )
+ const
+
+
+
+
+noexcept
+
+
+
+
Returns The amount of time in seconds the server will retain the MQTT session after a disconnect.
+
+
+
+
+
◆ getSharedSubscriptionsAvailable()
+
+
+
+
+
+
+
+
+ bool Aws::Crt::Mqtt5::NegotiatedSettings::getSharedSubscriptionsAvailable
+ (
+ )
+ const
+
+
+
+
+noexcept
+
+
+
+
Returns Whether the server supports shared subscriptions
+
+
+
+
+
◆ getSubscriptionIdentifiersAvailable()
+
+
+
+
+
+
+
+
+ bool Aws::Crt::Mqtt5::NegotiatedSettings::getSubscriptionIdentifiersAvailable
+ (
+ )
+ const
+
+
+
+
+noexcept
+
+
+
+
Returns Whether the server supports subscription identifiers
+
+
+
+
+
◆ getTopicAliasMaximumToClient()
+
+
+
+
+
+
+
+
+ uint16_t Aws::Crt::Mqtt5::NegotiatedSettings::getTopicAliasMaximumToClient
+ (
+ )
+ const
+
+
+
+
+noexcept
+
+
+
+
Returns returns the maximum allowed topic alias value on publishes sent from server to client
+
+
+
+
+
◆ getTopicAliasMaximumToServer()
+
+
+
+
+
+
+
+
+ uint16_t Aws::Crt::Mqtt5::NegotiatedSettings::getTopicAliasMaximumToServer
+ (
+ )
+ const
+
+
+
+
+noexcept
+
+
+
+
Returns returns the maximum allowed topic alias value on publishes sent from client to server
+
+
+
+
+
◆ getWildcardSubscriptionsAvailable()
+
+
+
+
+
+
+
+
+ bool Aws::Crt::Mqtt5::NegotiatedSettings::getWildcardSubscriptionsAvailable
+ (
+ )
+ const
+
+
+
+
+noexcept
+
+
+
+
Returns Whether the server supports wildcard subscriptions.
+
+
+
+
+
◆ operator=() [1/2]
+
+
+
+
◆ operator=() [2/2]
+
+
+
+
+
+
+
+
+
+delete noexcept
+
+
+
+
+
+
+
The documentation for this class was generated from the following files:
+
+
+
+
+
diff --git a/docs/class_aws_1_1_crt_1_1_mqtt5_1_1_pub_ack_packet-members.html b/docs/class_aws_1_1_crt_1_1_mqtt5_1_1_pub_ack_packet-members.html
new file mode 100644
index 000000000..79b55bb4b
--- /dev/null
+++ b/docs/class_aws_1_1_crt_1_1_mqtt5_1_1_pub_ack_packet-members.html
@@ -0,0 +1,92 @@
+
+
+
+
+
+
+
+aws-crt-cpp: Member List
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ 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.
+
+
+
+
+
diff --git a/docs/class_aws_1_1_crt_1_1_mqtt5_1_1_pub_ack_packet.html b/docs/class_aws_1_1_crt_1_1_mqtt5_1_1_pub_ack_packet.html
new file mode 100644
index 000000000..15ea449e7
--- /dev/null
+++ b/docs/class_aws_1_1_crt_1_1_mqtt5_1_1_pub_ack_packet.html
@@ -0,0 +1,401 @@
+
+
+
+
+
+
+
+aws-crt-cpp: Aws::Crt::Mqtt5::PubAckPacket Class Reference
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ 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 PUBACK packet
+
+
+
◆ PubAckPacket() [1/3]
+
+
+
+
+
+
+
+
+ Aws::Crt::Mqtt5::PubAckPacket::PubAckPacket
+ (
+ const aws_mqtt5_packet_puback_view &
+ packet ,
+
+
+
+
+ Allocator *
+ allocator = ApiAllocator ()
+
+
+
+ )
+
+
+
+
+
+noexcept
+
+
+
+
+
+
+
+
◆ ~PubAckPacket()
+
+
+
+
+
+
+
+
+ virtual Aws::Crt::Mqtt5::PubAckPacket::~PubAckPacket
+ (
+ )
+
+
+
+
+
+inline virtual
+
+
+
+
+
+
+
+
◆ PubAckPacket() [2/3]
+
+
+
+
+
+
+
+
+ Aws::Crt::Mqtt5::PubAckPacket::PubAckPacket
+ (
+ const PubAckPacket &
+ toCopy )
+
+
+
+
+
+delete noexcept
+
+
+
+
+
+
+
+
◆ PubAckPacket() [3/3]
+
+
+
+
+
+
+
+
+ Aws::Crt::Mqtt5::PubAckPacket::PubAckPacket
+ (
+ PubAckPacket &&
+ toMove )
+
+
+
+
+
+delete noexcept
+
+
+
+
+
+
+
+
+
◆ getReasonCode()
+
+
+
+
+
+
+
+
+ PubAckReasonCode Aws::Crt::Mqtt5::PubAckPacket::getReasonCode
+ (
+ )
+ const
+
+
+
+
+noexcept
+
+
+
+
Success indicator or failure reason for the associated PUBLISH packet.
+
See MQTT5 PUBACK Reason Code
+
Returns Success indicator or failure reason for the associated PUBLISH packet.
+
+
+
+
+
◆ getReasonString()
+
+
+
+
Additional diagnostic information about the result of the PUBLISH attempt.
+
See MQTT5 Reason String
+
Returns Additional diagnostic information about the result of the PUBLISH attempt.
+
+
+
+
+
◆ getType()
+
+
+
+
+
+
+
+
+ PacketType Aws::Crt::Mqtt5::PubAckPacket::getType
+ (
+ )
+
+
+
+
+
+inline override virtual
+
+
+
+
+
+
◆ getUserProperties()
+
+
+
+
List of MQTT5 user properties included with the packet.
+
See MQTT5 User Property
+
Returns List of MQTT5 user properties included with the packet.
+
+
+
+
+
◆ operator=() [1/2]
+
+
+
+
+
+
+
+
+
+delete noexcept
+
+
+
+
+
+
+
+
◆ operator=() [2/2]
+
+
+
+
+
+
+
+
+
+delete noexcept
+
+
+
+
+
+
+
The documentation for this class was generated from the following files:
+
+
+
+
+
diff --git a/docs/class_aws_1_1_crt_1_1_mqtt5_1_1_pub_ack_packet.png b/docs/class_aws_1_1_crt_1_1_mqtt5_1_1_pub_ack_packet.png
new file mode 100644
index 000000000..38ea4a277
Binary files /dev/null and b/docs/class_aws_1_1_crt_1_1_mqtt5_1_1_pub_ack_packet.png differ
diff --git a/docs/class_aws_1_1_crt_1_1_mqtt5_1_1_publish_packet-members.html b/docs/class_aws_1_1_crt_1_1_mqtt5_1_1_publish_packet-members.html
new file mode 100644
index 000000000..8c22471f3
--- /dev/null
+++ b/docs/class_aws_1_1_crt_1_1_mqtt5_1_1_publish_packet-members.html
@@ -0,0 +1,116 @@
+
+
+
+
+
+
+
+aws-crt-cpp: Member List
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ 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.
+
+
+
+
+
diff --git a/docs/class_aws_1_1_crt_1_1_mqtt5_1_1_publish_packet.html b/docs/class_aws_1_1_crt_1_1_mqtt5_1_1_publish_packet.html
new file mode 100644
index 000000000..c92bd1ab8
--- /dev/null
+++ b/docs/class_aws_1_1_crt_1_1_mqtt5_1_1_publish_packet.html
@@ -0,0 +1,1218 @@
+
+
+
+
+
+
+
+aws-crt-cpp: Aws::Crt::Mqtt5::PublishPacket Class Reference
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ 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 PUBLISH packet
+
+
+
◆ PublishPacket() [1/5]
+
+
+
+
+
+
+
+
+ Aws::Crt::Mqtt5::PublishPacket::PublishPacket
+ (
+ const aws_mqtt5_packet_publish_view &
+ raw_options ,
+
+
+
+
+ Allocator *
+ allocator = ApiAllocator ()
+
+
+
+ )
+
+
+
+
+
+noexcept
+
+
+
+
+
+
+
+
◆ PublishPacket() [2/5]
+
+
+
+
◆ PublishPacket() [3/5]
+
+
+
+
◆ ~PublishPacket()
+
+
+
+
+
+
+
+
+ Aws::Crt::Mqtt5::PublishPacket::~PublishPacket
+ (
+ )
+
+
+
+
+
+virtual
+
+
+
+
+
+
+
+
◆ PublishPacket() [4/5]
+
+
+
+
+
+
+
+
+ Aws::Crt::Mqtt5::PublishPacket::PublishPacket
+ (
+ const PublishPacket &
+ )
+
+
+
+
+
+delete
+
+
+
+
+
+
+
+
◆ PublishPacket() [5/5]
+
+
+
+
+
+
+
+
+ Aws::Crt::Mqtt5::PublishPacket::PublishPacket
+ (
+ PublishPacket &&
+ )
+
+
+
+
+
+delete noexcept
+
+
+
+
+
+
+
+
+
◆ getContentType()
+
+
+
+
Property specifying the content type of the payload. Not internally meaningful to MQTT5.
+
See MQTT5 Content Type
+
Returns ByteCursor to opaque binary data to the content type of the payload.
+
+
+
+
+
◆ getCorrelationData()
+
+
+
+
Opaque binary data used to correlate between publish messages, as a potential method for request-response implementation. Not internally meaningful to MQTT5.
+
See MQTT5 Correlation Data
+
Returns ByteCursor to opaque binary data used to correlate between publish messages.
+
+
+
+
+
◆ getMessageExpiryIntervalSec()
+
+
+
+
+
+
+
+
+ const Crt::Optional < uint32_t > & Aws::Crt::Mqtt5::PublishPacket::getMessageExpiryIntervalSec
+ (
+ )
+ const
+
+
+
+
+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
+
Returns The message expiry interval associated with this PUBLISH packet.
+
+
+
+
+
◆ getPayload()
+
+
+
+
+
+
+
+
+ const ByteCursor & Aws::Crt::Mqtt5::PublishPacket::getPayload
+ (
+ )
+ const
+
+
+
+
+noexcept
+
+
+
+
The payload of the publish message.
+
See MQTT5 Publish Payload
+
Returns The payload of the publish message.
+
+
+
+
+
◆ getPayloadFormatIndicator()
+
+
+
+
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
+
Returns Property specifying the format of the payload data.
+
+
+
+
+
◆ getQOS()
+
+
+
+
+
+
+
+
+ Mqtt5::QOS Aws::Crt::Mqtt5::PublishPacket::getQOS
+ (
+ )
+ const
+
+
+
+
+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
+
Returns The MQTT quality of service associated with this PUBLISH packet.
+
+
+
+
+
◆ getResponseTopic()
+
+
+
+
Opaque topic string intended to assist with request/response implementations. Not internally meaningful to MQTT5 or this client.
+
See MQTT5 Response Topic
+
Returns ByteCursor to topic string intended to assist with request/response implementations.
+
+
+
+
+
◆ getRetain()
+
+
+
+
+
+
+
+
+ bool Aws::Crt::Mqtt5::PublishPacket::getRetain
+ (
+ )
+ const
+
+
+
+
+noexcept
+
+
+
+
True if this is a retained message, false otherwise.
+
Always set on received publishes.
+
See MQTT5 Retain
+
Returns True if this is a retained message, false otherwise.
+
+
+
+
+
◆ getSubscriptionIdentifiers()
+
+
+
+
+
+
+
+
+ const Crt::Vector < uint32_t > & Aws::Crt::Mqtt5::PublishPacket::getSubscriptionIdentifiers
+ (
+ )
+ const
+
+
+
+
+noexcept
+
+
+
+
Sent publishes - ignored
+
Received publishes - the subscription identifiers of all the subscriptions this message matched.
+
See MQTT5 Subscription Identifier
+
Returns the subscription identifiers of all the subscriptions this message matched.
+
+
+
+
+
◆ getTopic()
+
+
+
+
+
+
+
+
+ const Crt::String & Aws::Crt::Mqtt5::PublishPacket::getTopic
+ (
+ )
+ const
+
+
+
+
+noexcept
+
+
+
+
Sent publishes - The topic this message should be published to.
+
Received publishes - The topic this message was published to.
+
See MQTT5 Topic Name
Returns The topic associated with this PUBLISH packet.
+
+
+
+
+
◆ getTopicAlias()
+
+
+
+
+
+
+
+
+ const Crt::Optional < uint16_t > & Aws::Crt::Mqtt5::PublishPacket::getTopicAlias
+ (
+ )
+ const
+
+
+
+
+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.
+
See MQTT5 Topic Alias
+
Returns the topic alias, if any, associated with this PUBLISH packet
+
+
+
+
+
◆ getType()
+
+
+
+
+
+
+
+
+ PacketType Aws::Crt::Mqtt5::PublishPacket::getType
+ (
+ )
+
+
+
+
+
+inline override virtual
+
+
+
+
+
+
◆ getUserProperties()
+
+
+
+
List of MQTT5 user properties included with the packet.
+
See MQTT5 User Property
+
Returns List of MQTT5 user properties included with the packet.
+
+
+
+
+
◆ initializeRawOptions()
+
+
+
+
+
+
+
+
+ bool Aws::Crt::Mqtt5::PublishPacket::initializeRawOptions
+ (
+ aws_mqtt5_packet_publish_view &
+ raw_options )
+
+
+
+
+
+noexcept
+
+
+
+
+
+
+
+
◆ operator=() [1/2]
+
+
+
+
◆ operator=() [2/2]
+
+
+
+
+
+
+
+
+
+delete noexcept
+
+
+
+
+
+
+
+
◆ WithCorrelationData()
+
+
+
+
Sets the opaque binary data used to correlate between publish messages, as a potential method for request-response implementation. Not internally meaningful to MQTT5.
+
See MQTT5 Correlation Data
+
Parameters
+
+ correlationData Opaque binary data used to correlate between publish messages
+
+
+
+
Returns The PublishPacket Object after setting the correlation data.
+
+
+
+
+
◆ WithMessageExpiryIntervalSec()
+
+
+
+
+
+
+
+
+ PublishPacket & Aws::Crt::Mqtt5::PublishPacket::WithMessageExpiryIntervalSec
+ (
+ uint32_t
+ second )
+
+
+
+
+
+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
+
Parameters
+
+ second The maximum amount of time allowed to elapse for message delivery before the server should instead delete the message (relative to a recipient).
+
+
+
+
Returns The PublishPacket Object after setting the message expiry interval.
+
+
+
+
+
◆ WithPayload()
+
+
+
+
Sets the payload for the publish message.
+
See MQTT5 Publish Payload
+
Parameters
+
+ payload The payload for the publish message.
+
+
+
+
Returns The PublishPacket Object after setting the payload.
+
+
+
+
+
◆ WithPayloadFormatIndicator()
+
+
+
+
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
+
Parameters
+
+ payloadFormat Property specifying the format of the payload data
+
+
+
+
Returns The PublishPacket Object after setting the payload format.
+
+
+
+
+
◆ WithQOS()
+
+
+
+
Sets the MQTT quality of service level the message should be delivered with.
+
See MQTT5 QoS
+
Parameters
+
+ packetQOS The MQTT quality of service level the message should be delivered with.
+
+
+
+
Returns The PublishPacket Object after setting the QOS.
+
+
+
+
+
◆ WithResponseTopic()
+
+
+
+
Sets the opaque topic string intended to assist with request/response implementations. Not internally meaningful to MQTT5 or this client.
+
See MQTT5 Response Topic
Parameters
+
+
+
+
Returns The PublishPacket Object after setting the response topic.
+
+
+
+
+
◆ WithRetain()
+
+
+
+
+
+
+
+
+ PublishPacket & Aws::Crt::Mqtt5::PublishPacket::WithRetain
+ (
+ bool
+ retain )
+
+
+
+
+
+noexcept
+
+
+
+
Sets if this should be a retained message.
+
See MQTT5 Retain
+
Parameters
+
+ retain if this is a retained message.
+
+
+
+
Returns The PublishPacket Object after setting the retain setting.
+
+
+
+
+
◆ WithTopic()
+
+
+
+
Sets the topic this message should be published to. See MQTT5 Topic Name
+
Parameters
+
+ topic The topic this message should be published to.
+
+
+
+
Returns The PublishPacket Object after setting the topic.
+
+
+
+
+
◆ WithTopicAlias()
+
+
+
+
+
+
+
+
+ PublishPacket & Aws::Crt::Mqtt5::PublishPacket::WithTopicAlias
+ (
+ uint16_t
+ topicAlias )
+
+
+
+
+
+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.
+
See MQTT5 Topic Alias
+
+
+
+
+
◆ WithUserProperties() [1/2]
+
+
+
+
Sets the list of MQTT5 user properties included with the packet.
+
See MQTT5 User Property
+
Parameters
+
+ userProperties List of MQTT5 user properties included with the packet.
+
+
+
+
Returns The PublishPacket Object after setting the user properties
+
+
+
+
+
◆ WithUserProperties() [2/2]
+
+
+
+
Sets the list of MQTT5 user properties included with the packet.
+
See MQTT5 User Property
+
Parameters
+
+ userProperties List of MQTT5 user properties included with the packet.
+
+
+
+
Returns The PublishPacket Object after setting the user properties
+
+
+
+
+
◆ WithUserProperty()
+
+
+
+
Put a MQTT5 user property to the back of the packet user property vector/list
+
See MQTT5 User Property
+
Parameters
+
+ property set of userProperty of MQTT5 user properties included with the packet.
+
+
+
+
Returns The PublishPacket Object after setting the user property
+
+
+
+
The documentation for this class was generated from the following files:
+
+
+
+
+
diff --git a/docs/class_aws_1_1_crt_1_1_mqtt5_1_1_publish_packet.png b/docs/class_aws_1_1_crt_1_1_mqtt5_1_1_publish_packet.png
new file mode 100644
index 000000000..d46eae449
Binary files /dev/null and b/docs/class_aws_1_1_crt_1_1_mqtt5_1_1_publish_packet.png differ
diff --git a/docs/class_aws_1_1_crt_1_1_mqtt5_1_1_publish_result-members.html b/docs/class_aws_1_1_crt_1_1_mqtt5_1_1_publish_result-members.html
new file mode 100644
index 000000000..1c2b1802b
--- /dev/null
+++ b/docs/class_aws_1_1_crt_1_1_mqtt5_1_1_publish_result-members.html
@@ -0,0 +1,93 @@
+
+
+
+
+
+
+
+aws-crt-cpp: Member List
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ 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.
+
+
+
+
+
diff --git a/docs/class_aws_1_1_crt_1_1_mqtt5_1_1_publish_result.html b/docs/class_aws_1_1_crt_1_1_mqtt5_1_1_publish_result.html
new file mode 100644
index 000000000..bf50e7710
--- /dev/null
+++ b/docs/class_aws_1_1_crt_1_1_mqtt5_1_1_publish_result.html
@@ -0,0 +1,382 @@
+
+
+
+
+
+
+
+aws-crt-cpp: Aws::Crt::Mqtt5::PublishResult Class Reference
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ aws-crt-cpp
+
+ C++ wrapper around the aws-c-* libraries. Provides Cross-Platform Transport Protocols and SSL/TLS implementations for C++.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
#include <Mqtt5Packets.h >
+
+
+
PublishResult returned with onPublishCompletionCallback after Publish get called
+
Publish with QoS0: Ack will be nullptr QoS1: Ack will contains a PubAckPacket
+
+
+
◆ PublishResult() [1/5]
+
+
+
+
+
+ Aws::Crt::Mqtt5::PublishResult::PublishResult
+ (
+ )
+
+
+
+
+
+
+
+
+
◆ PublishResult() [2/5]
+
+
+
+
+
+ Aws::Crt::Mqtt5::PublishResult::PublishResult
+ (
+ std::shared_ptr< PubAckPacket >
+ puback )
+
+
+
+
+
+
+
+
+
◆ PublishResult() [3/5]
+
+
+
+
+
+ Aws::Crt::Mqtt5::PublishResult::PublishResult
+ (
+ int
+ errorCode )
+
+
+
+
+
+
+
+
+
◆ ~PublishResult()
+
+
+
+
+
+
+
+
+ Aws::Crt::Mqtt5::PublishResult::~PublishResult
+ (
+ )
+
+
+
+
+
+noexcept
+
+
+
+
+
+
+
+
◆ PublishResult() [4/5]
+
+
+
+
+
+
+
+
+ Aws::Crt::Mqtt5::PublishResult::PublishResult
+ (
+ const PublishResult &
+ toCopy )
+
+
+
+
+
+delete noexcept
+
+
+
+
+
+
+
+
◆ PublishResult() [5/5]
+
+
+
+
+
+
+
+
+ Aws::Crt::Mqtt5::PublishResult::PublishResult
+ (
+ PublishResult &&
+ toMove )
+
+
+
+
+
+delete noexcept
+
+
+
+
+
+
+
+
+
◆ getAck()
+
+
+
+
+
+
+
+
+ std::shared_ptr<IPacket > Aws::Crt::Mqtt5::PublishResult::getAck
+ (
+ )
+ const
+
+
+
+
+inline
+
+
+
+
Get Publish ack packet
+
Returns std::shared_ptr<IPacket> contains a PubAckPacket if client Publish with QoS1, otherwise nullptr.
+
+
+
+
+
◆ getErrorCode()
+
+
+
+
+
+
+
+
+ int Aws::Crt::Mqtt5::PublishResult::getErrorCode
+ (
+ )
+ const
+
+
+
+
+inline
+
+
+
+
Get the error code value
+
Returns the error code
+
+
+
+
+
◆ operator=() [1/2]
+
+
+
+
+
+
+
+
+
+delete noexcept
+
+
+
+
+
+
+
+
◆ operator=() [2/2]
+
+
+
+
+
+
+
+
+
+delete noexcept
+
+
+
+
+
+
+
+
◆ wasSuccessful()
+
+
+
+
+
+
+
+
+ bool Aws::Crt::Mqtt5::PublishResult::wasSuccessful
+ (
+ )
+ const
+
+
+
+
+inline
+
+
+
+
Get if the publish succeed or not
+
Returns true if error code == 0 and publish succeed
+
+
+
+
The documentation for this class was generated from the following files:
+
+
+
+
+
diff --git a/docs/class_aws_1_1_crt_1_1_mqtt5_1_1_sub_ack_packet-members.html b/docs/class_aws_1_1_crt_1_1_mqtt5_1_1_sub_ack_packet-members.html
new file mode 100644
index 000000000..8826bd3d0
--- /dev/null
+++ b/docs/class_aws_1_1_crt_1_1_mqtt5_1_1_sub_ack_packet-members.html
@@ -0,0 +1,92 @@
+
+
+
+
+
+
+
+aws-crt-cpp: Member List
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ 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.
+
+
+
+
+
diff --git a/docs/class_aws_1_1_crt_1_1_mqtt5_1_1_sub_ack_packet.html b/docs/class_aws_1_1_crt_1_1_mqtt5_1_1_sub_ack_packet.html
new file mode 100644
index 000000000..4d6d86b7d
--- /dev/null
+++ b/docs/class_aws_1_1_crt_1_1_mqtt5_1_1_sub_ack_packet.html
@@ -0,0 +1,401 @@
+
+
+
+
+
+
+
+aws-crt-cpp: Aws::Crt::Mqtt5::SubAckPacket Class Reference
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ 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 SUBACK packet.
+
+
+
◆ SubAckPacket() [1/3]
+
+
+
+
+
+
+
+
+ Aws::Crt::Mqtt5::SubAckPacket::SubAckPacket
+ (
+ const aws_mqtt5_packet_suback_view &
+ packet ,
+
+
+
+
+ Allocator *
+ allocator = ApiAllocator ()
+
+
+
+ )
+
+
+
+
+
+noexcept
+
+
+
+
+
+
+
+
◆ ~SubAckPacket()
+
+
+
+
+
+
+
+
+ virtual Aws::Crt::Mqtt5::SubAckPacket::~SubAckPacket
+ (
+ )
+
+
+
+
+
+inline virtual
+
+
+
+
+
+
+
+
◆ SubAckPacket() [2/3]
+
+
+
+
+
+
+
+
+ Aws::Crt::Mqtt5::SubAckPacket::SubAckPacket
+ (
+ const SubAckPacket &
+ )
+
+
+
+
+
+delete noexcept
+
+
+
+
+
+
+
+
◆ SubAckPacket() [3/3]
+
+
+
+
+
+
+
+
+ Aws::Crt::Mqtt5::SubAckPacket::SubAckPacket
+ (
+ SubAckPacket &&
+ )
+
+
+
+
+
+delete noexcept
+
+
+
+
+
+
+
+
+
◆ getReasonCodes()
+
+
+
+
Returns list of reason codes indicating the result of each individual subscription entry in the associated SUBSCRIBE packet.
+
See MQTT5 Suback Payload
+
Returns list of reason codes indicating the result of each individual subscription entry in the associated SUBSCRIBE packet.
+
+
+
+
+
◆ getReasonString()
+
+
+
+
Returns additional diagnostic information about the result of the SUBSCRIBE attempt.
+
See MQTT5 Reason String
+
Returns Additional diagnostic information about the result of the SUBSCRIBE attempt.
+
+
+
+
+
◆ getType()
+
+
+
+
+
+
+
+
+ PacketType Aws::Crt::Mqtt5::SubAckPacket::getType
+ (
+ )
+
+
+
+
+
+inline override virtual
+
+
+
+
+
+
◆ getUserProperties()
+
+
+
+
Returns list of MQTT5 user properties included with the packet.
+
See MQTT5 User Property
+
Returns List of MQTT5 user properties included with the packet.
+
+
+
+
+
◆ operator=() [1/2]
+
+
+
+
+
+
+
+
+
+delete noexcept
+
+
+
+
+
+
+
+
◆ operator=() [2/2]
+
+
+
+
+
+
+
+
+
+delete noexcept
+
+
+
+
+
+
+
The documentation for this class was generated from the following files:
+
+
+
+
+
diff --git a/docs/class_aws_1_1_crt_1_1_mqtt5_1_1_sub_ack_packet.png b/docs/class_aws_1_1_crt_1_1_mqtt5_1_1_sub_ack_packet.png
new file mode 100644
index 000000000..ffa2c2eaa
Binary files /dev/null and b/docs/class_aws_1_1_crt_1_1_mqtt5_1_1_sub_ack_packet.png differ
diff --git a/docs/class_aws_1_1_crt_1_1_mqtt5_1_1_subscribe_packet-members.html b/docs/class_aws_1_1_crt_1_1_mqtt5_1_1_subscribe_packet-members.html
new file mode 100644
index 000000000..45f43a235
--- /dev/null
+++ b/docs/class_aws_1_1_crt_1_1_mqtt5_1_1_subscribe_packet-members.html
@@ -0,0 +1,97 @@
+
+
+
+
+
+
+
+aws-crt-cpp: Member List
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ 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.
+
+
+
+
+
diff --git a/docs/class_aws_1_1_crt_1_1_mqtt5_1_1_subscribe_packet.html b/docs/class_aws_1_1_crt_1_1_mqtt5_1_1_subscribe_packet.html
new file mode 100644
index 000000000..be8e4a2ea
--- /dev/null
+++ b/docs/class_aws_1_1_crt_1_1_mqtt5_1_1_subscribe_packet.html
@@ -0,0 +1,585 @@
+
+
+
+
+
+
+
+aws-crt-cpp: Aws::Crt::Mqtt5::SubscribePacket Class Reference
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ 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.
+
+
+
◆ SubscribePacket() [1/3]
+
+
+
+
+
+
+
+
+ Aws::Crt::Mqtt5::SubscribePacket::SubscribePacket
+ (
+ Allocator *
+ allocator = ApiAllocator ()
)
+
+
+
+
+
+noexcept
+
+
+
+
+
+
+
+
◆ ~SubscribePacket()
+
+
+
+
+
+
+
+
+ Aws::Crt::Mqtt5::SubscribePacket::~SubscribePacket
+ (
+ )
+
+
+
+
+
+virtual
+
+
+
+
+
+
+
+
◆ SubscribePacket() [2/3]
+
+
+
+
+
+
+
+
+ Aws::Crt::Mqtt5::SubscribePacket::SubscribePacket
+ (
+ const SubscribePacket &
+ )
+
+
+
+
+
+delete noexcept
+
+
+
+
+
+
+
+
◆ SubscribePacket() [3/3]
+
+
+
+
+
+
+
+
+ Aws::Crt::Mqtt5::SubscribePacket::SubscribePacket
+ (
+ SubscribePacket &&
+ )
+
+
+
+
+
+delete noexcept
+
+
+
+
+
+
+
+
+
◆ getType()
+
+
+
+
+
+
+
+
+ PacketType Aws::Crt::Mqtt5::SubscribePacket::getType
+ (
+ )
+
+
+
+
+
+inline override virtual
+
+
+
+
+
+
◆ initializeRawOptions()
+
+
+
+
+
+
+
+
+ bool Aws::Crt::Mqtt5::SubscribePacket::initializeRawOptions
+ (
+ aws_mqtt5_packet_subscribe_view &
+ raw_options )
+
+
+
+
+
+noexcept
+
+
+
+
+
+
+
+
◆ operator=() [1/2]
+
+
+
+
+
+
+
+
+
+delete noexcept
+
+
+
+
+
+
+
+
◆ operator=() [2/2]
+
+
+
+
+
+
+
+
+
+delete noexcept
+
+
+
+
+
+
+
+
◆ WithSubscription()
+
+
+
+
Sets a single subscription within the SUBSCRIBE packet.
+
Parameters
+
+ subscription The subscription to add within the SUBSCRIBE packet.
+
+
+
+
Returns The SubscribePacket Object after setting the subscription.
+
+
+
+
+
◆ WithSubscriptionIdentifier()
+
+
+
+
+
+
+
+
+ SubscribePacket & Aws::Crt::Mqtt5::SubscribePacket::WithSubscriptionIdentifier
+ (
+ uint32_t
+ subscriptionIdentifier )
+
+
+
+
+
+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
+
Parameters
+
+ subscriptionIdentifier A positive long to associate with all subscriptions in this request.
+
+
+
+
Returns The SubscribePacket Object after setting the subscription identifier.
+
+
+
+
+
◆ WithSubscriptions() [1/2]
+
+
+
+
Sets a list of subscriptions within the SUBSCRIBE packet.
+
Parameters
+
+ subscriptions vector of subscriptions to add within the SUBSCRIBE packet.
+
+
+
+
Returns The SubscribePacket Object after setting the subscription.
+
+
+
+
+
◆ WithSubscriptions() [2/2]
+
+
+
+
Sets a list of subscriptions within the SUBSCRIBE packet.
+
Parameters
+
+ subscriptions vector of subscriptions to add within the SUBSCRIBE packet.
+
+
+
+
Returns The SubscribePacket Object after setting the subscription.
+
+
+
+
+
◆ WithUserProperties() [1/2]
+
+
+
+
Sets the list of MQTT5 user properties included with the packet.
+
See MQTT5 User Property
+
Parameters
+
+ userProperties List of MQTT5 user properties included with the packet.
+
+
+
+
Returns the SubscribePacket Object after setting the reason string.
+
+
+
+
+
◆ WithUserProperties() [2/2]
+
+
+
+
Sets the list of MQTT5 user properties included with the packet.
+
See MQTT5 User Property
+
Parameters
+
+ userProperties List of MQTT5 user properties included with the packet.
+
+
+
+
Returns the SubscribePacket Object after setting the reason string.
+
+
+
+
+
◆ WithUserProperty()
+
+
+
+
Put a MQTT5 user property to the back of the packet user property vector/list
+
See MQTT5 User Property
+
Parameters
+
+ property userProperty of MQTT5 user properties included with the packet.
+
+
+
+
Returns The SubscribePacket Object after setting the user property
+
+
+
+
The documentation for this class was generated from the following files:
+
+
+
+
+
diff --git a/docs/class_aws_1_1_crt_1_1_mqtt5_1_1_subscribe_packet.png b/docs/class_aws_1_1_crt_1_1_mqtt5_1_1_subscribe_packet.png
new file mode 100644
index 000000000..be9ff6ad8
Binary files /dev/null and b/docs/class_aws_1_1_crt_1_1_mqtt5_1_1_subscribe_packet.png differ
diff --git a/docs/class_aws_1_1_crt_1_1_mqtt5_1_1_subscription-members.html b/docs/class_aws_1_1_crt_1_1_mqtt5_1_1_subscription-members.html
new file mode 100644
index 000000000..be83f485b
--- /dev/null
+++ b/docs/class_aws_1_1_crt_1_1_mqtt5_1_1_subscription-members.html
@@ -0,0 +1,96 @@
+
+
+
+
+
+
+
+aws-crt-cpp: Member List
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ 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.
+
+
+
+
+
diff --git a/docs/class_aws_1_1_crt_1_1_mqtt5_1_1_subscription.html b/docs/class_aws_1_1_crt_1_1_mqtt5_1_1_subscription.html
new file mode 100644
index 000000000..c4c26d253
--- /dev/null
+++ b/docs/class_aws_1_1_crt_1_1_mqtt5_1_1_subscription.html
@@ -0,0 +1,543 @@
+
+
+
+
+
+
+
+aws-crt-cpp: Aws::Crt::Mqtt5::Subscription Class Reference
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ aws-crt-cpp
+
+ C++ wrapper around the aws-c-* libraries. Provides Cross-Platform Transport Protocols and SSL/TLS implementations for C++.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
#include <Mqtt5Packets.h >
+
+
+
Configures a single subscription within a Subscribe operation
+
See MQTT5 Subscription Options
+
+
+
◆ Subscription() [1/4]
+
+
+
+
◆ Subscription() [2/4]
+
+
+
+
◆ ~Subscription()
+
+
+
+
+
+
+
+
+ virtual Aws::Crt::Mqtt5::Subscription::~Subscription
+ (
+ )
+
+
+
+
+
+inline virtual
+
+
+
+
+
+
+
+
◆ Subscription() [3/4]
+
+
+
+
+
+
+
+
+ Aws::Crt::Mqtt5::Subscription::Subscription
+ (
+ const Subscription &
+ toCopy )
+
+
+
+
+
+noexcept
+
+
+
+
+
+
+
+
◆ Subscription() [4/4]
+
+
+
+
+
+
+
+
+ Aws::Crt::Mqtt5::Subscription::Subscription
+ (
+ Subscription &&
+ toMove )
+
+
+
+
+
+noexcept
+
+
+
+
+
+
+
+
+
◆ initializeRawOptions()
+
+
+
+
+
+
+
+
+ bool Aws::Crt::Mqtt5::Subscription::initializeRawOptions
+ (
+ aws_mqtt5_subscription_view &
+ raw_options )
+ const
+
+
+
+
+noexcept
+
+
+
+
+
+
+
+
◆ operator=() [1/2]
+
+
+
+
◆ operator=() [2/2]
+
+
+
+
◆ WithNoLocal()
+
+
+
+
+
+
+
+
+ Subscription & Aws::Crt::Mqtt5::Subscription::WithNoLocal
+ (
+ bool
+ noLocal )
+
+
+
+
+
+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
+
Parameters
+
+
+
+
Returns The Subscription Object after setting the reason string.
+
+
+
+
+
◆ WithQOS()
+
+
+
+
Sets Maximum QoS on which the subscriber will accept publish messages. Negotiated QoS may be different.
+
See MQTT5 Subscription Options
+
Parameters
+
+
+
+
Returns The Subscription Object after setting the reason string.
+
+
+
+
+
◆ WithRetain()
+
+
+
+
+
+
+
+
+ Subscription & Aws::Crt::Mqtt5::Subscription::WithRetain
+ (
+ bool
+ retain )
+
+
+
+
+
+noexcept
+
+
+
+
+
+
◆ WithRetainAsPublished()
+
+
+
+
+
+
+
+
+ Subscription & Aws::Crt::Mqtt5::Subscription::WithRetainAsPublished
+ (
+ bool
+ retain )
+
+
+
+
+
+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
+
Parameters
+
+
+
+
Returns The Subscription Object after setting the reason string.
+
+
+
+
+
◆ WithRetainHandlingType()
+
+
+
+
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
+
Parameters
+
+
+
+
Returns The Subscription Object after setting the reason string.
+
+
+
+
+
◆ WithTopicFilter()
+
+
+
The documentation for this class was generated from the following files:
+
+
+
+
+
diff --git a/docs/class_aws_1_1_crt_1_1_mqtt5_1_1_un_sub_ack_packet-members.html b/docs/class_aws_1_1_crt_1_1_mqtt5_1_1_un_sub_ack_packet-members.html
new file mode 100644
index 000000000..fbbe85286
--- /dev/null
+++ b/docs/class_aws_1_1_crt_1_1_mqtt5_1_1_un_sub_ack_packet-members.html
@@ -0,0 +1,92 @@
+
+
+
+
+
+
+
+aws-crt-cpp: Member List
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ 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.
+
+
+
+
+
diff --git a/docs/class_aws_1_1_crt_1_1_mqtt5_1_1_un_sub_ack_packet.html b/docs/class_aws_1_1_crt_1_1_mqtt5_1_1_un_sub_ack_packet.html
new file mode 100644
index 000000000..25ecb9abc
--- /dev/null
+++ b/docs/class_aws_1_1_crt_1_1_mqtt5_1_1_un_sub_ack_packet.html
@@ -0,0 +1,401 @@
+
+
+
+
+
+
+
+aws-crt-cpp: Aws::Crt::Mqtt5::UnSubAckPacket Class Reference
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ 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 UNSUBACK packet.
+
+
+
◆ UnSubAckPacket() [1/3]
+
+
+
+
+
+
+
+
+ Aws::Crt::Mqtt5::UnSubAckPacket::UnSubAckPacket
+ (
+ const aws_mqtt5_packet_unsuback_view &
+ packet ,
+
+
+
+
+ Allocator *
+ allocator = ApiAllocator ()
+
+
+
+ )
+
+
+
+
+
+noexcept
+
+
+
+
+
+
+
+
◆ ~UnSubAckPacket()
+
+
+
+
+
+
+
+
+ virtual Aws::Crt::Mqtt5::UnSubAckPacket::~UnSubAckPacket
+ (
+ )
+
+
+
+
+
+inline virtual
+
+
+
+
+
+
+
+
◆ UnSubAckPacket() [2/3]
+
+
+
+
+
+
+
+
+ Aws::Crt::Mqtt5::UnSubAckPacket::UnSubAckPacket
+ (
+ const UnSubAckPacket &
+ )
+
+
+
+
+
+delete noexcept
+
+
+
+
+
+
+
+
◆ UnSubAckPacket() [3/3]
+
+
+
+
+
+
+
+
+ Aws::Crt::Mqtt5::UnSubAckPacket::UnSubAckPacket
+ (
+ UnSubAckPacket &&
+ )
+
+
+
+
+
+delete noexcept
+
+
+
+
+
+
+
+
+
◆ getReasonCodes()
+
+
+
+
Returns a list of reason codes indicating the result of unsubscribing from each individual topic filter entry in the associated UNSUBSCRIBE packet.
+
See MQTT5 Unsuback Payload
+
Returns A list of reason codes indicating the result of unsubscribing from each individual topic filter entry in the associated UNSUBSCRIBE packet.
+
+
+
+
+
◆ getReasonString()
+
+
+
+
Returns additional diagnostic information about the result of the UNSUBSCRIBE attempt.
+
See MQTT5 Reason String
+
Returns Additional diagnostic information about the result of the UNSUBSCRIBE attempt.
+
+
+
+
+
◆ getType()
+
+
+
+
+
+
+
+
+ PacketType Aws::Crt::Mqtt5::UnSubAckPacket::getType
+ (
+ )
+
+
+
+
+
+inline override virtual
+
+
+
+
+
+
◆ getUserProperties()
+
+
+
+
Returns list of MQTT5 user properties included with the packet.
+
See MQTT5 User Property
+
Returns List of MQTT5 user properties included with the packet.
+
+
+
+
+
◆ operator=() [1/2]
+
+
+
+
+
+
+
+
+
+delete noexcept
+
+
+
+
+
+
+
+
◆ operator=() [2/2]
+
+
+
+
+
+
+
+
+
+delete noexcept
+
+
+
+
+
+
+
The documentation for this class was generated from the following files:
+
+
+
+
+
diff --git a/docs/class_aws_1_1_crt_1_1_mqtt5_1_1_un_sub_ack_packet.png b/docs/class_aws_1_1_crt_1_1_mqtt5_1_1_un_sub_ack_packet.png
new file mode 100644
index 000000000..a5b72793e
Binary files /dev/null and b/docs/class_aws_1_1_crt_1_1_mqtt5_1_1_un_sub_ack_packet.png differ
diff --git a/docs/class_aws_1_1_crt_1_1_mqtt5_1_1_unsubscribe_packet-members.html b/docs/class_aws_1_1_crt_1_1_mqtt5_1_1_unsubscribe_packet-members.html
new file mode 100644
index 000000000..25f0c1745
--- /dev/null
+++ b/docs/class_aws_1_1_crt_1_1_mqtt5_1_1_unsubscribe_packet-members.html
@@ -0,0 +1,95 @@
+
+
+
+
+
+
+
+aws-crt-cpp: Member List
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ 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.
+
+
+
+
+
diff --git a/docs/class_aws_1_1_crt_1_1_mqtt5_1_1_unsubscribe_packet.html b/docs/class_aws_1_1_crt_1_1_mqtt5_1_1_unsubscribe_packet.html
new file mode 100644
index 000000000..6c4de614c
--- /dev/null
+++ b/docs/class_aws_1_1_crt_1_1_mqtt5_1_1_unsubscribe_packet.html
@@ -0,0 +1,512 @@
+
+
+
+
+
+
+
+aws-crt-cpp: Aws::Crt::Mqtt5::UnsubscribePacket Class Reference
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ 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 UNSUBSCRIBE packet.
+
+
+
◆ UnsubscribePacket() [1/3]
+
+
+
+
+
+
+
+
+ Aws::Crt::Mqtt5::UnsubscribePacket::UnsubscribePacket
+ (
+ Allocator *
+ allocator = ApiAllocator ()
)
+
+
+
+
+
+noexcept
+
+
+
+
+
+
+
+
◆ ~UnsubscribePacket()
+
+
+
+
+
+
+
+
+ Aws::Crt::Mqtt5::UnsubscribePacket::~UnsubscribePacket
+ (
+ )
+
+
+
+
+
+virtual
+
+
+
+
+
+
+
+
◆ UnsubscribePacket() [2/3]
+
+
+
+
+
+
+
+
+ Aws::Crt::Mqtt5::UnsubscribePacket::UnsubscribePacket
+ (
+ const UnsubscribePacket &
+ )
+
+
+
+
+
+delete noexcept
+
+
+
+
+
+
+
+
◆ UnsubscribePacket() [3/3]
+
+
+
+
+
+
+
+
+ Aws::Crt::Mqtt5::UnsubscribePacket::UnsubscribePacket
+ (
+ UnsubscribePacket &&
+ )
+
+
+
+
+
+delete noexcept
+
+
+
+
+
+
+
+
+
◆ getType()
+
+
+
+
+
+
+
+
+ PacketType Aws::Crt::Mqtt5::UnsubscribePacket::getType
+ (
+ )
+
+
+
+
+
+inline override virtual
+
+
+
+
+
+
◆ initializeRawOptions()
+
+
+
+
+
+
+
+
+ bool Aws::Crt::Mqtt5::UnsubscribePacket::initializeRawOptions
+ (
+ aws_mqtt5_packet_unsubscribe_view &
+ raw_options )
+
+
+
+
+
+noexcept
+
+
+
+
+
+
+
+
◆ operator=() [1/2]
+
+
+
+
+
+
+
+
+
+delete noexcept
+
+
+
+
+
+
+
+
◆ operator=() [2/2]
+
+
+
+
+
+
+
+
+
+delete noexcept
+
+
+
+
+
+
+
+
◆ WithTopicFilter()
+
+
+
+
Push back a topic filter that the client wishes to unsubscribe from.
+
Parameters
+
+ topicFilter that the client wishes to unsubscribe from
+
+
+
+
Returns The UnsubscribePacket Object after setting the subscription.
+
+
+
+
+
◆ WithTopicFilters()
+
+
+
+
Sets list of topic filter that the client wishes to unsubscribe from.
+
Parameters
+
+ topicFilters vector of subscription topic filters that the client wishes to unsubscribe from
+
+
+
+
Returns The UnsubscribePacket Object after setting the subscription.
+
+
+
+
+
◆ WithUserProperties() [1/2]
+
+
+
+
Sets the list of MQTT5 user properties included with the packet.
+
See MQTT5 User Property
+
Parameters
+
+ userProperties List of MQTT5 user properties included with the packet.
+
+
+
+
Returns The UnsubscribePacketBuilder after setting the user properties.
+
+
+
+
+
◆ WithUserProperties() [2/2]
+
+
+
+
Sets the list of MQTT5 user properties included with the packet.
+
See MQTT5 User Property
+
Parameters
+
+ userProperties List of MQTT5 user properties included with the packet.
+
+
+
+
Returns The UnsubscribePacketBuilder after setting the user properties.
+
+
+
+
+
◆ WithUserProperty()
+
+
+
+
Put a MQTT5 user property to the back of the packet user property vector/list
+
See MQTT5 User Property
+
Parameters
+
+ property set of userProperty of MQTT5 user properties included with the packet.
+
+
+
+
Returns The PublishPacket Object after setting the user property
+
+
+
+
The documentation for this class was generated from the following files:
+
+
+
+
+
diff --git a/docs/class_aws_1_1_crt_1_1_mqtt5_1_1_unsubscribe_packet.png b/docs/class_aws_1_1_crt_1_1_mqtt5_1_1_unsubscribe_packet.png
new file mode 100644
index 000000000..0c276448a
Binary files /dev/null and b/docs/class_aws_1_1_crt_1_1_mqtt5_1_1_unsubscribe_packet.png differ
diff --git a/docs/class_aws_1_1_crt_1_1_mqtt5_1_1_user_property-members.html b/docs/class_aws_1_1_crt_1_1_mqtt5_1_1_user_property-members.html
new file mode 100644
index 000000000..6d43a6471
--- /dev/null
+++ b/docs/class_aws_1_1_crt_1_1_mqtt5_1_1_user_property-members.html
@@ -0,0 +1,90 @@
+
+
+
+
+
+
+
+aws-crt-cpp: Member List
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ 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.
+
+
+
+
+
diff --git a/docs/class_aws_1_1_crt_1_1_mqtt5_1_1_user_property.html b/docs/class_aws_1_1_crt_1_1_mqtt5_1_1_user_property.html
new file mode 100644
index 000000000..14bcad3ee
--- /dev/null
+++ b/docs/class_aws_1_1_crt_1_1_mqtt5_1_1_user_property.html
@@ -0,0 +1,328 @@
+
+
+
+
+
+
+
+aws-crt-cpp: Aws::Crt::Mqtt5::UserProperty Class Reference
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ 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 for MQTT5 user properties.
+
A user property is a name-value pair of utf-8 strings that can be added to mqtt5 packets.
+
+
+
◆ UserProperty() [1/3]
+
+
+
+
+
+
+
+
+ Aws::Crt::Mqtt5::UserProperty::UserProperty
+ (
+ Crt::String
+ key ,
+
+
+
+
+ Crt::String
+ value
+
+
+
+ )
+
+
+
+
+
+noexcept
+
+
+
+
+
+
+
+
◆ ~UserProperty()
+
+
+
+
+
+
+
+
+ Aws::Crt::Mqtt5::UserProperty::~UserProperty
+ (
+ )
+
+
+
+
+
+noexcept
+
+
+
+
+
+
+
+
◆ UserProperty() [2/3]
+
+
+
+
+
+
+
+
+ Aws::Crt::Mqtt5::UserProperty::UserProperty
+ (
+ const UserProperty &
+ toCopy )
+
+
+
+
+
+noexcept
+
+
+
+
+
+
+
+
◆ UserProperty() [3/3]
+
+
+
+
+
+
+
+
+ Aws::Crt::Mqtt5::UserProperty::UserProperty
+ (
+ UserProperty &&
+ toMove )
+
+
+
+
+
+noexcept
+
+
+
+
+
+
+
+
+
◆ getName()
+
+
+
+
+
+
+
+
+ const Crt::String & Aws::Crt::Mqtt5::UserProperty::getName
+ (
+ )
+ const
+
+
+
+
+inline noexcept
+
+
+
+
+
+
+
+
◆ getValue()
+
+
+
+
+
+
+
+
+ const Crt::String & Aws::Crt::Mqtt5::UserProperty::getValue
+ (
+ )
+ const
+
+
+
+
+inline noexcept
+
+
+
+
+
+
+
+
◆ operator=() [1/2]
+
+
+
+
◆ operator=() [2/2]
+
+
+
The documentation for this class was generated from the following files:
+
+
+
+
+
diff --git a/docs/class_aws_1_1_crt_1_1_mqtt_1_1_mqtt_client-members.html b/docs/class_aws_1_1_crt_1_1_mqtt_1_1_mqtt_client-members.html
new file mode 100644
index 000000000..64436ebf6
--- /dev/null
+++ b/docs/class_aws_1_1_crt_1_1_mqtt_1_1_mqtt_client-members.html
@@ -0,0 +1,93 @@
+
+
+
+
+
+
+
+aws-crt-cpp: Member List
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ 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.
+
+
+
+
+
diff --git a/docs/class_aws_1_1_crt_1_1_mqtt_1_1_mqtt_client.html b/docs/class_aws_1_1_crt_1_1_mqtt_1_1_mqtt_client.html
new file mode 100644
index 000000000..956fbabb8
--- /dev/null
+++ b/docs/class_aws_1_1_crt_1_1_mqtt_1_1_mqtt_client.html
@@ -0,0 +1,480 @@
+
+
+
+
+
+
+
+aws-crt-cpp: Aws::Crt::Mqtt::MqttClient Class Reference
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ aws-crt-cpp
+
+ C++ wrapper around the aws-c-* libraries. Provides Cross-Platform Transport Protocols and SSL/TLS implementations for C++.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
#include <MqttClient.h >
+
+
+
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.
+
+
+
◆ MqttClient() [1/4]
+
+
+
+
Initialize an MqttClient using bootstrap and allocator
+
+
+
+
+
◆ MqttClient() [2/4]
+
+
+
+
◆ ~MqttClient()
+
+
+
+
+
+ Aws::Crt::Mqtt::MqttClient::~MqttClient
+ (
+ )
+
+
+
+
+
+
+
+
+
◆ MqttClient() [3/4]
+
+
+
+
+
+
+
+
+ Aws::Crt::Mqtt::MqttClient::MqttClient
+ (
+ const MqttClient &
+ )
+
+
+
+
+
+delete
+
+
+
+
+
+
+
+
◆ MqttClient() [4/4]
+
+
+
+
+
+
+
+
+ Aws::Crt::Mqtt::MqttClient::MqttClient
+ (
+ MqttClient &&
+ toMove )
+
+
+
+
+
+noexcept
+
+
+
+
+
+
+
+
+
◆ LastError()
+
+
+
+
+
+
+
+
+ int Aws::Crt::Mqtt::MqttClient::LastError
+ (
+ )
+ const
+
+
+
+
+noexcept
+
+
+
+
Returns the value of the last aws error encountered by operations on this instance.
+
+
+
+
+
◆ NewConnection() [1/2]
+
+
+
+
+
+
+
+
+ std::shared_ptr< MqttConnection > Aws::Crt::Mqtt::MqttClient::NewConnection
+ (
+ const char *
+ hostName ,
+
+
+
+
+ uint32_t
+ port ,
+
+
+
+
+ const Io::SocketOptions &
+ socketOptions ,
+
+
+
+
+ bool
+ useWebsocket = false
+
+
+
+ )
+
+
+
+
+
+noexcept
+
+
+
+
Create a new connection object over plain text from the client. The client must outlive all of its connection instances.
Parameters
+
+ 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?
+
+
+
+
Returns a new connection object. Connect() will still need to be called after all further configuration is finished.
+
+
+
+
+
◆ NewConnection() [2/2]
+
+
+
+
+
+
+
+
+ std::shared_ptr< MqttConnection > Aws::Crt::Mqtt::MqttClient::NewConnection
+ (
+ const char *
+ hostName ,
+
+
+
+
+ uint32_t
+ port ,
+
+
+
+
+ const Io::SocketOptions &
+ socketOptions ,
+
+
+
+
+ const Crt::Io::TlsContext &
+ tlsContext ,
+
+
+
+
+ bool
+ useWebsocket = false
+
+
+
+ )
+
+
+
+
+
+noexcept
+
+
+
+
Create a new connection object using TLS from the client. The client must outlive all of its connection instances.
+
Parameters
+
+ 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?
+
+
+
+
Returns a new connection object. Connect() will still need to be called after all further configuration is finished.
+
+
+
+
+
◆ operator bool()
+
+
+
+
+
+
+
+
+ Aws::Crt::Mqtt::MqttClient::operator bool
+ (
+ )
+ const
+
+
+
+
+noexcept
+
+
+
+
Returns true if the instance is in a valid state, false otherwise.
+
+
+
+
+
◆ operator=() [1/2]
+
+
+
+
◆ operator=() [2/2]
+
+
+
The documentation for this class was generated from the following files:
+
+
+
+
+
diff --git a/docs/class_aws_1_1_crt_1_1_mqtt_1_1_mqtt_connection-members.html b/docs/class_aws_1_1_crt_1_1_mqtt_1_1_mqtt_connection-members.html
new file mode 100644
index 000000000..b92ba09a2
--- /dev/null
+++ b/docs/class_aws_1_1_crt_1_1_mqtt_1_1_mqtt_connection-members.html
@@ -0,0 +1,116 @@
+
+
+
+
+
+
+
+aws-crt-cpp: Member List
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ 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) noexceptAws::Crt::Mqtt::MqttConnection
+ Disconnect () noexceptAws::Crt::Mqtt::MqttConnection
+ GetOperationStatistics () noexceptAws::Crt::Mqtt::MqttConnection
+ LastError () const noexceptAws::Crt::Mqtt::MqttConnection
+ Mqtt5::Mqtt5ClientCore classAws::Crt::Mqtt::MqttConnection friend
+ MqttClient classAws::Crt::Mqtt::MqttConnection friend
+ MqttConnection (const MqttConnection &)=deleteAws::Crt::Mqtt::MqttConnection
+ MqttConnection (MqttConnection &&)=deleteAws::Crt::Mqtt::MqttConnection
+ NewConnectionFromMqtt5Client (std::shared_ptr< Mqtt5::Mqtt5Client > mqtt5client) noexceptAws::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 noexceptAws::Crt::Mqtt::MqttConnection
+ operator= (const MqttConnection &)=deleteAws::Crt::Mqtt::MqttConnection
+ operator= (MqttConnection &&)=deleteAws::Crt::Mqtt::MqttConnection
+ Publish (const char *topic, QOS qos, bool retain, const ByteBuf &payload, OnOperationCompleteHandler &&onOpComplete) noexceptAws::Crt::Mqtt::MqttConnection
+ SetHttpProxyOptions (const Http::HttpClientConnectionProxyOptions &proxyOptions) noexceptAws::Crt::Mqtt::MqttConnection
+ SetLogin (const char *username, const char *password) noexceptAws::Crt::Mqtt::MqttConnection
+ SetOnMessageHandler (OnMessageReceivedHandler &&onMessage) noexceptAws::Crt::Mqtt::MqttConnection
+ SetOnMessageHandler (OnPublishReceivedHandler &&onPublish) noexceptAws::Crt::Mqtt::MqttConnection
+ SetReconnectTimeout (uint64_t min_seconds, uint64_t max_seconds) noexceptAws::Crt::Mqtt::MqttConnection
+ SetWebsocketProxyOptions (const Http::HttpClientConnectionProxyOptions &proxyOptions) noexceptAws::Crt::Mqtt::MqttConnection
+ SetWill (const char *topic, QOS qos, bool retain, const ByteBuf &payload) noexceptAws::Crt::Mqtt::MqttConnection
+ Subscribe (const char *topicFilter, QOS qos, OnMessageReceivedHandler &&onMessage, OnSubAckHandler &&onSubAck) noexceptAws::Crt::Mqtt::MqttConnection
+ Subscribe (const char *topicFilter, QOS qos, OnPublishReceivedHandler &&onPublish, OnSubAckHandler &&onSubAck) noexceptAws::Crt::Mqtt::MqttConnection
+ Subscribe (const Vector< std::pair< const char *, OnMessageReceivedHandler >> &topicFilters, QOS qos, OnMultiSubAckHandler &&onOpComplete) noexceptAws::Crt::Mqtt::MqttConnection
+ Subscribe (const Vector< std::pair< const char *, OnPublishReceivedHandler >> &topicFilters, QOS qos, OnMultiSubAckHandler &&onOpComplete) noexceptAws::Crt::Mqtt::MqttConnection
+ Unsubscribe (const char *topicFilter, OnOperationCompleteHandler &&onOpComplete) noexceptAws::Crt::Mqtt::MqttConnection
+ WebsocketInterceptor Aws::Crt::Mqtt::MqttConnection
+ ~MqttConnection ()Aws::Crt::Mqtt::MqttConnection
+
+
+
+
+
diff --git a/docs/class_aws_1_1_crt_1_1_mqtt_1_1_mqtt_connection.html b/docs/class_aws_1_1_crt_1_1_mqtt_1_1_mqtt_connection.html
new file mode 100644
index 000000000..a0df4f0b0
--- /dev/null
+++ b/docs/class_aws_1_1_crt_1_1_mqtt_1_1_mqtt_connection.html
@@ -0,0 +1,1266 @@
+
+
+
+
+
+
+
+aws-crt-cpp: Aws::Crt::Mqtt::MqttConnection Class Reference
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ aws-crt-cpp
+
+ C++ wrapper around the aws-c-* libraries. Provides Cross-Platform Transport Protocols and SSL/TLS implementations for C++.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
#include <MqttConnection.h >
+
+
+
+
+
+
+
+ ~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
+
+
+
+
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.
+
See also MqttClient::NewConnection
+
+Mqtt5Client::NewConnection
+
+
+
◆ ~MqttConnection()
+
+
+
+
+
+ Aws::Crt::Mqtt::MqttConnection::~MqttConnection
+ (
+ )
+
+
+
+
+
+
+
+
+
◆ MqttConnection() [1/2]
+
+
+
+
+
+
+
+
+ Aws::Crt::Mqtt::MqttConnection::MqttConnection
+ (
+ const MqttConnection &
+ )
+
+
+
+
+
+delete
+
+
+
+
+
+
+
+
◆ MqttConnection() [2/2]
+
+
+
+
+
+
+
+
+ Aws::Crt::Mqtt::MqttConnection::MqttConnection
+ (
+ MqttConnection &&
+ )
+
+
+
+
+
+delete
+
+
+
+
+
+
+
+
+
◆ Connect()
+
+
+
+
+
+
+
+
+ bool Aws::Crt::Mqtt::MqttConnection::Connect
+ (
+ const char *
+ clientId ,
+
+
+
+
+ bool
+ cleanSession ,
+
+
+
+
+ uint16_t
+ keepAliveTimeSecs = 0
,
+
+
+
+
+ uint32_t
+ pingTimeoutMs = 0
,
+
+
+
+
+ uint32_t
+ protocolOperationTimeoutMs = 0
+
+
+
+ )
+
+
+
+
+
+noexcept
+
+
+
+
Initiates the connection, OnConnectionCompleted will be invoked in an event-loop thread.
+
Parameters
+
+ 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.
+
+
+
+
Returns true if the connection attempt was successfully started (implying a callback will be invoked with the eventual result), false if it could not be started (no callback will happen)
+
+
+
+
+
◆ Disconnect()
+
+
+
+
+
+
+
+
+ bool Aws::Crt::Mqtt::MqttConnection::Disconnect
+ (
+ )
+
+
+
+
+
+noexcept
+
+
+
+
Initiates disconnect, OnDisconnectHandler will be invoked in an event-loop thread.
Returns success/failure in initiating disconnect
+
+
+
+
+
◆ GetOperationStatistics()
+
+
+
+
◆ LastError()
+
+
+
+
+
+
+
+
+ int Aws::Crt::Mqtt::MqttConnection::LastError
+ (
+ )
+ const
+
+
+
+
+noexcept
+
+
+
+
Returns the value of the last aws error encountered by operations on this instance.
+
+
+
+
+
◆ NewConnectionFromMqtt5Client()
+
+
+
+
+
+
+
+
+ std::shared_ptr< MqttConnection > Aws::Crt::Mqtt::MqttConnection::NewConnectionFromMqtt5Client
+ (
+ std::shared_ptr< Mqtt5::Mqtt5Client >
+ mqtt5client )
+
+
+
+
+
+static noexcept
+
+
+
+
Create a new MqttConnection object from the Mqtt5Client.
Parameters
+
+ mqtt5client The shared ptr of Mqtt5Client
+
+
+
+
Returns std::shared_ptr<Crt::Mqtt::MqttConnection>
+
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.
+
+
+
+
+
◆ operator bool()
+
+
+
+
+
+
+
+
+ Aws::Crt::Mqtt::MqttConnection::operator bool
+ (
+ )
+ const
+
+
+
+
+noexcept
+
+
+
+
Returns true if the instance is in a valid state, false otherwise.
+
+
+
+
+
◆ operator=() [1/2]
+
+
+
+
◆ operator=() [2/2]
+
+
+
+
◆ Publish()
+
+
+
+
+
+
+
+
+ uint16_t Aws::Crt::Mqtt::MqttConnection::Publish
+ (
+ const char *
+ topic ,
+
+
+
+
+ QOS
+ qos ,
+
+
+
+
+ bool
+ retain ,
+
+
+
+
+ const ByteBuf &
+ payload ,
+
+
+
+
+ OnOperationCompleteHandler &&
+ onOpComplete
+
+
+
+ )
+
+
+
+
+
+noexcept
+
+
+
+
Publishes to a topic.
+
Parameters
+
+ 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.
+
+
+
+
Returns packet id of the publish request, or 0 if the attempt failed synchronously
+
+
+
+
+
◆ SetHttpProxyOptions()
+
+
+
+
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
+
Parameters
+
+ proxyOptions proxy configuration for making the mqtt connection
+
+
+
+
Returns success/failure
+
+
+
+
+
◆ SetLogin()
+
+
+
+
+
+
+
+
+ bool Aws::Crt::Mqtt::MqttConnection::SetLogin
+ (
+ const char *
+ username ,
+
+
+
+
+ const char *
+ password
+
+
+
+ )
+
+
+
+
+
+noexcept
+
+
+
+
Sets login credentials for the connection. The must get set before the Connect call if it is to be used.
Parameters
+
+ username user name to add to the MQTT CONNECT packet
+ password password to add to the MQTT CONNECT packet
+
+
+
+
Returns success/failure
+
+
+
+
+
◆ SetOnMessageHandler() [1/2]
+
+
+
+
Installs a handler for all incoming publish messages, regardless of if Subscribe has been called on the topic.
+
Parameters
+
+ onMessage callback to invoke for all received messages
+
+
+
+
Returns success/failure
+
+
+
+
+
◆ SetOnMessageHandler() [2/2]
+
+
+
+
◆ SetReconnectTimeout()
+
+
+
+
+
+
+
+
+ bool Aws::Crt::Mqtt::MqttConnection::SetReconnectTimeout
+ (
+ uint64_t
+ min_seconds ,
+
+
+
+
+ uint64_t
+ max_seconds
+
+
+
+ )
+
+
+
+
+
+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() .
+
Parameters
+
+ min_seconds minimum time to wait before attempting a reconnect
+ max_seconds maximum time to wait before attempting a reconnect
+
+
+
+
Returns success/failure
+
+
+
+
+
◆ SetWebsocketProxyOptions()
+
+
+
+
Deprecated: Sets websocket proxy options. Replaced by SetHttpProxyOptions.
+
+
+
+
+
◆ SetWill()
+
+
+
+
+
+
+
+
+ bool Aws::Crt::Mqtt::MqttConnection::SetWill
+ (
+ const char *
+ topic ,
+
+
+
+
+ QOS
+ qos ,
+
+
+
+
+ bool
+ retain ,
+
+
+
+
+ const ByteBuf &
+ payload
+
+
+
+ )
+
+
+
+
+
+noexcept
+
+
+
+
Sets LastWill for the connection.
Parameters
+
+ 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
+
+
+
+
Returns success/failure in setting the will
+
+
+
+
+
◆ Subscribe() [1/4]
+
+
+
+
+
+
+
+
+ uint16_t Aws::Crt::Mqtt::MqttConnection::Subscribe
+ (
+ const char *
+ topicFilter ,
+
+
+
+
+ QOS
+ qos ,
+
+
+
+
+ OnMessageReceivedHandler &&
+ onMessage ,
+
+
+
+
+ OnSubAckHandler &&
+ onSubAck
+
+
+
+ )
+
+
+
+
+
+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.
+
Parameters
+
+ 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
+
+
+
+
Returns packet id of the subscribe request, or 0 if the attempt failed synchronously
+
+
+
+
+
◆ Subscribe() [2/4]
+
+
+
+
+
+
+
+
+ uint16_t Aws::Crt::Mqtt::MqttConnection::Subscribe
+ (
+ const char *
+ topicFilter ,
+
+
+
+
+ QOS
+ qos ,
+
+
+
+
+ OnPublishReceivedHandler &&
+ onPublish ,
+
+
+
+
+ OnSubAckHandler &&
+ onSubAck
+
+
+
+ )
+
+
+
+
+
+noexcept
+
+
+
+
+
+
◆ Subscribe() [3/4]
+
+
+
+
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.
+
Parameters
+
+ 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
+
+
+
+
Returns packet id of the subscribe request, or 0 if the attempt failed synchronously
+
+
+
+
+
◆ Subscribe() [4/4]
+
+
+
+
◆ Unsubscribe()
+
+
+
+
+
+
+
+
+ uint16_t Aws::Crt::Mqtt::MqttConnection::Unsubscribe
+ (
+ const char *
+ topicFilter ,
+
+
+
+
+ OnOperationCompleteHandler &&
+ onOpComplete
+
+
+
+ )
+
+
+
+
+
+noexcept
+
+
+
+
Unsubscribes from topicFilter. OnOperationCompleteHandler will be invoked upon receipt of an unsuback message.
+
Parameters
+
+ topicFilter topic filter to unsubscribe the session from
+ onOpComplete callback to invoke on receipt of the server's UNSUBACK message
+
+
+
+
Returns packet id of the unsubscribe request, or 0 if the attempt failed synchronously
+
+
+
+
+
+
◆ Mqtt5::Mqtt5ClientCore
+
+
+
+
+
+
+
+
+ friend class Mqtt5::Mqtt5ClientCore
+
+
+
+
+friend
+
+
+
+
+
+
+
+
◆ MqttClient
+
+
+
+
+
◆ OnConnectionClosed
+
+
+
+
Invoked when a connection is disconnected and shutdown successfully.
+
Note Currently callbackData will always be nullptr, but this may change in the future to send additional data.
+
+From the user perspective, this callback is indistinguishable from OnDisconnect.
+
+
+
+
+
◆ OnConnectionCompleted
+
+
+
+
Invoked when a connack message is received, or an error occurred.
+
+
+
+
+
◆ OnConnectionFailure
+
+
+
+
Invoked whenever the connection fails to connect.
+
This callback is invoked for every failed connect and every failed reconnect.
+
+
+
+
+
◆ OnConnectionInterrupted
+
+
+
+
A callback invoked every time the connections is interrupted.
+
+
+
+
+
◆ OnConnectionResumed
+
+
+
+
A callback invoked every time the connection is resumed.
+
+
+
+
+
◆ OnConnectionSuccess
+
+
+
+
Invoked whenever the connection successfully connects.
+
This callback is invoked for every successful connect and every successful reconnect.
+
+
+
+
+
◆ OnDisconnect
+
+
+
+
A callback invoked on disconnect.
+
+
+
+
+
◆ 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.
+
+
+
+
The documentation for this class was generated from the following files:
+
+
+
+
+
diff --git a/docs/class_aws_1_1_crt_1_1_mqtt_1_1_mqtt_connection.png b/docs/class_aws_1_1_crt_1_1_mqtt_1_1_mqtt_connection.png
new file mode 100644
index 000000000..36e8264ce
Binary files /dev/null and b/docs/class_aws_1_1_crt_1_1_mqtt_1_1_mqtt_connection.png differ
diff --git a/docs/class_aws_1_1_crt_1_1_optional-members.html b/docs/class_aws_1_1_crt_1_1_optional-members.html
new file mode 100644
index 000000000..81de16cae
--- /dev/null
+++ b/docs/class_aws_1_1_crt_1_1_optional-members.html
@@ -0,0 +1,107 @@
+
+
+
+
+
+
+
+aws-crt-cpp: Member List
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ 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.
+
+
+
+
+
diff --git a/docs/class_aws_1_1_crt_1_1_optional.html b/docs/class_aws_1_1_crt_1_1_optional.html
new file mode 100644
index 000000000..d0497e411
--- /dev/null
+++ b/docs/class_aws_1_1_crt_1_1_optional.html
@@ -0,0 +1,863 @@
+
+
+
+
+
+
+
+aws-crt-cpp: Aws::Crt::Optional< T > Class Template Reference
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ aws-crt-cpp
+
+ C++ wrapper around the aws-c-* libraries. Provides Cross-Platform Transport Protocols and SSL/TLS implementations for C++.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
#include <Optional.h >
+
+
+
template<typename T>
+class Aws::Crt::Optional< T >
+
+
Custom implementation of an Option type. std::optional requires C++17
Template Parameters
+
+ T type of the optional value
+
+
+
+
+
+
◆ Optional() [1/6]
+
+
+
+
+template<typename T >
+
+
+
+
+
+
+
◆ Optional() [2/6]
+
+
+
+
+template<typename T >
+
+
+
+
+
+
+
◆ Optional() [3/6]
+
+
+
+
+template<typename T >
+
+
+
+
+
+
+
◆ ~Optional()
+
+
+
+
+template<typename T >
+
+
+
+
+
+
+
◆ Optional() [4/6]
+
+
+
+
+template<typename T >
+
+
+
+
+
+
+
◆ Optional() [5/6]
+
+
+
+
+template<typename T >
+
+
+
+
+
+
+
◆ Optional() [6/6]
+
+
+
+
+template<typename T >
+
+template<typename... Args>
+
+
+
+
+
+
+inline explicit
+
+
+
+
+
+
+
+
+
◆ emplace()
+
+
+
+
+template<typename T >
+
+template<typename... Args>
+
+
+
+
+
+
+
◆ has_value()
+
+
+
+
+template<typename T >
+
+
+
+
+
+
+inline noexcept
+
+
+
+
+
+
+
+
◆ operator bool()
+
+
+
+
+template<typename T >
+
+
+
+
+
+
+inline explicit noexcept
+
+
+
+
+
+
+
+
◆ operator*() [1/4]
+
+
+
+
+template<typename T >
+
+
+
+
+
+
+
◆ operator*() [2/4]
+
+
+
+
+template<typename T >
+
+
+
+
+
+
+
◆ operator*() [3/4]
+
+
+
+
+template<typename T >
+
+
+
+
+
+
+
◆ operator*() [4/4]
+
+
+
+
+template<typename T >
+
+
+
+
+
+
+
◆ operator->() [1/2]
+
+
+
+
+template<typename T >
+
+
+
+
+
+
+
◆ operator->() [2/2]
+
+
+
+
+template<typename T >
+
+
+
+
+
+
+
◆ operator=() [1/4]
+
+
+
+
+template<typename T >
+
+
+
+
+
+
+
◆ operator=() [2/4]
+
+
+
+
+template<typename T >
+
+template<typename U = T>
+
+
+
+
+
+
+
◆ operator=() [3/4]
+
+
+
+
+template<typename T >
+
+template<typename U = T>
+
+
+
+
+
+
+
◆ operator=() [4/4]
+
+
+
+
+template<typename T >
+
+template<typename U = T>
+
+
+
+
+
+
+
◆ reset()
+
+
+
+
+template<typename T >
+
+
+
+
+
+
+
◆ value() [1/4]
+
+
+
+
+template<typename T >
+
+
+
+
+
+
+
◆ value() [2/4]
+
+
+
+
+template<typename T >
+
+
+
+
+
+
+
◆ value() [3/4]
+
+
+
+
+template<typename T >
+
+
+
+
+
+
+
◆ value() [4/4]
+
+
+
+
+template<typename T >
+
+
+
+
+
+
The documentation for this class was generated from the following file:
+
+
+
+
+
diff --git a/docs/class_aws_1_1_crt_1_1_ref_counted-members.html b/docs/class_aws_1_1_crt_1_1_ref_counted-members.html
new file mode 100644
index 000000000..e732f7512
--- /dev/null
+++ b/docs/class_aws_1_1_crt_1_1_ref_counted-members.html
@@ -0,0 +1,86 @@
+
+
+
+
+
+
+
+aws-crt-cpp: Member List
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ 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.
+
+
+
+
+
diff --git a/docs/class_aws_1_1_crt_1_1_ref_counted.html b/docs/class_aws_1_1_crt_1_1_ref_counted.html
new file mode 100644
index 000000000..9278d6992
--- /dev/null
+++ b/docs/class_aws_1_1_crt_1_1_ref_counted.html
@@ -0,0 +1,216 @@
+
+
+
+
+
+
+
+aws-crt-cpp: Aws::Crt::RefCounted< T > Class Template Reference
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ aws-crt-cpp
+
+ C++ wrapper around the aws-c-* libraries. Provides Cross-Platform Transport Protocols and SSL/TLS implementations for C++.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
#include <RefCounted.h >
+
+
+
template<class T>
+class Aws::Crt::RefCounted< T >
+
+
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.
+
+
+
◆ RefCounted()
+
+
+
+
+template<class T >
+
+
+
+
+
+
+inline protected
+
+
+
+
+
+
+
+
◆ ~RefCounted()
+
+
+
+
+template<class T >
+
+
+
+
+
+
+inline protected
+
+
+
+
+
+
+
+
+
◆ AcquireRef()
+
+
+
+
+template<class T >
+
+
+
+
+
+
+inline protected
+
+
+
+
+
+
+
+
◆ ReleaseRef()
+
+
+
+
+template<class T >
+
+
+
+
+
+
+inline protected
+
+
+
+
+
+
+
The documentation for this class was generated from the following file:
+
+
+
+
+
diff --git a/docs/class_aws_1_1_crt_1_1_stl_allocator-members.html b/docs/class_aws_1_1_crt_1_1_stl_allocator-members.html
new file mode 100644
index 000000000..fb9d7dc33
--- /dev/null
+++ b/docs/class_aws_1_1_crt_1_1_stl_allocator-members.html
@@ -0,0 +1,93 @@
+
+
+
+
+
+
+
+aws-crt-cpp: Member List
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ 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.
+
+
+
+
+
diff --git a/docs/class_aws_1_1_crt_1_1_stl_allocator.html b/docs/class_aws_1_1_crt_1_1_stl_allocator.html
new file mode 100644
index 000000000..cd60b6e4e
--- /dev/null
+++ b/docs/class_aws_1_1_crt_1_1_stl_allocator.html
@@ -0,0 +1,428 @@
+
+
+
+
+
+
+
+aws-crt-cpp: Aws::Crt::StlAllocator< T > Class Template Reference
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ aws-crt-cpp
+
+ C++ wrapper around the aws-c-* libraries. Provides Cross-Platform Transport Protocols and SSL/TLS implementations for C++.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
#include <StlAllocator.h >
+
+
+
+
+
+
+
+using Base = std::allocator< T >
+
+using size_type = std::size_t
+
+using RawPointer = typename std::allocator_traits< std::allocator< T > >::pointer
+
+
+
+
template<typename T>
+class Aws::Crt::StlAllocator< T >
+
+
Stateful allocator variant that uses an underlying CRT allocator
Template Parameters
+
+ T type that allocator can allocate
+
+
+
+
+
+
◆ Base
+
+
+
+
+template<typename T >
+
+
+
+
+
+
+
◆ RawPointer
+
+
+
+
+template<typename T >
+
+
+
+
+
+
+
◆ size_type
+
+
+
+
+template<typename T >
+
+
+
+
+
+
+
+
◆ StlAllocator() [1/4]
+
+
+
+
+template<typename T >
+
+
+
+
+
+
+inline noexcept
+
+
+
+
+
+
+
+
◆ StlAllocator() [2/4]
+
+
+
+
+template<typename T >
+
+
+
+
+
+
+inline noexcept
+
+
+
+
+
+
+
+
◆ StlAllocator() [3/4]
+
+
+
+
+template<typename T >
+
+
+
+
+
+
+inline noexcept
+
+
+
+
+
+
+
+
◆ StlAllocator() [4/4]
+
+
+
+
+template<typename T >
+
+template<class U >
+
+
+
+
+
+
+inline noexcept
+
+
+
+
+
+
+
+
◆ ~StlAllocator()
+
+
+
+
+template<typename T >
+
+
+
+
+
+
+
+
◆ allocate()
+
+
+
+
+template<typename T >
+
+
+
+
+
+
+
◆ deallocate()
+
+
+
+
+template<typename T >
+
+
+
+
+
+
+
+
◆ m_allocator
+
+
+
+
+template<typename T >
+
+
+
+
+
+
The documentation for this class was generated from the following file:
+
+
+
+
+
diff --git a/docs/class_aws_1_1_crt_1_1_stl_allocator.png b/docs/class_aws_1_1_crt_1_1_stl_allocator.png
new file mode 100644
index 000000000..683cbec08
Binary files /dev/null and b/docs/class_aws_1_1_crt_1_1_stl_allocator.png differ
diff --git a/docs/class_aws_1_1_crt_1_1_u_u_i_d-members.html b/docs/class_aws_1_1_crt_1_1_u_u_i_d-members.html
new file mode 100644
index 000000000..a412e5829
--- /dev/null
+++ b/docs/class_aws_1_1_crt_1_1_u_u_i_d-members.html
@@ -0,0 +1,92 @@
+
+
+
+
+
+
+
+aws-crt-cpp: Member List
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ 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.
+
+
+
+
+
diff --git a/docs/class_aws_1_1_crt_1_1_u_u_i_d.html b/docs/class_aws_1_1_crt_1_1_u_u_i_d.html
new file mode 100644
index 000000000..32006af65
--- /dev/null
+++ b/docs/class_aws_1_1_crt_1_1_u_u_i_d.html
@@ -0,0 +1,354 @@
+
+
+
+
+
+
+
+aws-crt-cpp: Aws::Crt::UUID Class Reference
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ aws-crt-cpp
+
+ C++ wrapper around the aws-c-* libraries. Provides Cross-Platform Transport Protocols and SSL/TLS implementations for C++.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
#include <UUID.h >
+
+
+
Utility class for creating UUIDs and serializing them to a string
+
+
+
◆ UUID() [1/2]
+
+
+
+
+
+
+
+
+ Aws::Crt::UUID::UUID
+ (
+ )
+
+
+
+
+
+noexcept
+
+
+
+
+
+
+
+
◆ UUID() [2/2]
+
+
+
+
+
+
+
+
+ Aws::Crt::UUID::UUID
+ (
+ const String &
+ str )
+
+
+
+
+
+noexcept
+
+
+
+
+
+
+
+
+
◆ GetLastError()
+
+
+
+
+
+
+
+
+ int Aws::Crt::UUID::GetLastError
+ (
+ )
+ const
+
+
+
+
+noexcept
+
+
+
+
+
+
+
+
◆ operator bool()
+
+
+
+
+
+
+
+
+ Aws::Crt::UUID::operator bool
+ (
+ )
+ const
+
+
+
+
+inline noexcept
+
+
+
+
+
+
+
+
◆ operator ByteBuf()
+
+
+
+
+
+
+
+
+ Aws::Crt::UUID::operator ByteBuf
+ (
+ )
+ const
+
+
+
+
+noexcept
+
+
+
+
+
+
+
+
◆ operator String()
+
+
+
+
+
+ Aws::Crt::UUID::operator String
+ (
+ )
+ const
+
+
+
+
+
+
+
+
◆ operator!=()
+
+
+
+
+
+
+
+
+ bool Aws::Crt::UUID::operator!=
+ (
+ const UUID &
+ other )
+
+
+
+
+
+noexcept
+
+
+
+
+
+
+
+
◆ operator=()
+
+
+
+
+
+
+
+
+ UUID & Aws::Crt::UUID::operator=
+ (
+ const String &
+ str )
+
+
+
+
+
+noexcept
+
+
+
+
+
+
+
+
◆ operator==()
+
+
+
+
+
+
+
+
+ bool Aws::Crt::UUID::operator==
+ (
+ const UUID &
+ other )
+
+
+
+
+
+noexcept
+
+
+
+
+
+
+
+
◆ ToString()
+
+
+
+
+
+ String Aws::Crt::UUID::ToString
+ (
+ )
+ const
+
+
+
+
+
+
+
The documentation for this class was generated from the following files:
+
+
+
+
+
diff --git a/docs/class_aws_1_1_crt_1_1_variant-members.html b/docs/class_aws_1_1_crt_1_1_variant-members.html
new file mode 100644
index 000000000..2bf9a97ab
--- /dev/null
+++ b/docs/class_aws_1_1_crt_1_1_variant-members.html
@@ -0,0 +1,108 @@
+
+
+
+
+
+
+
+aws-crt-cpp: Member List
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ 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::Variant< Ts > , including all inherited members.
+
+
+
+
+
diff --git a/docs/class_aws_1_1_crt_1_1_variant.html b/docs/class_aws_1_1_crt_1_1_variant.html
new file mode 100644
index 000000000..15445def1
--- /dev/null
+++ b/docs/class_aws_1_1_crt_1_1_variant.html
@@ -0,0 +1,908 @@
+
+
+
+
+
+
+
+aws-crt-cpp: Aws::Crt::Variant< Ts > Class Template Reference
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ aws-crt-cpp
+
+ C++ wrapper around the aws-c-* libraries. Provides Cross-Platform Transport Protocols and SSL/TLS implementations for C++.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
#include <Variant.h >
+
+
+ Variant ()
+
+ Variant (const Variant &other)
+
+ Variant (Variant &&other)
+
+template<typename T , EnableIfOtherIsThisVariantAlternative< T > = 1>
+ Variant (const T &val)
+
+template<typename T , EnableIfOtherIsThisVariantAlternative< T > = 1>
+ Variant (T &&val)
+
+template<typename T , typename... Args>
+ Variant (Aws::Crt::InPlaceTypeT < T >, Args &&...args)
+
+Variant & operator= (const Variant &other)
+
+Variant & operator= (Variant &&other)
+
+template<typename T , typename... Args, EnableIfOtherIsThisVariantAlternative< T > = 1>
+T & emplace (Args &&...args)
+
+template<std::size_t Index, typename... Args>
+auto emplace (Args &&...args) -> typename ThisVariantAlternative < Index >::type &
+
+template<typename T , EnableIfOtherIsThisVariantAlternative< T > = 1>
+bool holds_alternative () const
+
+template<typename T , EnableIfOtherIsThisVariantAlternative< T > = 1>
+T & get ()
+
+template<typename T , EnableIfOtherIsThisVariantAlternative< T > = 1>
+T * get_if ()
+
+template<std::size_t Index>
+auto get () -> typename ThisVariantAlternative < Index >::type &
+
+template<typename T , EnableIfOtherIsThisVariantAlternative< T > = 1>
+const T & get () const
+
+template<typename T , EnableIfOtherIsThisVariantAlternative< T > = 1>
+const T * get_if () const
+
+template<std::size_t Index>
+auto get () const -> const typename ThisVariantAlternative < Index >::type &
+
+template<std::size_t Index>
+auto get_if () -> RawAlternativePointerT < Index >
+
+template<std::size_t Index>
+auto get_if () const -> ConstRawAlternativePointerT < Index >
+
+std::size_t index () const
+
+ ~Variant ()
+
+template<typename VisitorT >
+void Visit (VisitorT &&visitor)
+
+
+
+
template<typename... Ts>
+class Aws::Crt::Variant< Ts >
+
+
Custom implementation of a Variant type. std::variant requires C++17
Template Parameters
+
+ Ts types of the variant value
+
+
+
+
+
+
◆ ConstRawAlternativePointerT
+
+
+
+
+template<typename... Ts>
+
+template<std::size_t Index>
+
+
+
+
+
+
+
◆ IndexT
+
+
+
+
+template<typename... Ts>
+
+
+
+
+
+
+
◆ RawAlternativePointerT
+
+
+
+
+template<typename... Ts>
+
+template<std::size_t Index>
+
+
+
+
+
+
+
+
◆ Variant() [1/6]
+
+
+
+
+template<typename... Ts>
+
+
+
+
+
+
+
◆ Variant() [2/6]
+
+
+
+
+template<typename... Ts>
+
+
+
+
+
+
+
◆ Variant() [3/6]
+
+
+
+
+template<typename... Ts>
+
+
+
+
+
+
+
◆ Variant() [4/6]
+
+
+
+
+template<typename... Ts>
+
+template<typename T , EnableIfOtherIsThisVariantAlternative< T > = 1>
+
+
+
+
+
+
+
◆ Variant() [5/6]
+
+
+
+
+template<typename... Ts>
+
+template<typename T , EnableIfOtherIsThisVariantAlternative< T > = 1>
+
+
+
+
+
+
+
◆ Variant() [6/6]
+
+
+
+
+template<typename... Ts>
+
+template<typename T , typename... Args>
+
+
+
+
+
+
+inline explicit
+
+
+
+
+
+
+
+
◆ ~Variant()
+
+
+
+
+template<typename... Ts>
+
+
+
+
+
+
+
+
◆ emplace() [1/2]
+
+
+
+
+template<typename... Ts>
+
+template<typename T , typename... Args, EnableIfOtherIsThisVariantAlternative< T > = 1>
+
+
+
+
+
+
+
◆ emplace() [2/2]
+
+
+
+
+template<typename... Ts>
+
+template<std::size_t Index, typename... Args>
+
+
+
+
+
+
+
◆ get() [1/4]
+
+
+
+
+template<typename... Ts>
+
+template<typename T , EnableIfOtherIsThisVariantAlternative< T > = 1>
+
+
+
+
+
+
+
◆ get() [2/4]
+
+
+
+
+template<typename... Ts>
+
+template<std::size_t Index>
+
+
+
+
+
+
+
◆ get() [3/4]
+
+
+
+
+template<typename... Ts>
+
+template<typename T , EnableIfOtherIsThisVariantAlternative< T > = 1>
+
+
+
+
+
+
+
◆ get() [4/4]
+
+
+
+
+template<typename... Ts>
+
+template<std::size_t Index>
+
+
+
+
+
+
+
◆ get_if() [1/4]
+
+
+
+
+template<typename... Ts>
+
+template<typename T , EnableIfOtherIsThisVariantAlternative< T > = 1>
+
+
+
+
+
+
+
◆ get_if() [2/4]
+
+
+
+
+template<typename... Ts>
+
+template<std::size_t Index>
+
+
+
+
+
+
+
◆ get_if() [3/4]
+
+
+
+
+template<typename... Ts>
+
+template<typename T , EnableIfOtherIsThisVariantAlternative< T > = 1>
+
+
+
+
+
+
+
◆ get_if() [4/4]
+
+
+
+
+template<typename... Ts>
+
+template<std::size_t Index>
+
+
+
+
+
+
+
◆ holds_alternative()
+
+
+
+
+template<typename... Ts>
+
+template<typename T , EnableIfOtherIsThisVariantAlternative< T > = 1>
+
+
+
+
+
+
+
◆ index()
+
+
+
+
+template<typename... Ts>
+
+
+
+
+
+
+
◆ operator=() [1/2]
+
+
+
+
+template<typename... Ts>
+
+
+
+
+
+
+
◆ operator=() [2/2]
+
+
+
+
+template<typename... Ts>
+
+
+
+
+
+
+
◆ Visit()
+
+
+
+
+template<typename... Ts>
+
+template<typename VisitorT >
+
+
+
+
+
+
+
+
◆ AlternativeCount
+
+
+
+
+template<typename... Ts>
+
+
+
+
+
+ constexpr std::size_t Aws::Crt::Variant < Ts >::AlternativeCount = sizeof...(Ts)
+
+
+
+
+static constexpr
+
+
+
+
+
+
+
The documentation for this class was generated from the following file:
+
+
+
+
+
diff --git a/docs/class_aws_1_1_crt_1_1_variant_alternative-members.html b/docs/class_aws_1_1_crt_1_1_variant_alternative-members.html
new file mode 100644
index 000000000..15ee82a59
--- /dev/null
+++ b/docs/class_aws_1_1_crt_1_1_variant_alternative-members.html
@@ -0,0 +1,85 @@
+
+
+
+
+
+
+
+aws-crt-cpp: Member List
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ 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::VariantAlternative< Index, Ts > , including all inherited members.
+
+
+
+
+
diff --git a/docs/class_aws_1_1_crt_1_1_variant_alternative.html b/docs/class_aws_1_1_crt_1_1_variant_alternative.html
new file mode 100644
index 000000000..2cf063682
--- /dev/null
+++ b/docs/class_aws_1_1_crt_1_1_variant_alternative.html
@@ -0,0 +1,175 @@
+
+
+
+
+
+
+
+aws-crt-cpp: Aws::Crt::VariantAlternative< Index, Ts > Class Template Reference
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ aws-crt-cpp
+
+ C++ wrapper around the aws-c-* libraries. Provides Cross-Platform Transport Protocols and SSL/TLS implementations for C++.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
#include <Variant.h >
+
+
+using type = typename std::tuple_element< Index, std::tuple< Ts... > >::type
+
+
+
+
+
◆ type
+
+
+
+
+template<std::size_t Index, typename... Ts>
+
+
+
+
+
+
+
+
◆ VariantAlternative() [1/2]
+
+
+
+
+template<std::size_t Index, typename... Ts>
+
+
+
+
+
+
+
◆ VariantAlternative() [2/2]
+
+
+
+
+template<std::size_t Index, typename... Ts>
+
+
+
+
+
+
The documentation for this class was generated from the following file:
+
+
+
+
+
diff --git a/docs/class_aws_1_1_crt_1_1_variant_size-members.html b/docs/class_aws_1_1_crt_1_1_variant_size-members.html
new file mode 100644
index 000000000..af45c3936
--- /dev/null
+++ b/docs/class_aws_1_1_crt_1_1_variant_size-members.html
@@ -0,0 +1,81 @@
+
+
+
+
+
+
+
+aws-crt-cpp: Member List
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ 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::VariantSize< T > , including all inherited members.
+
+
+
+
+
diff --git a/docs/class_aws_1_1_crt_1_1_variant_size.html b/docs/class_aws_1_1_crt_1_1_variant_size.html
new file mode 100644
index 000000000..b2d80b727
--- /dev/null
+++ b/docs/class_aws_1_1_crt_1_1_variant_size.html
@@ -0,0 +1,86 @@
+
+
+
+
+
+
+
+aws-crt-cpp: Aws::Crt::VariantSize< T > Class Template Reference
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ aws-crt-cpp
+
+ C++ wrapper around the aws-c-* libraries. Provides Cross-Platform Transport Protocols and SSL/TLS implementations for C++.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
#include <Variant.h >
+
The documentation for this class was generated from the following file:
+
+
+
+
+
diff --git a/docs/class_aws_1_1_crt_1_1basic__string__view-members.html b/docs/class_aws_1_1_crt_1_1basic__string__view-members.html
new file mode 100644
index 000000000..6642bdade
--- /dev/null
+++ b/docs/class_aws_1_1_crt_1_1basic__string__view-members.html
@@ -0,0 +1,158 @@
+
+
+
+
+
+
+
+aws-crt-cpp: Member List
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ 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.
+
+ at (size_type pos) constAws::Crt::basic_string_view< CharT, Traits > inline
+ back () const noexceptAws::Crt::basic_string_view< CharT, Traits > inline
+ basic_string_view () noexceptAws::Crt::basic_string_view< CharT, Traits > inline
+ basic_string_view (const basic_string_view &) noexcept=defaultAws::Crt::basic_string_view< CharT, Traits >
+ basic_string_view (const CharT *s) noexceptAws::Crt::basic_string_view< CharT, Traits > inline
+ basic_string_view (const CharT *s, size_type count) noexceptAws::Crt::basic_string_view< CharT, Traits > inline
+ begin () const noexceptAws::Crt::basic_string_view< CharT, Traits > inline
+ cbegin () const noexceptAws::Crt::basic_string_view< CharT, Traits > inline
+ cend () const noexceptAws::Crt::basic_string_view< CharT, Traits > inline
+ compare (const basic_string_view &s) const noexceptAws::Crt::basic_string_view< CharT, Traits > inline
+ compare (size_type pos1, size_type n1, const basic_string_view &s) constAws::Crt::basic_string_view< CharT, Traits > inline
+ compare (size_type pos1, size_type n1, const basic_string_view &s, size_type pos2, size_type n2) constAws::Crt::basic_string_view< CharT, Traits > inline
+ compare (const CharT *s) const noexceptAws::Crt::basic_string_view< CharT, Traits > inline
+ compare (size_type pos1, size_type n1, const CharT *s) constAws::Crt::basic_string_view< CharT, Traits > inline
+ compare (size_type pos1, size_type n1, const CharT *s, size_type n2) const noexcept(false)Aws::Crt::basic_string_view< CharT, Traits > inline
+ const_iterator typedefAws::Crt::basic_string_view< CharT, Traits >
+ const_pointer typedefAws::Crt::basic_string_view< CharT, Traits >
+ const_reference typedefAws::Crt::basic_string_view< CharT, Traits >
+ const_reverse_iterator typedefAws::Crt::basic_string_view< CharT, Traits >
+ copy (CharT *s, size_type n, size_type pos=0) constAws::Crt::basic_string_view< CharT, Traits > inline
+ crbegin () const noexceptAws::Crt::basic_string_view< CharT, Traits > inline
+ crend () const noexceptAws::Crt::basic_string_view< CharT, Traits > inline
+ data () const noexceptAws::Crt::basic_string_view< CharT, Traits > inline
+ difference_type typedefAws::Crt::basic_string_view< CharT, Traits >
+ empty () const noexceptAws::Crt::basic_string_view< CharT, Traits > inline
+ end () const noexceptAws::Crt::basic_string_view< CharT, Traits > inline
+ ends_with (const basic_string_view &other) const noexceptAws::Crt::basic_string_view< CharT, Traits > inline
+ ends_with (CharT c) const noexceptAws::Crt::basic_string_view< CharT, Traits > inline
+ ends_with (const CharT *s) const noexceptAws::Crt::basic_string_view< CharT, Traits > inline
+ find (const basic_string_view &s, size_type pos=0) const noexceptAws::Crt::basic_string_view< CharT, Traits > inline
+ find (CharT c, size_type pos=0) const noexceptAws::Crt::basic_string_view< CharT, Traits > inline
+ find (const CharT *s, size_type pos, size_type n) const noexceptAws::Crt::basic_string_view< CharT, Traits > inline
+ find (const CharT *s, size_type pos=0) const noexceptAws::Crt::basic_string_view< CharT, Traits > inline
+ find_first_not_of (basic_string_view s, size_type pos=0) const noexceptAws::Crt::basic_string_view< CharT, Traits > inline
+ find_first_not_of (CharT c, size_type pos=0) const noexceptAws::Crt::basic_string_view< CharT, Traits > inline
+ find_first_not_of (const CharT *s, size_type pos, size_type n) const noexceptAws::Crt::basic_string_view< CharT, Traits > inline
+ find_first_not_of (const CharT *s, size_type pos=0) const noexceptAws::Crt::basic_string_view< CharT, Traits > inline
+ find_first_of (basic_string_view s, size_type pos=0) const noexceptAws::Crt::basic_string_view< CharT, Traits > inline
+ find_first_of (CharT c, size_type pos=0) const noexceptAws::Crt::basic_string_view< CharT, Traits > inline
+ find_first_of (const CharT *s, size_type pos, size_type n) const noexceptAws::Crt::basic_string_view< CharT, Traits > inline
+ find_first_of (const CharT *s, size_type pos=0) const noexceptAws::Crt::basic_string_view< CharT, Traits > inline
+ find_last_not_of (basic_string_view s, size_type pos=npos) const noexceptAws::Crt::basic_string_view< CharT, Traits > inline
+ find_last_not_of (CharT c, size_type pos=npos) const noexceptAws::Crt::basic_string_view< CharT, Traits > inline
+ find_last_not_of (const CharT *s, size_type pos, size_type n) const noexceptAws::Crt::basic_string_view< CharT, Traits > inline
+ find_last_not_of (const CharT *s, size_type pos=npos) const noexceptAws::Crt::basic_string_view< CharT, Traits > inline
+ find_last_of (basic_string_view s, size_type pos=npos) const noexceptAws::Crt::basic_string_view< CharT, Traits > inline
+ find_last_of (CharT c, size_type pos=npos) const noexceptAws::Crt::basic_string_view< CharT, Traits > inline
+ find_last_of (const CharT *s, size_type pos, size_type n) const noexceptAws::Crt::basic_string_view< CharT, Traits > inline
+ find_last_of (const CharT *s, size_type pos=npos) const noexceptAws::Crt::basic_string_view< CharT, Traits > inline
+ front () const noexceptAws::Crt::basic_string_view< CharT, Traits > inline
+ iterator typedefAws::Crt::basic_string_view< CharT, Traits >
+ length () const noexceptAws::Crt::basic_string_view< CharT, Traits > inline
+ max_size () const noexceptAws::Crt::basic_string_view< CharT, Traits > inline
+ npos Aws::Crt::basic_string_view< CharT, Traits > static
+ operator= (const basic_string_view &) noexcept=defaultAws::Crt::basic_string_view< CharT, Traits >
+ operator[] (size_type pos) const noexceptAws::Crt::basic_string_view< CharT, Traits > inline
+ pointer typedefAws::Crt::basic_string_view< CharT, Traits >
+ rbegin () const noexceptAws::Crt::basic_string_view< CharT, Traits > inline
+ reference typedefAws::Crt::basic_string_view< CharT, Traits >
+ remove_prefix (size_type n) noexceptAws::Crt::basic_string_view< CharT, Traits > inline
+ remove_suffix (size_type n) noexceptAws::Crt::basic_string_view< CharT, Traits > inline
+ rend () const noexceptAws::Crt::basic_string_view< CharT, Traits > inline
+ reverse_iterator typedefAws::Crt::basic_string_view< CharT, Traits >
+ rfind (basic_string_view s, size_type pos=npos) const noexceptAws::Crt::basic_string_view< CharT, Traits > inline
+ rfind (CharT c, size_type pos=npos) const noexceptAws::Crt::basic_string_view< CharT, Traits > inline
+ rfind (const CharT *s, size_type pos, size_type n) const noexceptAws::Crt::basic_string_view< CharT, Traits > inline
+ rfind (const CharT *s, size_type pos=npos) const noexceptAws::Crt::basic_string_view< CharT, Traits > inline
+ size () const noexceptAws::Crt::basic_string_view< CharT, Traits > inline
+ size_type typedefAws::Crt::basic_string_view< CharT, Traits >
+ starts_with (const basic_string_view &other) const noexceptAws::Crt::basic_string_view< CharT, Traits > inline
+ starts_with (CharT c) const noexceptAws::Crt::basic_string_view< CharT, Traits > inline
+ starts_with (const CharT *s) const noexceptAws::Crt::basic_string_view< CharT, Traits > inline
+ substr (size_type pos=0, size_type n=npos) const noexcept(false)Aws::Crt::basic_string_view< CharT, Traits > inline
+ swap (basic_string_view &other) noexceptAws::Crt::basic_string_view< CharT, Traits > inline
+ traits_type typedefAws::Crt::basic_string_view< CharT, Traits >
+ value_type typedefAws::Crt::basic_string_view< CharT, Traits >
+
+
+
+
+
diff --git a/docs/class_aws_1_1_crt_1_1basic__string__view.html b/docs/class_aws_1_1_crt_1_1basic__string__view.html
new file mode 100644
index 000000000..8d909709f
--- /dev/null
+++ b/docs/class_aws_1_1_crt_1_1basic__string__view.html
@@ -0,0 +1,2624 @@
+
+
+
+
+
+
+
+aws-crt-cpp: Aws::Crt::basic_string_view< CharT, Traits > Class Template Reference
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ aws-crt-cpp
+
+ C++ wrapper around the aws-c-* libraries. Provides Cross-Platform Transport Protocols and SSL/TLS implementations for C++.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
#include <StringView.h >
+
+
+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
+
+
+
+
template<typename CharT, typename Traits = std::char_traits<CharT>>
+class Aws::Crt::basic_string_view< CharT, Traits >
+
+
Custom string view implementation in order to meet C++11 baseline
Template Parameters
+
+
+
+
+
+
◆ const_iterator
+
+
+
+
+template<typename CharT , typename Traits = std::char_traits<CharT>>
+
+
+
+
+
+
+
◆ const_pointer
+
+
+
+
+template<typename CharT , typename Traits = std::char_traits<CharT>>
+
+
+
+
+
+
+
◆ const_reference
+
+
+
+
+template<typename CharT , typename Traits = std::char_traits<CharT>>
+
+
+
+
+
+
+
◆ const_reverse_iterator
+
+
+
+
+template<typename CharT , typename Traits = std::char_traits<CharT>>
+
+
+
+
+
+
+
◆ difference_type
+
+
+
+
+template<typename CharT , typename Traits = std::char_traits<CharT>>
+
+
+
+
+
+
+
◆ iterator
+
+
+
+
+template<typename CharT , typename Traits = std::char_traits<CharT>>
+
+
+
+
+
+
+
◆ pointer
+
+
+
+
+template<typename CharT , typename Traits = std::char_traits<CharT>>
+
+
+
+
+
+
+
◆ reference
+
+
+
+
+template<typename CharT , typename Traits = std::char_traits<CharT>>
+
+
+
+
+
+
+
◆ reverse_iterator
+
+
+
+
+template<typename CharT , typename Traits = std::char_traits<CharT>>
+
+
+
+
+
+
+
◆ size_type
+
+
+
+
+template<typename CharT , typename Traits = std::char_traits<CharT>>
+
+
+
+
+
+
+
◆ traits_type
+
+
+
+
+template<typename CharT , typename Traits = std::char_traits<CharT>>
+
+
+
+
+
+
+
◆ value_type
+
+
+
+
+template<typename CharT , typename Traits = std::char_traits<CharT>>
+
+
+
+
+
+
+
+
◆ basic_string_view() [1/4]
+
+
+
+
+template<typename CharT , typename Traits = std::char_traits<CharT>>
+
+
+
+
+
+
+inline constexpr noexcept
+
+
+
+
+
+
+
+
◆ basic_string_view() [2/4]
+
+
+
+
+template<typename CharT , typename Traits = std::char_traits<CharT>>
+
+
+
+
+
+
+constexpr default noexcept
+
+
+
+
+
+
+
+
◆ basic_string_view() [3/4]
+
+
+
+
+template<typename CharT , typename Traits = std::char_traits<CharT>>
+
+
+
+
+
+
+inline constexpr noexcept
+
+
+
+
+
+
+
+
◆ basic_string_view() [4/4]
+
+
+
+
+template<typename CharT , typename Traits = std::char_traits<CharT>>
+
+
+
+
+
+
+inline constexpr noexcept
+
+
+
+
+
+
+
+
+
◆ at()
+
+
+
+
+template<typename CharT , typename Traits = std::char_traits<CharT>>
+
+
+
+
+
+
+
◆ back()
+
+
+
+
+template<typename CharT , typename Traits = std::char_traits<CharT>>
+
+
+
+
+
+
+inline noexcept
+
+
+
+
+
+
+
+
◆ begin()
+
+
+
+
+template<typename CharT , typename Traits = std::char_traits<CharT>>
+
+
+
+
+
+
+inline constexpr noexcept
+
+
+
+
+
+
+
+
◆ cbegin()
+
+
+
+
+template<typename CharT , typename Traits = std::char_traits<CharT>>
+
+
+
+
+
+
+inline constexpr noexcept
+
+
+
+
+
+
+
+
◆ cend()
+
+
+
+
+template<typename CharT , typename Traits = std::char_traits<CharT>>
+
+
+
+
+
+
+inline constexpr noexcept
+
+
+
+
+
+
+
+
◆ compare() [1/6]
+
+
+
+
+template<typename CharT , typename Traits = std::char_traits<CharT>>
+
+
+
+
+
+
+inline noexcept
+
+
+
+
+
+
+
+
◆ compare() [2/6]
+
+
+
+
+template<typename CharT , typename Traits = std::char_traits<CharT>>
+
+
+
+
+
+
+inline constexpr noexcept
+
+
+
+
+
+
+
+
◆ compare() [3/6]
+
+
+
+
+template<typename CharT , typename Traits = std::char_traits<CharT>>
+
+
+
+
+
+
+inline constexpr
+
+
+
+
+
+
+
+
◆ compare() [4/6]
+
+
+
+
+template<typename CharT , typename Traits = std::char_traits<CharT>>
+
+
+
+
+
+
+inline constexpr
+
+
+
+
+
+
+
+
◆ compare() [5/6]
+
+
+
+
+template<typename CharT , typename Traits = std::char_traits<CharT>>
+
+
+
+
+
+
+inline constexpr
+
+
+
+
+
+
+
+
◆ compare() [6/6]
+
+
+
+
+template<typename CharT , typename Traits = std::char_traits<CharT>>
+
+
+
+
+
+
+inline constexpr noexcept
+
+
+
+
+
+
+
+
◆ copy()
+
+
+
+
+template<typename CharT , typename Traits = std::char_traits<CharT>>
+
+
+
+
+
+
+
◆ crbegin()
+
+
+
+
+template<typename CharT , typename Traits = std::char_traits<CharT>>
+
+
+
+
+
+
+inline constexpr noexcept
+
+
+
+
+
+
+
+
◆ crend()
+
+
+
+
+template<typename CharT , typename Traits = std::char_traits<CharT>>
+
+
+
+
+
+
+inline constexpr noexcept
+
+
+
+
+
+
+
+
◆ data()
+
+
+
+
+template<typename CharT , typename Traits = std::char_traits<CharT>>
+
+
+
+
+
+
+inline constexpr noexcept
+
+
+
+
+
+
+
+
◆ empty()
+
+
+
+
+template<typename CharT , typename Traits = std::char_traits<CharT>>
+
+
+
+
+
+
+inline constexpr noexcept
+
+
+
+
+
+
+
+
◆ end()
+
+
+
+
+template<typename CharT , typename Traits = std::char_traits<CharT>>
+
+
+
+
+
+
+inline constexpr noexcept
+
+
+
+
+
+
+
+
◆ ends_with() [1/3]
+
+
+
+
+template<typename CharT , typename Traits = std::char_traits<CharT>>
+
+
+
+
+
+
+inline constexpr noexcept
+
+
+
+
+
+
+
+
◆ ends_with() [2/3]
+
+
+
+
+template<typename CharT , typename Traits = std::char_traits<CharT>>
+
+
+
+
+
+
+inline constexpr noexcept
+
+
+
+
+
+
+
+
◆ ends_with() [3/3]
+
+
+
+
+template<typename CharT , typename Traits = std::char_traits<CharT>>
+
+
+
+
+
+
+inline constexpr noexcept
+
+
+
+
+
+
+
+
◆ find() [1/4]
+
+
+
+
+template<typename CharT , typename Traits = std::char_traits<CharT>>
+
+
+
+
+
+
+inline noexcept
+
+
+
+
+
+
+
+
◆ find() [2/4]
+
+
+
+
+template<typename CharT , typename Traits = std::char_traits<CharT>>
+
+
+
+
+
+
+inline constexpr noexcept
+
+
+
+
+
+
+
+
◆ find() [3/4]
+
+
+
+
+template<typename CharT , typename Traits = std::char_traits<CharT>>
+
+
+
+
+
+
+inline noexcept
+
+
+
+
+
+
+
+
◆ find() [4/4]
+
+
+
+
+template<typename CharT , typename Traits = std::char_traits<CharT>>
+
+
+
+
+
+
+inline constexpr noexcept
+
+
+
+
+
+
+
+
◆ find_first_not_of() [1/4]
+
+
+
+
+template<typename CharT , typename Traits = std::char_traits<CharT>>
+
+
+
+
+
+
+inline noexcept
+
+
+
+
+
+
+
+
◆ find_first_not_of() [2/4]
+
+
+
+
+template<typename CharT , typename Traits = std::char_traits<CharT>>
+
+
+
+
+
+
+inline noexcept
+
+
+
+
+
+
+
+
◆ find_first_not_of() [3/4]
+
+
+
+
+template<typename CharT , typename Traits = std::char_traits<CharT>>
+
+
+
+
+
+
+inline noexcept
+
+
+
+
+
+
+
+
◆ find_first_not_of() [4/4]
+
+
+
+
+template<typename CharT , typename Traits = std::char_traits<CharT>>
+
+
+
+
+
+
+inline constexpr noexcept
+
+
+
+
+
+
+
+
◆ find_first_of() [1/4]
+
+
+
+
+template<typename CharT , typename Traits = std::char_traits<CharT>>
+
+
+
+
+
+
+inline constexpr noexcept
+
+
+
+
+
+
+
+
◆ find_first_of() [2/4]
+
+
+
+
+template<typename CharT , typename Traits = std::char_traits<CharT>>
+
+
+
+
+
+
+inline constexpr noexcept
+
+
+
+
+
+
+
+
◆ find_first_of() [3/4]
+
+
+
+
+template<typename CharT , typename Traits = std::char_traits<CharT>>
+
+
+
+
+
+
+inline noexcept
+
+
+
+
+
+
+
+
◆ find_first_of() [4/4]
+
+
+
+
+template<typename CharT , typename Traits = std::char_traits<CharT>>
+
+
+
+
+
+
+inline constexpr noexcept
+
+
+
+
+
+
+
+
◆ find_last_not_of() [1/4]
+
+
+
+
+template<typename CharT , typename Traits = std::char_traits<CharT>>
+
+
+
+
+
+
+inline noexcept
+
+
+
+
+
+
+
+
◆ find_last_not_of() [2/4]
+
+
+
+
+template<typename CharT , typename Traits = std::char_traits<CharT>>
+
+
+
+
+
+
+inline noexcept
+
+
+
+
+
+
+
+
◆ find_last_not_of() [3/4]
+
+
+
+
+template<typename CharT , typename Traits = std::char_traits<CharT>>
+
+
+
+
+
+
+inline noexcept
+
+
+
+
+
+
+
+
◆ find_last_not_of() [4/4]
+
+
+
+
+template<typename CharT , typename Traits = std::char_traits<CharT>>
+
+
+
+
+
+
+inline constexpr noexcept
+
+
+
+
+
+
+
+
◆ find_last_of() [1/4]
+
+
+
+
+template<typename CharT , typename Traits = std::char_traits<CharT>>
+
+
+
+
+
+
+inline constexpr noexcept
+
+
+
+
+
+
+
+
◆ find_last_of() [2/4]
+
+
+
+
+template<typename CharT , typename Traits = std::char_traits<CharT>>
+
+
+
+
+
+
+inline constexpr noexcept
+
+
+
+
+
+
+
+
◆ find_last_of() [3/4]
+
+
+
+
+template<typename CharT , typename Traits = std::char_traits<CharT>>
+
+
+
+
+
+
+inline noexcept
+
+
+
+
+
+
+
+
◆ find_last_of() [4/4]
+
+
+
+
+template<typename CharT , typename Traits = std::char_traits<CharT>>
+
+
+
+
+
+
+inline constexpr noexcept
+
+
+
+
+
+
+
+
◆ front()
+
+
+
+
+template<typename CharT , typename Traits = std::char_traits<CharT>>
+
+
+
+
+
+
+inline noexcept
+
+
+
+
+
+
+
+
◆ length()
+
+
+
+
+template<typename CharT , typename Traits = std::char_traits<CharT>>
+
+
+
+
+
+
+inline constexpr noexcept
+
+
+
+
+
+
+
+
◆ max_size()
+
+
+
+
+template<typename CharT , typename Traits = std::char_traits<CharT>>
+
+
+
+
+
+
+inline constexpr noexcept
+
+
+
+
+
+
+
+
◆ operator=()
+
+
+
+
+template<typename CharT , typename Traits = std::char_traits<CharT>>
+
+
+
+
+
+
+default noexcept
+
+
+
+
+
+
+
+
◆ operator[]()
+
+
+
+
+template<typename CharT , typename Traits = std::char_traits<CharT>>
+
+
+
+
+
+
+inline noexcept
+
+
+
+
+
+
+
+
◆ rbegin()
+
+
+
+
+template<typename CharT , typename Traits = std::char_traits<CharT>>
+
+
+
+
+
+
+inline constexpr noexcept
+
+
+
+
+
+
+
+
◆ remove_prefix()
+
+
+
+
+template<typename CharT , typename Traits = std::char_traits<CharT>>
+
+
+
+
+
+
+inline noexcept
+
+
+
+
+
+
+
+
◆ remove_suffix()
+
+
+
+
+template<typename CharT , typename Traits = std::char_traits<CharT>>
+
+
+
+
+
+
+inline noexcept
+
+
+
+
+
+
+
+
◆ rend()
+
+
+
+
+template<typename CharT , typename Traits = std::char_traits<CharT>>
+
+
+
+
+
+
+inline constexpr noexcept
+
+
+
+
+
+
+
+
◆ rfind() [1/4]
+
+
+
+
+template<typename CharT , typename Traits = std::char_traits<CharT>>
+
+
+
+
+
+
+inline noexcept
+
+
+
+
+
+
+
+
◆ rfind() [2/4]
+
+
+
+
+template<typename CharT , typename Traits = std::char_traits<CharT>>
+
+
+
+
+
+
+inline noexcept
+
+
+
+
+
+
+
+
◆ rfind() [3/4]
+
+
+
+
+template<typename CharT , typename Traits = std::char_traits<CharT>>
+
+
+
+
+
+
+inline noexcept
+
+
+
+
+
+
+
+
◆ rfind() [4/4]
+
+
+
+
+template<typename CharT , typename Traits = std::char_traits<CharT>>
+
+
+
+
+
+
+inline constexpr noexcept
+
+
+
+
+
+
+
+
◆ size()
+
+
+
+
+template<typename CharT , typename Traits = std::char_traits<CharT>>
+
+
+
+
+
+
+inline constexpr noexcept
+
+
+
+
+
+
+
+
◆ starts_with() [1/3]
+
+
+
+
+template<typename CharT , typename Traits = std::char_traits<CharT>>
+
+
+
+
+
+
+inline constexpr noexcept
+
+
+
+
+
+
+
+
◆ starts_with() [2/3]
+
+
+
+
+template<typename CharT , typename Traits = std::char_traits<CharT>>
+
+
+
+
+
+
+inline constexpr noexcept
+
+
+
+
+
+
+
+
◆ starts_with() [3/3]
+
+
+
+
+template<typename CharT , typename Traits = std::char_traits<CharT>>
+
+
+
+
+
+
+inline constexpr noexcept
+
+
+
+
+
+
+
+
◆ substr()
+
+
+
+
+template<typename CharT , typename Traits = std::char_traits<CharT>>
+
+
+
+
+
+
+inline noexcept
+
+
+
+
+
+
+
+
◆ swap()
+
+
+
+
+template<typename CharT , typename Traits = std::char_traits<CharT>>
+
+
+
+
+
+
+inline noexcept
+
+
+
+
+
+
+
+
+
◆ npos
+
+
+
+
+template<typename CharT , typename Traits = std::char_traits<CharT>>
+
+
+
+
+
+
+static constexpr
+
+
+
+
+
+
+
The documentation for this class was generated from the following file:
+
+
+
+
+
diff --git a/docs/class_aws_1_1_iot_1_1_mqtt5_client_builder-members.html b/docs/class_aws_1_1_iot_1_1_mqtt5_client_builder-members.html
new file mode 100644
index 000000000..508a09c9c
--- /dev/null
+++ b/docs/class_aws_1_1_iot_1_1_mqtt5_client_builder-members.html
@@ -0,0 +1,125 @@
+
+
+
+
+
+
+
+aws-crt-cpp: Member List
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ 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 () noexceptAws::Iot::Mqtt5ClientBuilder
+ LastError () const noexceptAws::Iot::Mqtt5ClientBuilder inline
+ Mqtt5ClientBuilder (const Mqtt5ClientBuilder &)=deleteAws::Iot::Mqtt5ClientBuilder
+ Mqtt5ClientBuilder (Mqtt5ClientBuilder &&)=deleteAws::Iot::Mqtt5ClientBuilder
+ NewMqtt5ClientBuilderWithCustomAuthorizer (const Crt::String hostName, const Mqtt5CustomAuthConfig &customAuthConfig, Crt::Allocator *allocator) noexceptAws::Iot::Mqtt5ClientBuilder static
+ NewMqtt5ClientBuilderWithCustomAuthorizerWebsocket (const Crt::String hostName, const Mqtt5CustomAuthConfig &customAuthConfig, const WebsocketConfig &config, Crt::Allocator *allocator) noexceptAws::Iot::Mqtt5ClientBuilder static
+ NewMqtt5ClientBuilderWithMtlsFromMemory (const Crt::String hostName, const Crt::ByteCursor &certPath, const Crt::ByteCursor &pkeyPath, Crt::Allocator *allocator=Crt::ApiAllocator()) noexceptAws::Iot::Mqtt5ClientBuilder static
+ NewMqtt5ClientBuilderWithMtlsFromPath (const Crt::String hostName, const char *certPath, const char *pkeyPath, Crt::Allocator *allocator=Crt::ApiAllocator()) noexceptAws::Iot::Mqtt5ClientBuilder static
+ NewMqtt5ClientBuilderWithMtlsPkcs11 (const Crt::String hostName, const Crt::Io::TlsContextPkcs11Options &pkcs11Options, Crt::Allocator *allocator=Crt::ApiAllocator()) noexceptAws::Iot::Mqtt5ClientBuilder static
+ NewMqtt5ClientBuilderWithMtlsPkcs12 (const Crt::String hostName, const struct Pkcs12Options &options, Crt::Allocator *allocator=Crt::ApiAllocator()) noexceptAws::Iot::Mqtt5ClientBuilder static
+ NewMqtt5ClientBuilderWithWebsocket (const Crt::String hostName, const WebsocketConfig &config, Crt::Allocator *allocator=Crt::ApiAllocator()) noexceptAws::Iot::Mqtt5ClientBuilder static
+ NewMqtt5ClientBuilderWithWindowsCertStorePath (const Crt::String hostName, const char *windowsCertStorePath, Crt::Allocator *allocator=Crt::ApiAllocator()) noexceptAws::Iot::Mqtt5ClientBuilder static
+ operator bool () const noexceptAws::Iot::Mqtt5ClientBuilder inline explicit
+ operator= (const Mqtt5ClientBuilder &)=deleteAws::Iot::Mqtt5ClientBuilder
+ operator= (Mqtt5ClientBuilder &&)=deleteAws::Iot::Mqtt5ClientBuilder
+ WithAckTimeoutSec (uint32_t ackTimeoutSec) noexceptAws::Iot::Mqtt5ClientBuilder
+ WithAckTimeoutSeconds (uint32_t ackTimeoutSec) noexceptAws::Iot::Mqtt5ClientBuilder
+ WithBootstrap (Crt::Io::ClientBootstrap *bootStrap) noexceptAws::Iot::Mqtt5ClientBuilder
+ WithCertificateAuthority (const char *caPath) noexceptAws::Iot::Mqtt5ClientBuilder
+ WithCertificateAuthority (const Crt::ByteCursor &cert) noexceptAws::Iot::Mqtt5ClientBuilder
+ WithClientAttemptingConnectCallback (OnAttemptingConnectHandler callback) noexceptAws::Iot::Mqtt5ClientBuilder
+ WithClientConnectionFailureCallback (OnConnectionFailureHandler callback) noexceptAws::Iot::Mqtt5ClientBuilder
+ WithClientConnectionSuccessCallback (OnConnectionSuccessHandler callback) noexceptAws::Iot::Mqtt5ClientBuilder
+ WithClientDisconnectionCallback (OnDisconnectionHandler callback) noexceptAws::Iot::Mqtt5ClientBuilder
+ WithClientExtendedValidationAndFlowControl (ClientExtendedValidationAndFlowControl clientExtendedValidationAndFlowControl) noexceptAws::Iot::Mqtt5ClientBuilder
+ WithClientStoppedCallback (OnStoppedHandler callback) noexceptAws::Iot::Mqtt5ClientBuilder
+ WithConnackTimeoutMs (uint32_t connackTimeoutMs) noexceptAws::Iot::Mqtt5ClientBuilder
+ WithConnectOptions (std::shared_ptr< ConnectPacket > packetConnect) noexceptAws::Iot::Mqtt5ClientBuilder
+ WithCustomAuthorizer (const Iot::Mqtt5CustomAuthConfig &config) noexceptAws::Iot::Mqtt5ClientBuilder
+ WithHostName (Crt::String hostname)Aws::Iot::Mqtt5ClientBuilder
+ WithHttpProxyOptions (const Crt::Http::HttpClientConnectionProxyOptions &proxyOptions) noexceptAws::Iot::Mqtt5ClientBuilder
+ WithMinConnectedTimeToResetReconnectDelayMs (uint64_t minConnectedTimeToResetReconnectDelayMs) noexceptAws::Iot::Mqtt5ClientBuilder
+ WithOfflineQueueBehavior (ClientOperationQueueBehaviorType offlineQueueBehavior) noexceptAws::Iot::Mqtt5ClientBuilder
+ WithPingTimeoutMs (uint32_t pingTimeoutMs) noexceptAws::Iot::Mqtt5ClientBuilder
+ WithPort (uint32_t port) noexceptAws::Iot::Mqtt5ClientBuilder
+ WithPublishReceivedCallback (OnPublishReceivedHandler callback) noexceptAws::Iot::Mqtt5ClientBuilder
+ WithReconnectOptions (ReconnectOptions reconnectOptions) noexceptAws::Iot::Mqtt5ClientBuilder
+ WithSdkName (const Crt::String &sdkName)Aws::Iot::Mqtt5ClientBuilder
+ WithSdkVersion (const Crt::String &sdkVersion)Aws::Iot::Mqtt5ClientBuilder
+ WithSessionBehavior (ClientSessionBehaviorType sessionBehavior) noexceptAws::Iot::Mqtt5ClientBuilder
+ WithSocketOptions (Crt::Io::SocketOptions socketOptions) noexceptAws::Iot::Mqtt5ClientBuilder
+ WithTopicAliasingOptions (TopicAliasingOptions topicAliasingOptions) noexceptAws::Iot::Mqtt5ClientBuilder
+ ~Mqtt5ClientBuilder ()Aws::Iot::Mqtt5ClientBuilder inline virtual
+
+
+
+
+
diff --git a/docs/class_aws_1_1_iot_1_1_mqtt5_client_builder.html b/docs/class_aws_1_1_iot_1_1_mqtt5_client_builder.html
new file mode 100644
index 000000000..391d130cc
--- /dev/null
+++ b/docs/class_aws_1_1_iot_1_1_mqtt5_client_builder.html
@@ -0,0 +1,1723 @@
+
+
+
+
+
+
+
+aws-crt-cpp: Aws::Iot::Mqtt5ClientBuilder Class Reference
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ aws-crt-cpp
+
+ C++ wrapper around the aws-c-* libraries. Provides Cross-Platform Transport Protocols and SSL/TLS implementations for C++.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
#include <Mqtt5Client.h >
+
+
+static Mqtt5ClientBuilder * NewMqtt5ClientBuilderWithMtlsFromPath (const Crt::String hostName, const char *certPath, const char *pkeyPath, Crt::Allocator *allocator=Crt::ApiAllocator ()) noexcept
+
+static Mqtt5ClientBuilder * NewMqtt5ClientBuilderWithMtlsFromMemory (const Crt::String hostName, const Crt::ByteCursor &certPath, const Crt::ByteCursor &pkeyPath, Crt::Allocator *allocator=Crt::ApiAllocator ()) noexcept
+
+static Mqtt5ClientBuilder * NewMqtt5ClientBuilderWithMtlsPkcs11 (const Crt::String hostName, const Crt::Io::TlsContextPkcs11Options &pkcs11Options, Crt::Allocator *allocator=Crt::ApiAllocator ()) noexcept
+
+static Mqtt5ClientBuilder * NewMqtt5ClientBuilderWithMtlsPkcs12 (const Crt::String hostName, const struct Pkcs12Options &options, Crt::Allocator *allocator=Crt::ApiAllocator ()) noexcept
+
+static Mqtt5ClientBuilder * NewMqtt5ClientBuilderWithWindowsCertStorePath (const Crt::String hostName, const char *windowsCertStorePath, Crt::Allocator *allocator=Crt::ApiAllocator ()) noexcept
+
+static Mqtt5ClientBuilder * NewMqtt5ClientBuilderWithWebsocket (const Crt::String hostName, const WebsocketConfig &config, Crt::Allocator *allocator=Crt::ApiAllocator ()) noexcept
+
+static Mqtt5ClientBuilder * NewMqtt5ClientBuilderWithCustomAuthorizer (const Crt::String hostName, const Mqtt5CustomAuthConfig &customAuthConfig, Crt::Allocator *allocator) noexcept
+
+static Mqtt5ClientBuilder * NewMqtt5ClientBuilderWithCustomAuthorizerWebsocket (const Crt::String hostName, const Mqtt5CustomAuthConfig &customAuthConfig, const WebsocketConfig &config, Crt::Allocator *allocator) noexcept
+
+
+
+
Represents a unique configuration for mqtt5 client and connection. Helps to setup Mqtt5ClientOptionsBuilder for mqtt5 client.
+
+
+
◆ ~Mqtt5ClientBuilder()
+
+
+
+
+
+
+
+
+ virtual Aws::Iot::Mqtt5ClientBuilder::~Mqtt5ClientBuilder
+ (
+ )
+
+
+
+
+
+inline virtual
+
+
+
+
+
+
+
+
◆ Mqtt5ClientBuilder() [1/2]
+
+
+
+
+
+
+
+
+ Aws::Iot::Mqtt5ClientBuilder::Mqtt5ClientBuilder
+ (
+ const Mqtt5ClientBuilder &
+ )
+
+
+
+
+
+delete
+
+
+
+
+
+
+
+
◆ Mqtt5ClientBuilder() [2/2]
+
+
+
+
+
+
+
+
+ Aws::Iot::Mqtt5ClientBuilder::Mqtt5ClientBuilder
+ (
+ Mqtt5ClientBuilder &&
+ )
+
+
+
+
+
+delete
+
+
+
+
+
+
+
+
+
◆ Build()
+
+
+
+
+
+
+
+
+ std::shared_ptr< Mqtt5Client > Aws::Iot::Mqtt5ClientBuilder::Build
+ (
+ )
+
+
+
+
+
+noexcept
+
+
+
+
Builds a client configuration object from the set options.
+
Returns a new client connection config instance
+
+
+
+
+
◆ LastError()
+
+
+
+
+
+
+
+
+ int Aws::Iot::Mqtt5ClientBuilder::LastError
+ (
+ )
+ const
+
+
+
+
+inline noexcept
+
+
+
+
Returns the value of the last aws error encountered by operations on this instance.
+
+
+
+
+
◆ NewMqtt5ClientBuilderWithCustomAuthorizer()
+
+
+
+
+
+
+
+
+
+static noexcept
+
+
+
+
Sets the builder up for connection using authorization configuration.
+
Parameters
+
+ hostName - AWS IoT endpoint to connect to
+ customAuthConfig custom authorization configuration information
+ allocator memory allocator to use
+
+
+
+
Mqtt5ClientBuilder
+
+
+
+
+
◆ NewMqtt5ClientBuilderWithCustomAuthorizerWebsocket()
+
+
+
+
+
+
+
+
+
+static noexcept
+
+
+
+
Sets the builder up for connection using authorization configuration using Websockets.
+
Parameters
+
+ hostName - AWS IoT endpoint to connect to
+ customAuthConfig custom authorization configuration information
+ config websocket configuration information
+ allocator memory allocator to use
+
+
+
+
Mqtt5ClientBuilder
+
+
+
+
+
◆ NewMqtt5ClientBuilderWithMtlsFromMemory()
+
+
+
+
+
+
+
+
+
+static noexcept
+
+
+
+
Sets the builder up for MTLS using cert and pkey. These are in-memory buffers and must be in the PEM format.
+
Parameters
+
+ 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
+
+
+
+
Returns Mqtt5ClientBuilder
+
+
+
+
+
◆ NewMqtt5ClientBuilderWithMtlsFromPath()
+
+
+
+
+
+
+
+
+
+static noexcept
+
+
+
+
Set the builder up for MTLS using certPath and pkeyPath. These are files on disk and must be in the PEM format.
+
Parameters
+
+ 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
+
+
+
+
Returns Mqtt5ClientBuilder
+
+
+
+
+
◆ NewMqtt5ClientBuilderWithMtlsPkcs11()
+
+
+
+
+
+
+
+
+
+static noexcept
+
+
+
+
Sets the builder up for MTLS, using a PKCS#11 library for private key operations.
+
NOTE: This only works on Unix devices.
+
Parameters
+
+ hostName - AWS IoT endpoint to connect to
+ pkcs11Options PKCS#11 options
+ allocator memory allocator to use
+
+
+
+
Returns Mqtt5ClientBuilder
+
+
+
+
+
◆ NewMqtt5ClientBuilderWithMtlsPkcs12()
+
+
+
+
+
+
+
+
+
+static noexcept
+
+
+
+
Sets the builder up for MTLS, using a PKCS#12 file for private key operations.
+
NOTE: This only works on MacOS devices.
+
Parameters
+
+ hostName - AWS IoT endpoint to connect to
+ options The PKCS12 options to use.
+ allocator - memory allocator to use
+
+
+
+
Returns Mqtt5ClientBuilder
+
+
+
+
+
◆ NewMqtt5ClientBuilderWithWebsocket()
+
+
+
+
+
+
+
+
+
+static noexcept
+
+
+
+
Sets the builder up for Websocket connection.
+
Parameters
+
+ hostName - AWS IoT endpoint to connect to
+ config websocket configuration information
+ allocator memory allocator to use
+
+
+
+
Mqtt5ClientBuilder
+
+
+
+
+
◆ NewMqtt5ClientBuilderWithWindowsCertStorePath()
+
+
+
+
+
+
+
+
+
+static noexcept
+
+
+
+
Sets the builder up for MTLS, using a certificate in a Windows certificate store.
+
NOTE: This only works on Windows.
+
Parameters
+
+ 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
+
+
+
+
Returns Mqtt5ClientBuilder
+
+
+
+
+
◆ operator bool()
+
+
+
+
+
+
+
+
+ Aws::Iot::Mqtt5ClientBuilder::operator bool
+ (
+ )
+ const
+
+
+
+
+inline explicit noexcept
+
+
+
+
Returns true if the instance is in a valid state, false otherwise.
+
+
+
+
+
◆ operator=() [1/2]
+
+
+
+
◆ operator=() [2/2]
+
+
+
+
◆ WithAckTimeoutSec()
+
+
+
+
+
+
+
+
+ Mqtt5ClientBuilder & Aws::Iot::Mqtt5ClientBuilder::WithAckTimeoutSec
+ (
+ uint32_t
+ ackTimeoutSec )
+
+
+
+
+
+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.
+
Parameters
+
+
+
+
Returns this option object
+
+
+
+
+
◆ WithAckTimeoutSeconds()
+
+
+
+
+
+
+
+
+ Mqtt5ClientBuilder & Aws::Iot::Mqtt5ClientBuilder::WithAckTimeoutSeconds
+ (
+ uint32_t
+ ackTimeoutSec )
+
+
+
+
+
+noexcept
+
+
+
+
Deprecated: the function is deprecated, please use 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.
+
Parameters
+
+
+
+
Returns this option object
+
+
+
+
+
◆ WithBootstrap()
+
+
+
+
Set booststrap for mqtt5 client
+
Parameters
+
+
+
+
Returns this option object
+
+
+
+
+
◆ WithCertificateAuthority() [1/2]
+
+
+
+
+
+
+
+
+ Mqtt5ClientBuilder & Aws::Iot::Mqtt5ClientBuilder::WithCertificateAuthority
+ (
+ const char *
+ caPath )
+
+
+
+
+
+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.
+
Parameters
+
+ caPath path to the CA file in PEM format
+
+
+
+
Returns this builder object
+
+
+
+
+
◆ WithCertificateAuthority() [2/2]
+
+
+
+
Sets the certificate authority for the endpoint you're connecting to. This is an in-memory buffer and must be in PEM format.
+
Parameters
+
+ cert buffer containing the CA certificate in a PEM format
+
+
+
+
Returns this builder object
+
+
+
+
+
◆ WithClientAttemptingConnectCallback()
+
+
+
+
Setup callback handler trigged when client begins an attempt to connect to the remote endpoint.
+
Parameters
+
+
+
+
Returns this option object
+
+
+
+
+
◆ WithClientConnectionFailureCallback()
+
+
+
+
Setup callback trigged when client fails to establish an MQTT connection
+
Parameters
+
+
+
+
Returns this option object
+
+
+
+
+
◆ WithClientConnectionSuccessCallback()
+
+
+
+
Setup callback trigged when client successfully establishes an MQTT connection
+
Parameters
+
+
+
+
Returns this option object
+
+
+
+
+
◆ WithClientDisconnectionCallback()
+
+
+
+
Setup callback handler trigged when client's current MQTT connection is closed
+
Parameters
+
+
+
+
Returns this option object
+
+
+
+
+
◆ WithClientExtendedValidationAndFlowControl()
+
+
+
+
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.
+
Parameters
+
+ clientExtendedValidationAndFlowControl
+
+
+
+
Returns this option object
+
+
+
+
+
◆ WithClientStoppedCallback()
+
+
+
+
Setup callback handler trigged when client reaches the "Stopped" state
+
Parameters
+
+
+
+
Returns this option object
+
+
+
+
+
◆ WithConnackTimeoutMs()
+
+
+
+
+
+
+
+
+ Mqtt5ClientBuilder & Aws::Iot::Mqtt5ClientBuilder::WithConnackTimeoutMs
+ (
+ uint32_t
+ connackTimeoutMs )
+
+
+
+
+
+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.
+
Parameters
+
+
+
+
Returns this option object
+
+
+
+
+
◆ WithConnectOptions()
+
+
+
+
Sets mqtt5 connection options
+
Parameters
+
+ packetConnect package connection options
+
+
+
+
Returns this option object
+
+
+
+
+
◆ WithCustomAuthorizer()
+
+
+
+
Sets the custom authorizer settings. This function will modify the username, port, and TLS options.
+
Returns this builder object
+
+
+
+
+
◆ WithHostName()
+
+
+
+
Sets the host to connect to.
+
Parameters
+
+ hostname endpoint to connect to
+
+
+
+
Returns this option object
+
+
+
+
+
◆ WithHttpProxyOptions()
+
+
+
+
Sets http proxy options.
+
Parameters
+
+ proxyOptions http proxy configuration for connection establishment
+
+
+
+
Returns this option object
+
+
+
+
+
◆ WithMinConnectedTimeToResetReconnectDelayMs()
+
+
+
+
+
+
+
+
+ Mqtt5ClientBuilder & Aws::Iot::Mqtt5ClientBuilder::WithMinConnectedTimeToResetReconnectDelayMs
+ (
+ uint64_t
+ minConnectedTimeToResetReconnectDelayMs )
+
+
+
+
+
+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.
+
Parameters
+
+ minConnectedTimeToResetReconnectDelayMs
+
+
+
+
Returns this option object
+
+
+
+
+
◆ WithOfflineQueueBehavior()
+
+
+
+
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.
+
Parameters
+
+
+
+
Returns this option object
+
+
+
+
+
◆ WithPingTimeoutMs()
+
+
+
+
+
+
+
+
+ Mqtt5ClientBuilder & Aws::Iot::Mqtt5ClientBuilder::WithPingTimeoutMs
+ (
+ uint32_t
+ pingTimeoutMs )
+
+
+
+
+
+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.
+
Parameters
+
+
+
+
Returns this option object
+
+
+
+
+
◆ WithPort()
+
+
+
+
+
+
+
+
+ Mqtt5ClientBuilder & Aws::Iot::Mqtt5ClientBuilder::WithPort
+ (
+ uint32_t
+ port )
+
+
+
+
+
+noexcept
+
+
+
+
Set port to connect to
+
Parameters
+
+ port port to connect to
+
+
+
+
Returns this option object
+
+
+
+
+
◆ WithPublishReceivedCallback()
+
+
+
+
Setup callback handler trigged when an MQTT PUBLISH packet is received by the client
+
Parameters
+
+
+
+
Returns this option object
+
+
+
+
+
◆ WithReconnectOptions()
+
+
+
+
Sets ReconnectOptions. Reconnect options includes retryJitterMode, min reconnect delay time and max reconnect delay time
+
Parameters
+
+
+
+
Returns this option object
+
+
+
+
+
◆ WithSdkName()
+
+
+
+
Overrides the default SDK Name to send as a metric in the MQTT CONNECT packet.
+
Parameters
+
+ sdkName string to use as the SDK name parameter in the connection string
+
+
+
+
Returns this builder object
+
+
+
+
+
◆ WithSdkVersion()
+
+
+
+
Overrides the default SDK Version to send as a metric in the MQTT CONNECT packet.
+
Parameters
+
+ sdkVersion string to use as the SDK version parameter in the connection string
+
+
+
+
Returns this builder object
+
+
+
+
+
◆ WithSessionBehavior()
+
+
+
+
Sets session behavior. Overrides how the MQTT5 client should behave with respect to MQTT sessions.
+
Parameters
+
+ sessionBehavior how the MQTT5 client should behave with respect to MQTT sessions.
+
+
+
+
Returns this option object
+
+
+
+
+
◆ WithSocketOptions()
+
+
+
+
Overrides the socket properties of the underlying MQTT connections made by the client. Leave undefined to use defaults (no TCP keep alive, 10 second socket timeout).
+
Parameters
+
+ socketOptions - The socket properties of the underlying MQTT connections made by the client
+
+
+
+
Returns - The Mqtt5ClientBuilder
+
+
+
+
+
◆ WithTopicAliasingOptions()
+
+
+
+
Sets the topic aliasing behavior that the client should use.
+
Parameters
+
+ topicAliasingOptions topic aliasing behavior options to use
+
+
+
+
Returns this builder object
+
+
+
+
The documentation for this class was generated from the following files:
+
+
+
+
+
diff --git a/docs/class_aws_1_1_iot_1_1_mqtt5_custom_auth_config-members.html b/docs/class_aws_1_1_iot_1_1_mqtt5_custom_auth_config-members.html
new file mode 100644
index 000000000..cf48a74c6
--- /dev/null
+++ b/docs/class_aws_1_1_iot_1_1_mqtt5_custom_auth_config-members.html
@@ -0,0 +1,100 @@
+
+
+
+
+
+
+
+aws-crt-cpp: Member List
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ 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.
+
+
+
+
+
diff --git a/docs/class_aws_1_1_iot_1_1_mqtt5_custom_auth_config.html b/docs/class_aws_1_1_iot_1_1_mqtt5_custom_auth_config.html
new file mode 100644
index 000000000..abd8f295f
--- /dev/null
+++ b/docs/class_aws_1_1_iot_1_1_mqtt5_custom_auth_config.html
@@ -0,0 +1,482 @@
+
+
+
+
+
+
+
+aws-crt-cpp: Aws::Iot::Mqtt5CustomAuthConfig Class Reference
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ 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
+
+
+
◆ Mqtt5CustomAuthConfig() [1/3]
+
+
+
+
Create a custom authorizer configuration
+
+
+
+
+
◆ ~Mqtt5CustomAuthConfig()
+
+
+
+
+
+
+
+
+ Aws::Iot::Mqtt5CustomAuthConfig::~Mqtt5CustomAuthConfig
+ (
+ )
+
+
+
+
+
+virtual
+
+
+
+
+
+
+
+
◆ Mqtt5CustomAuthConfig() [2/3]
+
+
+
+
+
+ Aws::Iot::Mqtt5CustomAuthConfig::Mqtt5CustomAuthConfig
+ (
+ const Mqtt5CustomAuthConfig &
+ rhs )
+
+
+
+
+
+
+
+
+
◆ Mqtt5CustomAuthConfig() [3/3]
+
+
+
+
+
◆ GetAuthorizerName()
+
+
+
+
◆ GetPassword()
+
+
+
+
◆ GetTokenKeyName()
+
+
+
+
◆ GetTokenSignature()
+
+
+
+
◆ GetTokenValue()
+
+
+
+
◆ GetUsername()
+
+
+
+
◆ operator=() [1/2]
+
+
+
+
◆ operator=() [2/2]
+
+
+
+
◆ WithAuthorizerName()
+
+
+
+
◆ WithPassword()
+
+
+
+
◆ WithTokenKeyName()
+
+
+
+
◆ WithTokenSignature()
+
+
+
+
◆ WithTokenValue()
+
+
+
+
◆ WithUsername()
+
+
+
The documentation for this class was generated from the following files:
+
+
+
+
+
diff --git a/docs/class_aws_1_1_iot_1_1_mqtt_client-members.html b/docs/class_aws_1_1_iot_1_1_mqtt_client-members.html
new file mode 100644
index 000000000..21e9430ba
--- /dev/null
+++ b/docs/class_aws_1_1_iot_1_1_mqtt_client-members.html
@@ -0,0 +1,87 @@
+
+
+
+
+
+
+
+aws-crt-cpp: Member List
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ 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.
+
+
+
+
+
diff --git a/docs/class_aws_1_1_iot_1_1_mqtt_client.html b/docs/class_aws_1_1_iot_1_1_mqtt_client.html
new file mode 100644
index 000000000..9841508b4
--- /dev/null
+++ b/docs/class_aws_1_1_iot_1_1_mqtt_client.html
@@ -0,0 +1,255 @@
+
+
+
+
+
+
+
+aws-crt-cpp: Aws::Iot::MqttClient Class Reference
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ aws-crt-cpp
+
+ C++ wrapper around the aws-c-* libraries. Provides Cross-Platform Transport Protocols and SSL/TLS implementations for C++.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
#include <MqttClient.h >
+
+
+
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
+
+
+
◆ MqttClient() [1/2]
+
+
+
+
◆ MqttClient() [2/2]
+
+
+
+
Constructs a new Mqtt Client object using the static default ClientBootstrap.
+
For more information on the default ClientBootstrap see Aws::Crt::ApiHandle::GetOrCreateDefaultClientBootstrap
+
+
+
+
+
+
◆ LastError()
+
+
+
+
+
+
+
+
+ int Aws::Iot::MqttClient::LastError
+ (
+ )
+ const
+
+
+
+
+inline noexcept
+
+
+
+
Returns the value of the last aws error encountered by operations on this instance.
+
+
+
+
+
◆ NewConnection()
+
+
+
+
Creates a new mqtt connection from a connection configuration object
Parameters
+
+ config mqtt connection configuration
+
+
+
+
Returns a new mqtt connection
+
+
+
+
+
◆ operator bool()
+
+
+
+
+
+
+
+
+ Aws::Iot::MqttClient::operator bool
+ (
+ )
+ const
+
+
+
+
+inline explicit noexcept
+
+
+
+
Returns true if the instance is in a valid state, false otherwise.
+
+
+
+
The documentation for this class was generated from the following files:
+
+
+
+
+
diff --git a/docs/class_aws_1_1_iot_1_1_mqtt_client_connection_config-members.html b/docs/class_aws_1_1_iot_1_1_mqtt_client_connection_config-members.html
new file mode 100644
index 000000000..fe65b94b3
--- /dev/null
+++ b/docs/class_aws_1_1_iot_1_1_mqtt_client_connection_config-members.html
@@ -0,0 +1,89 @@
+
+
+
+
+
+
+
+aws-crt-cpp: Member List
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ 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.
+
+
+
+
+
diff --git a/docs/class_aws_1_1_iot_1_1_mqtt_client_connection_config.html b/docs/class_aws_1_1_iot_1_1_mqtt_client_connection_config.html
new file mode 100644
index 000000000..80eb2076f
--- /dev/null
+++ b/docs/class_aws_1_1_iot_1_1_mqtt_client_connection_config.html
@@ -0,0 +1,356 @@
+
+
+
+
+
+
+
+aws-crt-cpp: Aws::Iot::MqttClientConnectionConfig Class Reference
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ aws-crt-cpp
+
+ C++ wrapper around the aws-c-* libraries. Provides Cross-Platform Transport Protocols and SSL/TLS implementations for C++.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
#include <MqttClient.h >
+
+
+
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.
+
+
+
◆ MqttClientConnectionConfig() [1/2]
+
+
+
+
Creates a client configuration for use with making new AWS Iot specific MQTT Connections with MTLS.
+
Parameters
+
+ 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
+
+
+
+
+
+
+
+
◆ MqttClientConnectionConfig() [2/2]
+
+
+
+
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.
+
Parameters
+
+ 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
+
+
+
+
+
+
+
+
+
◆ CreateInvalid()
+
+
+
+
+
+
+
+
+
+static noexcept
+
+
+
+
+
+
+
+
◆ LastError()
+
+
+
+
+
+
+
+
+ int Aws::Iot::MqttClientConnectionConfig::LastError
+ (
+ )
+ const
+
+
+
+
+inline noexcept
+
+
+
+
Returns the value of the last aws error encountered by operations on this instance.
+
+
+
+
+
◆ operator bool()
+
+
+
+
+
+
+
+
+ Aws::Iot::MqttClientConnectionConfig::operator bool
+ (
+ )
+ const
+
+
+
+
+inline explicit noexcept
+
+
+
+
Returns true if the instance is in a valid state, false otherwise.
+
+
+
+
+
+
◆ MqttClient
+
+
+
+
◆ MqttClientConnectionConfigBuilder
+
+
+
The documentation for this class was generated from the following files:
+
+
+
+
+
diff --git a/docs/class_aws_1_1_iot_1_1_mqtt_client_connection_config_builder-members.html b/docs/class_aws_1_1_iot_1_1_mqtt_client_connection_config_builder-members.html
new file mode 100644
index 000000000..096d1b7fa
--- /dev/null
+++ b/docs/class_aws_1_1_iot_1_1_mqtt_client_connection_config_builder-members.html
@@ -0,0 +1,112 @@
+
+
+
+
+
+
+
+aws-crt-cpp: Member List
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ 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.
+
+ Build () noexceptAws::Iot::MqttClientConnectionConfigBuilder
+ LastError () const noexceptAws::Iot::MqttClientConnectionConfigBuilder inline
+ MqttClientConnectionConfigBuilder ()Aws::Iot::MqttClientConnectionConfigBuilder
+ MqttClientConnectionConfigBuilder (const char *certPath, const char *pkeyPath, Crt::Allocator *allocator=Crt::ApiAllocator()) noexceptAws::Iot::MqttClientConnectionConfigBuilder
+ MqttClientConnectionConfigBuilder (const Crt::ByteCursor &cert, const Crt::ByteCursor &pkey, Crt::Allocator *allocator=Crt::ApiAllocator()) noexceptAws::Iot::MqttClientConnectionConfigBuilder
+ MqttClientConnectionConfigBuilder (const Crt::Io::TlsContextPkcs11Options &pkcs11Options, Crt::Allocator *allocator=Crt::ApiAllocator()) noexceptAws::Iot::MqttClientConnectionConfigBuilder
+ MqttClientConnectionConfigBuilder (const struct Pkcs12Options &options, Crt::Allocator *allocator=Crt::ApiAllocator()) noexceptAws::Iot::MqttClientConnectionConfigBuilder
+ MqttClientConnectionConfigBuilder (const char *windowsCertStorePath, Crt::Allocator *allocator=Crt::ApiAllocator()) noexceptAws::Iot::MqttClientConnectionConfigBuilder
+ MqttClientConnectionConfigBuilder (const WebsocketConfig &config, Crt::Allocator *allocator=Crt::ApiAllocator()) noexceptAws::Iot::MqttClientConnectionConfigBuilder
+ NewDefaultBuilder () noexceptAws::Iot::MqttClientConnectionConfigBuilder static
+ operator bool () const noexceptAws::Iot::MqttClientConnectionConfigBuilder inline explicit
+ WithCertificateAuthority (const char *caPath) noexceptAws::Iot::MqttClientConnectionConfigBuilder
+ WithCertificateAuthority (const Crt::ByteCursor &cert) noexceptAws::Iot::MqttClientConnectionConfigBuilder
+ WithCustomAuthorizer (const Crt::String &username, const Crt::String &authorizerName, const Crt::String &authorizerSignature, const Crt::String &password) noexceptAws::Iot::MqttClientConnectionConfigBuilder
+ WithCustomAuthorizer (const Crt::String &username, const Crt::String &authorizerName, const Crt::String &authorizerSignature, const Crt::String &password, const Crt::String &tokenKeyName, const Crt::String &tokenValue) noexceptAws::Iot::MqttClientConnectionConfigBuilder
+ WithEndpoint (const Crt::String &endpoint)Aws::Iot::MqttClientConnectionConfigBuilder
+ WithEndpoint (Crt::String &&endpoint)Aws::Iot::MqttClientConnectionConfigBuilder
+ WithHttpProxyOptions (const Crt::Http::HttpClientConnectionProxyOptions &proxyOptions) noexceptAws::Iot::MqttClientConnectionConfigBuilder
+ WithMetricsCollection (bool enabled)Aws::Iot::MqttClientConnectionConfigBuilder
+ WithMinimumTlsVersion (aws_tls_versions minimumTlsVersion) noexceptAws::Iot::MqttClientConnectionConfigBuilder
+ WithPassword (const Crt::String &password) noexceptAws::Iot::MqttClientConnectionConfigBuilder
+ WithPortOverride (uint32_t port) noexceptAws::Iot::MqttClientConnectionConfigBuilder
+ WithSdkName (const Crt::String &sdkName)Aws::Iot::MqttClientConnectionConfigBuilder
+ WithSdkVersion (const Crt::String &sdkVersion)Aws::Iot::MqttClientConnectionConfigBuilder
+ WithTcpConnectTimeout (uint32_t connectTimeoutMs) noexceptAws::Iot::MqttClientConnectionConfigBuilder
+ WithTcpKeepAlive () noexceptAws::Iot::MqttClientConnectionConfigBuilder
+ WithTcpKeepAliveInterval (uint16_t keepAliveIntervalSecs) noexceptAws::Iot::MqttClientConnectionConfigBuilder
+ WithTcpKeepAliveMaxProbes (uint16_t maxProbes) noexceptAws::Iot::MqttClientConnectionConfigBuilder
+ WithTcpKeepAliveTimeout (uint16_t keepAliveTimeoutSecs) noexceptAws::Iot::MqttClientConnectionConfigBuilder
+ WithUsername (const Crt::String &username) noexceptAws::Iot::MqttClientConnectionConfigBuilder
+
+
+
+
+
diff --git a/docs/class_aws_1_1_iot_1_1_mqtt_client_connection_config_builder.html b/docs/class_aws_1_1_iot_1_1_mqtt_client_connection_config_builder.html
new file mode 100644
index 000000000..4a6789252
--- /dev/null
+++ b/docs/class_aws_1_1_iot_1_1_mqtt_client_connection_config_builder.html
@@ -0,0 +1,1228 @@
+
+
+
+
+
+
+
+aws-crt-cpp: Aws::Iot::MqttClientConnectionConfigBuilder Class Reference
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ aws-crt-cpp
+
+ C++ wrapper around the aws-c-* libraries. Provides Cross-Platform Transport Protocols and SSL/TLS implementations for C++.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
#include <MqttClient.h >
+
+
+ MqttClientConnectionConfigBuilder ()
+
+ MqttClientConnectionConfigBuilder (const char *certPath, const char *pkeyPath, Crt::Allocator *allocator=Crt::ApiAllocator ()) noexcept
+
+ MqttClientConnectionConfigBuilder (const Crt::ByteCursor &cert, const Crt::ByteCursor &pkey, Crt::Allocator *allocator=Crt::ApiAllocator ()) noexcept
+
+ MqttClientConnectionConfigBuilder (const Crt::Io::TlsContextPkcs11Options &pkcs11Options, Crt::Allocator *allocator=Crt::ApiAllocator ()) noexcept
+
+ MqttClientConnectionConfigBuilder (const struct Pkcs12Options &options, Crt::Allocator *allocator=Crt::ApiAllocator ()) noexcept
+
+ MqttClientConnectionConfigBuilder (const char *windowsCertStorePath, Crt::Allocator *allocator=Crt::ApiAllocator ()) noexcept
+
+ MqttClientConnectionConfigBuilder (const WebsocketConfig &config, Crt::Allocator *allocator=Crt::ApiAllocator ()) noexcept
+
+MqttClientConnectionConfigBuilder & WithEndpoint (const Crt::String &endpoint)
+
+MqttClientConnectionConfigBuilder & WithEndpoint (Crt::String &&endpoint)
+
+MqttClientConnectionConfigBuilder & WithPortOverride (uint32_t port) noexcept
+
+MqttClientConnectionConfigBuilder & WithCertificateAuthority (const char *caPath) noexcept
+
+MqttClientConnectionConfigBuilder & WithCertificateAuthority (const Crt::ByteCursor &cert) noexcept
+
+MqttClientConnectionConfigBuilder & WithTcpKeepAlive () noexcept
+
+MqttClientConnectionConfigBuilder & WithTcpConnectTimeout (uint32_t connectTimeoutMs) noexcept
+
+MqttClientConnectionConfigBuilder & WithTcpKeepAliveTimeout (uint16_t keepAliveTimeoutSecs) noexcept
+
+MqttClientConnectionConfigBuilder & WithTcpKeepAliveInterval (uint16_t keepAliveIntervalSecs) noexcept
+
+MqttClientConnectionConfigBuilder & WithTcpKeepAliveMaxProbes (uint16_t maxProbes) noexcept
+
+MqttClientConnectionConfigBuilder & WithMinimumTlsVersion (aws_tls_versions minimumTlsVersion) noexcept
+
+MqttClientConnectionConfigBuilder & WithHttpProxyOptions (const Crt::Http::HttpClientConnectionProxyOptions &proxyOptions) noexcept
+
+MqttClientConnectionConfigBuilder & WithMetricsCollection (bool enabled)
+
+MqttClientConnectionConfigBuilder & WithSdkName (const Crt::String &sdkName)
+
+MqttClientConnectionConfigBuilder & WithSdkVersion (const Crt::String &sdkVersion)
+
+MqttClientConnectionConfigBuilder & WithCustomAuthorizer (const Crt::String &username, const Crt::String &authorizerName, const Crt::String &authorizerSignature, const Crt::String &password) noexcept
+
+MqttClientConnectionConfigBuilder & WithCustomAuthorizer (const Crt::String &username, const Crt::String &authorizerName, const Crt::String &authorizerSignature, const Crt::String &password, const Crt::String &tokenKeyName, const Crt::String &tokenValue) noexcept
+
+MqttClientConnectionConfigBuilder & WithUsername (const Crt::String &username) noexcept
+
+MqttClientConnectionConfigBuilder & WithPassword (const Crt::String &password) noexcept
+
+MqttClientConnectionConfig Build () noexcept
+
+ operator bool () const noexcept
+
+int LastError () const 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.
+
+
+
◆ MqttClientConnectionConfigBuilder() [1/7]
+
+
+
+
+
+ Aws::Iot::MqttClientConnectionConfigBuilder::MqttClientConnectionConfigBuilder
+ (
+ )
+
+
+
+
+
+
+
+
+
◆ MqttClientConnectionConfigBuilder() [2/7]
+
+
+
+
+
+
+
+
+ Aws::Iot::MqttClientConnectionConfigBuilder::MqttClientConnectionConfigBuilder
+ (
+ const char *
+ certPath ,
+
+
+
+
+ const char *
+ pkeyPath ,
+
+
+
+
+ Crt::Allocator *
+ allocator = Crt::ApiAllocator ()
+
+
+
+ )
+
+
+
+
+
+noexcept
+
+
+
+
Sets the builder up for MTLS using certPath and pkeyPath. These are files on disk and must be in the PEM format.
+
Parameters
+
+ 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
+
+
+
+
+
+
+
+
◆ MqttClientConnectionConfigBuilder() [3/7]
+
+
+
+
Sets the builder up for MTLS using cert and pkey. These are in-memory buffers and must be in the PEM format.
+
Parameters
+
+ 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
+
+
+
+
+
+
+
+
◆ MqttClientConnectionConfigBuilder() [4/7]
+
+
+
+
Sets the builder up for MTLS, using a PKCS#11 library for private key operations.
+
NOTE: This only works on Unix devices.
+
Parameters
+
+ pkcs11Options PKCS#11 options
+ allocator memory allocator to use
+
+
+
+
+
+
+
+
◆ MqttClientConnectionConfigBuilder() [5/7]
+
+
+
+
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.
+
Parameters
+
+ options The PKCS12 options to use. Has to contain a PKCS12 filepath and password.
+ allocator memory allocator to use
+
+
+
+
+
+
+
+
◆ MqttClientConnectionConfigBuilder() [6/7]
+
+
+
+
+
+
+
+
+ Aws::Iot::MqttClientConnectionConfigBuilder::MqttClientConnectionConfigBuilder
+ (
+ const char *
+ windowsCertStorePath ,
+
+
+
+
+ Crt::Allocator *
+ allocator = Crt::ApiAllocator ()
+
+
+
+ )
+
+
+
+
+
+noexcept
+
+
+
+
Sets the builder up for MTLS, using a certificate in a Windows certificate store.
+
NOTE: This only works on Windows.
+
Parameters
+
+ 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
+
+
+
+
+
+
+
+
◆ MqttClientConnectionConfigBuilder() [7/7]
+
+
+
+
Sets the builder up for Websocket connection.
+
Parameters
+
+ config websocket configuration information
+ allocator memory allocator to use
+
+
+
+
+
+
+
+
+
◆ Build()
+
+
+
+
Builds a client configuration object from the set options.
+
Returns a new client connection config instance
+
+
+
+
+
◆ LastError()
+
+
+
+
+
+
+
+
+ int Aws::Iot::MqttClientConnectionConfigBuilder::LastError
+ (
+ )
+ const
+
+
+
+
+inline noexcept
+
+
+
+
Returns the value of the last aws error encountered by operations on this instance.
+
+
+
+
+
◆ NewDefaultBuilder()
+
+
+
+
+
+
+
+
+
+static noexcept
+
+
+
+
Creates a new builder with default Tls options. This requires setting the connection details manually.
+
Returns a new builder with default Tls options
+
+
+
+
+
◆ operator bool()
+
+
+
+
+
+
+
+
+ Aws::Iot::MqttClientConnectionConfigBuilder::operator bool
+ (
+ )
+ const
+
+
+
+
+inline explicit noexcept
+
+
+
+
Returns true if the instance is in a valid state, false otherwise.
+
+
+
+
+
◆ WithCertificateAuthority() [1/2]
+
+
+
+
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.
+
Parameters
+
+ caPath path to the CA file in PEM format
+
+
+
+
Returns this builder object
+
+
+
+
+
◆ WithCertificateAuthority() [2/2]
+
+
+
+
Sets the certificate authority for the endpoint you're connecting to. This is an in-memory buffer and must be in PEM format.
+
Parameters
+
+ cert buffer containing the CA certificate in a PEM format
+
+
+
+
Returns this builder object
+
+
+
+
+
◆ WithCustomAuthorizer() [1/2]
+
+
+
+
Sets the custom authorizer settings. This function will modify the username, port, and TLS options.
+
Parameters
+
+ 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.
+
+
+
+
Deprecated: Please use the full WithCustomAuthorizer function that includes tokenKeyName
and tokenValue
. This version is left for backwards compatibility purposes.
+
Returns this builder object
+
+
+
+
+
◆ WithCustomAuthorizer() [2/2]
+
+
+
+
Sets the custom authorizer settings. This function will modify the username, port, and TLS options.
+
Parameters
+
+ 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.
+
+
+
+
Returns this builder object
+
+
+
+
+
◆ WithEndpoint() [1/2]
+
+
+
+
Sets endpoint to connect to.
+
Parameters
+
+ endpoint endpoint to connect to
+
+
+
+
Returns this builder object
+
+
+
+
+
◆ WithEndpoint() [2/2]
+
+
+
+
Sets endpoint to connect to.
+
Parameters
+
+ endpoint endpoint to connect to
+
+
+
+
Returns this builder object
+
+
+
+
+
◆ WithHttpProxyOptions()
+
+
+
+
Sets http proxy options.
+
Parameters
+
+ proxyOptions proxy configuration options for connection establishment
+
+
+
+
Returns this builder object
+
+
+
+
+
◆ WithMetricsCollection()
+
+
+
+
Whether to send the SDK name and version number in the MQTT CONNECT packet. Default is True.
+
Parameters
+
+ enabled true to send SDK version/name in the connect for metrics gathering purposes
+
+
+
+
Returns this builder object
+
+
+
+
+
◆ WithMinimumTlsVersion()
+
+
+
+
Sets the minimum tls version that is acceptable for connection establishment
+
Parameters
+
+ minimumTlsVersion minimum tls version allowed in client connections
+
+
+
+
Returns this builder object
+
+
+
+
+
◆ WithPassword()
+
+
+
+
Sets password for the connection
+
Parameters
+
+ password the password that will be passed with the MQTT connection
+
+
+
+
Returns this builder object
+
+
+
+
+
◆ WithPortOverride()
+
+
+
+
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.
+
Parameters
+
+ port port to connect to
+
+
+
+
Returns this builder object
+
+
+
+
+
◆ WithSdkName()
+
+
+
+
Overrides the default SDK Name to send as a metric in the MQTT CONNECT packet.
+
Parameters
+
+ sdkName string to use as the SDK name parameter in the connection string
+
+
+
+
Returns this builder object
+
+
+
+
+
◆ WithSdkVersion()
+
+
+
+
Overrides the default SDK Version to send as a metric in the MQTT CONNECT packet.
+
Parameters
+
+ sdkVersion string to use as the SDK version parameter in the connection string
+
+
+
+
Returns this builder object
+
+
+
+
+
◆ WithTcpConnectTimeout()
+
+
+
+
TCP option: Sets the connect timeout. Defaults to 3 seconds.
+
Parameters
+
+ connectTimeoutMs socket connection timeout
+
+
+
+
Returns this builder object
+
+
+
+
+
◆ WithTcpKeepAlive()
+
+
+
+
TCP option: Enables TCP keep alive. Defaults to off.
+
Returns this builder object
+
+
+
+
+
◆ WithTcpKeepAliveInterval()
+
+
+
+
TCP option: Sets the frequency of sending keep alive probes in seconds once the keep alive timeout expires. Defaults to kernel defaults.
+
Parameters
+
+ keepAliveIntervalSecs the frequency of sending keep alive probes in seconds once the keep alive timeout expires
+
+
+
+
Returns this builder object
+
+
+
+
+
◆ WithTcpKeepAliveMaxProbes()
+
+
+
+
TCP option: Sets the amount of keep alive probes allowed to fail before the connection is terminated. Defaults to kernel defaults.
+
Parameters
+
+ maxProbes the amount of keep alive probes allowed to fail before the connection is terminated
+
+
+
+
Returns this builder object
+
+
+
+
+
◆ WithTcpKeepAliveTimeout()
+
+
+
+
TCP option: Sets time before keep alive probes are sent. Defaults to kernel defaults
+
Parameters
+
+ keepAliveTimeoutSecs time interval of no activity, in seconds, before keep alive probes get sent
+
+
+
+
Returns this builder object
+
+
+
+
+
◆ WithUsername()
+
+
+
+
Sets username for the connection
+
Parameters
+
+ username the username that will be passed with the MQTT connection
+
+
+
+
Returns this builder object
+
+
+
+
The documentation for this class was generated from the following files:
+
+
+
+
+
diff --git a/docs/classes.html b/docs/classes.html
new file mode 100644
index 000000000..ad998da70
--- /dev/null
+++ b/docs/classes.html
@@ -0,0 +1,132 @@
+
+
+
+
+
+
+
+aws-crt-cpp: Class Index
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ aws-crt-cpp
+
+ C++ wrapper around the aws-c-* libraries. Provides Cross-Platform Transport Protocols and SSL/TLS implementations for C++.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/docs/closed.png b/docs/closed.png
new file mode 100644
index 000000000..98cc2c909
Binary files /dev/null and b/docs/closed.png differ
diff --git a/docs/crt_2mqtt_2_mqtt5_client_8h.html b/docs/crt_2mqtt_2_mqtt5_client_8h.html
new file mode 100644
index 000000000..938ea69f1
--- /dev/null
+++ b/docs/crt_2mqtt_2_mqtt5_client_8h.html
@@ -0,0 +1,163 @@
+
+
+
+
+
+
+
+aws-crt-cpp: include/aws/crt/mqtt/Mqtt5Client.h File Reference
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ aws-crt-cpp
+
+ C++ wrapper around the aws-c-* libraries. Provides Cross-Platform Transport Protocols and SSL/TLS implementations for C++.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/docs/crt_2mqtt_2_mqtt5_client_8h_source.html b/docs/crt_2mqtt_2_mqtt5_client_8h_source.html
new file mode 100644
index 000000000..d00fb8bf3
--- /dev/null
+++ b/docs/crt_2mqtt_2_mqtt5_client_8h_source.html
@@ -0,0 +1,470 @@
+
+
+
+
+
+
+
+aws-crt-cpp: include/aws/crt/mqtt/Mqtt5Client.h Source File
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ aws-crt-cpp
+
+ C++ wrapper around the aws-c-* libraries. Provides Cross-Platform Transport Protocols and SSL/TLS implementations for C++.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
Go to the documentation of this file.
+
+
+
+
+
+
+
+
+
+
+
+
+
18 class DisconnectPacket;
+
+
20 class Mqtt5ClientOptions;
+
21 class NegotiatedSettings;
+
+
+
+
25 class SubscribePacket;
+
+
27 class UnsubscribePacket;
+
+
29 class Mqtt5ClientCore;
+
+
31 class Mqtt5to3AdapterOptions;
+
+
+
+
+
46 Default = AWS_MQTT5_COTABT_DEFAULT,
+
+
56 Manual = AWS_MQTT5_COTABT_MANUAL,
+
+
62 LRU = AWS_MQTT5_COTABT_LRU,
+
+
67 Disabled = AWS_MQTT5_COTABT_DISABLED,
+
+
+
+
+
+
84 Default = AWS_MQTT5_CITABT_DEFAULT,
+
+
89 Enabled = AWS_MQTT5_CITABT_ENABLED,
+
+
94 Disabled = AWS_MQTT5_CITABT_DISABLED,
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
315 std::function<void(
const std::shared_ptr<Http::HttpRequest> &,
int )>;
+
+
+
+
+
+
+
+
+
+
343 static std::shared_ptr<Mqtt5Client> NewMqtt5Client(
+
+
+
+
+
+
358 operator bool() const noexcept;
+
+
+
+
372 bool Start() const noexcept;
+
+
380 bool Stop() noexcept;
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
442 std ::shared_ptr<Mqtt5ClientCore> m_client_core;
+
+
+
+
+
+
+
452 friend class Mqtt5ClientCore;
+
453 friend class Mqtt5to3AdapterOptions;
+
+
+
+
+
+
+
+
+
+
+
+
+
505 Mqtt5ClientOptions &WithTlsConnectionOptions(const Io::TlsConnectionOptions &tslOptions) noexcept;
+
+
+
515 const Crt::Http::HttpClientConnectionProxyOptions &proxyOptions) noexcept;
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
695 bool initializeRawOptions(aws_mqtt5_client_options &raw_options) const noexcept;
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
762 Io::ClientBootstrap *m_bootstrap;
+
+
768 Crt::Io::SocketOptions m_socketOptions;
+
+
774 Crt::
Optional <Crt::Io::TlsConnectionOptions> m_tlsConnectionOptions;
+
+
779 Crt::
Optional <Crt::Http::HttpClientConnectionProxyOptions> m_proxyOptions;
+
+
+
+
+
+
+
+
+
+
+
+
814 aws_mqtt5_client_topic_alias_options m_topicAliasingOptions;
+
+
820 uint32_t m_pingTimeoutMs;
+
+
826 uint32_t m_connackTimeoutMs;
+
+
832 uint32_t m_ackTimeoutSec;
+
+
+
+
836 aws_http_proxy_options m_httpProxyOptionsStorage;
+
837 aws_mqtt5_packet_connect_view m_packetConnectViewStorage;
+
+
+
+
+
+
#define AWS_CRT_CPP_API
Definition: Exports.h:37
+
+
+
Definition: Mqtt5Packets.h:663
+
Definition: Mqtt5Packets.h:1551
+
Definition: Mqtt5Client.h:332
+
Definition: Mqtt5Client.h:451
+
Definition: Mqtt5Packets.h:53
+
Definition: Mqtt5Packets.h:2029
+
Definition: Mqtt5Packets.h:2235
+
Definition: MqttConnection.h:158
+
+
+
aws_mqtt5_client_operation_queue_behavior_type ClientOperationQueueBehaviorType
Definition: Mqtt5Types.h:223
+
InboundTopicAliasBehaviorType
Definition: Mqtt5Client.h:78
+
+
+
+
std::function< void(const std::shared_ptr< Http::HttpRequest > &, int)> OnWebSocketHandshakeInterceptComplete
Definition: Mqtt5Client.h:315
+
aws_mqtt5_client_session_behavior_type ClientSessionBehaviorType
Definition: Mqtt5Types.h:186
+
std::function< void(const PublishReceivedEventData &)> OnPublishReceivedHandler
Definition: Mqtt5Client.h:308
+
std::function< void(int, std::shared_ptr< PublishResult >)> OnPublishCompletionHandler
Definition: Mqtt5Client.h:293
+
std::function< void(const OnStoppedEventData &)> OnStoppedHandler
Definition: Mqtt5Client.h:288
+
std::function< void(const OnDisconnectionEventData &)> OnDisconnectionHandler
Definition: Mqtt5Client.h:276
+
OutboundTopicAliasBehaviorType
Definition: Mqtt5Client.h:40
+
+
+
+
+
std::function< void(const OnConnectionSuccessEventData &)> OnConnectionSuccessHandler
Definition: Mqtt5Client.h:266
+
std::function< void(const OnAttemptingConnectEventData &)> OnAttemptingConnectHandler
Definition: Mqtt5Client.h:282
+
aws_exponential_backoff_jitter_mode ExponentialBackoffJitterMode
Definition: Mqtt5Types.h:242
+
std::function< void(std::shared_ptr< Http::HttpRequest >, const OnWebSocketHandshakeInterceptComplete &)> OnWebSocketHandshakeIntercept
Definition: Mqtt5Client.h:324
+
std::function< void(const OnConnectionFailureEventData &)> OnConnectionFailureHandler
Definition: Mqtt5Client.h:271
+
aws_mqtt5_extended_validation_and_flow_control_options ClientExtendedValidationAndFlowControl
Definition: Mqtt5Types.h:200
+
std::function< void(int, std::shared_ptr< UnSubAckPacket >)> OnUnsubscribeCompletionHandler
Definition: Mqtt5Client.h:303
+
std::function< void(int, std::shared_ptr< SubAckPacket >)> OnSubscribeCompletionHandler
Definition: Mqtt5Client.h:298
+
aws_allocator Allocator
Definition: Allocator.h:14
+
AWS_CRT_CPP_API Allocator * ApiAllocator() noexcept
Definition: Allocator.cpp:24
+
std::basic_string< char, std::char_traits< char >, StlAllocator< char > > String
Definition: Types.h:45
+
AWS_CRT_CPP_API int LastError() noexcept
Definition: Api.cpp:422
+
Definition: Allocator.h:11
+
Definition: StringView.h:852
+
Definition: Mqtt5Client.h:176
+
uint64_t unackedOperationCount
Definition: Mqtt5Client.h:193
+
uint64_t incompleteOperationSize
Definition: Mqtt5Client.h:187
+
uint64_t incompleteOperationCount
Definition: Mqtt5Client.h:181
+
uint64_t unackedOperationSize
Definition: Mqtt5Client.h:199
+
Definition: Mqtt5Client.h:207
+
OnAttemptingConnectEventData()
Definition: Mqtt5Client.h:208
+
Definition: Mqtt5Client.h:215
+
std::shared_ptr< ConnAckPacket > connAckPacket
Definition: Mqtt5Client.h:219
+
int errorCode
Definition: Mqtt5Client.h:218
+
OnConnectionFailureEventData()
Definition: Mqtt5Client.h:216
+
Definition: Mqtt5Client.h:226
+
std::shared_ptr< ConnAckPacket > connAckPacket
Definition: Mqtt5Client.h:229
+
OnConnectionSuccessEventData()
Definition: Mqtt5Client.h:227
+
std::shared_ptr< NegotiatedSettings > negotiatedSettings
Definition: Mqtt5Client.h:230
+
Definition: Mqtt5Client.h:237
+
int errorCode
Definition: Mqtt5Client.h:240
+
std::shared_ptr< DisconnectPacket > disconnectPacket
Definition: Mqtt5Client.h:241
+
OnDisconnectionEventData()
Definition: Mqtt5Client.h:238
+
Definition: Mqtt5Client.h:249
+
OnStoppedEventData()
Definition: Mqtt5Client.h:250
+
Definition: Mqtt5Client.h:257
+
std::shared_ptr< PublishPacket > publishPacket
Definition: Mqtt5Client.h:259
+
PublishReceivedEventData()
Definition: Mqtt5Client.h:258
+
Definition: Mqtt5Client.h:145
+
uint64_t m_minReconnectDelayMs
Definition: Mqtt5Client.h:156
+
uint64_t m_minConnectedTimeToResetReconnectDelayMs
Definition: Mqtt5Client.h:169
+
uint64_t m_maxReconnectDelayMs
Definition: Mqtt5Client.h:162
+
ExponentialBackoffJitterMode m_reconnectMode
Definition: Mqtt5Client.h:150
+
Definition: Mqtt5Client.h:101
+
Crt::Optional< InboundTopicAliasBehaviorType > m_inboundBehavior
Definition: Mqtt5Client.h:131
+
Crt::Optional< OutboundTopicAliasBehaviorType > m_outboundBehavior
Definition: Mqtt5Client.h:111
+
Crt::Optional< uint16_t > m_outboundCacheMaxSize
Definition: Mqtt5Client.h:123
+
Crt::Optional< uint16_t > m_inboundCacheMaxSize
Definition: Mqtt5Client.h:141
+
+
+
+
+
diff --git a/docs/crt_2mqtt_2_mqtt_client_8h.html b/docs/crt_2mqtt_2_mqtt_client_8h.html
new file mode 100644
index 000000000..ef06e04e9
--- /dev/null
+++ b/docs/crt_2mqtt_2_mqtt_client_8h.html
@@ -0,0 +1,117 @@
+
+
+
+
+
+
+
+aws-crt-cpp: include/aws/crt/mqtt/MqttClient.h File Reference
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ 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.
+
+
+
+
+
+
diff --git a/docs/crt_2mqtt_2_mqtt_client_8h_source.html b/docs/crt_2mqtt_2_mqtt_client_8h_source.html
new file mode 100644
index 000000000..1ea7d9af2
--- /dev/null
+++ b/docs/crt_2mqtt_2_mqtt_client_8h_source.html
@@ -0,0 +1,169 @@
+
+
+
+
+
+
+
+aws-crt-cpp: include/aws/crt/mqtt/MqttClient.h Source File
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ aws-crt-cpp
+
+ C++ wrapper around the aws-c-* libraries. Provides Cross-Platform Transport Protocols and SSL/TLS implementations for C++.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
Go to the documentation of this file.
+
+
+
+
+
+
+
+
+
14 #include <aws/mqtt/client.h>
+
15 #include <aws/mqtt/v5/mqtt5_client.h>
+
+
+
+
+
+
+
+
+
+
+
+
27 class ClientBootstrap;
+
+
+
+
+
+
+
+
+
+
37 class Mqtt5ClientCore;
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
72 operator
bool () const noexcept;
+
+
+
+
+
+
+
95 const Io::SocketOptions &socketOptions,
+
96 const Crt::Io::TlsContext &tlsContext,
+
97 bool useWebsocket = false) noexcept;
+
+
+
111 const
char *hostName,
+
+
113 const Io::SocketOptions &socketOptions,
+
114 bool useWebsocket = false) noexcept;
+
+
+
117 aws_mqtt_client *m_client;
+
+
+
+
+
+
#define AWS_CRT_CPP_API
Definition: Exports.h:37
+
+
+
+
+
+
+
Definition: Bootstrap.h:35
+
Definition: MqttClient.h:48
+
MqttClient(const MqttClient &)=delete
+
Definition: MqttConnection.h:158
+
aws_allocator Allocator
Definition: Allocator.h:14
+
AWS_CRT_CPP_API Allocator * ApiAllocator() noexcept
Definition: Allocator.cpp:24
+
AWS_CRT_CPP_API int LastError() noexcept
Definition: Api.cpp:422
+
Definition: Allocator.h:11
+
Definition: StringView.h:852
+
+
+
+
+
diff --git a/docs/deprecated.html b/docs/deprecated.html
new file mode 100644
index 000000000..31fc031e6
--- /dev/null
+++ b/docs/deprecated.html
@@ -0,0 +1,136 @@
+
+
+
+
+
+
+
+aws-crt-cpp: Deprecated List
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ aws-crt-cpp
+
+ C++ wrapper around the aws-c-* libraries. Provides Cross-Platform Transport Protocols and SSL/TLS implementations for C++.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Member Aws::Crt::Auth::SignedBodyValue::EmptySha256
+ to avoid issues with /DELAYLOAD on Windows.
+Member Aws::Crt::Auth::SignedBodyValue::StreamingAws4HmacSha256Events
+ to avoid issues with /DELAYLOAD on Windows.
+Member Aws::Crt::Auth::SignedBodyValue::StreamingAws4HmacSha256Payload
+ to avoid issues with /DELAYLOAD on Windows.
+Member Aws::Crt::Auth::SignedBodyValue::UnsignedPayload
+ to avoid issues with /DELAYLOAD on Windows.
+Member Aws::Crt::DefaultAllocator () noexcept
+ Use DefaultAllocatorImplementation() instead. DefaultAllocator() is too easily confused with ApiAllocator() .
+Member Aws::Crt::g_allocator
+ Use ApiAllocator() instead, to avoid issues with delay-loaded DLLs. https://github.com/aws/aws-sdk-cpp/issues/1960
+Member Aws::Crt::Http::AwsHttpProxyAuthenticationType
+ enum that designates what kind of authentication, if any, to use when connecting to a proxy server.
+Member Aws::Crt::Http::HttpClientConnectionProxyOptions::AuthType
+ What kind of authentication approach to use when connecting to the proxy Replaced by proxy strategy
+Member Aws::Crt::Http::HttpClientConnectionProxyOptions::BasicAuthPassword
+ The password to use if connecting to the proxy via basic authentication Replaced by using the result of CreateBasicHttpProxyStrategy()
+Member Aws::Crt::Http::HttpClientConnectionProxyOptions::BasicAuthUsername
+ The username to use if connecting to the proxy via basic authentication Replaced by using the result of CreateBasicHttpProxyStrategy()
+Member Aws::Crt::Io::OffsetType
+ Use int64_t instead for offsets in public APIs.
+Member Aws::Crt::Io::TlsContextOptions::SetKeychainPath (ByteCursor &keychain_path) noexcept
+ Custom keychain management is deprecated.
+Member Aws::Crt::JsonObject::GetErrorMessage () const
+
+Member Aws::Crt::Mqtt5::ConnAckPacket::getServerKeepAlive () const noexcept
+ The function is deprecated, please use 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.
+Member Aws::Crt::Mqtt5::ConnAckPacket::getSessionExpiryInterval () const noexcept
+ The function is deprecated, please use ConnAckPacket::getSessionExpiryIntervalSec()
.
+Member Aws::Crt::Mqtt5::ConnectPacket::getMaximumPacketSizeBytes () const noexcept
+ The function is deprecated, please use ConnectPacket::getMaximumPacketSizeToServer()
+Member Aws::Crt::Mqtt5::JitterMode
+ JitterMode is deprecated, please use Aws::Crt::Mqtt5::ExponentialBackoffJitterMode
+Member Aws::Crt::Mqtt5::Mqtt5ClientOptions::WithAckTimeoutSeconds (uint32_t ackTimeoutSec) noexcept
+ The function is deprecated, please use Mqtt5ClientOptions::WithAckTimeoutSec(uint32_t)
+Member Aws::Crt::Mqtt5::NegotiatedSettings::getMaximumPacketSizeBytes () const noexcept
+ the function is deprecated, please use NegotiatedSettings::getMaximumPacketSizeToServer()
+Member Aws::Crt::Mqtt5::NegotiatedSettings::getServerKeepAlive () const noexcept
+ The function is deprecated, please use NegotiatedSettings::getServerKeepAliveSec()
+Member Aws::Crt::Mqtt5::Subscription::WithRetain (bool retain) noexcept
+ The function is deprecated, please use Subscription::WithRetainAsPublished(bool)
.
+Member Aws::Crt::Mqtt::MqttConnection::SetOnMessageHandler (OnPublishReceivedHandler &&onPublish) noexcept
+ Use alternate SetOnMessageHandler()
+Member Aws::Crt::Mqtt::MqttConnection::SetWebsocketProxyOptions (const Http::HttpClientConnectionProxyOptions &proxyOptions) noexcept
+ Sets websocket proxy options. Replaced by SetHttpProxyOptions.
+Member Aws::Crt::Mqtt::MqttConnection::Subscribe (const char *topicFilter, QOS qos, OnPublishReceivedHandler &&onPublish, OnSubAckHandler &&onSubAck) noexcept
+ Use alternate Subscribe()
+Member Aws::Crt::Mqtt::MqttConnection::Subscribe (const Vector< std::pair< const char *, OnPublishReceivedHandler >> &topicFilters, QOS qos, OnMultiSubAckHandler &&onOpComplete) noexcept
+ Use alternate Subscribe()
+Member Aws::Crt::Mqtt::OnPublishReceivedHandler
+ Use OnMessageReceivedHandler
+Member Aws::Iot::Mqtt5ClientBuilder::WithAckTimeoutSeconds (uint32_t ackTimeoutSec) noexcept
+ the function is deprecated, please use Mqtt5ClientBuilder::WithAckTimeoutSec(uint32_t)
+Member Aws::Iot::MqttClientConnectionConfigBuilder::WithCustomAuthorizer (const Crt::String &username, const Crt::String &authorizerName, const Crt::String &authorizerSignature, const Crt::String &password) noexcept
+ Please use the full WithCustomAuthorizer function that includes tokenKeyName
and tokenValue
. This version is left for backwards compatibility purposes.
+Member Aws::Iot::WebsocketConfig::ProxyOptions
+ Specify ProxyOptions to use a proxy with your websocket connection.
+
+
+
+
+
+
+
diff --git a/docs/dir_04c8c256ddd3d4d2b725277e76e78a65.html b/docs/dir_04c8c256ddd3d4d2b725277e76e78a65.html
new file mode 100644
index 000000000..71253c9eb
--- /dev/null
+++ b/docs/dir_04c8c256ddd3d4d2b725277e76e78a65.html
@@ -0,0 +1,95 @@
+
+
+
+
+
+
+
+aws-crt-cpp: source/mqtt Directory Reference
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ aws-crt-cpp
+
+ C++ wrapper around the aws-c-* libraries. Provides Cross-Platform Transport Protocols and SSL/TLS implementations for C++.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/docs/dir_076842b242c291358044feb169933571.html b/docs/dir_076842b242c291358044feb169933571.html
new file mode 100644
index 000000000..772497845
--- /dev/null
+++ b/docs/dir_076842b242c291358044feb169933571.html
@@ -0,0 +1,87 @@
+
+
+
+
+
+
+
+aws-crt-cpp: include/aws Directory Reference
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ aws-crt-cpp
+
+ C++ wrapper around the aws-c-* libraries. Provides Cross-Platform Transport Protocols and SSL/TLS implementations for C++.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+directory crt
+
+directory iot
+
+
+
+
+
+
+
diff --git a/docs/dir_081d715f5a77a25d34a14961a14d5f62.html b/docs/dir_081d715f5a77a25d34a14961a14d5f62.html
new file mode 100644
index 000000000..ae3bd0353
--- /dev/null
+++ b/docs/dir_081d715f5a77a25d34a14961a14d5f62.html
@@ -0,0 +1,85 @@
+
+
+
+
+
+
+
+aws-crt-cpp: source/checksum Directory Reference
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ aws-crt-cpp
+
+ C++ wrapper around the aws-c-* libraries. Provides Cross-Platform Transport Protocols and SSL/TLS implementations for C++.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/docs/dir_12b2122a6630e500be21d46b9260b463.html b/docs/dir_12b2122a6630e500be21d46b9260b463.html
new file mode 100644
index 000000000..23e9704f7
--- /dev/null
+++ b/docs/dir_12b2122a6630e500be21d46b9260b463.html
@@ -0,0 +1,85 @@
+
+
+
+
+
+
+
+aws-crt-cpp: include/aws/crt/endpoints Directory Reference
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ aws-crt-cpp
+
+ C++ wrapper around the aws-c-* libraries. Provides Cross-Platform Transport Protocols and SSL/TLS implementations for C++.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/docs/dir_1c1b7215ba3c1921bc48512504dbf020.html b/docs/dir_1c1b7215ba3c1921bc48512504dbf020.html
new file mode 100644
index 000000000..64b92cd04
--- /dev/null
+++ b/docs/dir_1c1b7215ba3c1921bc48512504dbf020.html
@@ -0,0 +1,89 @@
+
+
+
+
+
+
+
+aws-crt-cpp: include/aws/crt/auth Directory Reference
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ aws-crt-cpp
+
+ C++ wrapper around the aws-c-* libraries. Provides Cross-Platform Transport Protocols and SSL/TLS implementations for C++.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/docs/dir_20a4262475d17d480fb582298e38031f.html b/docs/dir_20a4262475d17d480fb582298e38031f.html
new file mode 100644
index 000000000..fbbe456d3
--- /dev/null
+++ b/docs/dir_20a4262475d17d480fb582298e38031f.html
@@ -0,0 +1,85 @@
+
+
+
+
+
+
+
+aws-crt-cpp: source/cbor Directory Reference
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ aws-crt-cpp
+
+ C++ wrapper around the aws-c-* libraries. Provides Cross-Platform Transport Protocols and SSL/TLS implementations for C++.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/docs/dir_250558fd2cbacd247a45c0a39807db85.html b/docs/dir_250558fd2cbacd247a45c0a39807db85.html
new file mode 100644
index 000000000..188dff453
--- /dev/null
+++ b/docs/dir_250558fd2cbacd247a45c0a39807db85.html
@@ -0,0 +1,79 @@
+
+
+
+
+
+
+
+aws-crt-cpp: docsrc Directory Reference
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ aws-crt-cpp
+
+ C++ wrapper around the aws-c-* libraries. Provides Cross-Platform Transport Protocols and SSL/TLS implementations for C++.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/docs/dir_39e380afaaa4ac8ea3c0de67127c8f7f.html b/docs/dir_39e380afaaa4ac8ea3c0de67127c8f7f.html
new file mode 100644
index 000000000..ca78af9a5
--- /dev/null
+++ b/docs/dir_39e380afaaa4ac8ea3c0de67127c8f7f.html
@@ -0,0 +1,91 @@
+
+
+
+
+
+
+
+aws-crt-cpp: include/aws/crt/crypto Directory Reference
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ aws-crt-cpp
+
+ C++ wrapper around the aws-c-* libraries. Provides Cross-Platform Transport Protocols and SSL/TLS implementations for C++.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/docs/dir_43a9159a778c24a13ede58ea1064589b.html b/docs/dir_43a9159a778c24a13ede58ea1064589b.html
new file mode 100644
index 000000000..0ab6d3926
--- /dev/null
+++ b/docs/dir_43a9159a778c24a13ede58ea1064589b.html
@@ -0,0 +1,85 @@
+
+
+
+
+
+
+
+aws-crt-cpp: include/aws/crt/checksum Directory Reference
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ aws-crt-cpp
+
+ C++ wrapper around the aws-c-* libraries. Provides Cross-Platform Transport Protocols and SSL/TLS implementations for C++.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/docs/dir_510e4d76c639d1d492d492e3db24aaea.html b/docs/dir_510e4d76c639d1d492d492e3db24aaea.html
new file mode 100644
index 000000000..4ba2b8ad3
--- /dev/null
+++ b/docs/dir_510e4d76c639d1d492d492e3db24aaea.html
@@ -0,0 +1,87 @@
+
+
+
+
+
+
+
+aws-crt-cpp: include/aws/crt/mqtt/private Directory Reference
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ aws-crt-cpp
+
+ C++ wrapper around the aws-c-* libraries. Provides Cross-Platform Transport Protocols and SSL/TLS implementations for C++.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/docs/dir_59c38d69605e708946f03ec64f0b9d1a.html b/docs/dir_59c38d69605e708946f03ec64f0b9d1a.html
new file mode 100644
index 000000000..365a8fdf8
--- /dev/null
+++ b/docs/dir_59c38d69605e708946f03ec64f0b9d1a.html
@@ -0,0 +1,100 @@
+
+
+
+
+
+
+
+aws-crt-cpp: include/aws/crt/mqtt Directory Reference
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ aws-crt-cpp
+
+ C++ wrapper around the aws-c-* libraries. Provides Cross-Platform Transport Protocols and SSL/TLS implementations for C++.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/docs/dir_5adc267537e57ad8b251376e8df66131.html b/docs/dir_5adc267537e57ad8b251376e8df66131.html
new file mode 100644
index 000000000..197ca0c4e
--- /dev/null
+++ b/docs/dir_5adc267537e57ad8b251376e8df66131.html
@@ -0,0 +1,85 @@
+
+
+
+
+
+
+
+aws-crt-cpp: source/endpoints Directory Reference
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ aws-crt-cpp
+
+ C++ wrapper around the aws-c-* libraries. Provides Cross-Platform Transport Protocols and SSL/TLS implementations for C++.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/docs/dir_80c9bbdb0d239ca6adfcaca0891dbb0e.html b/docs/dir_80c9bbdb0d239ca6adfcaca0891dbb0e.html
new file mode 100644
index 000000000..fa78c74b0
--- /dev/null
+++ b/docs/dir_80c9bbdb0d239ca6adfcaca0891dbb0e.html
@@ -0,0 +1,101 @@
+
+
+
+
+
+
+
+aws-crt-cpp: source/io Directory Reference
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ aws-crt-cpp
+
+ C++ wrapper around the aws-c-* libraries. Provides Cross-Platform Transport Protocols and SSL/TLS implementations for C++.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/docs/dir_a5b00f0db1e9136a9dc3f36a4acdccb6.html b/docs/dir_a5b00f0db1e9136a9dc3f36a4acdccb6.html
new file mode 100644
index 000000000..6289b831c
--- /dev/null
+++ b/docs/dir_a5b00f0db1e9136a9dc3f36a4acdccb6.html
@@ -0,0 +1,87 @@
+
+
+
+
+
+
+
+aws-crt-cpp: source/auth Directory Reference
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ aws-crt-cpp
+
+ C++ wrapper around the aws-c-* libraries. Provides Cross-Platform Transport Protocols and SSL/TLS implementations for C++.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/docs/dir_b2f33c71d4aa5e7af42a1ca61ff5af1b.html b/docs/dir_b2f33c71d4aa5e7af42a1ca61ff5af1b.html
new file mode 100644
index 000000000..1ac3ed491
--- /dev/null
+++ b/docs/dir_b2f33c71d4aa5e7af42a1ca61ff5af1b.html
@@ -0,0 +1,120 @@
+
+
+
+
+
+
+
+aws-crt-cpp: source Directory Reference
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ aws-crt-cpp
+
+ C++ wrapper around the aws-c-* libraries. Provides Cross-Platform Transport Protocols and SSL/TLS implementations for C++.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/docs/dir_b63d257f1e67c216f4109ce7d5120ec1.html b/docs/dir_b63d257f1e67c216f4109ce7d5120ec1.html
new file mode 100644
index 000000000..690cc2ac0
--- /dev/null
+++ b/docs/dir_b63d257f1e67c216f4109ce7d5120ec1.html
@@ -0,0 +1,89 @@
+
+
+
+
+
+
+
+aws-crt-cpp: source/iot Directory Reference
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ aws-crt-cpp
+
+ C++ wrapper around the aws-c-* libraries. Provides Cross-Platform Transport Protocols and SSL/TLS implementations for C++.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/docs/dir_b7cefccc70786e24fcc1cc9528dacb60.html b/docs/dir_b7cefccc70786e24fcc1cc9528dacb60.html
new file mode 100644
index 000000000..9ba5d6283
--- /dev/null
+++ b/docs/dir_b7cefccc70786e24fcc1cc9528dacb60.html
@@ -0,0 +1,89 @@
+
+
+
+
+
+
+
+aws-crt-cpp: include/aws/iot Directory Reference
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ aws-crt-cpp
+
+ C++ wrapper around the aws-c-* libraries. Provides Cross-Platform Transport Protocols and SSL/TLS implementations for C++.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/docs/dir_b90b4e231cf9df4b6b8451850277e486.html b/docs/dir_b90b4e231cf9df4b6b8451850277e486.html
new file mode 100644
index 000000000..22530956f
--- /dev/null
+++ b/docs/dir_b90b4e231cf9df4b6b8451850277e486.html
@@ -0,0 +1,101 @@
+
+
+
+
+
+
+
+aws-crt-cpp: include/aws/crt/io Directory Reference
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ aws-crt-cpp
+
+ C++ wrapper around the aws-c-* libraries. Provides Cross-Platform Transport Protocols and SSL/TLS implementations for C++.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/docs/dir_b9cf997aa404a6575cbcba2c72e5e814.html b/docs/dir_b9cf997aa404a6575cbcba2c72e5e814.html
new file mode 100644
index 000000000..22a59bb3c
--- /dev/null
+++ b/docs/dir_b9cf997aa404a6575cbcba2c72e5e814.html
@@ -0,0 +1,91 @@
+
+
+
+
+
+
+
+aws-crt-cpp: source/http Directory Reference
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ aws-crt-cpp
+
+ C++ wrapper around the aws-c-* libraries. Provides Cross-Platform Transport Protocols and SSL/TLS implementations for C++.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/docs/dir_c6a1385c7766bf4afb2ab58934c6d76d.html b/docs/dir_c6a1385c7766bf4afb2ab58934c6d76d.html
new file mode 100644
index 000000000..be2469c52
--- /dev/null
+++ b/docs/dir_c6a1385c7766bf4afb2ab58934c6d76d.html
@@ -0,0 +1,91 @@
+
+
+
+
+
+
+
+aws-crt-cpp: source/crypto Directory Reference
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ aws-crt-cpp
+
+ C++ wrapper around the aws-c-* libraries. Provides Cross-Platform Transport Protocols and SSL/TLS implementations for C++.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/docs/dir_cc4322e4b2151c90adb7cd2e3f54423a.html b/docs/dir_cc4322e4b2151c90adb7cd2e3f54423a.html
new file mode 100644
index 000000000..3b30ad5e7
--- /dev/null
+++ b/docs/dir_cc4322e4b2151c90adb7cd2e3f54423a.html
@@ -0,0 +1,132 @@
+
+
+
+
+
+
+
+aws-crt-cpp: include/aws/crt Directory Reference
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ aws-crt-cpp
+
+ C++ wrapper around the aws-c-* libraries. Provides Cross-Platform Transport Protocols and SSL/TLS implementations for C++.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/docs/dir_d44c64559bbebec7f509842c48db8b23.html b/docs/dir_d44c64559bbebec7f509842c48db8b23.html
new file mode 100644
index 000000000..78c5ff37b
--- /dev/null
+++ b/docs/dir_d44c64559bbebec7f509842c48db8b23.html
@@ -0,0 +1,85 @@
+
+
+
+
+
+
+
+aws-crt-cpp: include Directory Reference
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ aws-crt-cpp
+
+ C++ wrapper around the aws-c-* libraries. Provides Cross-Platform Transport Protocols and SSL/TLS implementations for C++.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/docs/dir_def7896f1424c25315a9bd6c1620485d.html b/docs/dir_def7896f1424c25315a9bd6c1620485d.html
new file mode 100644
index 000000000..0326cc019
--- /dev/null
+++ b/docs/dir_def7896f1424c25315a9bd6c1620485d.html
@@ -0,0 +1,85 @@
+
+
+
+
+
+
+
+aws-crt-cpp: include/aws/crt/cbor Directory Reference
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ aws-crt-cpp
+
+ C++ wrapper around the aws-c-* libraries. Provides Cross-Platform Transport Protocols and SSL/TLS implementations for C++.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/docs/dir_e8db083dcbf399d3a7f9ad98d39e0e38.html b/docs/dir_e8db083dcbf399d3a7f9ad98d39e0e38.html
new file mode 100644
index 000000000..575ba0ead
--- /dev/null
+++ b/docs/dir_e8db083dcbf399d3a7f9ad98d39e0e38.html
@@ -0,0 +1,91 @@
+
+
+
+
+
+
+
+aws-crt-cpp: include/aws/crt/http Directory Reference
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ aws-crt-cpp
+
+ C++ wrapper around the aws-c-* libraries. Provides Cross-Platform Transport Protocols and SSL/TLS implementations for C++.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/docs/doc.png b/docs/doc.png
new file mode 100644
index 000000000..17edabff9
Binary files /dev/null and b/docs/doc.png differ
diff --git a/docs/doxygen.css b/docs/doxygen.css
new file mode 100644
index 000000000..ffbff0224
--- /dev/null
+++ b/docs/doxygen.css
@@ -0,0 +1,1793 @@
+/* The standard CSS for doxygen 1.9.1 */
+
+body, table, div, p, dl {
+ font: 400 14px/22px Roboto,sans-serif;
+}
+
+p.reference, p.definition {
+ font: 400 14px/22px Roboto,sans-serif;
+}
+
+/* @group Heading Levels */
+
+h1.groupheader {
+ font-size: 150%;
+}
+
+.title {
+ font: 400 14px/28px Roboto,sans-serif;
+ font-size: 150%;
+ font-weight: bold;
+ margin: 10px 2px;
+}
+
+h2.groupheader {
+ border-bottom: 1px solid #879ECB;
+ color: #354C7B;
+ font-size: 150%;
+ font-weight: normal;
+ margin-top: 1.75em;
+ padding-top: 8px;
+ padding-bottom: 4px;
+ width: 100%;
+}
+
+h3.groupheader {
+ font-size: 100%;
+}
+
+h1, h2, h3, h4, h5, h6 {
+ -webkit-transition: text-shadow 0.5s linear;
+ -moz-transition: text-shadow 0.5s linear;
+ -ms-transition: text-shadow 0.5s linear;
+ -o-transition: text-shadow 0.5s linear;
+ transition: text-shadow 0.5s linear;
+ margin-right: 15px;
+}
+
+h1.glow, h2.glow, h3.glow, h4.glow, h5.glow, h6.glow {
+ text-shadow: 0 0 15px cyan;
+}
+
+dt {
+ font-weight: bold;
+}
+
+ul.multicol {
+ -moz-column-gap: 1em;
+ -webkit-column-gap: 1em;
+ column-gap: 1em;
+ -moz-column-count: 3;
+ -webkit-column-count: 3;
+ column-count: 3;
+}
+
+p.startli, p.startdd {
+ margin-top: 2px;
+}
+
+th p.starttd, th p.intertd, th p.endtd {
+ font-size: 100%;
+ font-weight: 700;
+}
+
+p.starttd {
+ margin-top: 0px;
+}
+
+p.endli {
+ margin-bottom: 0px;
+}
+
+p.enddd {
+ margin-bottom: 4px;
+}
+
+p.endtd {
+ margin-bottom: 2px;
+}
+
+p.interli {
+}
+
+p.interdd {
+}
+
+p.intertd {
+}
+
+/* @end */
+
+caption {
+ font-weight: bold;
+}
+
+span.legend {
+ font-size: 70%;
+ text-align: center;
+}
+
+h3.version {
+ font-size: 90%;
+ text-align: center;
+}
+
+div.navtab {
+ border-right: 1px solid #A3B4D7;
+ padding-right: 15px;
+ text-align: right;
+ line-height: 110%;
+}
+
+div.navtab table {
+ border-spacing: 0;
+}
+
+td.navtab {
+ padding-right: 6px;
+ padding-left: 6px;
+}
+td.navtabHL {
+ background-image: url('tab_a.png');
+ background-repeat:repeat-x;
+ padding-right: 6px;
+ padding-left: 6px;
+}
+
+td.navtabHL a, td.navtabHL a:visited {
+ color: #fff;
+ text-shadow: 0px 1px 1px rgba(0, 0, 0, 1.0);
+}
+
+a.navtab {
+ font-weight: bold;
+}
+
+div.qindex{
+ text-align: center;
+ width: 100%;
+ line-height: 140%;
+ font-size: 130%;
+ color: #A0A0A0;
+}
+
+dt.alphachar{
+ font-size: 180%;
+ font-weight: bold;
+}
+
+.alphachar a{
+ color: black;
+}
+
+.alphachar a:hover, .alphachar a:visited{
+ text-decoration: none;
+}
+
+.classindex dl {
+ padding: 25px;
+ column-count:1
+}
+
+.classindex dd {
+ display:inline-block;
+ margin-left: 50px;
+ width: 90%;
+ line-height: 1.15em;
+}
+
+.classindex dl.odd {
+ background-color: #F8F9FC;
+}
+
+@media(min-width: 1120px) {
+ .classindex dl {
+ column-count:2
+ }
+}
+
+@media(min-width: 1320px) {
+ .classindex dl {
+ column-count:3
+ }
+}
+
+
+/* @group Link Styling */
+
+a {
+ color: #3D578C;
+ font-weight: normal;
+ text-decoration: none;
+}
+
+.contents a:visited {
+ color: #4665A2;
+}
+
+a:hover {
+ text-decoration: underline;
+}
+
+.contents a.qindexHL:visited {
+ color: #FFFFFF;
+}
+
+a.el {
+ font-weight: bold;
+}
+
+a.elRef {
+}
+
+a.code, a.code:visited, a.line, a.line:visited {
+ color: #4665A2;
+}
+
+a.codeRef, a.codeRef:visited, a.lineRef, a.lineRef:visited {
+ color: #4665A2;
+}
+
+/* @end */
+
+dl.el {
+ margin-left: -1cm;
+}
+
+ul {
+ overflow: hidden; /*Fixed: list item bullets overlap floating elements*/
+}
+
+#side-nav ul {
+ overflow: visible; /* reset ul rule for scroll bar in GENERATE_TREEVIEW window */
+}
+
+#main-nav ul {
+ overflow: visible; /* reset ul rule for the navigation bar drop down lists */
+}
+
+.fragment {
+ text-align: left;
+ direction: ltr;
+ overflow-x: auto; /*Fixed: fragment lines overlap floating elements*/
+ overflow-y: hidden;
+}
+
+pre.fragment {
+ border: 1px solid #C4CFE5;
+ background-color: #FBFCFD;
+ padding: 4px 6px;
+ margin: 4px 8px 4px 2px;
+ overflow: auto;
+ word-wrap: break-word;
+ font-size: 9pt;
+ line-height: 125%;
+ font-family: monospace, fixed;
+ font-size: 105%;
+}
+
+div.fragment {
+ padding: 0 0 1px 0; /*Fixed: last line underline overlap border*/
+ margin: 4px 8px 4px 2px;
+ background-color: #FBFCFD;
+ border: 1px solid #C4CFE5;
+}
+
+div.line {
+ font-family: monospace, fixed;
+ font-size: 13px;
+ min-height: 13px;
+ line-height: 1.0;
+ text-wrap: unrestricted;
+ white-space: -moz-pre-wrap; /* Moz */
+ white-space: -pre-wrap; /* Opera 4-6 */
+ white-space: -o-pre-wrap; /* Opera 7 */
+ white-space: pre-wrap; /* CSS3 */
+ word-wrap: break-word; /* IE 5.5+ */
+ text-indent: -53px;
+ padding-left: 53px;
+ padding-bottom: 0px;
+ margin: 0px;
+ -webkit-transition-property: background-color, box-shadow;
+ -webkit-transition-duration: 0.5s;
+ -moz-transition-property: background-color, box-shadow;
+ -moz-transition-duration: 0.5s;
+ -ms-transition-property: background-color, box-shadow;
+ -ms-transition-duration: 0.5s;
+ -o-transition-property: background-color, box-shadow;
+ -o-transition-duration: 0.5s;
+ transition-property: background-color, box-shadow;
+ transition-duration: 0.5s;
+}
+
+div.line:after {
+ content:"\000A";
+ white-space: pre;
+}
+
+div.line.glow {
+ background-color: cyan;
+ box-shadow: 0 0 10px cyan;
+}
+
+
+span.lineno {
+ padding-right: 4px;
+ text-align: right;
+ border-right: 2px solid #0F0;
+ background-color: #E8E8E8;
+ white-space: pre;
+}
+span.lineno a {
+ background-color: #D8D8D8;
+}
+
+span.lineno a:hover {
+ background-color: #C8C8C8;
+}
+
+.lineno {
+ -webkit-touch-callout: none;
+ -webkit-user-select: none;
+ -khtml-user-select: none;
+ -moz-user-select: none;
+ -ms-user-select: none;
+ user-select: none;
+}
+
+div.ah, span.ah {
+ background-color: black;
+ font-weight: bold;
+ color: #FFFFFF;
+ margin-bottom: 3px;
+ margin-top: 3px;
+ padding: 0.2em;
+ border: solid thin #333;
+ border-radius: 0.5em;
+ -webkit-border-radius: .5em;
+ -moz-border-radius: .5em;
+ box-shadow: 2px 2px 3px #999;
+ -webkit-box-shadow: 2px 2px 3px #999;
+ -moz-box-shadow: rgba(0, 0, 0, 0.15) 2px 2px 2px;
+ background-image: -webkit-gradient(linear, left top, left bottom, from(#eee), to(#000),color-stop(0.3, #444));
+ background-image: -moz-linear-gradient(center top, #eee 0%, #444 40%, #000 110%);
+}
+
+div.classindex ul {
+ list-style: none;
+ padding-left: 0;
+}
+
+div.classindex span.ai {
+ display: inline-block;
+}
+
+div.groupHeader {
+ margin-left: 16px;
+ margin-top: 12px;
+ font-weight: bold;
+}
+
+div.groupText {
+ margin-left: 16px;
+ font-style: italic;
+}
+
+body {
+ background-color: white;
+ color: black;
+ margin: 0;
+}
+
+div.contents {
+ margin-top: 10px;
+ margin-left: 12px;
+ margin-right: 8px;
+}
+
+td.indexkey {
+ background-color: #EBEFF6;
+ font-weight: bold;
+ border: 1px solid #C4CFE5;
+ margin: 2px 0px 2px 0;
+ padding: 2px 10px;
+ white-space: nowrap;
+ vertical-align: top;
+}
+
+td.indexvalue {
+ background-color: #EBEFF6;
+ border: 1px solid #C4CFE5;
+ padding: 2px 10px;
+ margin: 2px 0px;
+}
+
+tr.memlist {
+ background-color: #EEF1F7;
+}
+
+p.formulaDsp {
+ text-align: center;
+}
+
+img.formulaDsp {
+
+}
+
+img.formulaInl, img.inline {
+ vertical-align: middle;
+}
+
+div.center {
+ text-align: center;
+ margin-top: 0px;
+ margin-bottom: 0px;
+ padding: 0px;
+}
+
+div.center img {
+ border: 0px;
+}
+
+address.footer {
+ text-align: right;
+ padding-right: 12px;
+}
+
+img.footer {
+ border: 0px;
+ vertical-align: middle;
+}
+
+/* @group Code Colorization */
+
+span.keyword {
+ color: #008000
+}
+
+span.keywordtype {
+ color: #604020
+}
+
+span.keywordflow {
+ color: #e08000
+}
+
+span.comment {
+ color: #800000
+}
+
+span.preprocessor {
+ color: #806020
+}
+
+span.stringliteral {
+ color: #002080
+}
+
+span.charliteral {
+ color: #008080
+}
+
+span.vhdldigit {
+ color: #ff00ff
+}
+
+span.vhdlchar {
+ color: #000000
+}
+
+span.vhdlkeyword {
+ color: #700070
+}
+
+span.vhdllogic {
+ color: #ff0000
+}
+
+blockquote {
+ background-color: #F7F8FB;
+ border-left: 2px solid #9CAFD4;
+ margin: 0 24px 0 4px;
+ padding: 0 12px 0 16px;
+}
+
+blockquote.DocNodeRTL {
+ border-left: 0;
+ border-right: 2px solid #9CAFD4;
+ margin: 0 4px 0 24px;
+ padding: 0 16px 0 12px;
+}
+
+/* @end */
+
+/*
+.search {
+ color: #003399;
+ font-weight: bold;
+}
+
+form.search {
+ margin-bottom: 0px;
+ margin-top: 0px;
+}
+
+input.search {
+ font-size: 75%;
+ color: #000080;
+ font-weight: normal;
+ background-color: #e8eef2;
+}
+*/
+
+td.tiny {
+ font-size: 75%;
+}
+
+.dirtab {
+ padding: 4px;
+ border-collapse: collapse;
+ border: 1px solid #A3B4D7;
+}
+
+th.dirtab {
+ background: #EBEFF6;
+ font-weight: bold;
+}
+
+hr {
+ height: 0px;
+ border: none;
+ border-top: 1px solid #4A6AAA;
+}
+
+hr.footer {
+ height: 1px;
+}
+
+/* @group Member Descriptions */
+
+table.memberdecls {
+ border-spacing: 0px;
+ padding: 0px;
+}
+
+.memberdecls td, .fieldtable tr {
+ -webkit-transition-property: background-color, box-shadow;
+ -webkit-transition-duration: 0.5s;
+ -moz-transition-property: background-color, box-shadow;
+ -moz-transition-duration: 0.5s;
+ -ms-transition-property: background-color, box-shadow;
+ -ms-transition-duration: 0.5s;
+ -o-transition-property: background-color, box-shadow;
+ -o-transition-duration: 0.5s;
+ transition-property: background-color, box-shadow;
+ transition-duration: 0.5s;
+}
+
+.memberdecls td.glow, .fieldtable tr.glow {
+ background-color: cyan;
+ box-shadow: 0 0 15px cyan;
+}
+
+.mdescLeft, .mdescRight,
+.memItemLeft, .memItemRight,
+.memTemplItemLeft, .memTemplItemRight, .memTemplParams {
+ background-color: #F9FAFC;
+ border: none;
+ margin: 4px;
+ padding: 1px 0 0 8px;
+}
+
+.mdescLeft, .mdescRight {
+ padding: 0px 8px 4px 8px;
+ color: #555;
+}
+
+.memSeparator {
+ border-bottom: 1px solid #DEE4F0;
+ line-height: 1px;
+ margin: 0px;
+ padding: 0px;
+}
+
+.memItemLeft, .memTemplItemLeft {
+ white-space: nowrap;
+}
+
+.memItemRight, .memTemplItemRight {
+ width: 100%;
+}
+
+.memTemplParams {
+ color: #4665A2;
+ white-space: nowrap;
+ font-size: 80%;
+}
+
+/* @end */
+
+/* @group Member Details */
+
+/* Styles for detailed member documentation */
+
+.memtitle {
+ padding: 8px;
+ border-top: 1px solid #A8B8D9;
+ border-left: 1px solid #A8B8D9;
+ border-right: 1px solid #A8B8D9;
+ border-top-right-radius: 4px;
+ border-top-left-radius: 4px;
+ margin-bottom: -1px;
+ background-image: url('nav_f.png');
+ background-repeat: repeat-x;
+ background-color: #E2E8F2;
+ line-height: 1.25;
+ font-weight: 300;
+ float:left;
+}
+
+.permalink
+{
+ font-size: 65%;
+ display: inline-block;
+ vertical-align: middle;
+}
+
+.memtemplate {
+ font-size: 80%;
+ color: #4665A2;
+ font-weight: normal;
+ margin-left: 9px;
+}
+
+.memnav {
+ background-color: #EBEFF6;
+ border: 1px solid #A3B4D7;
+ text-align: center;
+ margin: 2px;
+ margin-right: 15px;
+ padding: 2px;
+}
+
+.mempage {
+ width: 100%;
+}
+
+.memitem {
+ padding: 0;
+ margin-bottom: 10px;
+ margin-right: 5px;
+ -webkit-transition: box-shadow 0.5s linear;
+ -moz-transition: box-shadow 0.5s linear;
+ -ms-transition: box-shadow 0.5s linear;
+ -o-transition: box-shadow 0.5s linear;
+ transition: box-shadow 0.5s linear;
+ display: table !important;
+ width: 100%;
+}
+
+.memitem.glow {
+ box-shadow: 0 0 15px cyan;
+}
+
+.memname {
+ font-weight: 400;
+ margin-left: 6px;
+}
+
+.memname td {
+ vertical-align: bottom;
+}
+
+.memproto, dl.reflist dt {
+ border-top: 1px solid #A8B8D9;
+ border-left: 1px solid #A8B8D9;
+ border-right: 1px solid #A8B8D9;
+ padding: 6px 0px 6px 0px;
+ color: #253555;
+ font-weight: bold;
+ text-shadow: 0px 1px 1px rgba(255, 255, 255, 0.9);
+ background-color: #DFE5F1;
+ /* opera specific markup */
+ box-shadow: 5px 5px 5px rgba(0, 0, 0, 0.15);
+ border-top-right-radius: 4px;
+ /* firefox specific markup */
+ -moz-box-shadow: rgba(0, 0, 0, 0.15) 5px 5px 5px;
+ -moz-border-radius-topright: 4px;
+ /* webkit specific markup */
+ -webkit-box-shadow: 5px 5px 5px rgba(0, 0, 0, 0.15);
+ -webkit-border-top-right-radius: 4px;
+
+}
+
+.overload {
+ font-family: "courier new",courier,monospace;
+ font-size: 65%;
+}
+
+.memdoc, dl.reflist dd {
+ border-bottom: 1px solid #A8B8D9;
+ border-left: 1px solid #A8B8D9;
+ border-right: 1px solid #A8B8D9;
+ padding: 6px 10px 2px 10px;
+ background-color: #FBFCFD;
+ border-top-width: 0;
+ background-image:url('nav_g.png');
+ background-repeat:repeat-x;
+ background-color: #FFFFFF;
+ /* opera specific markup */
+ border-bottom-left-radius: 4px;
+ border-bottom-right-radius: 4px;
+ box-shadow: 5px 5px 5px rgba(0, 0, 0, 0.15);
+ /* firefox specific markup */
+ -moz-border-radius-bottomleft: 4px;
+ -moz-border-radius-bottomright: 4px;
+ -moz-box-shadow: rgba(0, 0, 0, 0.15) 5px 5px 5px;
+ /* webkit specific markup */
+ -webkit-border-bottom-left-radius: 4px;
+ -webkit-border-bottom-right-radius: 4px;
+ -webkit-box-shadow: 5px 5px 5px rgba(0, 0, 0, 0.15);
+}
+
+dl.reflist dt {
+ padding: 5px;
+}
+
+dl.reflist dd {
+ margin: 0px 0px 10px 0px;
+ padding: 5px;
+}
+
+.paramkey {
+ text-align: right;
+}
+
+.paramtype {
+ white-space: nowrap;
+}
+
+.paramname {
+ color: #602020;
+ white-space: nowrap;
+}
+.paramname em {
+ font-style: normal;
+}
+.paramname code {
+ line-height: 14px;
+}
+
+.params, .retval, .exception, .tparams {
+ margin-left: 0px;
+ padding-left: 0px;
+}
+
+.params .paramname, .retval .paramname, .tparams .paramname, .exception .paramname {
+ font-weight: bold;
+ vertical-align: top;
+}
+
+.params .paramtype, .tparams .paramtype {
+ font-style: italic;
+ vertical-align: top;
+}
+
+.params .paramdir, .tparams .paramdir {
+ font-family: "courier new",courier,monospace;
+ vertical-align: top;
+}
+
+table.mlabels {
+ border-spacing: 0px;
+}
+
+td.mlabels-left {
+ width: 100%;
+ padding: 0px;
+}
+
+td.mlabels-right {
+ vertical-align: bottom;
+ padding: 0px;
+ white-space: nowrap;
+}
+
+span.mlabels {
+ margin-left: 8px;
+}
+
+span.mlabel {
+ background-color: #728DC1;
+ border-top:1px solid #5373B4;
+ border-left:1px solid #5373B4;
+ border-right:1px solid #C4CFE5;
+ border-bottom:1px solid #C4CFE5;
+ text-shadow: none;
+ color: white;
+ margin-right: 4px;
+ padding: 2px 3px;
+ border-radius: 3px;
+ font-size: 7pt;
+ white-space: nowrap;
+ vertical-align: middle;
+}
+
+
+
+/* @end */
+
+/* these are for tree view inside a (index) page */
+
+div.directory {
+ margin: 10px 0px;
+ border-top: 1px solid #9CAFD4;
+ border-bottom: 1px solid #9CAFD4;
+ width: 100%;
+}
+
+.directory table {
+ border-collapse:collapse;
+}
+
+.directory td {
+ margin: 0px;
+ padding: 0px;
+ vertical-align: top;
+}
+
+.directory td.entry {
+ white-space: nowrap;
+ padding-right: 6px;
+ padding-top: 3px;
+}
+
+.directory td.entry a {
+ outline:none;
+}
+
+.directory td.entry a img {
+ border: none;
+}
+
+.directory td.desc {
+ width: 100%;
+ padding-left: 6px;
+ padding-right: 6px;
+ padding-top: 3px;
+ border-left: 1px solid rgba(0,0,0,0.05);
+}
+
+.directory tr.even {
+ padding-left: 6px;
+ background-color: #F7F8FB;
+}
+
+.directory img {
+ vertical-align: -30%;
+}
+
+.directory .levels {
+ white-space: nowrap;
+ width: 100%;
+ text-align: right;
+ font-size: 9pt;
+}
+
+.directory .levels span {
+ cursor: pointer;
+ padding-left: 2px;
+ padding-right: 2px;
+ color: #3D578C;
+}
+
+.arrow {
+ color: #9CAFD4;
+ -webkit-user-select: none;
+ -khtml-user-select: none;
+ -moz-user-select: none;
+ -ms-user-select: none;
+ user-select: none;
+ cursor: pointer;
+ font-size: 80%;
+ display: inline-block;
+ width: 16px;
+ height: 22px;
+}
+
+.icon {
+ font-family: Arial, Helvetica;
+ font-weight: bold;
+ font-size: 12px;
+ height: 14px;
+ width: 16px;
+ display: inline-block;
+ background-color: #728DC1;
+ color: white;
+ text-align: center;
+ border-radius: 4px;
+ margin-left: 2px;
+ margin-right: 2px;
+}
+
+.icona {
+ width: 24px;
+ height: 22px;
+ display: inline-block;
+}
+
+.iconfopen {
+ width: 24px;
+ height: 18px;
+ margin-bottom: 4px;
+ background-image:url('folderopen.png');
+ background-position: 0px -4px;
+ background-repeat: repeat-y;
+ vertical-align:top;
+ display: inline-block;
+}
+
+.iconfclosed {
+ width: 24px;
+ height: 18px;
+ margin-bottom: 4px;
+ background-image:url('folderclosed.png');
+ background-position: 0px -4px;
+ background-repeat: repeat-y;
+ vertical-align:top;
+ display: inline-block;
+}
+
+.icondoc {
+ width: 24px;
+ height: 18px;
+ margin-bottom: 4px;
+ background-image:url('doc.png');
+ background-position: 0px -4px;
+ background-repeat: repeat-y;
+ vertical-align:top;
+ display: inline-block;
+}
+
+table.directory {
+ font: 400 14px Roboto,sans-serif;
+}
+
+/* @end */
+
+div.dynheader {
+ margin-top: 8px;
+ -webkit-touch-callout: none;
+ -webkit-user-select: none;
+ -khtml-user-select: none;
+ -moz-user-select: none;
+ -ms-user-select: none;
+ user-select: none;
+}
+
+address {
+ font-style: normal;
+ color: #2A3D61;
+}
+
+table.doxtable caption {
+ caption-side: top;
+}
+
+table.doxtable {
+ border-collapse:collapse;
+ margin-top: 4px;
+ margin-bottom: 4px;
+}
+
+table.doxtable td, table.doxtable th {
+ border: 1px solid #2D4068;
+ padding: 3px 7px 2px;
+}
+
+table.doxtable th {
+ background-color: #374F7F;
+ color: #FFFFFF;
+ font-size: 110%;
+ padding-bottom: 4px;
+ padding-top: 5px;
+}
+
+table.fieldtable {
+ /*width: 100%;*/
+ margin-bottom: 10px;
+ border: 1px solid #A8B8D9;
+ border-spacing: 0px;
+ -moz-border-radius: 4px;
+ -webkit-border-radius: 4px;
+ border-radius: 4px;
+ -moz-box-shadow: rgba(0, 0, 0, 0.15) 2px 2px 2px;
+ -webkit-box-shadow: 2px 2px 2px rgba(0, 0, 0, 0.15);
+ box-shadow: 2px 2px 2px rgba(0, 0, 0, 0.15);
+}
+
+.fieldtable td, .fieldtable th {
+ padding: 3px 7px 2px;
+}
+
+.fieldtable td.fieldtype, .fieldtable td.fieldname {
+ white-space: nowrap;
+ border-right: 1px solid #A8B8D9;
+ border-bottom: 1px solid #A8B8D9;
+ vertical-align: top;
+}
+
+.fieldtable td.fieldname {
+ padding-top: 3px;
+}
+
+.fieldtable td.fielddoc {
+ border-bottom: 1px solid #A8B8D9;
+ /*width: 100%;*/
+}
+
+.fieldtable td.fielddoc p:first-child {
+ margin-top: 0px;
+}
+
+.fieldtable td.fielddoc p:last-child {
+ margin-bottom: 2px;
+}
+
+.fieldtable tr:last-child td {
+ border-bottom: none;
+}
+
+.fieldtable th {
+ background-image:url('nav_f.png');
+ background-repeat:repeat-x;
+ background-color: #E2E8F2;
+ font-size: 90%;
+ color: #253555;
+ padding-bottom: 4px;
+ padding-top: 5px;
+ text-align:left;
+ font-weight: 400;
+ -moz-border-radius-topleft: 4px;
+ -moz-border-radius-topright: 4px;
+ -webkit-border-top-left-radius: 4px;
+ -webkit-border-top-right-radius: 4px;
+ border-top-left-radius: 4px;
+ border-top-right-radius: 4px;
+ border-bottom: 1px solid #A8B8D9;
+}
+
+
+.tabsearch {
+ top: 0px;
+ left: 10px;
+ height: 36px;
+ background-image: url('tab_b.png');
+ z-index: 101;
+ overflow: hidden;
+ font-size: 13px;
+}
+
+.navpath ul
+{
+ font-size: 11px;
+ background-image:url('tab_b.png');
+ background-repeat:repeat-x;
+ background-position: 0 -5px;
+ height:30px;
+ line-height:30px;
+ color:#8AA0CC;
+ border:solid 1px #C2CDE4;
+ overflow:hidden;
+ margin:0px;
+ padding:0px;
+}
+
+.navpath li
+{
+ list-style-type:none;
+ float:left;
+ padding-left:10px;
+ padding-right:15px;
+ background-image:url('bc_s.png');
+ background-repeat:no-repeat;
+ background-position:right;
+ color:#364D7C;
+}
+
+.navpath li.navelem a
+{
+ height:32px;
+ display:block;
+ text-decoration: none;
+ outline: none;
+ color: #283A5D;
+ font-family: 'Lucida Grande',Geneva,Helvetica,Arial,sans-serif;
+ text-shadow: 0px 1px 1px rgba(255, 255, 255, 0.9);
+ text-decoration: none;
+}
+
+.navpath li.navelem a:hover
+{
+ color:#6884BD;
+}
+
+.navpath li.footer
+{
+ list-style-type:none;
+ float:right;
+ padding-left:10px;
+ padding-right:15px;
+ background-image:none;
+ background-repeat:no-repeat;
+ background-position:right;
+ color:#364D7C;
+ font-size: 8pt;
+}
+
+
+div.summary
+{
+ float: right;
+ font-size: 8pt;
+ padding-right: 5px;
+ width: 50%;
+ text-align: right;
+}
+
+div.summary a
+{
+ white-space: nowrap;
+}
+
+table.classindex
+{
+ margin: 10px;
+ white-space: nowrap;
+ margin-left: 3%;
+ margin-right: 3%;
+ width: 94%;
+ border: 0;
+ border-spacing: 0;
+ padding: 0;
+}
+
+div.ingroups
+{
+ font-size: 8pt;
+ width: 50%;
+ text-align: left;
+}
+
+div.ingroups a
+{
+ white-space: nowrap;
+}
+
+div.header
+{
+ background-image:url('nav_h.png');
+ background-repeat:repeat-x;
+ background-color: #F9FAFC;
+ margin: 0px;
+ border-bottom: 1px solid #C4CFE5;
+}
+
+div.headertitle
+{
+ padding: 5px 5px 5px 10px;
+}
+
+.PageDocRTL-title div.headertitle {
+ text-align: right;
+ direction: rtl;
+}
+
+dl {
+ padding: 0 0 0 0;
+}
+
+/* dl.note, dl.warning, dl.attention, dl.pre, dl.post, dl.invariant, dl.deprecated, dl.todo, dl.test, dl.bug, dl.examples */
+dl.section {
+ margin-left: 0px;
+ padding-left: 0px;
+}
+
+dl.section.DocNodeRTL {
+ margin-right: 0px;
+ padding-right: 0px;
+}
+
+dl.note {
+ margin-left: -7px;
+ padding-left: 3px;
+ border-left: 4px solid;
+ border-color: #D0C000;
+}
+
+dl.note.DocNodeRTL {
+ margin-left: 0;
+ padding-left: 0;
+ border-left: 0;
+ margin-right: -7px;
+ padding-right: 3px;
+ border-right: 4px solid;
+ border-color: #D0C000;
+}
+
+dl.warning, dl.attention {
+ margin-left: -7px;
+ padding-left: 3px;
+ border-left: 4px solid;
+ border-color: #FF0000;
+}
+
+dl.warning.DocNodeRTL, dl.attention.DocNodeRTL {
+ margin-left: 0;
+ padding-left: 0;
+ border-left: 0;
+ margin-right: -7px;
+ padding-right: 3px;
+ border-right: 4px solid;
+ border-color: #FF0000;
+}
+
+dl.pre, dl.post, dl.invariant {
+ margin-left: -7px;
+ padding-left: 3px;
+ border-left: 4px solid;
+ border-color: #00D000;
+}
+
+dl.pre.DocNodeRTL, dl.post.DocNodeRTL, dl.invariant.DocNodeRTL {
+ margin-left: 0;
+ padding-left: 0;
+ border-left: 0;
+ margin-right: -7px;
+ padding-right: 3px;
+ border-right: 4px solid;
+ border-color: #00D000;
+}
+
+dl.deprecated {
+ margin-left: -7px;
+ padding-left: 3px;
+ border-left: 4px solid;
+ border-color: #505050;
+}
+
+dl.deprecated.DocNodeRTL {
+ margin-left: 0;
+ padding-left: 0;
+ border-left: 0;
+ margin-right: -7px;
+ padding-right: 3px;
+ border-right: 4px solid;
+ border-color: #505050;
+}
+
+dl.todo {
+ margin-left: -7px;
+ padding-left: 3px;
+ border-left: 4px solid;
+ border-color: #00C0E0;
+}
+
+dl.todo.DocNodeRTL {
+ margin-left: 0;
+ padding-left: 0;
+ border-left: 0;
+ margin-right: -7px;
+ padding-right: 3px;
+ border-right: 4px solid;
+ border-color: #00C0E0;
+}
+
+dl.test {
+ margin-left: -7px;
+ padding-left: 3px;
+ border-left: 4px solid;
+ border-color: #3030E0;
+}
+
+dl.test.DocNodeRTL {
+ margin-left: 0;
+ padding-left: 0;
+ border-left: 0;
+ margin-right: -7px;
+ padding-right: 3px;
+ border-right: 4px solid;
+ border-color: #3030E0;
+}
+
+dl.bug {
+ margin-left: -7px;
+ padding-left: 3px;
+ border-left: 4px solid;
+ border-color: #C08050;
+}
+
+dl.bug.DocNodeRTL {
+ margin-left: 0;
+ padding-left: 0;
+ border-left: 0;
+ margin-right: -7px;
+ padding-right: 3px;
+ border-right: 4px solid;
+ border-color: #C08050;
+}
+
+dl.section dd {
+ margin-bottom: 6px;
+}
+
+
+#projectlogo
+{
+ text-align: center;
+ vertical-align: bottom;
+ border-collapse: separate;
+}
+
+#projectlogo img
+{
+ border: 0px none;
+}
+
+#projectalign
+{
+ vertical-align: middle;
+}
+
+#projectname
+{
+ font: 300% Tahoma, Arial,sans-serif;
+ margin: 0px;
+ padding: 2px 0px;
+}
+
+#projectbrief
+{
+ font: 120% Tahoma, Arial,sans-serif;
+ margin: 0px;
+ padding: 0px;
+}
+
+#projectnumber
+{
+ font: 50% Tahoma, Arial,sans-serif;
+ margin: 0px;
+ padding: 0px;
+}
+
+#titlearea
+{
+ padding: 0px;
+ margin: 0px;
+ width: 100%;
+ border-bottom: 1px solid #5373B4;
+}
+
+.image
+{
+ text-align: center;
+}
+
+.dotgraph
+{
+ text-align: center;
+}
+
+.mscgraph
+{
+ text-align: center;
+}
+
+.plantumlgraph
+{
+ text-align: center;
+}
+
+.diagraph
+{
+ text-align: center;
+}
+
+.caption
+{
+ font-weight: bold;
+}
+
+div.zoom
+{
+ border: 1px solid #90A5CE;
+}
+
+dl.citelist {
+ margin-bottom:50px;
+}
+
+dl.citelist dt {
+ color:#334975;
+ float:left;
+ font-weight:bold;
+ margin-right:10px;
+ padding:5px;
+ text-align:right;
+ width:52px;
+}
+
+dl.citelist dd {
+ margin:2px 0 2px 72px;
+ padding:5px 0;
+}
+
+div.toc {
+ padding: 14px 25px;
+ background-color: #F4F6FA;
+ border: 1px solid #D8DFEE;
+ border-radius: 7px 7px 7px 7px;
+ float: right;
+ height: auto;
+ margin: 0 8px 10px 10px;
+ width: 200px;
+}
+
+.PageDocRTL-title div.toc {
+ float: left !important;
+ text-align: right;
+}
+
+div.toc li {
+ background: url("bdwn.png") no-repeat scroll 0 5px transparent;
+ font: 10px/1.2 Verdana,DejaVu Sans,Geneva,sans-serif;
+ margin-top: 5px;
+ padding-left: 10px;
+ padding-top: 2px;
+}
+
+.PageDocRTL-title div.toc li {
+ background-position-x: right !important;
+ padding-left: 0 !important;
+ padding-right: 10px;
+}
+
+div.toc h3 {
+ font: bold 12px/1.2 Arial,FreeSans,sans-serif;
+ color: #4665A2;
+ border-bottom: 0 none;
+ margin: 0;
+}
+
+div.toc ul {
+ list-style: none outside none;
+ border: medium none;
+ padding: 0px;
+}
+
+div.toc li.level1 {
+ margin-left: 0px;
+}
+
+div.toc li.level2 {
+ margin-left: 15px;
+}
+
+div.toc li.level3 {
+ margin-left: 30px;
+}
+
+div.toc li.level4 {
+ margin-left: 45px;
+}
+
+span.emoji {
+ /* font family used at the site: https://unicode.org/emoji/charts/full-emoji-list.html
+ * font-family: "Noto Color Emoji", "Apple Color Emoji", "Segoe UI Emoji", Times, Symbola, Aegyptus, Code2000, Code2001, Code2002, Musica, serif, LastResort;
+ */
+}
+
+.PageDocRTL-title div.toc li.level1 {
+ margin-left: 0 !important;
+ margin-right: 0;
+}
+
+.PageDocRTL-title div.toc li.level2 {
+ margin-left: 0 !important;
+ margin-right: 15px;
+}
+
+.PageDocRTL-title div.toc li.level3 {
+ margin-left: 0 !important;
+ margin-right: 30px;
+}
+
+.PageDocRTL-title div.toc li.level4 {
+ margin-left: 0 !important;
+ margin-right: 45px;
+}
+
+.inherit_header {
+ font-weight: bold;
+ color: gray;
+ cursor: pointer;
+ -webkit-touch-callout: none;
+ -webkit-user-select: none;
+ -khtml-user-select: none;
+ -moz-user-select: none;
+ -ms-user-select: none;
+ user-select: none;
+}
+
+.inherit_header td {
+ padding: 6px 0px 2px 5px;
+}
+
+.inherit {
+ display: none;
+}
+
+tr.heading h2 {
+ margin-top: 12px;
+ margin-bottom: 4px;
+}
+
+/* tooltip related style info */
+
+.ttc {
+ position: absolute;
+ display: none;
+}
+
+#powerTip {
+ cursor: default;
+ white-space: nowrap;
+ background-color: white;
+ border: 1px solid gray;
+ border-radius: 4px 4px 4px 4px;
+ box-shadow: 1px 1px 7px gray;
+ display: none;
+ font-size: smaller;
+ max-width: 80%;
+ opacity: 0.9;
+ padding: 1ex 1em 1em;
+ position: absolute;
+ z-index: 2147483647;
+}
+
+#powerTip div.ttdoc {
+ color: grey;
+ font-style: italic;
+}
+
+#powerTip div.ttname a {
+ font-weight: bold;
+}
+
+#powerTip div.ttname {
+ font-weight: bold;
+}
+
+#powerTip div.ttdeci {
+ color: #006318;
+}
+
+#powerTip div {
+ margin: 0px;
+ padding: 0px;
+ font: 12px/16px Roboto,sans-serif;
+}
+
+#powerTip:before, #powerTip:after {
+ content: "";
+ position: absolute;
+ margin: 0px;
+}
+
+#powerTip.n:after, #powerTip.n:before,
+#powerTip.s:after, #powerTip.s:before,
+#powerTip.w:after, #powerTip.w:before,
+#powerTip.e:after, #powerTip.e:before,
+#powerTip.ne:after, #powerTip.ne:before,
+#powerTip.se:after, #powerTip.se:before,
+#powerTip.nw:after, #powerTip.nw:before,
+#powerTip.sw:after, #powerTip.sw:before {
+ border: solid transparent;
+ content: " ";
+ height: 0;
+ width: 0;
+ position: absolute;
+}
+
+#powerTip.n:after, #powerTip.s:after,
+#powerTip.w:after, #powerTip.e:after,
+#powerTip.nw:after, #powerTip.ne:after,
+#powerTip.sw:after, #powerTip.se:after {
+ border-color: rgba(255, 255, 255, 0);
+}
+
+#powerTip.n:before, #powerTip.s:before,
+#powerTip.w:before, #powerTip.e:before,
+#powerTip.nw:before, #powerTip.ne:before,
+#powerTip.sw:before, #powerTip.se:before {
+ border-color: rgba(128, 128, 128, 0);
+}
+
+#powerTip.n:after, #powerTip.n:before,
+#powerTip.ne:after, #powerTip.ne:before,
+#powerTip.nw:after, #powerTip.nw:before {
+ top: 100%;
+}
+
+#powerTip.n:after, #powerTip.ne:after, #powerTip.nw:after {
+ border-top-color: #FFFFFF;
+ border-width: 10px;
+ margin: 0px -10px;
+}
+#powerTip.n:before {
+ border-top-color: #808080;
+ border-width: 11px;
+ margin: 0px -11px;
+}
+#powerTip.n:after, #powerTip.n:before {
+ left: 50%;
+}
+
+#powerTip.nw:after, #powerTip.nw:before {
+ right: 14px;
+}
+
+#powerTip.ne:after, #powerTip.ne:before {
+ left: 14px;
+}
+
+#powerTip.s:after, #powerTip.s:before,
+#powerTip.se:after, #powerTip.se:before,
+#powerTip.sw:after, #powerTip.sw:before {
+ bottom: 100%;
+}
+
+#powerTip.s:after, #powerTip.se:after, #powerTip.sw:after {
+ border-bottom-color: #FFFFFF;
+ border-width: 10px;
+ margin: 0px -10px;
+}
+
+#powerTip.s:before, #powerTip.se:before, #powerTip.sw:before {
+ border-bottom-color: #808080;
+ border-width: 11px;
+ margin: 0px -11px;
+}
+
+#powerTip.s:after, #powerTip.s:before {
+ left: 50%;
+}
+
+#powerTip.sw:after, #powerTip.sw:before {
+ right: 14px;
+}
+
+#powerTip.se:after, #powerTip.se:before {
+ left: 14px;
+}
+
+#powerTip.e:after, #powerTip.e:before {
+ left: 100%;
+}
+#powerTip.e:after {
+ border-left-color: #FFFFFF;
+ border-width: 10px;
+ top: 50%;
+ margin-top: -10px;
+}
+#powerTip.e:before {
+ border-left-color: #808080;
+ border-width: 11px;
+ top: 50%;
+ margin-top: -11px;
+}
+
+#powerTip.w:after, #powerTip.w:before {
+ right: 100%;
+}
+#powerTip.w:after {
+ border-right-color: #FFFFFF;
+ border-width: 10px;
+ top: 50%;
+ margin-top: -10px;
+}
+#powerTip.w:before {
+ border-right-color: #808080;
+ border-width: 11px;
+ top: 50%;
+ margin-top: -11px;
+}
+
+@media print
+{
+ #top { display: none; }
+ #side-nav { display: none; }
+ #nav-path { display: none; }
+ body { overflow:visible; }
+ h1, h2, h3, h4, h5, h6 { page-break-after: avoid; }
+ .summary { display: none; }
+ .memitem { page-break-inside: avoid; }
+ #doc-content
+ {
+ margin-left:0 !important;
+ height:auto !important;
+ width:auto !important;
+ overflow:inherit;
+ display:inline;
+ }
+}
+
+/* @group Markdown */
+
+table.markdownTable {
+ border-collapse:collapse;
+ margin-top: 4px;
+ margin-bottom: 4px;
+}
+
+table.markdownTable td, table.markdownTable th {
+ border: 1px solid #2D4068;
+ padding: 3px 7px 2px;
+}
+
+table.markdownTable tr {
+}
+
+th.markdownTableHeadLeft, th.markdownTableHeadRight, th.markdownTableHeadCenter, th.markdownTableHeadNone {
+ background-color: #374F7F;
+ color: #FFFFFF;
+ font-size: 110%;
+ padding-bottom: 4px;
+ padding-top: 5px;
+}
+
+th.markdownTableHeadLeft, td.markdownTableBodyLeft {
+ text-align: left
+}
+
+th.markdownTableHeadRight, td.markdownTableBodyRight {
+ text-align: right
+}
+
+th.markdownTableHeadCenter, td.markdownTableBodyCenter {
+ text-align: center
+}
+
+.DocNodeRTL {
+ text-align: right;
+ direction: rtl;
+}
+
+.DocNodeLTR {
+ text-align: left;
+ direction: ltr;
+}
+
+table.DocNodeRTL {
+ width: auto;
+ margin-right: 0;
+ margin-left: auto;
+}
+
+table.DocNodeLTR {
+ width: auto;
+ margin-right: auto;
+ margin-left: 0;
+}
+
+tt, code, kbd, samp
+{
+ display: inline-block;
+ direction:ltr;
+}
+/* @end */
+
+u {
+ text-decoration: underline;
+}
+
diff --git a/docs/doxygen.svg b/docs/doxygen.svg
new file mode 100644
index 000000000..d42dad52d
--- /dev/null
+++ b/docs/doxygen.svg
@@ -0,0 +1,26 @@
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/docs/dynsections.js b/docs/dynsections.js
new file mode 100644
index 000000000..3174bd7be
--- /dev/null
+++ b/docs/dynsections.js
@@ -0,0 +1,121 @@
+/*
+ @licstart The following is the entire license notice for the JavaScript code in this file.
+
+ The MIT License (MIT)
+
+ Copyright (C) 1997-2020 by Dimitri van Heesch
+
+ Permission is hereby granted, free of charge, to any person obtaining a copy of this software
+ and associated documentation files (the "Software"), to deal in the Software without restriction,
+ including without limitation the rights to use, copy, modify, merge, publish, distribute,
+ sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is
+ furnished to do so, subject to the following conditions:
+
+ The above copyright notice and this permission notice shall be included in all copies or
+ substantial portions of the Software.
+
+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING
+ BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+ NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,
+ DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+
+ @licend The above is the entire license notice for the JavaScript code in this file
+ */
+function toggleVisibility(linkObj)
+{
+ var base = $(linkObj).attr('id');
+ var summary = $('#'+base+'-summary');
+ var content = $('#'+base+'-content');
+ var trigger = $('#'+base+'-trigger');
+ var src=$(trigger).attr('src');
+ if (content.is(':visible')===true) {
+ content.hide();
+ summary.show();
+ $(linkObj).addClass('closed').removeClass('opened');
+ $(trigger).attr('src',src.substring(0,src.length-8)+'closed.png');
+ } else {
+ content.show();
+ summary.hide();
+ $(linkObj).removeClass('closed').addClass('opened');
+ $(trigger).attr('src',src.substring(0,src.length-10)+'open.png');
+ }
+ return false;
+}
+
+function updateStripes()
+{
+ $('table.directory tr').
+ removeClass('even').filter(':visible:even').addClass('even');
+}
+
+function toggleLevel(level)
+{
+ $('table.directory tr').each(function() {
+ var l = this.id.split('_').length-1;
+ var i = $('#img'+this.id.substring(3));
+ var a = $('#arr'+this.id.substring(3));
+ if (l
+
+
+
+
+
+
+aws-crt-cpp: File List
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ aws-crt-cpp
+
+ C++ wrapper around the aws-c-* libraries. Provides Cross-Platform Transport Protocols and SSL/TLS implementations for C++.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
Here is a list of all files with brief descriptions:
+
+
+
+
+
diff --git a/docs/folderclosed.png b/docs/folderclosed.png
new file mode 100644
index 000000000..bb8ab35ed
Binary files /dev/null and b/docs/folderclosed.png differ
diff --git a/docs/folderopen.png b/docs/folderopen.png
new file mode 100644
index 000000000..d6c7f676a
Binary files /dev/null and b/docs/folderopen.png differ
diff --git a/docs/functions.html b/docs/functions.html
new file mode 100644
index 000000000..d98bbfa99
--- /dev/null
+++ b/docs/functions.html
@@ -0,0 +1,184 @@
+
+
+
+
+
+
+
+aws-crt-cpp: Class Members
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ aws-crt-cpp
+
+ C++ wrapper around the aws-c-* libraries. Provides Cross-Platform Transport Protocols and SSL/TLS implementations for C++.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
Here is a list of all class members with links to the classes they belong to:
+
+
- a -
+AccessKeyId
+: Aws::Crt::Auth::CredentialsProviderStaticConfig
+
+accountId
+: Aws::Crt::Imds::InstanceInfo
+, Aws::Crt::Imds::InstanceInfoView
+
+AcquireConnection()
+: Aws::Crt::Http::HttpClientConnectionManager
+
+AcquireMaxSizeMessageForWrite()
+: Aws::Crt::Io::ChannelHandler
+
+AcquireMessageFromPool()
+: Aws::Crt::Io::ChannelHandler
+
+AcquireRef()
+: Aws::Crt::RefCounted< T >
+
+Activate()
+: Aws::Crt::Http::HttpClientStream
+
+AdaptiveHttpProxyStrategy()
+: Aws::Crt::Http::AdaptiveHttpProxyStrategy
+
+AddBoolean()
+: Aws::Crt::Endpoints::RequestContext
+
+AddHeader()
+: Aws::Crt::Http::HttpMessage
+
+AddString()
+: Aws::Crt::Endpoints::RequestContext
+
+AddStringArray()
+: Aws::Crt::Endpoints::RequestContext
+
+Alloc
+: Aws::Crt::Auth::HttpSignerCallbackData
+
+allocate()
+: Aws::Crt::StlAllocator< T >
+
+allocator
+: Aws::Crt::Auth::DelegateCredentialsProviderCallbackArgs
+, Aws::Crt::Http::ClientStreamCallbackData
+, Aws::Crt::Http::ConnectionCallbackData
+, Aws::Crt::Imds::WrappedCallbackArgs< T >
+, Aws::Crt::Io::TaskWrapper
+, Aws::Crt::Mqtt::MqttConnectionOptions
+
+AlternativeCount
+: Aws::Crt::Variant< Ts >
+
+ApiHandle()
+: Aws::Crt::ApiHandle
+, Aws::Crt::JsonObject
+
+architecture
+: Aws::Crt::Imds::InstanceInfo
+, Aws::Crt::Imds::InstanceInfoView
+
+AsArray()
+: Aws::Crt::JsonObject
+, Aws::Crt::JsonView
+
+AsBool()
+: Aws::Crt::JsonObject
+, Aws::Crt::JsonView
+
+AsDouble()
+: Aws::Crt::JsonObject
+, Aws::Crt::JsonView
+
+AsInt64()
+: Aws::Crt::JsonObject
+, Aws::Crt::JsonView
+
+AsInteger()
+: Aws::Crt::JsonObject
+, Aws::Crt::JsonView
+
+AsNull()
+: Aws::Crt::JsonObject
+
+AsObject()
+: Aws::Crt::JsonObject
+, Aws::Crt::JsonView
+
+AsString()
+: Aws::Crt::JsonObject
+, Aws::Crt::JsonView
+
+at()
+: Aws::Crt::basic_string_view< CharT, Traits >
+
+AuthType
+: Aws::Crt::Http::HttpClientConnectionProxyOptions
+
+availabilityZone
+: Aws::Crt::Imds::InstanceInfo
+, Aws::Crt::Imds::InstanceInfoView
+
+aws_tls_handler_protocol
+: Aws::Crt::Io::TlsChannelHandler
+
+AwsSigningConfig()
+: Aws::Crt::Auth::AwsSigningConfig
+
+
+
+
+
+
+
diff --git a/docs/functions_b.html b/docs/functions_b.html
new file mode 100644
index 000000000..8b8db4442
--- /dev/null
+++ b/docs/functions_b.html
@@ -0,0 +1,117 @@
+
+
+
+
+
+
+
+aws-crt-cpp: Class Members
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ aws-crt-cpp
+
+ C++ wrapper around the aws-c-* libraries. Provides Cross-Platform Transport Protocols and SSL/TLS implementations for C++.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
Here is a list of all class members with links to the classes they belong to:
+
+
- b -
+back()
+: Aws::Crt::basic_string_view< CharT, Traits >
+
+Base
+: Aws::Crt::StlAllocator< T >
+
+basic_string_view()
+: Aws::Crt::basic_string_view< CharT, Traits >
+
+BasicAuthPassword
+: Aws::Crt::Http::HttpClientConnectionProxyOptions
+
+BasicAuthUsername
+: Aws::Crt::Http::HttpClientConnectionProxyOptions
+
+begin()
+: Aws::Crt::basic_string_view< CharT, Traits >
+
+billingProducts
+: Aws::Crt::Imds::InstanceInfo
+, Aws::Crt::Imds::InstanceInfoView
+
+Bootstrap
+: Aws::Crt::Auth::CredentialsProviderChainDefaultConfig
+, Aws::Crt::Auth::CredentialsProviderCognitoConfig
+, Aws::Crt::Auth::CredentialsProviderImdsConfig
+, Aws::Crt::Auth::CredentialsProviderProfileConfig
+, Aws::Crt::Auth::CredentialsProviderSTSConfig
+, Aws::Crt::Auth::CredentialsProviderX509Config
+, Aws::Crt::Http::HttpClientConnectionOptions
+, Aws::Crt::Imds::ImdsClientConfig
+
+Build()
+: Aws::Iot::Mqtt5ClientBuilder
+, Aws::Iot::MqttClientConnectionConfigBuilder
+
+ByoHash()
+: Aws::Crt::Crypto::ByoHash
+
+ByoHMAC()
+: Aws::Crt::Crypto::ByoHMAC
+
+
+
+
+
+
+
diff --git a/docs/functions_c.html b/docs/functions_c.html
new file mode 100644
index 000000000..f5a15eca1
--- /dev/null
+++ b/docs/functions_c.html
@@ -0,0 +1,303 @@
+
+
+
+
+
+
+
+aws-crt-cpp: Class Members
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ aws-crt-cpp
+
+ C++ wrapper around the aws-c-* libraries. Provides Cross-Platform Transport Protocols and SSL/TLS implementations for C++.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
Here is a list of all class members with links to the classes they belong to:
+
+
- c -
+CachedCredentialTTL
+: Aws::Crt::Auth::CredentialsProviderCachedConfig
+
+callback
+: Aws::Crt::Imds::WrappedCallbackArgs< T >
+
+cbegin()
+: Aws::Crt::basic_string_view< CharT, Traits >
+
+CborDecoder()
+: Aws::Crt::Cbor::CborDecoder
+
+CborEncoder()
+: Aws::Crt::Cbor::CborEncoder
+
+cend()
+: Aws::Crt::basic_string_view< CharT, Traits >
+
+ChannelHandler()
+: Aws::Crt::Io::ChannelHandler
+
+ChannelsThreadIsCallersThread()
+: Aws::Crt::Io::ChannelHandler
+
+ClientBootstrap()
+: Aws::Crt::Io::ClientBootstrap
+
+ClientStreamCallbackData()
+: Aws::Crt::Http::ClientStreamCallbackData
+
+ClientTlsChannelHandler()
+: Aws::Crt::Io::ClientTlsChannelHandler
+
+Close()
+: Aws::Crt::Http::HttpClientConnection
+
+compare()
+: Aws::Crt::basic_string_view< CharT, Traits >
+
+CompleteTlsNegotiation()
+: Aws::Crt::Io::TlsChannelHandler
+
+ComputeOneShot()
+: Aws::Crt::Crypto::Hash
+, Aws::Crt::Crypto::HMAC
+
+ConfigFileNameOverride
+: Aws::Crt::Auth::CredentialsProviderProfileConfig
+
+ConnAckPacket()
+: Aws::Crt::Mqtt5::ConnAckPacket
+
+connAckPacket
+: Aws::Crt::Mqtt5::OnConnectionFailureEventData
+, Aws::Crt::Mqtt5::OnConnectionSuccessEventData
+
+Connect()
+: Aws::Crt::Mqtt::MqttConnection
+
+connection
+: Aws::Crt::Http::ConnectionCallbackData
+
+ConnectionCallbackData()
+: Aws::Crt::Http::ConnectionCallbackData
+
+ConnectionManagerCallbackArgs()
+: Aws::Crt::Http::ConnectionManagerCallbackArgs
+
+ConnectionOptions
+: Aws::Crt::Http::HttpClientConnectionManagerOptions
+
+ConnectionType
+: Aws::Crt::Http::HttpProxyStrategyBasicAuthConfig
+
+ConnectPacket()
+: Aws::Crt::Mqtt5::ConnectPacket
+
+const_iterator
+: Aws::Crt::basic_string_view< CharT, Traits >
+
+const_pointer
+: Aws::Crt::basic_string_view< CharT, Traits >
+
+const_reference
+: Aws::Crt::basic_string_view< CharT, Traits >
+
+const_reverse_iterator
+: Aws::Crt::basic_string_view< CharT, Traits >
+
+ConstRawAlternativePointerT
+: Aws::Crt::Variant< Ts >
+
+ConsumeNextSingleElement()
+: Aws::Crt::Cbor::CborDecoder
+
+ConsumeNextWholeDataItem()
+: Aws::Crt::Cbor::CborDecoder
+
+copy()
+: Aws::Crt::basic_string_view< CharT, Traits >
+
+crbegin()
+: Aws::Crt::basic_string_view< CharT, Traits >
+
+Create()
+: Aws::Crt::Io::Pkcs11Lib
+
+CreateAdaptiveHttpProxyStrategy()
+: Aws::Crt::Http::HttpProxyStrategy
+
+CreateAES_256_CBC_Cipher()
+: Aws::Crt::Crypto::SymmetricCipher
+
+CreateAES_256_CTR_Cipher()
+: Aws::Crt::Crypto::SymmetricCipher
+
+CreateAES_256_GCM_Cipher()
+: Aws::Crt::Crypto::SymmetricCipher
+
+CreateAES_256_KeyWrap_Cipher()
+: Aws::Crt::Crypto::SymmetricCipher
+
+CreateBasicHttpProxyStrategy()
+: Aws::Crt::Http::HttpProxyStrategy
+
+CreateConnection()
+: Aws::Crt::Http::HttpClientConnection
+
+CreateCredentialsProviderAnonymous()
+: Aws::Crt::Auth::CredentialsProvider
+
+CreateCredentialsProviderCached()
+: Aws::Crt::Auth::CredentialsProvider
+
+CreateCredentialsProviderChain()
+: Aws::Crt::Auth::CredentialsProvider
+
+CreateCredentialsProviderChainDefault()
+: Aws::Crt::Auth::CredentialsProvider
+
+CreateCredentialsProviderCognito()
+: Aws::Crt::Auth::CredentialsProvider
+
+CreateCredentialsProviderDelegate()
+: Aws::Crt::Auth::CredentialsProvider
+
+CreateCredentialsProviderEnvironment()
+: Aws::Crt::Auth::CredentialsProvider
+
+CreateCredentialsProviderImds()
+: Aws::Crt::Auth::CredentialsProvider
+
+CreateCredentialsProviderProfile()
+: Aws::Crt::Auth::CredentialsProvider
+
+CreateCredentialsProviderStatic()
+: Aws::Crt::Auth::CredentialsProvider
+
+CreateCredentialsProviderSTS()
+: Aws::Crt::Auth::CredentialsProvider
+
+CreateCredentialsProviderX509()
+: Aws::Crt::Auth::CredentialsProvider
+
+CreateInvalid()
+: Aws::Iot::MqttClientConnectionConfig
+
+CreateMD5()
+: Aws::Crt::Crypto::Hash
+
+CreateSHA1()
+: Aws::Crt::Crypto::Hash
+
+CreateSHA256()
+: Aws::Crt::Crypto::Hash
+
+CreateSHA256HMAC()
+: Aws::Crt::Crypto::HMAC
+
+CreateSigningConfigCb
+: Aws::Iot::WebsocketConfig
+
+Credentials()
+: Aws::Crt::Auth::Credentials
+
+CredentialsFileNameOverride
+: Aws::Crt::Auth::CredentialsProviderProfileConfig
+
+CredentialsProvider()
+: Aws::Crt::Auth::CredentialsProvider
+, Aws::Iot::WebsocketConfig
+
+CredentialsProviderCachedConfig()
+: Aws::Crt::Auth::CredentialsProviderCachedConfig
+
+CredentialsProviderCallbackArgs()
+: Aws::Crt::Auth::CredentialsProviderCallbackArgs
+
+CredentialsProviderChainConfig()
+: Aws::Crt::Auth::CredentialsProviderChainConfig
+
+CredentialsProviderChainDefaultConfig()
+: Aws::Crt::Auth::CredentialsProviderChainDefaultConfig
+
+CredentialsProviderCognitoConfig()
+: Aws::Crt::Auth::CredentialsProviderCognitoConfig
+
+CredentialsProviderImdsConfig()
+: Aws::Crt::Auth::CredentialsProviderImdsConfig
+
+CredentialsProviderProfileConfig()
+: Aws::Crt::Auth::CredentialsProviderProfileConfig
+
+CredentialsProviderStaticConfig()
+: Aws::Crt::Auth::CredentialsProviderStaticConfig
+
+CredentialsProviderSTSConfig()
+: Aws::Crt::Auth::CredentialsProviderSTSConfig
+
+CredentialsProviderX509Config()
+: Aws::Crt::Auth::CredentialsProviderX509Config
+
+crend()
+: Aws::Crt::basic_string_view< CharT, Traits >
+
+CustomRoleArn
+: Aws::Crt::Auth::CredentialsProviderCognitoConfig
+
+
+
+
+
+
+
diff --git a/docs/functions_d.html b/docs/functions_d.html
new file mode 100644
index 000000000..a2b23a00b
--- /dev/null
+++ b/docs/functions_d.html
@@ -0,0 +1,123 @@
+
+
+
+
+
+
+
+aws-crt-cpp: Class Members
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ aws-crt-cpp
+
+ C++ wrapper around the aws-c-* libraries. Provides Cross-Platform Transport Protocols and SSL/TLS implementations for C++.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
Here is a list of all class members with links to the classes they belong to:
+
+
- d -
+
+
+
+
+
diff --git a/docs/functions_e.html b/docs/functions_e.html
new file mode 100644
index 000000000..a3188c892
--- /dev/null
+++ b/docs/functions_e.html
@@ -0,0 +1,112 @@
+
+
+
+
+
+
+
+aws-crt-cpp: Class Members
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ aws-crt-cpp
+
+ C++ wrapper around the aws-c-* libraries. Provides Cross-Platform Transport Protocols and SSL/TLS implementations for C++.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
Here is a list of all class members with links to the classes they belong to:
+
+
- e -
+
+
+
+
+
diff --git a/docs/functions_enum.html b/docs/functions_enum.html
new file mode 100644
index 000000000..0b6a13695
--- /dev/null
+++ b/docs/functions_enum.html
@@ -0,0 +1,76 @@
+
+
+
+
+
+
+
+aws-crt-cpp: Class Members - Enumerations
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ aws-crt-cpp
+
+ C++ wrapper around the aws-c-* libraries. Provides Cross-Platform Transport Protocols and SSL/TLS implementations for C++.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/docs/functions_f.html b/docs/functions_f.html
new file mode 100644
index 000000000..69b7278f9
--- /dev/null
+++ b/docs/functions_f.html
@@ -0,0 +1,99 @@
+
+
+
+
+
+
+
+aws-crt-cpp: Class Members
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ aws-crt-cpp
+
+ C++ wrapper around the aws-c-* libraries. Provides Cross-Platform Transport Protocols and SSL/TLS implementations for C++.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
Here is a list of all class members with links to the classes they belong to:
+
+
- f -
+
+
+
+
+
diff --git a/docs/functions_func.html b/docs/functions_func.html
new file mode 100644
index 000000000..50f83f5c1
--- /dev/null
+++ b/docs/functions_func.html
@@ -0,0 +1,148 @@
+
+
+
+
+
+
+
+aws-crt-cpp: Class Members - Functions
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ aws-crt-cpp
+
+ C++ wrapper around the aws-c-* libraries. Provides Cross-Platform Transport Protocols and SSL/TLS implementations for C++.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/docs/functions_func_b.html b/docs/functions_func_b.html
new file mode 100644
index 000000000..b3195e3c7
--- /dev/null
+++ b/docs/functions_func_b.html
@@ -0,0 +1,94 @@
+
+
+
+
+
+
+
+aws-crt-cpp: Class Members - Functions
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ aws-crt-cpp
+
+ C++ wrapper around the aws-c-* libraries. Provides Cross-Platform Transport Protocols and SSL/TLS implementations for C++.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/docs/functions_func_c.html b/docs/functions_func_c.html
new file mode 100644
index 000000000..a26a6c904
--- /dev/null
+++ b/docs/functions_func_c.html
@@ -0,0 +1,256 @@
+
+
+
+
+
+
+
+aws-crt-cpp: Class Members - Functions
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ aws-crt-cpp
+
+ C++ wrapper around the aws-c-* libraries. Provides Cross-Platform Transport Protocols and SSL/TLS implementations for C++.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/docs/functions_func_d.html b/docs/functions_func_d.html
new file mode 100644
index 000000000..79c90384a
--- /dev/null
+++ b/docs/functions_func_d.html
@@ -0,0 +1,114 @@
+
+
+
+
+
+
+
+aws-crt-cpp: Class Members - Functions
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ aws-crt-cpp
+
+ C++ wrapper around the aws-c-* libraries. Provides Cross-Platform Transport Protocols and SSL/TLS implementations for C++.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/docs/functions_func_e.html b/docs/functions_func_e.html
new file mode 100644
index 000000000..ef1559eb8
--- /dev/null
+++ b/docs/functions_func_e.html
@@ -0,0 +1,100 @@
+
+
+
+
+
+
+
+aws-crt-cpp: Class Members - Functions
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ aws-crt-cpp
+
+ C++ wrapper around the aws-c-* libraries. Provides Cross-Platform Transport Protocols and SSL/TLS implementations for C++.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/docs/functions_func_f.html b/docs/functions_func_f.html
new file mode 100644
index 000000000..674a412ce
--- /dev/null
+++ b/docs/functions_func_f.html
@@ -0,0 +1,99 @@
+
+
+
+
+
+
+
+aws-crt-cpp: Class Members - Functions
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ aws-crt-cpp
+
+ C++ wrapper around the aws-c-* libraries. Provides Cross-Platform Transport Protocols and SSL/TLS implementations for C++.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/docs/functions_func_g.html b/docs/functions_func_g.html
new file mode 100644
index 000000000..cda1a8364
--- /dev/null
+++ b/docs/functions_func_g.html
@@ -0,0 +1,625 @@
+
+
+
+
+
+
+
+aws-crt-cpp: Class Members - Functions
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ aws-crt-cpp
+
+ C++ wrapper around the aws-c-* libraries. Provides Cross-Platform Transport Protocols and SSL/TLS implementations for C++.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
- g -
+GatherStatistics()
+: Aws::Crt::Io::ChannelHandler
+
+get()
+: Aws::Crt::Variant< Ts >
+
+get_if()
+: Aws::Crt::Variant< Ts >
+
+GetAccessKeyId()
+: Aws::Crt::Auth::Credentials
+
+getAck()
+: Aws::Crt::Mqtt5::PublishResult
+
+GetAllObjects()
+: Aws::Crt::JsonView
+
+GetAmiId()
+: Aws::Crt::Imds::ImdsClient
+
+GetAmiLaunchIndex()
+: Aws::Crt::Imds::ImdsClient
+
+GetAmiManifestPath()
+: Aws::Crt::Imds::ImdsClient
+
+GetAncestorAmiIds()
+: Aws::Crt::Imds::ImdsClient
+
+GetArray()
+: Aws::Crt::JsonView
+
+getAssignedClientIdentifier()
+: Aws::Crt::Mqtt5::ConnAckPacket
+
+GetAttachedIamRole()
+: Aws::Crt::Imds::ImdsClient
+
+GetAuthority()
+: Aws::Crt::Io::Uri
+
+GetAuthorizerName()
+: Aws::Iot::Mqtt5CustomAuthConfig
+
+GetAvailabilityZone()
+: Aws::Crt::Imds::ImdsClient
+
+GetBlockDeviceMapping()
+: Aws::Crt::Imds::ImdsClient
+
+GetBody()
+: Aws::Crt::Http::HttpMessage
+
+GetBool()
+: Aws::Crt::JsonView
+
+getClientId()
+: Aws::Crt::Mqtt5::ConnectPacket
+, Aws::Crt::Mqtt5::NegotiatedSettings
+
+GetConnection()
+: Aws::Crt::Http::HttpStream
+
+GetConnectTimeoutMs()
+: Aws::Crt::Io::SocketOptions
+
+getContentType()
+: Aws::Crt::Mqtt5::PublishPacket
+
+getCorrelationData()
+: Aws::Crt::Mqtt5::PublishPacket
+
+GetCredentials()
+: Aws::Crt::Auth::AwsSigningConfig
+, Aws::Crt::Auth::CredentialsProvider
+, Aws::Crt::Auth::ICredentialsProvider
+, Aws::Crt::Imds::ImdsClient
+
+GetCredentialsProvider()
+: Aws::Crt::Auth::AwsSigningConfig
+
+GetCrtVersion()
+: Aws::Crt::ApiHandle
+
+GetDay()
+: Aws::Crt::DateTime
+
+GetDayOfWeek()
+: Aws::Crt::DateTime
+
+GetDouble()
+: Aws::Crt::JsonView
+
+GetEncodedData()
+: Aws::Crt::Cbor::CborEncoder
+
+GetError()
+: Aws::Crt::Endpoints::ResolutionOutcome
+
+getErrorCode()
+: Aws::Crt::Mqtt5::PublishResult
+
+GetErrorMessage()
+: Aws::Crt::JsonObject
+
+GetExpirationInSeconds()
+: Aws::Crt::Auth::AwsSigningConfig
+
+GetExpirationTimepointInSeconds()
+: Aws::Crt::Auth::Credentials
+
+GetFullUri()
+: Aws::Crt::Io::Uri
+
+GetHeader()
+: Aws::Crt::Http::HttpMessage
+
+GetHeaderCount()
+: Aws::Crt::Http::HttpMessage
+
+GetHeaders()
+: Aws::Crt::Endpoints::ResolutionOutcome
+
+GetHostName()
+: Aws::Crt::Io::Uri
+
+GetHour()
+: Aws::Crt::DateTime
+
+GetIamProfile()
+: Aws::Crt::Imds::ImdsClient
+
+GetInitializationError()
+: Aws::Crt::Io::TlsContext
+
+GetInstanceAction()
+: Aws::Crt::Imds::ImdsClient
+
+GetInstanceId()
+: Aws::Crt::Imds::ImdsClient
+
+GetInstanceInfo()
+: Aws::Crt::Imds::ImdsClient
+
+GetInstanceSignature()
+: Aws::Crt::Imds::ImdsClient
+
+GetInstanceType()
+: Aws::Crt::Imds::ImdsClient
+
+GetInt64()
+: Aws::Crt::JsonView
+
+GetInteger()
+: Aws::Crt::JsonView
+
+GetIV()
+: Aws::Crt::Crypto::SymmetricCipher
+
+GetJsonObject()
+: Aws::Crt::JsonView
+
+GetJsonObjectCopy()
+: Aws::Crt::JsonView
+
+GetKeepAlive()
+: Aws::Crt::Io::SocketOptions
+
+GetKeepAliveIntervalSec()
+: Aws::Crt::Io::SocketOptions
+
+getKeepAliveIntervalSec()
+: Aws::Crt::Mqtt5::ConnectPacket
+
+GetKeepAliveMaxFailedProbes()
+: Aws::Crt::Io::SocketOptions
+
+GetKeepAliveTimeoutSec()
+: Aws::Crt::Io::SocketOptions
+
+GetKey()
+: Aws::Crt::Crypto::SymmetricCipher
+
+GetLastError()
+: Aws::Crt::DateTime
+, Aws::Crt::UUID
+
+GetLength()
+: Aws::Crt::Io::InputStream
+
+GetLengthImpl()
+: Aws::Crt::Io::InputStream
+, Aws::Crt::Io::StdIOStreamInputStream
+
+GetMacAddress()
+: Aws::Crt::Imds::ImdsClient
+
+getMaximumPacketSize()
+: Aws::Crt::Mqtt5::ConnAckPacket
+
+getMaximumPacketSizeBytes()
+: Aws::Crt::Mqtt5::ConnectPacket
+, Aws::Crt::Mqtt5::NegotiatedSettings
+
+getMaximumPacketSizeToServer()
+: Aws::Crt::Mqtt5::ConnectPacket
+, Aws::Crt::Mqtt5::NegotiatedSettings
+
+getMaximumQOS()
+: Aws::Crt::Mqtt5::ConnAckPacket
+, Aws::Crt::Mqtt5::NegotiatedSettings
+
+getMessageExpiryIntervalSec()
+: Aws::Crt::Mqtt5::PublishPacket
+
+GetMethod()
+: Aws::Crt::Http::HttpRequest
+
+GetMinute()
+: Aws::Crt::DateTime
+
+GetMonth()
+: Aws::Crt::DateTime
+
+getName()
+: Aws::Crt::Mqtt5::UserProperty
+
+GetOmitSessionToken()
+: Aws::Crt::Auth::AwsSigningConfig
+
+GetOperationStatistics()
+: Aws::Crt::Mqtt5::Mqtt5Client
+, Aws::Crt::Mqtt::MqttConnection
+
+GetOrCreateStaticDefaultClientBootstrap()
+: Aws::Crt::ApiHandle
+
+GetOrCreateStaticDefaultEventLoopGroup()
+: Aws::Crt::ApiHandle
+
+GetOrCreateStaticDefaultHostResolver()
+: Aws::Crt::ApiHandle
+
+getPassword()
+: Aws::Crt::Mqtt5::ConnectPacket
+
+GetPassword()
+: Aws::Iot::Mqtt5CustomAuthConfig
+
+GetPath()
+: Aws::Crt::Http::HttpRequest
+, Aws::Crt::Io::Uri
+
+GetPathAndQuery()
+: Aws::Crt::Io::Uri
+
+getPayload()
+: Aws::Crt::Mqtt5::PublishPacket
+
+getPayloadFormatIndicator()
+: Aws::Crt::Mqtt5::PublishPacket
+
+GetPort()
+: Aws::Crt::Io::Uri
+
+GetPrivateIpAddress()
+: Aws::Crt::Imds::ImdsClient
+
+GetProductCodes()
+: Aws::Crt::Imds::ImdsClient
+
+GetProperties()
+: Aws::Crt::Endpoints::ResolutionOutcome
+
+GetProtocol()
+: Aws::Crt::Io::TlsChannelHandler
+
+getptr()
+: Aws::Crt::Mqtt5::Mqtt5Client
+
+GetPublicKey()
+: Aws::Crt::Imds::ImdsClient
+
+getQOS()
+: Aws::Crt::Mqtt5::PublishPacket
+
+GetQueryString()
+: Aws::Crt::Io::Uri
+
+GetRamDiskId()
+: Aws::Crt::Imds::ImdsClient
+
+getReasonCode()
+: Aws::Crt::Mqtt5::ConnAckPacket
+, Aws::Crt::Mqtt5::DisconnectPacket
+, Aws::Crt::Mqtt5::PubAckPacket
+
+getReasonCodes()
+: Aws::Crt::Mqtt5::SubAckPacket
+, Aws::Crt::Mqtt5::UnSubAckPacket
+
+getReasonString()
+: Aws::Crt::Mqtt5::ConnAckPacket
+, Aws::Crt::Mqtt5::DisconnectPacket
+, Aws::Crt::Mqtt5::PubAckPacket
+, Aws::Crt::Mqtt5::SubAckPacket
+, Aws::Crt::Mqtt5::UnSubAckPacket
+
+getReceiveMaximum()
+: Aws::Crt::Mqtt5::ConnAckPacket
+, Aws::Crt::Mqtt5::ConnectPacket
+
+getReceiveMaximumFromServer()
+: Aws::Crt::Mqtt5::NegotiatedSettings
+
+GetRegion()
+: Aws::Crt::Auth::AwsSigningConfig
+
+getRejoinedSession()
+: Aws::Crt::Mqtt5::NegotiatedSettings
+
+GetRemainingLength()
+: Aws::Crt::Cbor::CborDecoder
+
+getRequestProblemInformation()
+: Aws::Crt::Mqtt5::ConnectPacket
+
+getRequestResponseInformation()
+: Aws::Crt::Mqtt5::ConnectPacket
+
+GetReservationId()
+: Aws::Crt::Imds::ImdsClient
+
+GetResource()
+: Aws::Crt::Imds::ImdsClient
+
+GetResponseCode()
+: Aws::Crt::Http::HttpResponse
+
+getResponseInformation()
+: Aws::Crt::Mqtt5::ConnAckPacket
+
+GetResponseStatusCode()
+: Aws::Crt::Http::HttpClientStream
+, Aws::Crt::Http::HttpStream
+
+getResponseTopic()
+: Aws::Crt::Mqtt5::PublishPacket
+
+getRetain()
+: Aws::Crt::Mqtt5::PublishPacket
+
+getRetainAvailable()
+: Aws::Crt::Mqtt5::ConnAckPacket
+, Aws::Crt::Mqtt5::NegotiatedSettings
+
+GetScheme()
+: Aws::Crt::Io::Uri
+
+GetSecond()
+: Aws::Crt::DateTime
+
+GetSecretAccessKey()
+: Aws::Crt::Auth::Credentials
+
+GetSecurityGroups()
+: Aws::Crt::Imds::ImdsClient
+
+getServerKeepAlive()
+: Aws::Crt::Mqtt5::ConnAckPacket
+, Aws::Crt::Mqtt5::NegotiatedSettings
+
+getServerKeepAliveSec()
+: Aws::Crt::Mqtt5::ConnAckPacket
+, Aws::Crt::Mqtt5::NegotiatedSettings
+
+getServerReference()
+: Aws::Crt::Mqtt5::ConnAckPacket
+, Aws::Crt::Mqtt5::DisconnectPacket
+
+GetService()
+: Aws::Crt::Auth::AwsSigningConfig
+
+getSessionExpiryInterval()
+: Aws::Crt::Mqtt5::ConnAckPacket
+
+getSessionExpiryIntervalSec()
+: Aws::Crt::Mqtt5::ConnAckPacket
+, Aws::Crt::Mqtt5::ConnectPacket
+, Aws::Crt::Mqtt5::DisconnectPacket
+, Aws::Crt::Mqtt5::NegotiatedSettings
+
+getSessionPresent()
+: Aws::Crt::Mqtt5::ConnAckPacket
+
+GetSessionToken()
+: Aws::Crt::Auth::Credentials
+
+getSharedSubscriptionsAvailable()
+: Aws::Crt::Mqtt5::ConnAckPacket
+, Aws::Crt::Mqtt5::NegotiatedSettings
+
+GetShouldNormalizeUriPath()
+: Aws::Crt::Auth::AwsSigningConfig
+
+GetShouldSignHeaderCallback()
+: Aws::Crt::Auth::AwsSigningConfig
+
+GetShouldSignHeaderUserData()
+: Aws::Crt::Auth::AwsSigningConfig
+
+GetSignatureType()
+: Aws::Crt::Auth::AwsSigningConfig
+
+GetSignedBodyHeader()
+: Aws::Crt::Auth::AwsSigningConfig
+
+GetSignedBodyValue()
+: Aws::Crt::Auth::AwsSigningConfig
+
+GetSigningAlgorithm()
+: Aws::Crt::Auth::AwsSigningConfig
+
+GetSigningTimepoint()
+: Aws::Crt::Auth::AwsSigningConfig
+
+GetSlot()
+: Aws::Crt::Io::ChannelHandler
+
+GetSocketDomain()
+: Aws::Crt::Io::SocketOptions
+
+GetSocketType()
+: Aws::Crt::Io::SocketOptions
+
+GetState()
+: Aws::Crt::Crypto::SymmetricCipher
+
+GetStatus()
+: Aws::Crt::Io::InputStream
+
+GetStatusImpl()
+: Aws::Crt::Io::InputStream
+, Aws::Crt::Io::StdIOStreamInputStream
+
+GetString()
+: Aws::Crt::JsonView
+
+getSubscriptionIdentifiers()
+: Aws::Crt::Mqtt5::PublishPacket
+
+getSubscriptionIdentifiersAvailable()
+: Aws::Crt::Mqtt5::ConnAckPacket
+, Aws::Crt::Mqtt5::NegotiatedSettings
+
+GetTag()
+: Aws::Crt::Crypto::SymmetricCipher
+
+GetTokenKeyName()
+: Aws::Iot::Mqtt5CustomAuthConfig
+
+GetTokenSignature()
+: Aws::Iot::Mqtt5CustomAuthConfig
+
+GetTokenValue()
+: Aws::Iot::Mqtt5CustomAuthConfig
+
+getTopic()
+: Aws::Crt::Mqtt5::PublishPacket
+
+getTopicAlias()
+: Aws::Crt::Mqtt5::PublishPacket
+
+getTopicAliasMaximum()
+: Aws::Crt::Mqtt5::ConnAckPacket
+
+getTopicAliasMaximumToClient()
+: Aws::Crt::Mqtt5::NegotiatedSettings
+
+getTopicAliasMaximumToServer()
+: Aws::Crt::Mqtt5::NegotiatedSettings
+
+GetType()
+: Aws::Crt::Auth::AwsSigningConfig
+, Aws::Crt::Auth::ISigningConfig
+
+getType()
+: Aws::Crt::Mqtt5::ConnAckPacket
+, Aws::Crt::Mqtt5::ConnectPacket
+, Aws::Crt::Mqtt5::DisconnectPacket
+, Aws::Crt::Mqtt5::IPacket
+, Aws::Crt::Mqtt5::PubAckPacket
+, Aws::Crt::Mqtt5::PublishPacket
+, Aws::Crt::Mqtt5::SubAckPacket
+, Aws::Crt::Mqtt5::SubscribePacket
+, Aws::Crt::Mqtt5::UnSubAckPacket
+, Aws::Crt::Mqtt5::UnsubscribePacket
+
+GetUnderlyingHandle()
+: Aws::Crt::Auth::Credentials
+, Aws::Crt::Auth::CredentialsProvider
+, Aws::Crt::Auth::ICredentialsProvider
+, Aws::Crt::Imds::ImdsClient
+
+GetUrl()
+: Aws::Crt::Endpoints::ResolutionOutcome
+
+GetUseDoubleUriEncode()
+: Aws::Crt::Auth::AwsSigningConfig
+
+GetUserData()
+: Aws::Crt::Imds::ImdsClient
+
+getUsername()
+: Aws::Crt::Mqtt5::ConnectPacket
+
+GetUsername()
+: Aws::Iot::Mqtt5CustomAuthConfig
+
+getUserProperties()
+: Aws::Crt::Mqtt5::ConnectPacket
+, Aws::Crt::Mqtt5::DisconnectPacket
+, Aws::Crt::Mqtt5::PubAckPacket
+, Aws::Crt::Mqtt5::PublishPacket
+, Aws::Crt::Mqtt5::SubAckPacket
+, Aws::Crt::Mqtt5::UnSubAckPacket
+
+getUserProperty()
+: Aws::Crt::Mqtt5::ConnAckPacket
+
+getValue()
+: Aws::Crt::Mqtt5::UserProperty
+
+GetVersion()
+: Aws::Crt::Http::HttpClientConnection
+
+getWildcardSubscriptionsAvailable()
+: Aws::Crt::Mqtt5::ConnAckPacket
+, Aws::Crt::Mqtt5::NegotiatedSettings
+
+getWill()
+: Aws::Crt::Mqtt5::ConnectPacket
+
+getWillDelayIntervalSec()
+: Aws::Crt::Mqtt5::ConnectPacket
+
+GetYear()
+: Aws::Crt::DateTime
+
+
+
+
+
+
+
diff --git a/docs/functions_func_h.html b/docs/functions_func_h.html
new file mode 100644
index 000000000..59a852d3f
--- /dev/null
+++ b/docs/functions_func_h.html
@@ -0,0 +1,126 @@
+
+
+
+
+
+
+
+aws-crt-cpp: Class Members - Functions
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ aws-crt-cpp
+
+ C++ wrapper around the aws-c-* libraries. Provides Cross-Platform Transport Protocols and SSL/TLS implementations for C++.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/docs/functions_func_i.html b/docs/functions_func_i.html
new file mode 100644
index 000000000..065b1f378
--- /dev/null
+++ b/docs/functions_func_i.html
@@ -0,0 +1,194 @@
+
+
+
+
+
+
+
+aws-crt-cpp: Class Members - Functions
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ aws-crt-cpp
+
+ C++ wrapper around the aws-c-* libraries. Provides Cross-Platform Transport Protocols and SSL/TLS implementations for C++.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
- i -
+IamProfile()
+: Aws::Crt::Imds::IamProfile
+
+IHttpRequestSigner()
+: Aws::Crt::Auth::IHttpRequestSigner
+
+ImdsClient()
+: Aws::Crt::Imds::ImdsClient
+
+ImdsClientConfig()
+: Aws::Crt::Imds::ImdsClientConfig
+
+IncrementReadWindow()
+: Aws::Crt::Io::ChannelHandler
+
+IncrementUpstreamReadWindow()
+: Aws::Crt::Io::ChannelHandler
+
+index()
+: Aws::Crt::Variant< Ts >
+
+InitClientWithMtls()
+: Aws::Crt::Io::TlsContextOptions
+
+InitClientWithMtlsPkcs11()
+: Aws::Crt::Io::TlsContextOptions
+
+InitClientWithMtlsPkcs12()
+: Aws::Crt::Io::TlsContextOptions
+
+InitClientWithMtlsSystemPath()
+: Aws::Crt::Io::TlsContextOptions
+
+InitDefaultClient()
+: Aws::Crt::Io::TlsContextOptions
+
+InitializeLogging()
+: Aws::Crt::ApiHandle
+
+initializeRawOptions()
+: Aws::Crt::Mqtt5::ConnectPacket
+, Aws::Crt::Mqtt5::DisconnectPacket
+, Aws::Crt::Mqtt5::Mqtt5ClientOptions
+, Aws::Crt::Mqtt5::PublishPacket
+, Aws::Crt::Mqtt5::SubscribePacket
+, Aws::Crt::Mqtt5::Subscription
+, Aws::Crt::Mqtt5::UnsubscribePacket
+
+InitializeRawProxyOptions()
+: Aws::Crt::Http::HttpClientConnectionProxyOptions
+
+InitialWindowSize()
+: Aws::Crt::Io::ChannelHandler
+
+InitiateShutdown()
+: Aws::Crt::Http::HttpClientConnectionManager
+
+InPlaceT()
+: Aws::Crt::InPlaceT
+
+InPlaceTypeT()
+: Aws::Crt::InPlaceTypeT< T >
+
+InputStream()
+: Aws::Crt::Io::InputStream
+
+InstanceInfo()
+: Aws::Crt::Imds::InstanceInfo
+
+IsAlpnSupported()
+: Aws::Crt::Io::TlsContextOptions
+
+IsBool()
+: Aws::Crt::JsonView
+
+IsDST()
+: Aws::Crt::DateTime
+
+IsEndpoint()
+: Aws::Crt::Endpoints::ResolutionOutcome
+
+IsError()
+: Aws::Crt::Endpoints::ResolutionOutcome
+
+IsFloatingPointType()
+: Aws::Crt::JsonView
+
+ISigningConfig()
+: Aws::Crt::Auth::ISigningConfig
+
+IsIntegerType()
+: Aws::Crt::JsonView
+
+IsListType()
+: Aws::Crt::JsonView
+
+IsNull()
+: Aws::Crt::JsonView
+
+IsNumber()
+: Aws::Crt::JsonView
+
+IsObject()
+: Aws::Crt::JsonView
+
+IsOpen()
+: Aws::Crt::Http::HttpClientConnection
+
+IsString()
+: Aws::Crt::JsonView
+
+IsValid()
+: Aws::Crt::Auth::CredentialsProvider
+, Aws::Crt::Auth::ICredentialsProvider
+, Aws::Crt::Auth::IHttpRequestSigner
+, Aws::Crt::Auth::Sigv4HttpRequestSigner
+, Aws::Crt::Io::InputStream
+, Aws::Crt::Io::StdIOStreamInputStream
+
+
+
+
+
+
+
diff --git a/docs/functions_func_j.html b/docs/functions_func_j.html
new file mode 100644
index 000000000..b499d3366
--- /dev/null
+++ b/docs/functions_func_j.html
@@ -0,0 +1,81 @@
+
+
+
+
+
+
+
+aws-crt-cpp: Class Members - Functions
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ aws-crt-cpp
+
+ C++ wrapper around the aws-c-* libraries. Provides Cross-Platform Transport Protocols and SSL/TLS implementations for C++.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/docs/functions_func_k.html b/docs/functions_func_k.html
new file mode 100644
index 000000000..2f365f1d2
--- /dev/null
+++ b/docs/functions_func_k.html
@@ -0,0 +1,81 @@
+
+
+
+
+
+
+
+aws-crt-cpp: Class Members - Functions
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ aws-crt-cpp
+
+ C++ wrapper around the aws-c-* libraries. Provides Cross-Platform Transport Protocols and SSL/TLS implementations for C++.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/docs/functions_func_l.html b/docs/functions_func_l.html
new file mode 100644
index 000000000..17f8b3113
--- /dev/null
+++ b/docs/functions_func_l.html
@@ -0,0 +1,98 @@
+
+
+
+
+
+
+
+aws-crt-cpp: Class Members - Functions
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ aws-crt-cpp
+
+ C++ wrapper around the aws-c-* libraries. Provides Cross-Platform Transport Protocols and SSL/TLS implementations for C++.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
- l -
+LastError()
+: Aws::Crt::Cbor::CborDecoder
+, Aws::Crt::Crypto::Hash
+, Aws::Crt::Crypto::HMAC
+, Aws::Crt::Crypto::SymmetricCipher
+, Aws::Crt::Http::HttpClientConnection
+, Aws::Crt::Io::ClientBootstrap
+, Aws::Crt::Io::DefaultHostResolver
+, Aws::Crt::Io::EventLoopGroup
+, Aws::Crt::Io::TlsConnectionOptions
+, Aws::Crt::Io::TlsContextOptions
+, Aws::Crt::Io::Uri
+, Aws::Crt::Mqtt5::Mqtt5Client
+, Aws::Crt::Mqtt::MqttClient
+, Aws::Crt::Mqtt::MqttConnection
+, Aws::Iot::Mqtt5ClientBuilder
+, Aws::Iot::MqttClient
+, Aws::Iot::MqttClientConnectionConfig
+, Aws::Iot::MqttClientConnectionConfigBuilder
+
+length()
+: Aws::Crt::basic_string_view< CharT, Traits >
+
+
+
+
+
+
+
diff --git a/docs/functions_func_m.html b/docs/functions_func_m.html
new file mode 100644
index 000000000..f11df17b0
--- /dev/null
+++ b/docs/functions_func_m.html
@@ -0,0 +1,112 @@
+
+
+
+
+
+
+
+aws-crt-cpp: Class Members - Functions
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ aws-crt-cpp
+
+ C++ wrapper around the aws-c-* libraries. Provides Cross-Platform Transport Protocols and SSL/TLS implementations for C++.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/docs/functions_func_n.html b/docs/functions_func_n.html
new file mode 100644
index 000000000..0ea529baa
--- /dev/null
+++ b/docs/functions_func_n.html
@@ -0,0 +1,133 @@
+
+
+
+
+
+
+
+aws-crt-cpp: Class Members - Functions
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ aws-crt-cpp
+
+ C++ wrapper around the aws-c-* libraries. Provides Cross-Platform Transport Protocols and SSL/TLS implementations for C++.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/docs/functions_func_o.html b/docs/functions_func_o.html
new file mode 100644
index 000000000..4beedb4e7
--- /dev/null
+++ b/docs/functions_func_o.html
@@ -0,0 +1,233 @@
+
+
+
+
+
+
+
+aws-crt-cpp: Class Members - Functions
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ aws-crt-cpp
+
+ C++ wrapper around the aws-c-* libraries. Provides Cross-Platform Transport Protocols and SSL/TLS implementations for C++.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
- o -
+OnAttemptingConnectEventData()
+: Aws::Crt::Mqtt5::OnAttemptingConnectEventData
+
+OnConnectionFailureEventData()
+: Aws::Crt::Mqtt5::OnConnectionFailureEventData
+
+OnConnectionSuccessEventData()
+: Aws::Crt::Mqtt5::OnConnectionSuccessEventData
+
+OnDisconnectionEventData()
+: Aws::Crt::Mqtt5::OnDisconnectionEventData
+
+OnShutdownComplete()
+: Aws::Crt::Io::ChannelHandler
+
+OnStoppedEventData()
+: Aws::Crt::Mqtt5::OnStoppedEventData
+
+operator bool()
+: Aws::Crt::Auth::Credentials
+, Aws::Crt::Crypto::Hash
+, Aws::Crt::Crypto::HMAC
+, Aws::Crt::Crypto::SymmetricCipher
+, Aws::Crt::DateTime
+, Aws::Crt::Endpoints::RequestContext
+, Aws::Crt::Endpoints::ResolutionOutcome
+, Aws::Crt::Endpoints::RuleEngine
+, Aws::Crt::Http::HttpMessage
+, Aws::Crt::Io::ClientBootstrap
+, Aws::Crt::Io::DefaultHostResolver
+, Aws::Crt::Io::EventLoopGroup
+, Aws::Crt::Io::InputStream
+, Aws::Crt::Io::TlsConnectionOptions
+, Aws::Crt::Io::TlsContext
+, Aws::Crt::Io::TlsContextOptions
+, Aws::Crt::Io::Uri
+, Aws::Crt::Mqtt5::Mqtt5Client
+, Aws::Crt::Mqtt::MqttClient
+, Aws::Crt::Mqtt::MqttConnection
+, Aws::Crt::Optional< T >
+, Aws::Crt::UUID
+, Aws::Iot::Mqtt5ClientBuilder
+, Aws::Iot::MqttClient
+, Aws::Iot::MqttClientConnectionConfig
+, Aws::Iot::MqttClientConnectionConfigBuilder
+
+operator ByteBuf()
+: Aws::Crt::UUID
+
+operator String()
+: Aws::Crt::UUID
+
+operator!=()
+: Aws::Crt::DateTime
+, Aws::Crt::JsonObject
+, Aws::Crt::UUID
+
+operator()()
+: std::hash< Aws::Crt::basic_string_view< CharT, Traits > >
+
+operator*()
+: Aws::Crt::Optional< T >
+
+operator+()
+: Aws::Crt::DateTime
+
+operator-()
+: Aws::Crt::DateTime
+
+operator->()
+: Aws::Crt::Optional< T >
+
+operator<()
+: Aws::Crt::DateTime
+
+operator<=()
+: Aws::Crt::DateTime
+
+operator=()
+: Aws::Crt::ApiHandle
+, Aws::Crt::Auth::Credentials
+, Aws::Crt::Auth::CredentialsProvider
+, Aws::Crt::Auth::IHttpRequestSigner
+, Aws::Crt::Auth::ISigningConfig
+, Aws::Crt::basic_string_view< CharT, Traits >
+, Aws::Crt::Cbor::CborDecoder
+, Aws::Crt::Cbor::CborEncoder
+, Aws::Crt::Crypto::Hash
+, Aws::Crt::Crypto::HMAC
+, Aws::Crt::Crypto::SymmetricCipher
+, Aws::Crt::DateTime
+, Aws::Crt::Endpoints::RequestContext
+, Aws::Crt::Endpoints::ResolutionOutcome
+, Aws::Crt::Endpoints::RuleEngine
+, Aws::Crt::Http::HttpClientConnection
+, Aws::Crt::Http::HttpClientConnectionManagerOptions
+, Aws::Crt::Http::HttpClientConnectionOptions
+, Aws::Crt::Http::HttpClientConnectionProxyOptions
+, Aws::Crt::Http::HttpClientStream
+, Aws::Crt::Http::HttpMessage
+, Aws::Crt::Http::HttpStream
+, Aws::Crt::Imds::IamProfile
+, Aws::Crt::Imds::ImdsClient
+, Aws::Crt::Imds::InstanceInfo
+, Aws::Crt::Io::ChannelHandler
+, Aws::Crt::Io::ClientBootstrap
+, Aws::Crt::Io::DefaultHostResolver
+, Aws::Crt::Io::EventLoopGroup
+, Aws::Crt::Io::InputStream
+, Aws::Crt::Io::SocketOptions
+, Aws::Crt::Io::TlsConnectionOptions
+, Aws::Crt::Io::TlsContext
+, Aws::Crt::Io::TlsContextOptions
+, Aws::Crt::Io::Uri
+, Aws::Crt::JsonObject
+, Aws::Crt::JsonView
+, Aws::Crt::Mqtt5::ConnAckPacket
+, Aws::Crt::Mqtt5::ConnectPacket
+, Aws::Crt::Mqtt5::DisconnectPacket
+, Aws::Crt::Mqtt5::Mqtt5ClientOptions
+, Aws::Crt::Mqtt5::NegotiatedSettings
+, Aws::Crt::Mqtt5::PubAckPacket
+, Aws::Crt::Mqtt5::PublishPacket
+, Aws::Crt::Mqtt5::PublishResult
+, Aws::Crt::Mqtt5::SubAckPacket
+, Aws::Crt::Mqtt5::SubscribePacket
+, Aws::Crt::Mqtt5::Subscription
+, Aws::Crt::Mqtt5::UnSubAckPacket
+, Aws::Crt::Mqtt5::UnsubscribePacket
+, Aws::Crt::Mqtt5::UserProperty
+, Aws::Crt::Mqtt::MqttClient
+, Aws::Crt::Mqtt::MqttConnection
+, Aws::Crt::Optional< T >
+, Aws::Crt::UUID
+, Aws::Crt::Variant< Ts >
+, Aws::Iot::Mqtt5ClientBuilder
+, Aws::Iot::Mqtt5CustomAuthConfig
+
+operator==()
+: Aws::Crt::DateTime
+, Aws::Crt::JsonObject
+, Aws::Crt::UUID
+
+operator>()
+: Aws::Crt::DateTime
+
+operator>=()
+: Aws::Crt::DateTime
+
+operator[]()
+: Aws::Crt::basic_string_view< CharT, Traits >
+
+Optional()
+: Aws::Crt::Optional< T >
+
+OverrideDefaultTrustStore()
+: Aws::Crt::Io::TlsContextOptions
+
+
+
+
+
+
+
diff --git a/docs/functions_func_p.html b/docs/functions_func_p.html
new file mode 100644
index 000000000..98e69ec07
--- /dev/null
+++ b/docs/functions_func_p.html
@@ -0,0 +1,134 @@
+
+
+
+
+
+
+
+aws-crt-cpp: Class Members - Functions
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ aws-crt-cpp
+
+ C++ wrapper around the aws-c-* libraries. Provides Cross-Platform Transport Protocols and SSL/TLS implementations for C++.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/docs/functions_func_r.html b/docs/functions_func_r.html
new file mode 100644
index 000000000..d47d47c42
--- /dev/null
+++ b/docs/functions_func_r.html
@@ -0,0 +1,133 @@
+
+
+
+
+
+
+
+aws-crt-cpp: Class Members - Functions
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ aws-crt-cpp
+
+ C++ wrapper around the aws-c-* libraries. Provides Cross-Platform Transport Protocols and SSL/TLS implementations for C++.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/docs/functions_func_s.html b/docs/functions_func_s.html
new file mode 100644
index 000000000..53b6674fd
--- /dev/null
+++ b/docs/functions_func_s.html
@@ -0,0 +1,310 @@
+
+
+
+
+
+
+
+aws-crt-cpp: Class Members - Functions
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ aws-crt-cpp
+
+ C++ wrapper around the aws-c-* libraries. Provides Cross-Platform Transport Protocols and SSL/TLS implementations for C++.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/docs/functions_func_t.html b/docs/functions_func_t.html
new file mode 100644
index 000000000..a58461b38
--- /dev/null
+++ b/docs/functions_func_t.html
@@ -0,0 +1,99 @@
+
+
+
+
+
+
+
+aws-crt-cpp: Class Members - Functions
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ aws-crt-cpp
+
+ C++ wrapper around the aws-c-* libraries. Provides Cross-Platform Transport Protocols and SSL/TLS implementations for C++.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/docs/functions_func_u.html b/docs/functions_func_u.html
new file mode 100644
index 000000000..a62a48802
--- /dev/null
+++ b/docs/functions_func_u.html
@@ -0,0 +1,114 @@
+
+
+
+
+
+
+
+aws-crt-cpp: Class Members - Functions
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ aws-crt-cpp
+
+ C++ wrapper around the aws-c-* libraries. Provides Cross-Platform Transport Protocols and SSL/TLS implementations for C++.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/docs/functions_func_v.html b/docs/functions_func_v.html
new file mode 100644
index 000000000..72bbd7ab5
--- /dev/null
+++ b/docs/functions_func_v.html
@@ -0,0 +1,93 @@
+
+
+
+
+
+
+
+aws-crt-cpp: Class Members - Functions
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ aws-crt-cpp
+
+ C++ wrapper around the aws-c-* libraries. Provides Cross-Platform Transport Protocols and SSL/TLS implementations for C++.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/docs/functions_func_w.html b/docs/functions_func_w.html
new file mode 100644
index 000000000..392f6253e
--- /dev/null
+++ b/docs/functions_func_w.html
@@ -0,0 +1,428 @@
+
+
+
+
+
+
+
+aws-crt-cpp: Class Members - Functions
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ aws-crt-cpp
+
+ C++ wrapper around the aws-c-* libraries. Provides Cross-Platform Transport Protocols and SSL/TLS implementations for C++.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
- w -
+WasParseSuccessful()
+: Aws::Crt::JsonObject
+
+wasSuccessful()
+: Aws::Crt::Mqtt5::PublishResult
+
+WebsocketConfig()
+: Aws::Iot::WebsocketConfig
+
+WithAckTimeoutSec()
+: Aws::Crt::Mqtt5::Mqtt5ClientOptions
+, Aws::Iot::Mqtt5ClientBuilder
+
+WithAckTimeoutSeconds()
+: Aws::Crt::Mqtt5::Mqtt5ClientOptions
+, Aws::Iot::Mqtt5ClientBuilder
+
+WithArray()
+: Aws::Crt::JsonObject
+
+WithAuthorizerName()
+: Aws::Iot::Mqtt5CustomAuthConfig
+
+WithBool()
+: Aws::Crt::JsonObject
+
+WithBootstrap()
+: Aws::Crt::Mqtt5::Mqtt5ClientOptions
+, Aws::Iot::Mqtt5ClientBuilder
+
+WithCertificateAuthority()
+: Aws::Iot::Mqtt5ClientBuilder
+, Aws::Iot::MqttClientConnectionConfigBuilder
+
+WithClientAttemptingConnectCallback()
+: Aws::Crt::Mqtt5::Mqtt5ClientOptions
+, Aws::Iot::Mqtt5ClientBuilder
+
+WithClientConnectionFailureCallback()
+: Aws::Crt::Mqtt5::Mqtt5ClientOptions
+, Aws::Iot::Mqtt5ClientBuilder
+
+WithClientConnectionSuccessCallback()
+: Aws::Crt::Mqtt5::Mqtt5ClientOptions
+, Aws::Iot::Mqtt5ClientBuilder
+
+WithClientDisconnectionCallback()
+: Aws::Crt::Mqtt5::Mqtt5ClientOptions
+, Aws::Iot::Mqtt5ClientBuilder
+
+WithClientExtendedValidationAndFlowControl()
+: Aws::Crt::Mqtt5::Mqtt5ClientOptions
+, Aws::Iot::Mqtt5ClientBuilder
+
+WithClientId()
+: Aws::Crt::Mqtt5::ConnectPacket
+
+WithClientStoppedCallback()
+: Aws::Crt::Mqtt5::Mqtt5ClientOptions
+, Aws::Iot::Mqtt5ClientBuilder
+
+WithConnackTimeoutMs()
+: Aws::Crt::Mqtt5::Mqtt5ClientOptions
+, Aws::Iot::Mqtt5ClientBuilder
+
+WithConnectOptions()
+: Aws::Crt::Mqtt5::Mqtt5ClientOptions
+, Aws::Iot::Mqtt5ClientBuilder
+
+WithCorrelationData()
+: Aws::Crt::Mqtt5::PublishPacket
+
+WithCustomAuthorizer()
+: Aws::Iot::Mqtt5ClientBuilder
+, Aws::Iot::MqttClientConnectionConfigBuilder
+
+WithDouble()
+: Aws::Crt::JsonObject
+
+WithEndpoint()
+: Aws::Iot::MqttClientConnectionConfigBuilder
+
+WithHostName()
+: Aws::Crt::Mqtt5::Mqtt5ClientOptions
+, Aws::Iot::Mqtt5ClientBuilder
+
+WithHttpProxyOptions()
+: Aws::Crt::Mqtt5::Mqtt5ClientOptions
+, Aws::Iot::Mqtt5ClientBuilder
+, Aws::Iot::MqttClientConnectionConfigBuilder
+
+WithInt64()
+: Aws::Crt::JsonObject
+
+WithInteger()
+: Aws::Crt::JsonObject
+
+WithKeepAliveIntervalSec()
+: Aws::Crt::Mqtt5::ConnectPacket
+
+WithMaximumPacketSizeBytes()
+: Aws::Crt::Mqtt5::ConnectPacket
+
+WithMessageExpiryIntervalSec()
+: Aws::Crt::Mqtt5::PublishPacket
+
+WithMetricsCollection()
+: Aws::Iot::MqttClientConnectionConfigBuilder
+
+WithMinConnectedTimeToResetReconnectDelayMs()
+: Aws::Iot::Mqtt5ClientBuilder
+
+WithMinimumTlsVersion()
+: Aws::Iot::MqttClientConnectionConfigBuilder
+
+WithNoLocal()
+: Aws::Crt::Mqtt5::Subscription
+
+WithObject()
+: Aws::Crt::JsonObject
+
+WithOfflineQueueBehavior()
+: Aws::Crt::Mqtt5::Mqtt5ClientOptions
+, Aws::Iot::Mqtt5ClientBuilder
+
+WithPassword()
+: Aws::Crt::Mqtt5::ConnectPacket
+, Aws::Iot::Mqtt5CustomAuthConfig
+, Aws::Iot::MqttClientConnectionConfigBuilder
+
+WithPayload()
+: Aws::Crt::Mqtt5::PublishPacket
+
+WithPayloadFormatIndicator()
+: Aws::Crt::Mqtt5::PublishPacket
+
+WithPingTimeoutMs()
+: Aws::Crt::Mqtt5::Mqtt5ClientOptions
+, Aws::Iot::Mqtt5ClientBuilder
+
+WithPort()
+: Aws::Crt::Mqtt5::Mqtt5ClientOptions
+, Aws::Iot::Mqtt5ClientBuilder
+
+WithPortOverride()
+: Aws::Iot::MqttClientConnectionConfigBuilder
+
+WithPublishReceivedCallback()
+: Aws::Crt::Mqtt5::Mqtt5ClientOptions
+, Aws::Iot::Mqtt5ClientBuilder
+
+WithQOS()
+: Aws::Crt::Mqtt5::PublishPacket
+, Aws::Crt::Mqtt5::Subscription
+
+WithReasonCode()
+: Aws::Crt::Mqtt5::DisconnectPacket
+
+WithReasonString()
+: Aws::Crt::Mqtt5::DisconnectPacket
+
+WithReceiveMaximum()
+: Aws::Crt::Mqtt5::ConnectPacket
+
+WithReconnectOptions()
+: Aws::Crt::Mqtt5::Mqtt5ClientOptions
+, Aws::Iot::Mqtt5ClientBuilder
+
+WithRequestProblemInformation()
+: Aws::Crt::Mqtt5::ConnectPacket
+
+WithRequestResponseInformation()
+: Aws::Crt::Mqtt5::ConnectPacket
+
+WithResponseTopic()
+: Aws::Crt::Mqtt5::PublishPacket
+
+WithRetain()
+: Aws::Crt::Mqtt5::PublishPacket
+, Aws::Crt::Mqtt5::Subscription
+
+WithRetainAsPublished()
+: Aws::Crt::Mqtt5::Subscription
+
+WithRetainHandlingType()
+: Aws::Crt::Mqtt5::Subscription
+
+WithSdkName()
+: Aws::Iot::Mqtt5ClientBuilder
+, Aws::Iot::MqttClientConnectionConfigBuilder
+
+WithSdkVersion()
+: Aws::Iot::Mqtt5ClientBuilder
+, Aws::Iot::MqttClientConnectionConfigBuilder
+
+WithServerReference()
+: Aws::Crt::Mqtt5::DisconnectPacket
+
+WithSessionBehavior()
+: Aws::Crt::Mqtt5::Mqtt5ClientOptions
+, Aws::Iot::Mqtt5ClientBuilder
+
+WithSessionExpiryIntervalSec()
+: Aws::Crt::Mqtt5::ConnectPacket
+, Aws::Crt::Mqtt5::DisconnectPacket
+
+WithSocketOptions()
+: Aws::Crt::Mqtt5::Mqtt5ClientOptions
+, Aws::Iot::Mqtt5ClientBuilder
+
+WithString()
+: Aws::Crt::JsonObject
+
+WithSubscription()
+: Aws::Crt::Mqtt5::SubscribePacket
+
+WithSubscriptionIdentifier()
+: Aws::Crt::Mqtt5::SubscribePacket
+
+WithSubscriptions()
+: Aws::Crt::Mqtt5::SubscribePacket
+
+WithTcpConnectTimeout()
+: Aws::Iot::MqttClientConnectionConfigBuilder
+
+WithTcpKeepAlive()
+: Aws::Iot::MqttClientConnectionConfigBuilder
+
+WithTcpKeepAliveInterval()
+: Aws::Iot::MqttClientConnectionConfigBuilder
+
+WithTcpKeepAliveMaxProbes()
+: Aws::Iot::MqttClientConnectionConfigBuilder
+
+WithTcpKeepAliveTimeout()
+: Aws::Iot::MqttClientConnectionConfigBuilder
+
+WithTlsConnectionOptions()
+: Aws::Crt::Mqtt5::Mqtt5ClientOptions
+
+WithTokenKeyName()
+: Aws::Iot::Mqtt5CustomAuthConfig
+
+WithTokenSignature()
+: Aws::Iot::Mqtt5CustomAuthConfig
+
+WithTokenValue()
+: Aws::Iot::Mqtt5CustomAuthConfig
+
+WithTopic()
+: Aws::Crt::Mqtt5::PublishPacket
+
+WithTopicAlias()
+: Aws::Crt::Mqtt5::PublishPacket
+
+WithTopicAliasingOptions()
+: Aws::Crt::Mqtt5::Mqtt5ClientOptions
+, Aws::Iot::Mqtt5ClientBuilder
+
+WithTopicFilter()
+: Aws::Crt::Mqtt5::Subscription
+, Aws::Crt::Mqtt5::UnsubscribePacket
+
+WithTopicFilters()
+: Aws::Crt::Mqtt5::UnsubscribePacket
+
+WithUserName()
+: Aws::Crt::Mqtt5::ConnectPacket
+
+WithUsername()
+: Aws::Iot::Mqtt5CustomAuthConfig
+, Aws::Iot::MqttClientConnectionConfigBuilder
+
+WithUserProperties()
+: Aws::Crt::Mqtt5::ConnectPacket
+, Aws::Crt::Mqtt5::DisconnectPacket
+, Aws::Crt::Mqtt5::PublishPacket
+, Aws::Crt::Mqtt5::SubscribePacket
+, Aws::Crt::Mqtt5::UnsubscribePacket
+
+WithUserProperty()
+: Aws::Crt::Mqtt5::ConnectPacket
+, Aws::Crt::Mqtt5::DisconnectPacket
+, Aws::Crt::Mqtt5::PublishPacket
+, Aws::Crt::Mqtt5::SubscribePacket
+, Aws::Crt::Mqtt5::UnsubscribePacket
+
+WithWebsocketHandshakeTransformCallback()
+: Aws::Crt::Mqtt5::Mqtt5ClientOptions
+
+WithWill()
+: Aws::Crt::Mqtt5::ConnectPacket
+
+WithWillDelayIntervalSec()
+: Aws::Crt::Mqtt5::ConnectPacket
+
+WrappedCallbackArgs()
+: Aws::Crt::Imds::WrappedCallbackArgs< T >
+
+WriteArrayStart()
+: Aws::Crt::Cbor::CborEncoder
+
+WriteBool()
+: Aws::Crt::Cbor::CborEncoder
+
+WriteBreak()
+: Aws::Crt::Cbor::CborEncoder
+
+WriteBytes()
+: Aws::Crt::Cbor::CborEncoder
+
+WriteCompact()
+: Aws::Crt::JsonView
+
+WriteFloat()
+: Aws::Crt::Cbor::CborEncoder
+
+WriteIndefArrayStart()
+: Aws::Crt::Cbor::CborEncoder
+
+WriteIndefBytesStart()
+: Aws::Crt::Cbor::CborEncoder
+
+WriteIndefMapStart()
+: Aws::Crt::Cbor::CborEncoder
+
+WriteIndefTextStart()
+: Aws::Crt::Cbor::CborEncoder
+
+WriteMapStart()
+: Aws::Crt::Cbor::CborEncoder
+
+WriteNegInt()
+: Aws::Crt::Cbor::CborEncoder
+
+WriteNull()
+: Aws::Crt::Cbor::CborEncoder
+
+WriteReadable()
+: Aws::Crt::JsonView
+
+WriteTag()
+: Aws::Crt::Cbor::CborEncoder
+
+WriteText()
+: Aws::Crt::Cbor::CborEncoder
+
+WriteUInt()
+: Aws::Crt::Cbor::CborEncoder
+
+WriteUndefined()
+: Aws::Crt::Cbor::CborEncoder
+
+
+
+
+
+
+
diff --git a/docs/functions_func_~.html b/docs/functions_func_~.html
new file mode 100644
index 000000000..cf3c37e2e
--- /dev/null
+++ b/docs/functions_func_~.html
@@ -0,0 +1,267 @@
+
+
+
+
+
+
+
+aws-crt-cpp: Class Members - Functions
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ aws-crt-cpp
+
+ C++ wrapper around the aws-c-* libraries. Provides Cross-Platform Transport Protocols and SSL/TLS implementations for C++.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/docs/functions_g.html b/docs/functions_g.html
new file mode 100644
index 000000000..d05bf7e82
--- /dev/null
+++ b/docs/functions_g.html
@@ -0,0 +1,625 @@
+
+
+
+
+
+
+
+aws-crt-cpp: Class Members
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ aws-crt-cpp
+
+ C++ wrapper around the aws-c-* libraries. Provides Cross-Platform Transport Protocols and SSL/TLS implementations for C++.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
Here is a list of all class members with links to the classes they belong to:
+
+
- g -
+GatherStatistics()
+: Aws::Crt::Io::ChannelHandler
+
+get()
+: Aws::Crt::Variant< Ts >
+
+get_if()
+: Aws::Crt::Variant< Ts >
+
+GetAccessKeyId()
+: Aws::Crt::Auth::Credentials
+
+getAck()
+: Aws::Crt::Mqtt5::PublishResult
+
+GetAllObjects()
+: Aws::Crt::JsonView
+
+GetAmiId()
+: Aws::Crt::Imds::ImdsClient
+
+GetAmiLaunchIndex()
+: Aws::Crt::Imds::ImdsClient
+
+GetAmiManifestPath()
+: Aws::Crt::Imds::ImdsClient
+
+GetAncestorAmiIds()
+: Aws::Crt::Imds::ImdsClient
+
+GetArray()
+: Aws::Crt::JsonView
+
+getAssignedClientIdentifier()
+: Aws::Crt::Mqtt5::ConnAckPacket
+
+GetAttachedIamRole()
+: Aws::Crt::Imds::ImdsClient
+
+GetAuthority()
+: Aws::Crt::Io::Uri
+
+GetAuthorizerName()
+: Aws::Iot::Mqtt5CustomAuthConfig
+
+GetAvailabilityZone()
+: Aws::Crt::Imds::ImdsClient
+
+GetBlockDeviceMapping()
+: Aws::Crt::Imds::ImdsClient
+
+GetBody()
+: Aws::Crt::Http::HttpMessage
+
+GetBool()
+: Aws::Crt::JsonView
+
+getClientId()
+: Aws::Crt::Mqtt5::ConnectPacket
+, Aws::Crt::Mqtt5::NegotiatedSettings
+
+GetConnection()
+: Aws::Crt::Http::HttpStream
+
+GetConnectTimeoutMs()
+: Aws::Crt::Io::SocketOptions
+
+getContentType()
+: Aws::Crt::Mqtt5::PublishPacket
+
+getCorrelationData()
+: Aws::Crt::Mqtt5::PublishPacket
+
+GetCredentials()
+: Aws::Crt::Auth::AwsSigningConfig
+, Aws::Crt::Auth::CredentialsProvider
+, Aws::Crt::Auth::ICredentialsProvider
+, Aws::Crt::Imds::ImdsClient
+
+GetCredentialsProvider()
+: Aws::Crt::Auth::AwsSigningConfig
+
+GetCrtVersion()
+: Aws::Crt::ApiHandle
+
+GetDay()
+: Aws::Crt::DateTime
+
+GetDayOfWeek()
+: Aws::Crt::DateTime
+
+GetDouble()
+: Aws::Crt::JsonView
+
+GetEncodedData()
+: Aws::Crt::Cbor::CborEncoder
+
+GetError()
+: Aws::Crt::Endpoints::ResolutionOutcome
+
+getErrorCode()
+: Aws::Crt::Mqtt5::PublishResult
+
+GetErrorMessage()
+: Aws::Crt::JsonObject
+
+GetExpirationInSeconds()
+: Aws::Crt::Auth::AwsSigningConfig
+
+GetExpirationTimepointInSeconds()
+: Aws::Crt::Auth::Credentials
+
+GetFullUri()
+: Aws::Crt::Io::Uri
+
+GetHeader()
+: Aws::Crt::Http::HttpMessage
+
+GetHeaderCount()
+: Aws::Crt::Http::HttpMessage
+
+GetHeaders()
+: Aws::Crt::Endpoints::ResolutionOutcome
+
+GetHostName()
+: Aws::Crt::Io::Uri
+
+GetHour()
+: Aws::Crt::DateTime
+
+GetIamProfile()
+: Aws::Crt::Imds::ImdsClient
+
+GetInitializationError()
+: Aws::Crt::Io::TlsContext
+
+GetInstanceAction()
+: Aws::Crt::Imds::ImdsClient
+
+GetInstanceId()
+: Aws::Crt::Imds::ImdsClient
+
+GetInstanceInfo()
+: Aws::Crt::Imds::ImdsClient
+
+GetInstanceSignature()
+: Aws::Crt::Imds::ImdsClient
+
+GetInstanceType()
+: Aws::Crt::Imds::ImdsClient
+
+GetInt64()
+: Aws::Crt::JsonView
+
+GetInteger()
+: Aws::Crt::JsonView
+
+GetIV()
+: Aws::Crt::Crypto::SymmetricCipher
+
+GetJsonObject()
+: Aws::Crt::JsonView
+
+GetJsonObjectCopy()
+: Aws::Crt::JsonView
+
+GetKeepAlive()
+: Aws::Crt::Io::SocketOptions
+
+GetKeepAliveIntervalSec()
+: Aws::Crt::Io::SocketOptions
+
+getKeepAliveIntervalSec()
+: Aws::Crt::Mqtt5::ConnectPacket
+
+GetKeepAliveMaxFailedProbes()
+: Aws::Crt::Io::SocketOptions
+
+GetKeepAliveTimeoutSec()
+: Aws::Crt::Io::SocketOptions
+
+GetKey()
+: Aws::Crt::Crypto::SymmetricCipher
+
+GetLastError()
+: Aws::Crt::DateTime
+, Aws::Crt::UUID
+
+GetLength()
+: Aws::Crt::Io::InputStream
+
+GetLengthImpl()
+: Aws::Crt::Io::InputStream
+, Aws::Crt::Io::StdIOStreamInputStream
+
+GetMacAddress()
+: Aws::Crt::Imds::ImdsClient
+
+getMaximumPacketSize()
+: Aws::Crt::Mqtt5::ConnAckPacket
+
+getMaximumPacketSizeBytes()
+: Aws::Crt::Mqtt5::ConnectPacket
+, Aws::Crt::Mqtt5::NegotiatedSettings
+
+getMaximumPacketSizeToServer()
+: Aws::Crt::Mqtt5::ConnectPacket
+, Aws::Crt::Mqtt5::NegotiatedSettings
+
+getMaximumQOS()
+: Aws::Crt::Mqtt5::ConnAckPacket
+, Aws::Crt::Mqtt5::NegotiatedSettings
+
+getMessageExpiryIntervalSec()
+: Aws::Crt::Mqtt5::PublishPacket
+
+GetMethod()
+: Aws::Crt::Http::HttpRequest
+
+GetMinute()
+: Aws::Crt::DateTime
+
+GetMonth()
+: Aws::Crt::DateTime
+
+getName()
+: Aws::Crt::Mqtt5::UserProperty
+
+GetOmitSessionToken()
+: Aws::Crt::Auth::AwsSigningConfig
+
+GetOperationStatistics()
+: Aws::Crt::Mqtt5::Mqtt5Client
+, Aws::Crt::Mqtt::MqttConnection
+
+GetOrCreateStaticDefaultClientBootstrap()
+: Aws::Crt::ApiHandle
+
+GetOrCreateStaticDefaultEventLoopGroup()
+: Aws::Crt::ApiHandle
+
+GetOrCreateStaticDefaultHostResolver()
+: Aws::Crt::ApiHandle
+
+getPassword()
+: Aws::Crt::Mqtt5::ConnectPacket
+
+GetPassword()
+: Aws::Iot::Mqtt5CustomAuthConfig
+
+GetPath()
+: Aws::Crt::Http::HttpRequest
+, Aws::Crt::Io::Uri
+
+GetPathAndQuery()
+: Aws::Crt::Io::Uri
+
+getPayload()
+: Aws::Crt::Mqtt5::PublishPacket
+
+getPayloadFormatIndicator()
+: Aws::Crt::Mqtt5::PublishPacket
+
+GetPort()
+: Aws::Crt::Io::Uri
+
+GetPrivateIpAddress()
+: Aws::Crt::Imds::ImdsClient
+
+GetProductCodes()
+: Aws::Crt::Imds::ImdsClient
+
+GetProperties()
+: Aws::Crt::Endpoints::ResolutionOutcome
+
+GetProtocol()
+: Aws::Crt::Io::TlsChannelHandler
+
+getptr()
+: Aws::Crt::Mqtt5::Mqtt5Client
+
+GetPublicKey()
+: Aws::Crt::Imds::ImdsClient
+
+getQOS()
+: Aws::Crt::Mqtt5::PublishPacket
+
+GetQueryString()
+: Aws::Crt::Io::Uri
+
+GetRamDiskId()
+: Aws::Crt::Imds::ImdsClient
+
+getReasonCode()
+: Aws::Crt::Mqtt5::ConnAckPacket
+, Aws::Crt::Mqtt5::DisconnectPacket
+, Aws::Crt::Mqtt5::PubAckPacket
+
+getReasonCodes()
+: Aws::Crt::Mqtt5::SubAckPacket
+, Aws::Crt::Mqtt5::UnSubAckPacket
+
+getReasonString()
+: Aws::Crt::Mqtt5::ConnAckPacket
+, Aws::Crt::Mqtt5::DisconnectPacket
+, Aws::Crt::Mqtt5::PubAckPacket
+, Aws::Crt::Mqtt5::SubAckPacket
+, Aws::Crt::Mqtt5::UnSubAckPacket
+
+getReceiveMaximum()
+: Aws::Crt::Mqtt5::ConnAckPacket
+, Aws::Crt::Mqtt5::ConnectPacket
+
+getReceiveMaximumFromServer()
+: Aws::Crt::Mqtt5::NegotiatedSettings
+
+GetRegion()
+: Aws::Crt::Auth::AwsSigningConfig
+
+getRejoinedSession()
+: Aws::Crt::Mqtt5::NegotiatedSettings
+
+GetRemainingLength()
+: Aws::Crt::Cbor::CborDecoder
+
+getRequestProblemInformation()
+: Aws::Crt::Mqtt5::ConnectPacket
+
+getRequestResponseInformation()
+: Aws::Crt::Mqtt5::ConnectPacket
+
+GetReservationId()
+: Aws::Crt::Imds::ImdsClient
+
+GetResource()
+: Aws::Crt::Imds::ImdsClient
+
+GetResponseCode()
+: Aws::Crt::Http::HttpResponse
+
+getResponseInformation()
+: Aws::Crt::Mqtt5::ConnAckPacket
+
+GetResponseStatusCode()
+: Aws::Crt::Http::HttpClientStream
+, Aws::Crt::Http::HttpStream
+
+getResponseTopic()
+: Aws::Crt::Mqtt5::PublishPacket
+
+getRetain()
+: Aws::Crt::Mqtt5::PublishPacket
+
+getRetainAvailable()
+: Aws::Crt::Mqtt5::ConnAckPacket
+, Aws::Crt::Mqtt5::NegotiatedSettings
+
+GetScheme()
+: Aws::Crt::Io::Uri
+
+GetSecond()
+: Aws::Crt::DateTime
+
+GetSecretAccessKey()
+: Aws::Crt::Auth::Credentials
+
+GetSecurityGroups()
+: Aws::Crt::Imds::ImdsClient
+
+getServerKeepAlive()
+: Aws::Crt::Mqtt5::ConnAckPacket
+, Aws::Crt::Mqtt5::NegotiatedSettings
+
+getServerKeepAliveSec()
+: Aws::Crt::Mqtt5::ConnAckPacket
+, Aws::Crt::Mqtt5::NegotiatedSettings
+
+getServerReference()
+: Aws::Crt::Mqtt5::ConnAckPacket
+, Aws::Crt::Mqtt5::DisconnectPacket
+
+GetService()
+: Aws::Crt::Auth::AwsSigningConfig
+
+getSessionExpiryInterval()
+: Aws::Crt::Mqtt5::ConnAckPacket
+
+getSessionExpiryIntervalSec()
+: Aws::Crt::Mqtt5::ConnAckPacket
+, Aws::Crt::Mqtt5::ConnectPacket
+, Aws::Crt::Mqtt5::DisconnectPacket
+, Aws::Crt::Mqtt5::NegotiatedSettings
+
+getSessionPresent()
+: Aws::Crt::Mqtt5::ConnAckPacket
+
+GetSessionToken()
+: Aws::Crt::Auth::Credentials
+
+getSharedSubscriptionsAvailable()
+: Aws::Crt::Mqtt5::ConnAckPacket
+, Aws::Crt::Mqtt5::NegotiatedSettings
+
+GetShouldNormalizeUriPath()
+: Aws::Crt::Auth::AwsSigningConfig
+
+GetShouldSignHeaderCallback()
+: Aws::Crt::Auth::AwsSigningConfig
+
+GetShouldSignHeaderUserData()
+: Aws::Crt::Auth::AwsSigningConfig
+
+GetSignatureType()
+: Aws::Crt::Auth::AwsSigningConfig
+
+GetSignedBodyHeader()
+: Aws::Crt::Auth::AwsSigningConfig
+
+GetSignedBodyValue()
+: Aws::Crt::Auth::AwsSigningConfig
+
+GetSigningAlgorithm()
+: Aws::Crt::Auth::AwsSigningConfig
+
+GetSigningTimepoint()
+: Aws::Crt::Auth::AwsSigningConfig
+
+GetSlot()
+: Aws::Crt::Io::ChannelHandler
+
+GetSocketDomain()
+: Aws::Crt::Io::SocketOptions
+
+GetSocketType()
+: Aws::Crt::Io::SocketOptions
+
+GetState()
+: Aws::Crt::Crypto::SymmetricCipher
+
+GetStatus()
+: Aws::Crt::Io::InputStream
+
+GetStatusImpl()
+: Aws::Crt::Io::InputStream
+, Aws::Crt::Io::StdIOStreamInputStream
+
+GetString()
+: Aws::Crt::JsonView
+
+getSubscriptionIdentifiers()
+: Aws::Crt::Mqtt5::PublishPacket
+
+getSubscriptionIdentifiersAvailable()
+: Aws::Crt::Mqtt5::ConnAckPacket
+, Aws::Crt::Mqtt5::NegotiatedSettings
+
+GetTag()
+: Aws::Crt::Crypto::SymmetricCipher
+
+GetTokenKeyName()
+: Aws::Iot::Mqtt5CustomAuthConfig
+
+GetTokenSignature()
+: Aws::Iot::Mqtt5CustomAuthConfig
+
+GetTokenValue()
+: Aws::Iot::Mqtt5CustomAuthConfig
+
+getTopic()
+: Aws::Crt::Mqtt5::PublishPacket
+
+getTopicAlias()
+: Aws::Crt::Mqtt5::PublishPacket
+
+getTopicAliasMaximum()
+: Aws::Crt::Mqtt5::ConnAckPacket
+
+getTopicAliasMaximumToClient()
+: Aws::Crt::Mqtt5::NegotiatedSettings
+
+getTopicAliasMaximumToServer()
+: Aws::Crt::Mqtt5::NegotiatedSettings
+
+GetType()
+: Aws::Crt::Auth::AwsSigningConfig
+, Aws::Crt::Auth::ISigningConfig
+
+getType()
+: Aws::Crt::Mqtt5::ConnAckPacket
+, Aws::Crt::Mqtt5::ConnectPacket
+, Aws::Crt::Mqtt5::DisconnectPacket
+, Aws::Crt::Mqtt5::IPacket
+, Aws::Crt::Mqtt5::PubAckPacket
+, Aws::Crt::Mqtt5::PublishPacket
+, Aws::Crt::Mqtt5::SubAckPacket
+, Aws::Crt::Mqtt5::SubscribePacket
+, Aws::Crt::Mqtt5::UnSubAckPacket
+, Aws::Crt::Mqtt5::UnsubscribePacket
+
+GetUnderlyingHandle()
+: Aws::Crt::Auth::Credentials
+, Aws::Crt::Auth::CredentialsProvider
+, Aws::Crt::Auth::ICredentialsProvider
+, Aws::Crt::Imds::ImdsClient
+
+GetUrl()
+: Aws::Crt::Endpoints::ResolutionOutcome
+
+GetUseDoubleUriEncode()
+: Aws::Crt::Auth::AwsSigningConfig
+
+GetUserData()
+: Aws::Crt::Imds::ImdsClient
+
+getUsername()
+: Aws::Crt::Mqtt5::ConnectPacket
+
+GetUsername()
+: Aws::Iot::Mqtt5CustomAuthConfig
+
+getUserProperties()
+: Aws::Crt::Mqtt5::ConnectPacket
+, Aws::Crt::Mqtt5::DisconnectPacket
+, Aws::Crt::Mqtt5::PubAckPacket
+, Aws::Crt::Mqtt5::PublishPacket
+, Aws::Crt::Mqtt5::SubAckPacket
+, Aws::Crt::Mqtt5::UnSubAckPacket
+
+getUserProperty()
+: Aws::Crt::Mqtt5::ConnAckPacket
+
+getValue()
+: Aws::Crt::Mqtt5::UserProperty
+
+GetVersion()
+: Aws::Crt::Http::HttpClientConnection
+
+getWildcardSubscriptionsAvailable()
+: Aws::Crt::Mqtt5::ConnAckPacket
+, Aws::Crt::Mqtt5::NegotiatedSettings
+
+getWill()
+: Aws::Crt::Mqtt5::ConnectPacket
+
+getWillDelayIntervalSec()
+: Aws::Crt::Mqtt5::ConnectPacket
+
+GetYear()
+: Aws::Crt::DateTime
+
+
+
+
+
+
+
diff --git a/docs/functions_h.html b/docs/functions_h.html
new file mode 100644
index 000000000..855ed9054
--- /dev/null
+++ b/docs/functions_h.html
@@ -0,0 +1,138 @@
+
+
+
+
+
+
+
+aws-crt-cpp: Class Members
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ aws-crt-cpp
+
+ C++ wrapper around the aws-c-* libraries. Provides Cross-Platform Transport Protocols and SSL/TLS implementations for C++.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
Here is a list of all class members with links to the classes they belong to:
+
+
- h -
+
+
+
+
+
diff --git a/docs/functions_i.html b/docs/functions_i.html
new file mode 100644
index 000000000..2338ac8c7
--- /dev/null
+++ b/docs/functions_i.html
@@ -0,0 +1,241 @@
+
+
+
+
+
+
+
+aws-crt-cpp: Class Members
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ aws-crt-cpp
+
+ C++ wrapper around the aws-c-* libraries. Provides Cross-Platform Transport Protocols and SSL/TLS implementations for C++.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
Here is a list of all class members with links to the classes they belong to:
+
+
- i -
+IamProfile()
+: Aws::Crt::Imds::IamProfile
+
+Identity
+: Aws::Crt::Auth::CredentialsProviderCognitoConfig
+
+IdentityProviderName
+: Aws::Crt::Auth::CognitoLoginPair
+
+IdentityProviderToken
+: Aws::Crt::Auth::CognitoLoginPair
+
+IHttpRequestSigner()
+: Aws::Crt::Auth::IHttpRequestSigner
+
+imageId
+: Aws::Crt::Imds::InstanceInfo
+, Aws::Crt::Imds::InstanceInfoView
+
+ImdsClient()
+: Aws::Crt::Imds::ImdsClient
+
+ImdsClientConfig()
+: Aws::Crt::Imds::ImdsClientConfig
+
+incompleteOperationCount
+: Aws::Crt::Mqtt5::Mqtt5ClientOperationStatistics
+, Aws::Crt::Mqtt::MqttConnectionOperationStatistics
+
+incompleteOperationSize
+: Aws::Crt::Mqtt5::Mqtt5ClientOperationStatistics
+, Aws::Crt::Mqtt::MqttConnectionOperationStatistics
+
+IncrementReadWindow()
+: Aws::Crt::Io::ChannelHandler
+
+IncrementUpstreamReadWindow()
+: Aws::Crt::Io::ChannelHandler
+
+index()
+: Aws::Crt::Variant< Ts >
+
+IndexT
+: Aws::Crt::Variant< Ts >
+
+InitClientWithMtls()
+: Aws::Crt::Io::TlsContextOptions
+
+InitClientWithMtlsPkcs11()
+: Aws::Crt::Io::TlsContextOptions
+
+InitClientWithMtlsPkcs12()
+: Aws::Crt::Io::TlsContextOptions
+
+InitClientWithMtlsSystemPath()
+: Aws::Crt::Io::TlsContextOptions
+
+InitDefaultClient()
+: Aws::Crt::Io::TlsContextOptions
+
+InitializeFinalizeBehavior
+: Aws::Crt::Io::Pkcs11Lib
+
+InitializeLogging()
+: Aws::Crt::ApiHandle
+
+initializeRawOptions()
+: Aws::Crt::Mqtt5::ConnectPacket
+, Aws::Crt::Mqtt5::DisconnectPacket
+, Aws::Crt::Mqtt5::Mqtt5ClientOptions
+, Aws::Crt::Mqtt5::PublishPacket
+, Aws::Crt::Mqtt5::SubscribePacket
+, Aws::Crt::Mqtt5::Subscription
+, Aws::Crt::Mqtt5::UnsubscribePacket
+
+InitializeRawProxyOptions()
+: Aws::Crt::Http::HttpClientConnectionProxyOptions
+
+InitialWindowSize
+: Aws::Crt::Http::HttpClientConnectionOptions
+, Aws::Crt::Io::ChannelHandler
+
+InitiateShutdown()
+: Aws::Crt::Http::HttpClientConnectionManager
+
+InPlaceT()
+: Aws::Crt::InPlaceT
+
+InPlaceTypeT()
+: Aws::Crt::InPlaceTypeT< T >
+
+InputStream()
+: Aws::Crt::Io::InputStream
+
+instanceId
+: Aws::Crt::Imds::InstanceInfo
+, Aws::Crt::Imds::InstanceInfoView
+
+InstanceInfo()
+: Aws::Crt::Imds::InstanceInfo
+
+instanceProfileArn
+: Aws::Crt::Imds::IamProfile
+, Aws::Crt::Imds::IamProfileView
+
+instanceProfileId
+: Aws::Crt::Imds::IamProfile
+, Aws::Crt::Imds::IamProfileView
+
+instanceType
+: Aws::Crt::Imds::InstanceInfo
+, Aws::Crt::Imds::InstanceInfoView
+
+IsAlpnSupported()
+: Aws::Crt::Io::TlsContextOptions
+
+IsBool()
+: Aws::Crt::JsonView
+
+IsDST()
+: Aws::Crt::DateTime
+
+IsEndpoint()
+: Aws::Crt::Endpoints::ResolutionOutcome
+
+IsError()
+: Aws::Crt::Endpoints::ResolutionOutcome
+
+IsFloatingPointType()
+: Aws::Crt::JsonView
+
+ISigningConfig()
+: Aws::Crt::Auth::ISigningConfig
+
+IsIntegerType()
+: Aws::Crt::JsonView
+
+IsListType()
+: Aws::Crt::JsonView
+
+IsNull()
+: Aws::Crt::JsonView
+
+IsNumber()
+: Aws::Crt::JsonView
+
+IsObject()
+: Aws::Crt::JsonView
+
+IsOpen()
+: Aws::Crt::Http::HttpClientConnection
+
+IsString()
+: Aws::Crt::JsonView
+
+IsValid()
+: Aws::Crt::Auth::CredentialsProvider
+, Aws::Crt::Auth::ICredentialsProvider
+, Aws::Crt::Auth::IHttpRequestSigner
+, Aws::Crt::Auth::Sigv4HttpRequestSigner
+, Aws::Crt::Io::InputStream
+, Aws::Crt::Io::StdIOStreamInputStream
+
+iterator
+: Aws::Crt::basic_string_view< CharT, Traits >
+
+
+
+
+
+
+
diff --git a/docs/functions_j.html b/docs/functions_j.html
new file mode 100644
index 000000000..0598782e0
--- /dev/null
+++ b/docs/functions_j.html
@@ -0,0 +1,82 @@
+
+
+
+
+
+
+
+aws-crt-cpp: Class Members
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ aws-crt-cpp
+
+ C++ wrapper around the aws-c-* libraries. Provides Cross-Platform Transport Protocols and SSL/TLS implementations for C++.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
Here is a list of all class members with links to the classes they belong to:
+
+
- j -
+
+
+
+
+
diff --git a/docs/functions_k.html b/docs/functions_k.html
new file mode 100644
index 000000000..68c273e20
--- /dev/null
+++ b/docs/functions_k.html
@@ -0,0 +1,86 @@
+
+
+
+
+
+
+
+aws-crt-cpp: Class Members
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ aws-crt-cpp
+
+ C++ wrapper around the aws-c-* libraries. Provides Cross-Platform Transport Protocols and SSL/TLS implementations for C++.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
Here is a list of all class members with links to the classes they belong to:
+
+
- k -
+
+
+
+
+
diff --git a/docs/functions_l.html b/docs/functions_l.html
new file mode 100644
index 000000000..0f5949f38
--- /dev/null
+++ b/docs/functions_l.html
@@ -0,0 +1,105 @@
+
+
+
+
+
+
+
+aws-crt-cpp: Class Members
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ aws-crt-cpp
+
+ C++ wrapper around the aws-c-* libraries. Provides Cross-Platform Transport Protocols and SSL/TLS implementations for C++.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
Here is a list of all class members with links to the classes they belong to:
+
+
- l -
+LastError()
+: Aws::Crt::Cbor::CborDecoder
+, Aws::Crt::Crypto::Hash
+, Aws::Crt::Crypto::HMAC
+, Aws::Crt::Crypto::SymmetricCipher
+, Aws::Crt::Http::HttpClientConnection
+, Aws::Crt::Io::ClientBootstrap
+, Aws::Crt::Io::DefaultHostResolver
+, Aws::Crt::Io::EventLoopGroup
+, Aws::Crt::Io::TlsConnectionOptions
+, Aws::Crt::Io::TlsContextOptions
+, Aws::Crt::Io::Uri
+, Aws::Crt::Mqtt5::Mqtt5Client
+, Aws::Crt::Mqtt::MqttClient
+, Aws::Crt::Mqtt::MqttConnection
+, Aws::Iot::Mqtt5ClientBuilder
+, Aws::Iot::MqttClient
+, Aws::Iot::MqttClientConnectionConfig
+, Aws::Iot::MqttClientConnectionConfigBuilder
+
+lastUpdated
+: Aws::Crt::Imds::IamProfile
+, Aws::Crt::Imds::IamProfileView
+
+length()
+: Aws::Crt::basic_string_view< CharT, Traits >
+
+Logins
+: Aws::Crt::Auth::CredentialsProviderCognitoConfig
+
+
+
+
+
+
+
diff --git a/docs/functions_m.html b/docs/functions_m.html
new file mode 100644
index 000000000..5c8e47d5d
--- /dev/null
+++ b/docs/functions_m.html
@@ -0,0 +1,215 @@
+
+
+
+
+
+
+
+aws-crt-cpp: Class Members
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ aws-crt-cpp
+
+ C++ wrapper around the aws-c-* libraries. Provides Cross-Platform Transport Protocols and SSL/TLS implementations for C++.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
Here is a list of all class members with links to the classes they belong to:
+
+
- m -
+m_allocator
+: Aws::Crt::Http::HttpMessage
+, Aws::Crt::Io::ChannelHandler
+, Aws::Crt::Io::InputStream
+, Aws::Crt::StlAllocator< T >
+
+m_bodyStream
+: Aws::Crt::Http::HttpMessage
+
+m_connection
+: Aws::Crt::Http::HttpClientConnection
+, Aws::Crt::Http::HttpStream
+
+m_connectionManager
+: Aws::Crt::Http::ConnectionManagerCallbackArgs
+
+m_Handler
+: Aws::Crt::Auth::DelegateCredentialsProviderCallbackArgs
+
+m_handler
+: Aws::Crt::Io::ChannelHandler
+
+m_inboundBehavior
+: Aws::Crt::Mqtt5::TopicAliasingOptions
+
+m_inboundCacheMaxSize
+: Aws::Crt::Mqtt5::TopicAliasingOptions
+
+m_maxReconnectDelayMs
+: Aws::Crt::Mqtt5::ReconnectOptions
+
+m_message
+: Aws::Crt::Http::HttpMessage
+
+m_minConnectedTimeToResetReconnectDelayMs
+: Aws::Crt::Mqtt5::ReconnectOptions
+
+m_minReconnectDelayMs
+: Aws::Crt::Mqtt5::ReconnectOptions
+
+m_onClientConnectionAvailable
+: Aws::Crt::Http::ConnectionManagerCallbackArgs
+
+m_onCredentialsResolved
+: Aws::Crt::Auth::CredentialsProviderCallbackArgs
+
+m_outboundBehavior
+: Aws::Crt::Mqtt5::TopicAliasingOptions
+
+m_outboundCacheMaxSize
+: Aws::Crt::Mqtt5::TopicAliasingOptions
+
+m_provider
+: Aws::Crt::Auth::CredentialsProviderCallbackArgs
+
+m_reconnectMode
+: Aws::Crt::Mqtt5::ReconnectOptions
+
+m_strategy
+: Aws::Crt::Http::HttpProxyStrategy
+
+m_stream
+: Aws::Crt::Http::HttpStream
+
+m_underlying_stream
+: Aws::Crt::Io::InputStream
+
+major
+: Aws::Crt::ApiHandle::Version
+
+ManagedConnection
+: Aws::Crt::Http::HttpClientConnectionManager
+, Aws::Crt::Http::ManagedConnection
+
+ManualWindowManagement
+: Aws::Crt::Http::HttpClientConnectionOptions
+
+marketplaceProductCodes
+: Aws::Crt::Imds::InstanceInfo
+, Aws::Crt::Imds::InstanceInfoView
+
+Materialize()
+: Aws::Crt::JsonView
+
+max_size()
+: Aws::Crt::basic_string_view< CharT, Traits >
+
+MaxConnections
+: Aws::Crt::Http::HttpClientConnectionManagerOptions
+
+MessageOverhead()
+: Aws::Crt::Io::ChannelHandler
+
+Millis()
+: Aws::Crt::DateTime
+
+minor
+: Aws::Crt::ApiHandle::Version
+
+Mqtt5::Mqtt5ClientCore
+: Aws::Crt::Http::HttpRequest
+, Aws::Crt::Mqtt::MqttConnection
+
+Mqtt5ClientBuilder()
+: Aws::Iot::Mqtt5ClientBuilder
+
+Mqtt5ClientCore
+: Aws::Crt::Mqtt5::Mqtt5ClientOptions
+
+Mqtt5ClientOptions()
+: Aws::Crt::Mqtt5::Mqtt5ClientOptions
+
+Mqtt5CustomAuthConfig()
+: Aws::Iot::Mqtt5CustomAuthConfig
+
+Mqtt5to3AdapterOptions
+: Aws::Crt::Mqtt5::Mqtt5ClientOptions
+
+Mqtt::MqttConnection
+: Aws::Crt::Mqtt5::Mqtt5Client
+
+Mqtt::MqttConnectionCore
+: Aws::Crt::Http::HttpRequest
+
+MqttClient()
+: Aws::Crt::Mqtt::MqttClient
+, Aws::Crt::Mqtt::MqttConnection
+, Aws::Iot::MqttClient
+, Aws::Iot::MqttClientConnectionConfig
+
+MqttClientConnectionConfig()
+: Aws::Iot::MqttClientConnectionConfig
+
+MqttClientConnectionConfigBuilder
+: Aws::Iot::MqttClientConnectionConfig
+, Aws::Iot::MqttClientConnectionConfigBuilder
+
+MqttConnection()
+: Aws::Crt::Mqtt::MqttConnection
+
+
+
+
+
+
+
diff --git a/docs/functions_n.html b/docs/functions_n.html
new file mode 100644
index 000000000..eb15d9f79
--- /dev/null
+++ b/docs/functions_n.html
@@ -0,0 +1,141 @@
+
+
+
+
+
+
+
+aws-crt-cpp: Class Members
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ aws-crt-cpp
+
+ C++ wrapper around the aws-c-* libraries. Provides Cross-Platform Transport Protocols and SSL/TLS implementations for C++.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
Here is a list of all class members with links to the classes they belong to:
+
+
- n -
+
+
+
+
+
diff --git a/docs/functions_o.html b/docs/functions_o.html
new file mode 100644
index 000000000..d81db2dfe
--- /dev/null
+++ b/docs/functions_o.html
@@ -0,0 +1,284 @@
+
+
+
+
+
+
+
+aws-crt-cpp: Class Members
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ aws-crt-cpp
+
+ C++ wrapper around the aws-c-* libraries. Provides Cross-Platform Transport Protocols and SSL/TLS implementations for C++.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
Here is a list of all class members with links to the classes they belong to:
+
+
- o -
+OnAttemptingConnectEventData()
+: Aws::Crt::Mqtt5::OnAttemptingConnectEventData
+
+OnConnectionClosed
+: Aws::Crt::Mqtt::MqttConnection
+
+OnConnectionCompleted
+: Aws::Crt::Mqtt::MqttConnection
+
+OnConnectionFailure
+: Aws::Crt::Mqtt::MqttConnection
+
+OnConnectionFailureEventData()
+: Aws::Crt::Mqtt5::OnConnectionFailureEventData
+
+OnConnectionInterrupted
+: Aws::Crt::Mqtt::MqttConnection
+
+OnConnectionResumed
+: Aws::Crt::Mqtt::MqttConnection
+
+onConnectionSetup
+: Aws::Crt::Http::ConnectionCallbackData
+
+OnConnectionSetupCallback
+: Aws::Crt::Http::HttpClientConnectionOptions
+
+onConnectionShutdown
+: Aws::Crt::Http::ConnectionCallbackData
+
+OnConnectionShutdownCallback
+: Aws::Crt::Http::HttpClientConnectionOptions
+
+OnConnectionSuccess
+: Aws::Crt::Mqtt::MqttConnection
+
+OnConnectionSuccessEventData()
+: Aws::Crt::Mqtt5::OnConnectionSuccessEventData
+
+OnDisconnect
+: Aws::Crt::Mqtt::MqttConnection
+
+OnDisconnectionEventData()
+: Aws::Crt::Mqtt5::OnDisconnectionEventData
+
+onIncomingBody
+: Aws::Crt::Http::HttpRequestOptions
+
+onIncomingHeaders
+: Aws::Crt::Http::HttpRequestOptions
+
+onIncomingHeadersBlockDone
+: Aws::Crt::Http::HttpRequestOptions
+
+OnRequestSigningComplete
+: Aws::Crt::Auth::HttpSignerCallbackData
+
+OnShutdownComplete()
+: Aws::Crt::Io::ChannelHandler
+
+OnStoppedEventData()
+: Aws::Crt::Mqtt5::OnStoppedEventData
+
+onStreamComplete
+: Aws::Crt::Http::HttpRequestOptions
+
+operator bool()
+: Aws::Crt::Auth::Credentials
+, Aws::Crt::Crypto::Hash
+, Aws::Crt::Crypto::HMAC
+, Aws::Crt::Crypto::SymmetricCipher
+, Aws::Crt::DateTime
+, Aws::Crt::Endpoints::RequestContext
+, Aws::Crt::Endpoints::ResolutionOutcome
+, Aws::Crt::Endpoints::RuleEngine
+, Aws::Crt::Http::HttpMessage
+, Aws::Crt::Io::ClientBootstrap
+, Aws::Crt::Io::DefaultHostResolver
+, Aws::Crt::Io::EventLoopGroup
+, Aws::Crt::Io::InputStream
+, Aws::Crt::Io::TlsConnectionOptions
+, Aws::Crt::Io::TlsContext
+, Aws::Crt::Io::TlsContextOptions
+, Aws::Crt::Io::Uri
+, Aws::Crt::Mqtt5::Mqtt5Client
+, Aws::Crt::Mqtt::MqttClient
+, Aws::Crt::Mqtt::MqttConnection
+, Aws::Crt::Optional< T >
+, Aws::Crt::UUID
+, Aws::Iot::Mqtt5ClientBuilder
+, Aws::Iot::MqttClient
+, Aws::Iot::MqttClientConnectionConfig
+, Aws::Iot::MqttClientConnectionConfigBuilder
+
+operator ByteBuf()
+: Aws::Crt::UUID
+
+operator String()
+: Aws::Crt::UUID
+
+operator!=()
+: Aws::Crt::DateTime
+, Aws::Crt::JsonObject
+, Aws::Crt::UUID
+
+operator()()
+: std::hash< Aws::Crt::basic_string_view< CharT, Traits > >
+
+operator*()
+: Aws::Crt::Optional< T >
+
+operator+()
+: Aws::Crt::DateTime
+
+operator-()
+: Aws::Crt::DateTime
+
+operator->()
+: Aws::Crt::Optional< T >
+
+operator<()
+: Aws::Crt::DateTime
+
+operator<=()
+: Aws::Crt::DateTime
+
+operator=()
+: Aws::Crt::ApiHandle
+, Aws::Crt::Auth::Credentials
+, Aws::Crt::Auth::CredentialsProvider
+, Aws::Crt::Auth::IHttpRequestSigner
+, Aws::Crt::Auth::ISigningConfig
+, Aws::Crt::basic_string_view< CharT, Traits >
+, Aws::Crt::Cbor::CborDecoder
+, Aws::Crt::Cbor::CborEncoder
+, Aws::Crt::Crypto::Hash
+, Aws::Crt::Crypto::HMAC
+, Aws::Crt::Crypto::SymmetricCipher
+, Aws::Crt::DateTime
+, Aws::Crt::Endpoints::RequestContext
+, Aws::Crt::Endpoints::ResolutionOutcome
+, Aws::Crt::Endpoints::RuleEngine
+, Aws::Crt::Http::HttpClientConnection
+, Aws::Crt::Http::HttpClientConnectionManagerOptions
+, Aws::Crt::Http::HttpClientConnectionOptions
+, Aws::Crt::Http::HttpClientConnectionProxyOptions
+, Aws::Crt::Http::HttpClientStream
+, Aws::Crt::Http::HttpMessage
+, Aws::Crt::Http::HttpStream
+, Aws::Crt::Imds::IamProfile
+, Aws::Crt::Imds::ImdsClient
+, Aws::Crt::Imds::InstanceInfo
+, Aws::Crt::Io::ChannelHandler
+, Aws::Crt::Io::ClientBootstrap
+, Aws::Crt::Io::DefaultHostResolver
+, Aws::Crt::Io::EventLoopGroup
+, Aws::Crt::Io::InputStream
+, Aws::Crt::Io::SocketOptions
+, Aws::Crt::Io::TlsConnectionOptions
+, Aws::Crt::Io::TlsContext
+, Aws::Crt::Io::TlsContextOptions
+, Aws::Crt::Io::Uri
+, Aws::Crt::JsonObject
+, Aws::Crt::JsonView
+, Aws::Crt::Mqtt5::ConnAckPacket
+, Aws::Crt::Mqtt5::ConnectPacket
+, Aws::Crt::Mqtt5::DisconnectPacket
+, Aws::Crt::Mqtt5::Mqtt5ClientOptions
+, Aws::Crt::Mqtt5::NegotiatedSettings
+, Aws::Crt::Mqtt5::PubAckPacket
+, Aws::Crt::Mqtt5::PublishPacket
+, Aws::Crt::Mqtt5::PublishResult
+, Aws::Crt::Mqtt5::SubAckPacket
+, Aws::Crt::Mqtt5::SubscribePacket
+, Aws::Crt::Mqtt5::Subscription
+, Aws::Crt::Mqtt5::UnSubAckPacket
+, Aws::Crt::Mqtt5::UnsubscribePacket
+, Aws::Crt::Mqtt5::UserProperty
+, Aws::Crt::Mqtt::MqttClient
+, Aws::Crt::Mqtt::MqttConnection
+, Aws::Crt::Optional< T >
+, Aws::Crt::UUID
+, Aws::Crt::Variant< Ts >
+, Aws::Iot::Mqtt5ClientBuilder
+, Aws::Iot::Mqtt5CustomAuthConfig
+
+operator==()
+: Aws::Crt::DateTime
+, Aws::Crt::JsonObject
+, Aws::Crt::UUID
+
+operator>()
+: Aws::Crt::DateTime
+
+operator>=()
+: Aws::Crt::DateTime
+
+operator[]()
+: Aws::Crt::basic_string_view< CharT, Traits >
+
+Optional()
+: Aws::Crt::Optional< T >
+
+other
+: Aws::Crt::StlAllocator< T >::rebind< U >
+
+OverrideDefaultTrustStore()
+: Aws::Crt::Io::TlsContextOptions
+
+
+
+
+
+
+
diff --git a/docs/functions_p.html b/docs/functions_p.html
new file mode 100644
index 000000000..e800f8aa5
--- /dev/null
+++ b/docs/functions_p.html
@@ -0,0 +1,190 @@
+
+
+
+
+
+
+
+aws-crt-cpp: Class Members
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ aws-crt-cpp
+
+ C++ wrapper around the aws-c-* libraries. Provides Cross-Platform Transport Protocols and SSL/TLS implementations for C++.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
Here is a list of all class members with links to the classes they belong to:
+
+
- p -
+Password
+: Aws::Crt::Http::HttpProxyStrategyBasicAuthConfig
+
+patch
+: Aws::Crt::ApiHandle::Version
+
+PeekImpl()
+: Aws::Crt::Io::InputStream
+, Aws::Crt::Io::StdIOStreamInputStream
+
+PeekType()
+: Aws::Crt::Cbor::CborDecoder
+
+pendingTime
+: Aws::Crt::Imds::InstanceInfo
+, Aws::Crt::Imds::InstanceInfoView
+
+pkcs12_file
+: Aws::Iot::Pkcs12Options
+
+pkcs12_password
+: Aws::Iot::Pkcs12Options
+
+pointer
+: Aws::Crt::basic_string_view< CharT, Traits >
+
+PopNextArrayStart()
+: Aws::Crt::Cbor::CborDecoder
+
+PopNextBooleanVal()
+: Aws::Crt::Cbor::CborDecoder
+
+PopNextBytesVal()
+: Aws::Crt::Cbor::CborDecoder
+
+PopNextFloatVal()
+: Aws::Crt::Cbor::CborDecoder
+
+PopNextMapStart()
+: Aws::Crt::Cbor::CborDecoder
+
+PopNextNegativeIntVal()
+: Aws::Crt::Cbor::CborDecoder
+
+PopNextTagVal()
+: Aws::Crt::Cbor::CborDecoder
+
+PopNextTextVal()
+: Aws::Crt::Cbor::CborDecoder
+
+PopNextUnsignedIntVal()
+: Aws::Crt::Cbor::CborDecoder
+
+Port
+: Aws::Crt::Http::HttpClientConnectionOptions
+, Aws::Crt::Http::HttpClientConnectionProxyOptions
+
+port
+: Aws::Crt::Mqtt::MqttConnectionOptions
+
+privateIp
+: Aws::Crt::Imds::InstanceInfo
+, Aws::Crt::Imds::InstanceInfoView
+
+ProcessReadMessage()
+: Aws::Crt::Io::ChannelHandler
+
+ProcessShutdown()
+: Aws::Crt::Io::ChannelHandler
+
+ProcessWriteMessage()
+: Aws::Crt::Io::ChannelHandler
+
+ProfileNameOverride
+: Aws::Crt::Auth::CredentialsProviderProfileConfig
+
+Provider
+: Aws::Crt::Auth::CredentialsProviderCachedConfig
+, Aws::Crt::Auth::CredentialsProviderSTSConfig
+
+Providers
+: Aws::Crt::Auth::CredentialsProviderChainConfig
+
+ProxyConnectionType
+: Aws::Crt::Http::HttpClientConnectionProxyOptions
+
+ProxyOptions
+: Aws::Crt::Auth::CredentialsProviderCognitoConfig
+, Aws::Crt::Auth::CredentialsProviderSTSConfig
+, Aws::Crt::Auth::CredentialsProviderX509Config
+, Aws::Crt::Http::HttpClientConnectionOptions
+, Aws::Iot::WebsocketConfig
+
+ProxyStrategy
+: Aws::Crt::Http::HttpClientConnectionProxyOptions
+
+PubAckPacket()
+: Aws::Crt::Mqtt5::PubAckPacket
+
+Publish()
+: Aws::Crt::Mqtt5::Mqtt5Client
+, Aws::Crt::Mqtt::MqttConnection
+
+PublishPacket()
+: Aws::Crt::Mqtt5::PublishPacket
+
+publishPacket
+: Aws::Crt::Mqtt5::PublishReceivedEventData
+
+PublishReceivedEventData()
+: Aws::Crt::Mqtt5::PublishReceivedEventData
+
+PublishResult()
+: Aws::Crt::Mqtt5::PublishResult
+
+
+
+
+
+
+
diff --git a/docs/functions_r.html b/docs/functions_r.html
new file mode 100644
index 000000000..0f51be87b
--- /dev/null
+++ b/docs/functions_r.html
@@ -0,0 +1,168 @@
+
+
+
+
+
+
+
+aws-crt-cpp: Class Members
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ aws-crt-cpp
+
+ C++ wrapper around the aws-c-* libraries. Provides Cross-Platform Transport Protocols and SSL/TLS implementations for C++.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
Here is a list of all class members with links to the classes they belong to:
+
+
- r -
+ramdiskId
+: Aws::Crt::Imds::InstanceInfo
+, Aws::Crt::Imds::InstanceInfoView
+
+RawAlternativePointerT
+: Aws::Crt::Variant< Ts >
+
+RawPointer
+: Aws::Crt::StlAllocator< T >
+
+rbegin()
+: Aws::Crt::basic_string_view< CharT, Traits >
+
+Read()
+: Aws::Crt::Io::InputStream
+
+ReadImpl()
+: Aws::Crt::Io::InputStream
+, Aws::Crt::Io::StdIOStreamInputStream
+
+ReadSomeImpl()
+: Aws::Crt::Io::InputStream
+, Aws::Crt::Io::StdIOStreamInputStream
+
+RefCounted()
+: Aws::Crt::RefCounted< T >
+
+reference
+: Aws::Crt::basic_string_view< CharT, Traits >
+
+region
+: Aws::Crt::Imds::InstanceInfo
+, Aws::Crt::Imds::InstanceInfoView
+
+ReleaseRef()
+: Aws::Crt::RefCounted< T >
+
+remove_prefix()
+: Aws::Crt::basic_string_view< CharT, Traits >
+
+remove_suffix()
+: Aws::Crt::basic_string_view< CharT, Traits >
+
+rend()
+: Aws::Crt::basic_string_view< CharT, Traits >
+
+Request
+: Aws::Crt::Auth::HttpSignerCallbackData
+
+request
+: Aws::Crt::Http::HttpRequestOptions
+
+RequestContext()
+: Aws::Crt::Endpoints::RequestContext
+
+Reset()
+: Aws::Crt::Cbor::CborEncoder
+, Aws::Crt::Crypto::SymmetricCipher
+
+reset()
+: Aws::Crt::Optional< T >
+
+ResetStatistics()
+: Aws::Crt::Io::ChannelHandler
+
+ResolutionOutcome()
+: Aws::Crt::Endpoints::ResolutionOutcome
+
+Resolve()
+: Aws::Crt::Endpoints::RuleEngine
+
+ResolveHost()
+: Aws::Crt::Io::DefaultHostResolver
+, Aws::Crt::Io::HostResolver
+
+returnCode
+: Aws::Crt::Mqtt::OnConnectionSuccessData
+
+reverse_iterator
+: Aws::Crt::basic_string_view< CharT, Traits >
+
+rfind()
+: Aws::Crt::basic_string_view< CharT, Traits >
+
+RoleAlias
+: Aws::Crt::Auth::CredentialsProviderX509Config
+
+RoleArn
+: Aws::Crt::Auth::CredentialsProviderSTSConfig
+
+RuleEngine()
+: Aws::Crt::Endpoints::RuleEngine
+
+
+
+
+
+
+
diff --git a/docs/functions_rela.html b/docs/functions_rela.html
new file mode 100644
index 000000000..ba1b9d62c
--- /dev/null
+++ b/docs/functions_rela.html
@@ -0,0 +1,116 @@
+
+
+
+
+
+
+
+aws-crt-cpp: Class Members - Related Functions
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ aws-crt-cpp
+
+ C++ wrapper around the aws-c-* libraries. Provides Cross-Platform Transport Protocols and SSL/TLS implementations for C++.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/docs/functions_s.html b/docs/functions_s.html
new file mode 100644
index 000000000..3831ba20f
--- /dev/null
+++ b/docs/functions_s.html
@@ -0,0 +1,369 @@
+
+
+
+
+
+
+
+aws-crt-cpp: Class Members
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ aws-crt-cpp
+
+ C++ wrapper around the aws-c-* libraries. Provides Cross-Platform Transport Protocols and SSL/TLS implementations for C++.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
Here is a list of all class members with links to the classes they belong to:
+
+
- s -
+s_GatherStatistics
+: Aws::Crt::Io::ChannelHandler
+
+s_IncrementReadWindow
+: Aws::Crt::Io::ChannelHandler
+
+s_InitialWindowSize
+: Aws::Crt::Io::ChannelHandler
+
+s_MessageOverhead
+: Aws::Crt::Io::ChannelHandler
+
+s_ProcessReadMessage
+: Aws::Crt::Io::ChannelHandler
+
+s_ProcessShutdown
+: Aws::Crt::Io::ChannelHandler
+
+s_ProcessWriteMessage
+: Aws::Crt::Io::ChannelHandler
+
+s_ResetStatistics
+: Aws::Crt::Io::ChannelHandler
+
+ScheduleTask()
+: Aws::Crt::Io::ChannelHandler
+
+SecondsWithMSPrecision()
+: Aws::Crt::DateTime
+
+SecretAccessKey
+: Aws::Crt::Auth::CredentialsProviderStaticConfig
+
+Seek()
+: Aws::Crt::Io::InputStream
+
+SeekImpl()
+: Aws::Crt::Io::InputStream
+, Aws::Crt::Io::StdIOStreamInputStream
+
+SendMessage()
+: Aws::Crt::Io::ChannelHandler
+
+ServiceName
+: Aws::Iot::WebsocketConfig
+
+SessionName
+: Aws::Crt::Auth::CredentialsProviderSTSConfig
+
+sessionPresent
+: Aws::Crt::Mqtt::OnConnectionSuccessData
+
+SessionToken
+: Aws::Crt::Auth::CredentialsProviderStaticConfig
+
+SetAlpnList()
+: Aws::Crt::Io::TlsConnectionOptions
+, Aws::Crt::Io::TlsContextOptions
+
+SetBody()
+: Aws::Crt::Http::HttpMessage
+
+SetBYOCryptoClientTlsCallback()
+: Aws::Crt::ApiHandle
+
+SetBYOCryptoNewMD5Callback()
+: Aws::Crt::ApiHandle
+
+SetBYOCryptoNewSHA1Callback()
+: Aws::Crt::ApiHandle
+
+SetBYOCryptoNewSHA256Callback()
+: Aws::Crt::ApiHandle
+
+SetBYOCryptoNewSHA256HMACCallback()
+: Aws::Crt::ApiHandle
+
+SetBYOCryptoTlsContextCallbacks()
+: Aws::Crt::ApiHandle
+
+SetCertificateFileContents()
+: Aws::Crt::Io::TlsContextPkcs11Options
+
+SetCertificateFilePath()
+: Aws::Crt::Io::TlsContextPkcs11Options
+
+SetConnectTimeoutMs()
+: Aws::Crt::Io::SocketOptions
+
+SetCredentials()
+: Aws::Crt::Auth::AwsSigningConfig
+
+SetCredentialsProvider()
+: Aws::Crt::Auth::AwsSigningConfig
+
+SetExpirationInSeconds()
+: Aws::Crt::Auth::AwsSigningConfig
+
+SetHttpProxyOptions()
+: Aws::Crt::Mqtt::MqttConnection
+
+SetKeepAlive()
+: Aws::Crt::Io::SocketOptions
+
+SetKeepAliveIntervalSec()
+: Aws::Crt::Io::SocketOptions
+
+SetKeepAliveMaxFailedProbes()
+: Aws::Crt::Io::SocketOptions
+
+SetKeepAliveTimeoutSec()
+: Aws::Crt::Io::SocketOptions
+
+SetKeychainPath()
+: Aws::Crt::Io::TlsContextOptions
+
+SetLogin()
+: Aws::Crt::Mqtt::MqttConnection
+
+SetMethod()
+: Aws::Crt::Http::HttpRequest
+
+SetMinimumTlsVersion()
+: Aws::Crt::Io::TlsContextOptions
+
+SetOmitSessionToken()
+: Aws::Crt::Auth::AwsSigningConfig
+
+SetOnMessageHandler()
+: Aws::Crt::Mqtt::MqttConnection
+
+SetPath()
+: Aws::Crt::Http::HttpRequest
+
+SetPrivateKeyObjectLabel()
+: Aws::Crt::Io::TlsContextPkcs11Options
+
+SetReconnectTimeout()
+: Aws::Crt::Mqtt::MqttConnection
+
+SetRegion()
+: Aws::Crt::Auth::AwsSigningConfig
+
+SetResponseCode()
+: Aws::Crt::Http::HttpResponse
+
+SetServerName()
+: Aws::Crt::Io::TlsConnectionOptions
+
+SetService()
+: Aws::Crt::Auth::AwsSigningConfig
+
+SetShouldNormalizeUriPath()
+: Aws::Crt::Auth::AwsSigningConfig
+
+SetShouldSignHeaderCallback()
+: Aws::Crt::Auth::AwsSigningConfig
+
+SetShouldSignHeaderUserData()
+: Aws::Crt::Auth::AwsSigningConfig
+
+SetShutdownBehavior()
+: Aws::Crt::ApiHandle
+
+SetShutdownCompleteCallback()
+: Aws::Crt::Io::ClientBootstrap
+
+SetSignatureType()
+: Aws::Crt::Auth::AwsSigningConfig
+
+SetSignedBodyHeader()
+: Aws::Crt::Auth::AwsSigningConfig
+
+SetSignedBodyValue()
+: Aws::Crt::Auth::AwsSigningConfig
+
+SetSigningAlgorithm()
+: Aws::Crt::Auth::AwsSigningConfig
+
+SetSigningTimepoint()
+: Aws::Crt::Auth::AwsSigningConfig
+
+SetSlotId()
+: Aws::Crt::Io::TlsContextPkcs11Options
+
+SetSocketDomain()
+: Aws::Crt::Io::SocketOptions
+
+SetSocketType()
+: Aws::Crt::Io::SocketOptions
+
+SetStrategy()
+: Aws::Crt::Http::AdaptiveHttpProxyStrategy
+
+SetTag()
+: Aws::Crt::Crypto::SymmetricCipher
+
+SetTlsCipherPreference()
+: Aws::Crt::Io::TlsContextOptions
+
+SetTokenLabel()
+: Aws::Crt::Io::TlsContextPkcs11Options
+
+SetUseDoubleUriEncode()
+: Aws::Crt::Auth::AwsSigningConfig
+
+SetUserPin()
+: Aws::Crt::Io::TlsContextPkcs11Options
+
+SetVerifyPeer()
+: Aws::Crt::Io::TlsContextOptions
+
+SetWebsocketProxyOptions()
+: Aws::Crt::Mqtt::MqttConnection
+
+SetWill()
+: Aws::Crt::Mqtt::MqttConnection
+
+ShutDownChannel()
+: Aws::Crt::Io::ChannelHandler
+
+Signable
+: Aws::Crt::Auth::HttpSignerCallbackData
+
+Signer
+: Aws::Iot::WebsocketConfig
+
+SigningRegion
+: Aws::Iot::WebsocketConfig
+
+SignRequest()
+: Aws::Crt::Auth::IHttpRequestSigner
+, Aws::Crt::Auth::Sigv4HttpRequestSigner
+
+Sigv4HttpRequestSigner()
+: Aws::Crt::Auth::Sigv4HttpRequestSigner
+
+size()
+: Aws::Crt::basic_string_view< CharT, Traits >
+
+size_type
+: Aws::Crt::basic_string_view< CharT, Traits >
+, Aws::Crt::StlAllocator< T >
+
+SocketOptions
+: Aws::Crt::Http::HttpClientConnectionOptions
+, Aws::Crt::Io::SocketOptions
+
+socketOptions
+: Aws::Crt::Mqtt::MqttConnectionOptions
+
+Start()
+: Aws::Crt::Mqtt5::Mqtt5Client
+
+StartNegotiation()
+: Aws::Crt::Io::ClientTlsChannelHandler
+
+starts_with()
+: Aws::Crt::basic_string_view< CharT, Traits >
+
+StdIOStreamInputStream()
+: Aws::Crt::Io::StdIOStreamInputStream
+
+StlAllocator()
+: Aws::Crt::StlAllocator< T >
+
+Stop()
+: Aws::Crt::Mqtt5::Mqtt5Client
+
+stream
+: Aws::Crt::Http::ClientStreamCallbackData
+
+SubAckPacket()
+: Aws::Crt::Mqtt5::SubAckPacket
+
+Subscribe()
+: Aws::Crt::Mqtt5::Mqtt5Client
+, Aws::Crt::Mqtt::MqttConnection
+
+SubscribePacket()
+: Aws::Crt::Mqtt5::SubscribePacket
+
+Subscription()
+: Aws::Crt::Mqtt5::Subscription
+
+substr()
+: Aws::Crt::basic_string_view< CharT, Traits >
+
+swap()
+: Aws::Crt::basic_string_view< CharT, Traits >
+
+SymmetricCipher()
+: Aws::Crt::Crypto::SymmetricCipher
+
+
+
+
+
+
+
diff --git a/docs/functions_t.html b/docs/functions_t.html
new file mode 100644
index 000000000..f88831a4a
--- /dev/null
+++ b/docs/functions_t.html
@@ -0,0 +1,127 @@
+
+
+
+
+
+
+
+aws-crt-cpp: Class Members
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ aws-crt-cpp
+
+ C++ wrapper around the aws-c-* libraries. Provides Cross-Platform Transport Protocols and SSL/TLS implementations for C++.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
Here is a list of all class members with links to the classes they belong to:
+
+
- t -
+
+
+
+
+
diff --git a/docs/functions_type.html b/docs/functions_type.html
new file mode 100644
index 000000000..4c2accf91
--- /dev/null
+++ b/docs/functions_type.html
@@ -0,0 +1,131 @@
+
+
+
+
+
+
+
+aws-crt-cpp: Class Members - Typedefs
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ aws-crt-cpp
+
+ C++ wrapper around the aws-c-* libraries. Provides Cross-Platform Transport Protocols and SSL/TLS implementations for C++.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Base
+: Aws::Crt::StlAllocator< T >
+
+const_iterator
+: Aws::Crt::basic_string_view< CharT, Traits >
+
+const_pointer
+: Aws::Crt::basic_string_view< CharT, Traits >
+
+const_reference
+: Aws::Crt::basic_string_view< CharT, Traits >
+
+const_reverse_iterator
+: Aws::Crt::basic_string_view< CharT, Traits >
+
+ConstRawAlternativePointerT
+: Aws::Crt::Variant< Ts >
+
+difference_type
+: Aws::Crt::basic_string_view< CharT, Traits >
+
+IndexT
+: Aws::Crt::Variant< Ts >
+
+iterator
+: Aws::Crt::basic_string_view< CharT, Traits >
+
+other
+: Aws::Crt::StlAllocator< T >::rebind< U >
+
+pointer
+: Aws::Crt::basic_string_view< CharT, Traits >
+
+RawAlternativePointerT
+: Aws::Crt::Variant< Ts >
+
+RawPointer
+: Aws::Crt::StlAllocator< T >
+
+reference
+: Aws::Crt::basic_string_view< CharT, Traits >
+
+reverse_iterator
+: Aws::Crt::basic_string_view< CharT, Traits >
+
+size_type
+: Aws::Crt::basic_string_view< CharT, Traits >
+, Aws::Crt::StlAllocator< T >
+
+traits_type
+: Aws::Crt::basic_string_view< CharT, Traits >
+
+type
+: Aws::Crt::VariantAlternative< Index, Ts >
+
+value_type
+: Aws::Crt::basic_string_view< CharT, Traits >
+
+
+
+
+
+
+
diff --git a/docs/functions_u.html b/docs/functions_u.html
new file mode 100644
index 000000000..d4705d5f4
--- /dev/null
+++ b/docs/functions_u.html
@@ -0,0 +1,134 @@
+
+
+
+
+
+
+
+aws-crt-cpp: Class Members
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ aws-crt-cpp
+
+ C++ wrapper around the aws-c-* libraries. Provides Cross-Platform Transport Protocols and SSL/TLS implementations for C++.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
Here is a list of all class members with links to the classes they belong to:
+
+
- u -
+
+
+
+
+
diff --git a/docs/functions_v.html b/docs/functions_v.html
new file mode 100644
index 000000000..229f9faf6
--- /dev/null
+++ b/docs/functions_v.html
@@ -0,0 +1,101 @@
+
+
+
+
+
+
+
+aws-crt-cpp: Class Members
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ aws-crt-cpp
+
+ C++ wrapper around the aws-c-* libraries. Provides Cross-Platform Transport Protocols and SSL/TLS implementations for C++.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
Here is a list of all class members with links to the classes they belong to:
+
+
- v -
+
+
+
+
+
diff --git a/docs/functions_vars.html b/docs/functions_vars.html
new file mode 100644
index 000000000..c976314aa
--- /dev/null
+++ b/docs/functions_vars.html
@@ -0,0 +1,107 @@
+
+
+
+
+
+
+
+aws-crt-cpp: Class Members - Variables
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ aws-crt-cpp
+
+ C++ wrapper around the aws-c-* libraries. Provides Cross-Platform Transport Protocols and SSL/TLS implementations for C++.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/docs/functions_vars_b.html b/docs/functions_vars_b.html
new file mode 100644
index 000000000..27198f539
--- /dev/null
+++ b/docs/functions_vars_b.html
@@ -0,0 +1,95 @@
+
+
+
+
+
+
+
+aws-crt-cpp: Class Members - Variables
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ aws-crt-cpp
+
+ C++ wrapper around the aws-c-* libraries. Provides Cross-Platform Transport Protocols and SSL/TLS implementations for C++.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/docs/functions_vars_c.html b/docs/functions_vars_c.html
new file mode 100644
index 000000000..6c10e6ebc
--- /dev/null
+++ b/docs/functions_vars_c.html
@@ -0,0 +1,109 @@
+
+
+
+
+
+
+
+aws-crt-cpp: Class Members - Variables
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ aws-crt-cpp
+
+ C++ wrapper around the aws-c-* libraries. Provides Cross-Platform Transport Protocols and SSL/TLS implementations for C++.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/docs/functions_vars_d.html b/docs/functions_vars_d.html
new file mode 100644
index 000000000..2a55c9bc8
--- /dev/null
+++ b/docs/functions_vars_d.html
@@ -0,0 +1,81 @@
+
+
+
+
+
+
+
+aws-crt-cpp: Class Members - Variables
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ aws-crt-cpp
+
+ C++ wrapper around the aws-c-* libraries. Provides Cross-Platform Transport Protocols and SSL/TLS implementations for C++.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/docs/functions_vars_e.html b/docs/functions_vars_e.html
new file mode 100644
index 000000000..f82701142
--- /dev/null
+++ b/docs/functions_vars_e.html
@@ -0,0 +1,89 @@
+
+
+
+
+
+
+
+aws-crt-cpp: Class Members - Variables
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ aws-crt-cpp
+
+ C++ wrapper around the aws-c-* libraries. Provides Cross-Platform Transport Protocols and SSL/TLS implementations for C++.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/docs/functions_vars_h.html b/docs/functions_vars_h.html
new file mode 100644
index 000000000..21c1c2f20
--- /dev/null
+++ b/docs/functions_vars_h.html
@@ -0,0 +1,85 @@
+
+
+
+
+
+
+
+aws-crt-cpp: Class Members - Variables
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ aws-crt-cpp
+
+ C++ wrapper around the aws-c-* libraries. Provides Cross-Platform Transport Protocols and SSL/TLS implementations for C++.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/docs/functions_vars_i.html b/docs/functions_vars_i.html
new file mode 100644
index 000000000..573ff6618
--- /dev/null
+++ b/docs/functions_vars_i.html
@@ -0,0 +1,115 @@
+
+
+
+
+
+
+
+aws-crt-cpp: Class Members - Variables
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ aws-crt-cpp
+
+ C++ wrapper around the aws-c-* libraries. Provides Cross-Platform Transport Protocols and SSL/TLS implementations for C++.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/docs/functions_vars_k.html b/docs/functions_vars_k.html
new file mode 100644
index 000000000..50029940e
--- /dev/null
+++ b/docs/functions_vars_k.html
@@ -0,0 +1,82 @@
+
+
+
+
+
+
+
+aws-crt-cpp: Class Members - Variables
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ aws-crt-cpp
+
+ C++ wrapper around the aws-c-* libraries. Provides Cross-Platform Transport Protocols and SSL/TLS implementations for C++.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/docs/functions_vars_l.html b/docs/functions_vars_l.html
new file mode 100644
index 000000000..a5d4ef6d3
--- /dev/null
+++ b/docs/functions_vars_l.html
@@ -0,0 +1,82 @@
+
+
+
+
+
+
+
+aws-crt-cpp: Class Members - Variables
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ aws-crt-cpp
+
+ C++ wrapper around the aws-c-* libraries. Provides Cross-Platform Transport Protocols and SSL/TLS implementations for C++.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/docs/functions_vars_m.html b/docs/functions_vars_m.html
new file mode 100644
index 000000000..eb44393ed
--- /dev/null
+++ b/docs/functions_vars_m.html
@@ -0,0 +1,158 @@
+
+
+
+
+
+
+
+aws-crt-cpp: Class Members - Variables
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ aws-crt-cpp
+
+ C++ wrapper around the aws-c-* libraries. Provides Cross-Platform Transport Protocols and SSL/TLS implementations for C++.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/docs/functions_vars_n.html b/docs/functions_vars_n.html
new file mode 100644
index 000000000..8df499a4f
--- /dev/null
+++ b/docs/functions_vars_n.html
@@ -0,0 +1,87 @@
+
+
+
+
+
+
+
+aws-crt-cpp: Class Members - Variables
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ aws-crt-cpp
+
+ C++ wrapper around the aws-c-* libraries. Provides Cross-Platform Transport Protocols and SSL/TLS implementations for C++.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/docs/functions_vars_o.html b/docs/functions_vars_o.html
new file mode 100644
index 000000000..41e17db07
--- /dev/null
+++ b/docs/functions_vars_o.html
@@ -0,0 +1,123 @@
+
+
+
+
+
+
+
+aws-crt-cpp: Class Members - Variables
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ aws-crt-cpp
+
+ C++ wrapper around the aws-c-* libraries. Provides Cross-Platform Transport Protocols and SSL/TLS implementations for C++.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/docs/functions_vars_p.html b/docs/functions_vars_p.html
new file mode 100644
index 000000000..9dafa3b9e
--- /dev/null
+++ b/docs/functions_vars_p.html
@@ -0,0 +1,128 @@
+
+
+
+
+
+
+
+aws-crt-cpp: Class Members - Variables
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ aws-crt-cpp
+
+ C++ wrapper around the aws-c-* libraries. Provides Cross-Platform Transport Protocols and SSL/TLS implementations for C++.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/docs/functions_vars_r.html b/docs/functions_vars_r.html
new file mode 100644
index 000000000..49d816d7a
--- /dev/null
+++ b/docs/functions_vars_r.html
@@ -0,0 +1,98 @@
+
+
+
+
+
+
+
+aws-crt-cpp: Class Members - Variables
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ aws-crt-cpp
+
+ C++ wrapper around the aws-c-* libraries. Provides Cross-Platform Transport Protocols and SSL/TLS implementations for C++.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/docs/functions_vars_s.html b/docs/functions_vars_s.html
new file mode 100644
index 000000000..2ef7b0c8c
--- /dev/null
+++ b/docs/functions_vars_s.html
@@ -0,0 +1,132 @@
+
+
+
+
+
+
+
+aws-crt-cpp: Class Members - Variables
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ aws-crt-cpp
+
+ C++ wrapper around the aws-c-* libraries. Provides Cross-Platform Transport Protocols and SSL/TLS implementations for C++.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/docs/functions_vars_t.html b/docs/functions_vars_t.html
new file mode 100644
index 000000000..f7369050d
--- /dev/null
+++ b/docs/functions_vars_t.html
@@ -0,0 +1,97 @@
+
+
+
+
+
+
+
+aws-crt-cpp: Class Members - Variables
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ aws-crt-cpp
+
+ C++ wrapper around the aws-c-* libraries. Provides Cross-Platform Transport Protocols and SSL/TLS implementations for C++.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/docs/functions_vars_u.html b/docs/functions_vars_u.html
new file mode 100644
index 000000000..d5d48e255
--- /dev/null
+++ b/docs/functions_vars_u.html
@@ -0,0 +1,95 @@
+
+
+
+
+
+
+
+aws-crt-cpp: Class Members - Variables
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ aws-crt-cpp
+
+ C++ wrapper around the aws-c-* libraries. Provides Cross-Platform Transport Protocols and SSL/TLS implementations for C++.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/docs/functions_vars_v.html b/docs/functions_vars_v.html
new file mode 100644
index 000000000..1a6e1af06
--- /dev/null
+++ b/docs/functions_vars_v.html
@@ -0,0 +1,82 @@
+
+
+
+
+
+
+
+aws-crt-cpp: Class Members - Variables
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ aws-crt-cpp
+
+ C++ wrapper around the aws-c-* libraries. Provides Cross-Platform Transport Protocols and SSL/TLS implementations for C++.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/docs/functions_vars_w.html b/docs/functions_vars_w.html
new file mode 100644
index 000000000..cf0ef5b29
--- /dev/null
+++ b/docs/functions_vars_w.html
@@ -0,0 +1,81 @@
+
+
+
+
+
+
+
+aws-crt-cpp: Class Members - Variables
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ aws-crt-cpp
+
+ C++ wrapper around the aws-c-* libraries. Provides Cross-Platform Transport Protocols and SSL/TLS implementations for C++.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/docs/functions_w.html b/docs/functions_w.html
new file mode 100644
index 000000000..9397e04eb
--- /dev/null
+++ b/docs/functions_w.html
@@ -0,0 +1,434 @@
+
+
+
+
+
+
+
+aws-crt-cpp: Class Members
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ aws-crt-cpp
+
+ C++ wrapper around the aws-c-* libraries. Provides Cross-Platform Transport Protocols and SSL/TLS implementations for C++.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
Here is a list of all class members with links to the classes they belong to:
+
+
- w -
+WasParseSuccessful()
+: Aws::Crt::JsonObject
+
+wasSuccessful()
+: Aws::Crt::Mqtt5::PublishResult
+
+WebsocketConfig()
+: Aws::Iot::WebsocketConfig
+
+WebsocketInterceptor
+: Aws::Crt::Mqtt::MqttConnection
+
+WithAckTimeoutSec()
+: Aws::Crt::Mqtt5::Mqtt5ClientOptions
+, Aws::Iot::Mqtt5ClientBuilder
+
+WithAckTimeoutSeconds()
+: Aws::Crt::Mqtt5::Mqtt5ClientOptions
+, Aws::Iot::Mqtt5ClientBuilder
+
+WithArray()
+: Aws::Crt::JsonObject
+
+WithAuthorizerName()
+: Aws::Iot::Mqtt5CustomAuthConfig
+
+WithBool()
+: Aws::Crt::JsonObject
+
+WithBootstrap()
+: Aws::Crt::Mqtt5::Mqtt5ClientOptions
+, Aws::Iot::Mqtt5ClientBuilder
+
+WithCertificateAuthority()
+: Aws::Iot::Mqtt5ClientBuilder
+, Aws::Iot::MqttClientConnectionConfigBuilder
+
+WithClientAttemptingConnectCallback()
+: Aws::Crt::Mqtt5::Mqtt5ClientOptions
+, Aws::Iot::Mqtt5ClientBuilder
+
+WithClientConnectionFailureCallback()
+: Aws::Crt::Mqtt5::Mqtt5ClientOptions
+, Aws::Iot::Mqtt5ClientBuilder
+
+WithClientConnectionSuccessCallback()
+: Aws::Crt::Mqtt5::Mqtt5ClientOptions
+, Aws::Iot::Mqtt5ClientBuilder
+
+WithClientDisconnectionCallback()
+: Aws::Crt::Mqtt5::Mqtt5ClientOptions
+, Aws::Iot::Mqtt5ClientBuilder
+
+WithClientExtendedValidationAndFlowControl()
+: Aws::Crt::Mqtt5::Mqtt5ClientOptions
+, Aws::Iot::Mqtt5ClientBuilder
+
+WithClientId()
+: Aws::Crt::Mqtt5::ConnectPacket
+
+WithClientStoppedCallback()
+: Aws::Crt::Mqtt5::Mqtt5ClientOptions
+, Aws::Iot::Mqtt5ClientBuilder
+
+WithConnackTimeoutMs()
+: Aws::Crt::Mqtt5::Mqtt5ClientOptions
+, Aws::Iot::Mqtt5ClientBuilder
+
+WithConnectOptions()
+: Aws::Crt::Mqtt5::Mqtt5ClientOptions
+, Aws::Iot::Mqtt5ClientBuilder
+
+WithCorrelationData()
+: Aws::Crt::Mqtt5::PublishPacket
+
+WithCustomAuthorizer()
+: Aws::Iot::Mqtt5ClientBuilder
+, Aws::Iot::MqttClientConnectionConfigBuilder
+
+WithDouble()
+: Aws::Crt::JsonObject
+
+WithEndpoint()
+: Aws::Iot::MqttClientConnectionConfigBuilder
+
+WithHostName()
+: Aws::Crt::Mqtt5::Mqtt5ClientOptions
+, Aws::Iot::Mqtt5ClientBuilder
+
+WithHttpProxyOptions()
+: Aws::Crt::Mqtt5::Mqtt5ClientOptions
+, Aws::Iot::Mqtt5ClientBuilder
+, Aws::Iot::MqttClientConnectionConfigBuilder
+
+WithInt64()
+: Aws::Crt::JsonObject
+
+WithInteger()
+: Aws::Crt::JsonObject
+
+WithKeepAliveIntervalSec()
+: Aws::Crt::Mqtt5::ConnectPacket
+
+WithMaximumPacketSizeBytes()
+: Aws::Crt::Mqtt5::ConnectPacket
+
+WithMessageExpiryIntervalSec()
+: Aws::Crt::Mqtt5::PublishPacket
+
+WithMetricsCollection()
+: Aws::Iot::MqttClientConnectionConfigBuilder
+
+WithMinConnectedTimeToResetReconnectDelayMs()
+: Aws::Iot::Mqtt5ClientBuilder
+
+WithMinimumTlsVersion()
+: Aws::Iot::MqttClientConnectionConfigBuilder
+
+WithNoLocal()
+: Aws::Crt::Mqtt5::Subscription
+
+WithObject()
+: Aws::Crt::JsonObject
+
+WithOfflineQueueBehavior()
+: Aws::Crt::Mqtt5::Mqtt5ClientOptions
+, Aws::Iot::Mqtt5ClientBuilder
+
+WithPassword()
+: Aws::Crt::Mqtt5::ConnectPacket
+, Aws::Iot::Mqtt5CustomAuthConfig
+, Aws::Iot::MqttClientConnectionConfigBuilder
+
+WithPayload()
+: Aws::Crt::Mqtt5::PublishPacket
+
+WithPayloadFormatIndicator()
+: Aws::Crt::Mqtt5::PublishPacket
+
+WithPingTimeoutMs()
+: Aws::Crt::Mqtt5::Mqtt5ClientOptions
+, Aws::Iot::Mqtt5ClientBuilder
+
+WithPort()
+: Aws::Crt::Mqtt5::Mqtt5ClientOptions
+, Aws::Iot::Mqtt5ClientBuilder
+
+WithPortOverride()
+: Aws::Iot::MqttClientConnectionConfigBuilder
+
+WithPublishReceivedCallback()
+: Aws::Crt::Mqtt5::Mqtt5ClientOptions
+, Aws::Iot::Mqtt5ClientBuilder
+
+WithQOS()
+: Aws::Crt::Mqtt5::PublishPacket
+, Aws::Crt::Mqtt5::Subscription
+
+WithReasonCode()
+: Aws::Crt::Mqtt5::DisconnectPacket
+
+WithReasonString()
+: Aws::Crt::Mqtt5::DisconnectPacket
+
+WithReceiveMaximum()
+: Aws::Crt::Mqtt5::ConnectPacket
+
+WithReconnectOptions()
+: Aws::Crt::Mqtt5::Mqtt5ClientOptions
+, Aws::Iot::Mqtt5ClientBuilder
+
+WithRequestProblemInformation()
+: Aws::Crt::Mqtt5::ConnectPacket
+
+WithRequestResponseInformation()
+: Aws::Crt::Mqtt5::ConnectPacket
+
+WithResponseTopic()
+: Aws::Crt::Mqtt5::PublishPacket
+
+WithRetain()
+: Aws::Crt::Mqtt5::PublishPacket
+, Aws::Crt::Mqtt5::Subscription
+
+WithRetainAsPublished()
+: Aws::Crt::Mqtt5::Subscription
+
+WithRetainHandlingType()
+: Aws::Crt::Mqtt5::Subscription
+
+WithSdkName()
+: Aws::Iot::Mqtt5ClientBuilder
+, Aws::Iot::MqttClientConnectionConfigBuilder
+
+WithSdkVersion()
+: Aws::Iot::Mqtt5ClientBuilder
+, Aws::Iot::MqttClientConnectionConfigBuilder
+
+WithServerReference()
+: Aws::Crt::Mqtt5::DisconnectPacket
+
+WithSessionBehavior()
+: Aws::Crt::Mqtt5::Mqtt5ClientOptions
+, Aws::Iot::Mqtt5ClientBuilder
+
+WithSessionExpiryIntervalSec()
+: Aws::Crt::Mqtt5::ConnectPacket
+, Aws::Crt::Mqtt5::DisconnectPacket
+
+WithSocketOptions()
+: Aws::Crt::Mqtt5::Mqtt5ClientOptions
+, Aws::Iot::Mqtt5ClientBuilder
+
+WithString()
+: Aws::Crt::JsonObject
+
+WithSubscription()
+: Aws::Crt::Mqtt5::SubscribePacket
+
+WithSubscriptionIdentifier()
+: Aws::Crt::Mqtt5::SubscribePacket
+
+WithSubscriptions()
+: Aws::Crt::Mqtt5::SubscribePacket
+
+WithTcpConnectTimeout()
+: Aws::Iot::MqttClientConnectionConfigBuilder
+
+WithTcpKeepAlive()
+: Aws::Iot::MqttClientConnectionConfigBuilder
+
+WithTcpKeepAliveInterval()
+: Aws::Iot::MqttClientConnectionConfigBuilder
+
+WithTcpKeepAliveMaxProbes()
+: Aws::Iot::MqttClientConnectionConfigBuilder
+
+WithTcpKeepAliveTimeout()
+: Aws::Iot::MqttClientConnectionConfigBuilder
+
+WithTlsConnectionOptions()
+: Aws::Crt::Mqtt5::Mqtt5ClientOptions
+
+WithTokenKeyName()
+: Aws::Iot::Mqtt5CustomAuthConfig
+
+WithTokenSignature()
+: Aws::Iot::Mqtt5CustomAuthConfig
+
+WithTokenValue()
+: Aws::Iot::Mqtt5CustomAuthConfig
+
+WithTopic()
+: Aws::Crt::Mqtt5::PublishPacket
+
+WithTopicAlias()
+: Aws::Crt::Mqtt5::PublishPacket
+
+WithTopicAliasingOptions()
+: Aws::Crt::Mqtt5::Mqtt5ClientOptions
+, Aws::Iot::Mqtt5ClientBuilder
+
+WithTopicFilter()
+: Aws::Crt::Mqtt5::Subscription
+, Aws::Crt::Mqtt5::UnsubscribePacket
+
+WithTopicFilters()
+: Aws::Crt::Mqtt5::UnsubscribePacket
+
+WithUserName()
+: Aws::Crt::Mqtt5::ConnectPacket
+
+WithUsername()
+: Aws::Iot::Mqtt5CustomAuthConfig
+, Aws::Iot::MqttClientConnectionConfigBuilder
+
+WithUserProperties()
+: Aws::Crt::Mqtt5::ConnectPacket
+, Aws::Crt::Mqtt5::DisconnectPacket
+, Aws::Crt::Mqtt5::PublishPacket
+, Aws::Crt::Mqtt5::SubscribePacket
+, Aws::Crt::Mqtt5::UnsubscribePacket
+
+WithUserProperty()
+: Aws::Crt::Mqtt5::ConnectPacket
+, Aws::Crt::Mqtt5::DisconnectPacket
+, Aws::Crt::Mqtt5::PublishPacket
+, Aws::Crt::Mqtt5::SubscribePacket
+, Aws::Crt::Mqtt5::UnsubscribePacket
+
+WithWebsocketHandshakeTransformCallback()
+: Aws::Crt::Mqtt5::Mqtt5ClientOptions
+
+WithWill()
+: Aws::Crt::Mqtt5::ConnectPacket
+
+WithWillDelayIntervalSec()
+: Aws::Crt::Mqtt5::ConnectPacket
+
+WrappedCallbackArgs()
+: Aws::Crt::Imds::WrappedCallbackArgs< T >
+
+wrappingFn
+: Aws::Crt::Io::TaskWrapper
+
+WriteArrayStart()
+: Aws::Crt::Cbor::CborEncoder
+
+WriteBool()
+: Aws::Crt::Cbor::CborEncoder
+
+WriteBreak()
+: Aws::Crt::Cbor::CborEncoder
+
+WriteBytes()
+: Aws::Crt::Cbor::CborEncoder
+
+WriteCompact()
+: Aws::Crt::JsonView
+
+WriteFloat()
+: Aws::Crt::Cbor::CborEncoder
+
+WriteIndefArrayStart()
+: Aws::Crt::Cbor::CborEncoder
+
+WriteIndefBytesStart()
+: Aws::Crt::Cbor::CborEncoder
+
+WriteIndefMapStart()
+: Aws::Crt::Cbor::CborEncoder
+
+WriteIndefTextStart()
+: Aws::Crt::Cbor::CborEncoder
+
+WriteMapStart()
+: Aws::Crt::Cbor::CborEncoder
+
+WriteNegInt()
+: Aws::Crt::Cbor::CborEncoder
+
+WriteNull()
+: Aws::Crt::Cbor::CborEncoder
+
+WriteReadable()
+: Aws::Crt::JsonView
+
+WriteTag()
+: Aws::Crt::Cbor::CborEncoder
+
+WriteText()
+: Aws::Crt::Cbor::CborEncoder
+
+WriteUInt()
+: Aws::Crt::Cbor::CborEncoder
+
+WriteUndefined()
+: Aws::Crt::Cbor::CborEncoder
+
+
+
+
+
+
+
diff --git a/docs/functions_~.html b/docs/functions_~.html
new file mode 100644
index 000000000..03e3f74d2
--- /dev/null
+++ b/docs/functions_~.html
@@ -0,0 +1,267 @@
+
+
+
+
+
+
+
+aws-crt-cpp: Class Members
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ aws-crt-cpp
+
+ C++ wrapper around the aws-c-* libraries. Provides Cross-Platform Transport Protocols and SSL/TLS implementations for C++.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
Here is a list of all class members with links to the classes they belong to:
+
+
- ~ -
+
+
+
+
+
diff --git a/docs/globals.html b/docs/globals.html
new file mode 100644
index 000000000..f72553951
--- /dev/null
+++ b/docs/globals.html
@@ -0,0 +1,79 @@
+
+
+
+
+
+
+
+aws-crt-cpp: File Members
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ aws-crt-cpp
+
+ C++ wrapper around the aws-c-* libraries. Provides Cross-Platform Transport Protocols and SSL/TLS implementations for C++.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
Here is a list of all file members with links to the files they belong to:
+
+
+
+
+
diff --git a/docs/globals_defs.html b/docs/globals_defs.html
new file mode 100644
index 000000000..7914d61cf
--- /dev/null
+++ b/docs/globals_defs.html
@@ -0,0 +1,79 @@
+
+
+
+
+
+
+
+aws-crt-cpp: File Members
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ aws-crt-cpp
+
+ C++ wrapper around the aws-c-* libraries. Provides Cross-Platform Transport Protocols and SSL/TLS implementations for C++.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/docs/hierarchy.html b/docs/hierarchy.html
new file mode 100644
index 000000000..d161d67cb
--- /dev/null
+++ b/docs/hierarchy.html
@@ -0,0 +1,236 @@
+
+
+
+
+
+
+
+aws-crt-cpp: Class Hierarchy
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ aws-crt-cpp
+
+ C++ wrapper around the aws-c-* libraries. Provides Cross-Platform Transport Protocols and SSL/TLS implementations for C++.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
This inheritance list is sorted roughly, but not completely, alphabetically:
+
+
+
+
+
diff --git a/docs/index.html b/docs/index.html
new file mode 100644
index 000000000..7572b0ec8
--- /dev/null
+++ b/docs/index.html
@@ -0,0 +1,78 @@
+
+
+
+
+
+
+
+aws-crt-cpp: Welcome to awscrt's documentation!
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ aws-crt-cpp
+
+ C++ wrapper around the aws-c-* libraries. Provides Cross-Platform Transport Protocols and SSL/TLS implementations for C++.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
C++ bindings for the AWS Common Runtime.
+
Github: https://github.com/awslabs/aws-crt-cpp
+
+
+
+
+
+
diff --git a/docs/index_8md.html b/docs/index_8md.html
new file mode 100644
index 000000000..7f05e6ef6
--- /dev/null
+++ b/docs/index_8md.html
@@ -0,0 +1,75 @@
+
+
+
+
+
+
+
+aws-crt-cpp: docsrc/index.md File Reference
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ aws-crt-cpp
+
+ C++ wrapper around the aws-c-* libraries. Provides Cross-Platform Transport Protocols and SSL/TLS implementations for C++.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/docs/iot_2_mqtt5_client_8cpp.html b/docs/iot_2_mqtt5_client_8cpp.html
new file mode 100644
index 000000000..cf4bf90a2
--- /dev/null
+++ b/docs/iot_2_mqtt5_client_8cpp.html
@@ -0,0 +1,104 @@
+
+
+
+
+
+
+
+aws-crt-cpp: source/iot/Mqtt5Client.cpp File Reference
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ aws-crt-cpp
+
+ C++ wrapper around the aws-c-* libraries. Provides Cross-Platform Transport Protocols and SSL/TLS implementations for C++.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/docs/iot_2_mqtt5_client_8h.html b/docs/iot_2_mqtt5_client_8h.html
new file mode 100644
index 000000000..117900254
--- /dev/null
+++ b/docs/iot_2_mqtt5_client_8h.html
@@ -0,0 +1,106 @@
+
+
+
+
+
+
+
+aws-crt-cpp: include/aws/iot/Mqtt5Client.h File Reference
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ aws-crt-cpp
+
+ C++ wrapper around the aws-c-* libraries. Provides Cross-Platform Transport Protocols and SSL/TLS implementations for C++.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/docs/iot_2_mqtt5_client_8h_source.html b/docs/iot_2_mqtt5_client_8h_source.html
new file mode 100644
index 000000000..45dd29fe1
--- /dev/null
+++ b/docs/iot_2_mqtt5_client_8h_source.html
@@ -0,0 +1,344 @@
+
+
+
+
+
+
+
+aws-crt-cpp: include/aws/iot/Mqtt5Client.h Source File
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ aws-crt-cpp
+
+ C++ wrapper around the aws-c-* libraries. Provides Cross-Platform Transport Protocols and SSL/TLS implementations for C++.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
Go to the documentation of this file.
+
6 #include <aws/crt/Config.h>
+
+
+
+
+
+
+
+
+
+
16 using namespace Crt::Mqtt5;
+
+
+
+
20 class ClientBootstrap;
+
+
22 class TlsContextOptions;
+
23 class WebsocketConfig;
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
138 const char *certPath,
+
139 const char *pkeyPath,
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
206 const char *windowsCertStorePath,
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
334 Mqtt5ClientBuilder &WithConnectOptions(std::shared_ptr<ConnectPacket> packetConnect) noexcept;
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
398 uint64_t minConnectedTimeToResetReconnectDelayMs) noexcept;
+
+
+
+
+
+
+
+
+
+
+
+
+
+
465 std::shared_ptr<Mqtt5Client> Build() noexcept;
+
+
470 explicit operator
bool () const noexcept {
return m_lastError == 0; }
+
+
475 int LastError () const noexcept {
return m_lastError ? m_lastError : AWS_ERROR_UNKNOWN; }
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
581 std::shared_ptr<ConnectPacket> m_connectOptions;
+
+
+
+
+
+
+
588 bool m_enableMetricsCollection;
+
+
+
+
+
+
+
+
+
+
+
#define AWS_CRT_CPP_API
Definition: Exports.h:37
+
+
+
Definition: HttpConnection.h:270
+
Definition: Bootstrap.h:35
+
Definition: SocketOptions.h:48
+
Definition: TlsOptions.h:217
+
Definition: Mqtt5Client.h:451
+
+
Definition: Mqtt5Client.h:123
+
Mqtt5ClientBuilder & operator=(const Mqtt5ClientBuilder &)=delete
+
Mqtt5ClientBuilder(const Mqtt5ClientBuilder &)=delete
+
Mqtt5ClientBuilder(Mqtt5ClientBuilder &&)=delete
+
Mqtt5ClientBuilder & WithMinConnectedTimeToResetReconnectDelayMs(uint64_t minConnectedTimeToResetReconnectDelayMs) noexcept
+
Mqtt5ClientBuilder & operator=(Mqtt5ClientBuilder &&)=delete
+
int LastError() const noexcept
Definition: Mqtt5Client.h:475
+
virtual ~Mqtt5ClientBuilder()
Definition: Mqtt5Client.h:477
+
Definition: Mqtt5Client.h:33
+
Mqtt5CustomAuthConfig & operator=(Mqtt5CustomAuthConfig &&rhs)=delete
+
Mqtt5CustomAuthConfig(Mqtt5CustomAuthConfig &&rhs)=delete
+
+
aws_mqtt5_client_operation_queue_behavior_type ClientOperationQueueBehaviorType
Definition: Mqtt5Types.h:223
+
aws_mqtt5_client_session_behavior_type ClientSessionBehaviorType
Definition: Mqtt5Types.h:186
+
std::function< void(const PublishReceivedEventData &)> OnPublishReceivedHandler
Definition: Mqtt5Client.h:308
+
std::function< void(const OnStoppedEventData &)> OnStoppedHandler
Definition: Mqtt5Client.h:288
+
std::function< void(const OnDisconnectionEventData &)> OnDisconnectionHandler
Definition: Mqtt5Client.h:276
+
std::function< void(const OnConnectionSuccessEventData &)> OnConnectionSuccessHandler
Definition: Mqtt5Client.h:266
+
std::function< void(const OnAttemptingConnectEventData &)> OnAttemptingConnectHandler
Definition: Mqtt5Client.h:282
+
std::function< void(const OnConnectionFailureEventData &)> OnConnectionFailureHandler
Definition: Mqtt5Client.h:271
+
aws_mqtt5_extended_validation_and_flow_control_options ClientExtendedValidationAndFlowControl
Definition: Mqtt5Types.h:200
+
aws_byte_cursor ByteCursor
Definition: Types.h:31
+
aws_allocator Allocator
Definition: Allocator.h:14
+
AWS_CRT_CPP_API Allocator * ApiAllocator() noexcept
Definition: Allocator.cpp:24
+
std::basic_string< char, std::char_traits< char >, StlAllocator< char > > String
Definition: Types.h:45
+
aws_byte_buf ByteBuf
Definition: Types.h:30
+
Definition: Allocator.h:11
+
Definition: Mqtt5Client.h:145
+
Definition: Mqtt5Client.h:101
+
Definition: MqttCommon.h:105
+
Definition: MqttCommon.h:24
+
+
+
+
+
diff --git a/docs/iot_2_mqtt_client_8cpp.html b/docs/iot_2_mqtt_client_8cpp.html
new file mode 100644
index 000000000..6904ee92b
--- /dev/null
+++ b/docs/iot_2_mqtt_client_8cpp.html
@@ -0,0 +1,95 @@
+
+
+
+
+
+
+
+aws-crt-cpp: source/iot/MqttClient.cpp File Reference
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ aws-crt-cpp
+
+ C++ wrapper around the aws-c-* libraries. Provides Cross-Platform Transport Protocols and SSL/TLS implementations for C++.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/docs/iot_2_mqtt_client_8h.html b/docs/iot_2_mqtt_client_8h.html
new file mode 100644
index 000000000..be83f840f
--- /dev/null
+++ b/docs/iot_2_mqtt_client_8h.html
@@ -0,0 +1,106 @@
+
+
+
+
+
+
+
+aws-crt-cpp: include/aws/iot/MqttClient.h File Reference
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ aws-crt-cpp
+
+ C++ wrapper around the aws-c-* libraries. Provides Cross-Platform Transport Protocols and SSL/TLS implementations for C++.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/docs/iot_2_mqtt_client_8h_source.html b/docs/iot_2_mqtt_client_8h_source.html
new file mode 100644
index 000000000..97ef88ae9
--- /dev/null
+++ b/docs/iot_2_mqtt_client_8h_source.html
@@ -0,0 +1,305 @@
+
+
+
+
+
+
+
+aws-crt-cpp: include/aws/iot/MqttClient.h Source File
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ aws-crt-cpp
+
+ C++ wrapper around the aws-c-* libraries. Provides Cross-Platform Transport Protocols and SSL/TLS implementations for C++.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
Go to the documentation of this file.
+
6 #include <aws/crt/Config.h>
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
72 explicit operator bool() const noexcept {
return m_context ? true :
false ; }
+
+
77 int LastError () const noexcept {
return m_lastError; }
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
122 const char *certPath,
+
123 const char *pkeyPath,
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
175 const char *windowsCertStorePath,
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
421 explicit operator bool() const noexcept {
return m_lastError == 0; }
+
+
426 int LastError () const noexcept {
return m_lastError ? m_lastError : AWS_ERROR_UNKNOWN; }
+
+
+
+
+
+
+
+
+
+
+
+
+
+
440 uint32_t m_portOverride;
+
+
+
+
+
445 bool m_enableMetricsCollection =
true ;
+
+
+
+
+
450 bool m_isUsingCustomAuthorizer =
false ;
+
+
+
+
+
+
+
+
+
+
+
+
+
+
483 int LastError () const noexcept {
return m_client.LastError(); }
+
+
488 explicit operator bool() const noexcept {
return m_client ? true :
false ; }
+
+
+
+
+
+
+
+
+
+
+
#define AWS_CRT_CPP_API
Definition: Exports.h:37
+
+
+
+
Definition: HttpConnection.h:270
+
Definition: Bootstrap.h:35
+
Definition: SocketOptions.h:48
+
Definition: TlsOptions.h:350
+
Definition: TlsOptions.h:36
+
Definition: TlsOptions.h:217
+
Definition: MqttClient.h:48
+
Definition: Optional.h:18
+
Definition: MqttClient.h:109
+
int LastError() const noexcept
Definition: MqttClient.h:426
+
Definition: MqttClient.h:26
+
int LastError() const noexcept
Definition: MqttClient.h:77
+
Definition: MqttClient.h:461
+
int LastError() const noexcept
Definition: MqttClient.h:483
+
std::function< void(std::shared_ptr< Http::HttpRequest > req, const OnWebSocketHandshakeInterceptComplete &onComplete)> OnWebSocketHandshakeIntercept
Definition: MqttConnection.h:146
+
aws_byte_cursor ByteCursor
Definition: Types.h:31
+
aws_allocator Allocator
Definition: Allocator.h:14
+
AWS_CRT_CPP_API Allocator * ApiAllocator() noexcept
Definition: Allocator.cpp:24
+
std::basic_string< char, std::char_traits< char >, StlAllocator< char > > String
Definition: Types.h:45
+
static Crt::String AddToUsernameParameter(Crt::String currentUsername, Crt::String parameterValue, Crt::String parameterPreText)
Definition: Mqtt5Client.cpp:21
+
Definition: Allocator.h:11
+
Definition: MqttCommon.h:105
+
Definition: MqttCommon.h:24
+
+
+
+
+
diff --git a/docs/jquery.js b/docs/jquery.js
new file mode 100644
index 000000000..103c32d79
--- /dev/null
+++ b/docs/jquery.js
@@ -0,0 +1,35 @@
+/*! jQuery v3.4.1 | (c) JS Foundation and other contributors | jquery.org/license */
+!function(e,t){"use strict";"object"==typeof module&&"object"==typeof module.exports?module.exports=e.document?t(e,!0):function(e){if(!e.document)throw new Error("jQuery requires a window with a document");return t(e)}:t(e)}("undefined"!=typeof window?window:this,function(C,e){"use strict";var t=[],E=C.document,r=Object.getPrototypeOf,s=t.slice,g=t.concat,u=t.push,i=t.indexOf,n={},o=n.toString,v=n.hasOwnProperty,a=v.toString,l=a.call(Object),y={},m=function(e){return"function"==typeof e&&"number"!=typeof e.nodeType},x=function(e){return null!=e&&e===e.window},c={type:!0,src:!0,nonce:!0,noModule:!0};function b(e,t,n){var r,i,o=(n=n||E).createElement("script");if(o.text=e,t)for(r in c)(i=t[r]||t.getAttribute&&t.getAttribute(r))&&o.setAttribute(r,i);n.head.appendChild(o).parentNode.removeChild(o)}function w(e){return null==e?e+"":"object"==typeof e||"function"==typeof e?n[o.call(e)]||"object":typeof e}var f="3.4.1",k=function(e,t){return new k.fn.init(e,t)},p=/^[\s\uFEFF\xA0]+|[\s\uFEFF\xA0]+$/g;function d(e){var t=!!e&&"length"in e&&e.length,n=w(e);return!m(e)&&!x(e)&&("array"===n||0===t||"number"==typeof t&&0+~]|"+M+")"+M+"*"),U=new RegExp(M+"|>"),X=new RegExp($),V=new RegExp("^"+I+"$"),G={ID:new RegExp("^#("+I+")"),CLASS:new RegExp("^\\.("+I+")"),TAG:new RegExp("^("+I+"|[*])"),ATTR:new RegExp("^"+W),PSEUDO:new RegExp("^"+$),CHILD:new RegExp("^:(only|first|last|nth|nth-last)-(child|of-type)(?:\\("+M+"*(even|odd|(([+-]|)(\\d*)n|)"+M+"*(?:([+-]|)"+M+"*(\\d+)|))"+M+"*\\)|)","i"),bool:new RegExp("^(?:"+R+")$","i"),needsContext:new RegExp("^"+M+"*[>+~]|:(even|odd|eq|gt|lt|nth|first|last)(?:\\("+M+"*((?:-\\d)?\\d*)"+M+"*\\)|)(?=[^-]|$)","i")},Y=/HTML$/i,Q=/^(?:input|select|textarea|button)$/i,J=/^h\d$/i,K=/^[^{]+\{\s*\[native \w/,Z=/^(?:#([\w-]+)|(\w+)|\.([\w-]+))$/,ee=/[+~]/,te=new RegExp("\\\\([\\da-f]{1,6}"+M+"?|("+M+")|.)","ig"),ne=function(e,t,n){var r="0x"+t-65536;return r!=r||n?t:r<0?String.fromCharCode(r+65536):String.fromCharCode(r>>10|55296,1023&r|56320)},re=/([\0-\x1f\x7f]|^-?\d)|^-$|[^\0-\x1f\x7f-\uFFFF\w-]/g,ie=function(e,t){return t?"\0"===e?"\ufffd":e.slice(0,-1)+"\\"+e.charCodeAt(e.length-1).toString(16)+" ":"\\"+e},oe=function(){T()},ae=be(function(e){return!0===e.disabled&&"fieldset"===e.nodeName.toLowerCase()},{dir:"parentNode",next:"legend"});try{H.apply(t=O.call(m.childNodes),m.childNodes),t[m.childNodes.length].nodeType}catch(e){H={apply:t.length?function(e,t){L.apply(e,O.call(t))}:function(e,t){var n=e.length,r=0;while(e[n++]=t[r++]);e.length=n-1}}}function se(t,e,n,r){var i,o,a,s,u,l,c,f=e&&e.ownerDocument,p=e?e.nodeType:9;if(n=n||[],"string"!=typeof t||!t||1!==p&&9!==p&&11!==p)return n;if(!r&&((e?e.ownerDocument||e:m)!==C&&T(e),e=e||C,E)){if(11!==p&&(u=Z.exec(t)))if(i=u[1]){if(9===p){if(!(a=e.getElementById(i)))return n;if(a.id===i)return n.push(a),n}else if(f&&(a=f.getElementById(i))&&y(e,a)&&a.id===i)return n.push(a),n}else{if(u[2])return H.apply(n,e.getElementsByTagName(t)),n;if((i=u[3])&&d.getElementsByClassName&&e.getElementsByClassName)return H.apply(n,e.getElementsByClassName(i)),n}if(d.qsa&&!A[t+" "]&&(!v||!v.test(t))&&(1!==p||"object"!==e.nodeName.toLowerCase())){if(c=t,f=e,1===p&&U.test(t)){(s=e.getAttribute("id"))?s=s.replace(re,ie):e.setAttribute("id",s=k),o=(l=h(t)).length;while(o--)l[o]="#"+s+" "+xe(l[o]);c=l.join(","),f=ee.test(t)&&ye(e.parentNode)||e}try{return H.apply(n,f.querySelectorAll(c)),n}catch(e){A(t,!0)}finally{s===k&&e.removeAttribute("id")}}}return g(t.replace(B,"$1"),e,n,r)}function ue(){var r=[];return function e(t,n){return r.push(t+" ")>b.cacheLength&&delete e[r.shift()],e[t+" "]=n}}function le(e){return e[k]=!0,e}function ce(e){var t=C.createElement("fieldset");try{return!!e(t)}catch(e){return!1}finally{t.parentNode&&t.parentNode.removeChild(t),t=null}}function fe(e,t){var n=e.split("|"),r=n.length;while(r--)b.attrHandle[n[r]]=t}function pe(e,t){var n=t&&e,r=n&&1===e.nodeType&&1===t.nodeType&&e.sourceIndex-t.sourceIndex;if(r)return r;if(n)while(n=n.nextSibling)if(n===t)return-1;return e?1:-1}function de(t){return function(e){return"input"===e.nodeName.toLowerCase()&&e.type===t}}function he(n){return function(e){var t=e.nodeName.toLowerCase();return("input"===t||"button"===t)&&e.type===n}}function ge(t){return function(e){return"form"in e?e.parentNode&&!1===e.disabled?"label"in e?"label"in e.parentNode?e.parentNode.disabled===t:e.disabled===t:e.isDisabled===t||e.isDisabled!==!t&&ae(e)===t:e.disabled===t:"label"in e&&e.disabled===t}}function ve(a){return le(function(o){return o=+o,le(function(e,t){var n,r=a([],e.length,o),i=r.length;while(i--)e[n=r[i]]&&(e[n]=!(t[n]=e[n]))})})}function ye(e){return e&&"undefined"!=typeof e.getElementsByTagName&&e}for(e in d=se.support={},i=se.isXML=function(e){var t=e.namespaceURI,n=(e.ownerDocument||e).documentElement;return!Y.test(t||n&&n.nodeName||"HTML")},T=se.setDocument=function(e){var t,n,r=e?e.ownerDocument||e:m;return r!==C&&9===r.nodeType&&r.documentElement&&(a=(C=r).documentElement,E=!i(C),m!==C&&(n=C.defaultView)&&n.top!==n&&(n.addEventListener?n.addEventListener("unload",oe,!1):n.attachEvent&&n.attachEvent("onunload",oe)),d.attributes=ce(function(e){return e.className="i",!e.getAttribute("className")}),d.getElementsByTagName=ce(function(e){return e.appendChild(C.createComment("")),!e.getElementsByTagName("*").length}),d.getElementsByClassName=K.test(C.getElementsByClassName),d.getById=ce(function(e){return a.appendChild(e).id=k,!C.getElementsByName||!C.getElementsByName(k).length}),d.getById?(b.filter.ID=function(e){var t=e.replace(te,ne);return function(e){return e.getAttribute("id")===t}},b.find.ID=function(e,t){if("undefined"!=typeof t.getElementById&&E){var n=t.getElementById(e);return n?[n]:[]}}):(b.filter.ID=function(e){var n=e.replace(te,ne);return function(e){var t="undefined"!=typeof e.getAttributeNode&&e.getAttributeNode("id");return t&&t.value===n}},b.find.ID=function(e,t){if("undefined"!=typeof t.getElementById&&E){var n,r,i,o=t.getElementById(e);if(o){if((n=o.getAttributeNode("id"))&&n.value===e)return[o];i=t.getElementsByName(e),r=0;while(o=i[r++])if((n=o.getAttributeNode("id"))&&n.value===e)return[o]}return[]}}),b.find.TAG=d.getElementsByTagName?function(e,t){return"undefined"!=typeof t.getElementsByTagName?t.getElementsByTagName(e):d.qsa?t.querySelectorAll(e):void 0}:function(e,t){var n,r=[],i=0,o=t.getElementsByTagName(e);if("*"===e){while(n=o[i++])1===n.nodeType&&r.push(n);return r}return o},b.find.CLASS=d.getElementsByClassName&&function(e,t){if("undefined"!=typeof t.getElementsByClassName&&E)return t.getElementsByClassName(e)},s=[],v=[],(d.qsa=K.test(C.querySelectorAll))&&(ce(function(e){a.appendChild(e).innerHTML=" ",e.querySelectorAll("[msallowcapture^='']").length&&v.push("[*^$]="+M+"*(?:''|\"\")"),e.querySelectorAll("[selected]").length||v.push("\\["+M+"*(?:value|"+R+")"),e.querySelectorAll("[id~="+k+"-]").length||v.push("~="),e.querySelectorAll(":checked").length||v.push(":checked"),e.querySelectorAll("a#"+k+"+*").length||v.push(".#.+[+~]")}),ce(function(e){e.innerHTML=" ";var t=C.createElement("input");t.setAttribute("type","hidden"),e.appendChild(t).setAttribute("name","D"),e.querySelectorAll("[name=d]").length&&v.push("name"+M+"*[*^$|!~]?="),2!==e.querySelectorAll(":enabled").length&&v.push(":enabled",":disabled"),a.appendChild(e).disabled=!0,2!==e.querySelectorAll(":disabled").length&&v.push(":enabled",":disabled"),e.querySelectorAll("*,:x"),v.push(",.*:")})),(d.matchesSelector=K.test(c=a.matches||a.webkitMatchesSelector||a.mozMatchesSelector||a.oMatchesSelector||a.msMatchesSelector))&&ce(function(e){d.disconnectedMatch=c.call(e,"*"),c.call(e,"[s!='']:x"),s.push("!=",$)}),v=v.length&&new RegExp(v.join("|")),s=s.length&&new RegExp(s.join("|")),t=K.test(a.compareDocumentPosition),y=t||K.test(a.contains)?function(e,t){var n=9===e.nodeType?e.documentElement:e,r=t&&t.parentNode;return e===r||!(!r||1!==r.nodeType||!(n.contains?n.contains(r):e.compareDocumentPosition&&16&e.compareDocumentPosition(r)))}:function(e,t){if(t)while(t=t.parentNode)if(t===e)return!0;return!1},D=t?function(e,t){if(e===t)return l=!0,0;var n=!e.compareDocumentPosition-!t.compareDocumentPosition;return n||(1&(n=(e.ownerDocument||e)===(t.ownerDocument||t)?e.compareDocumentPosition(t):1)||!d.sortDetached&&t.compareDocumentPosition(e)===n?e===C||e.ownerDocument===m&&y(m,e)?-1:t===C||t.ownerDocument===m&&y(m,t)?1:u?P(u,e)-P(u,t):0:4&n?-1:1)}:function(e,t){if(e===t)return l=!0,0;var n,r=0,i=e.parentNode,o=t.parentNode,a=[e],s=[t];if(!i||!o)return e===C?-1:t===C?1:i?-1:o?1:u?P(u,e)-P(u,t):0;if(i===o)return pe(e,t);n=e;while(n=n.parentNode)a.unshift(n);n=t;while(n=n.parentNode)s.unshift(n);while(a[r]===s[r])r++;return r?pe(a[r],s[r]):a[r]===m?-1:s[r]===m?1:0}),C},se.matches=function(e,t){return se(e,null,null,t)},se.matchesSelector=function(e,t){if((e.ownerDocument||e)!==C&&T(e),d.matchesSelector&&E&&!A[t+" "]&&(!s||!s.test(t))&&(!v||!v.test(t)))try{var n=c.call(e,t);if(n||d.disconnectedMatch||e.document&&11!==e.document.nodeType)return n}catch(e){A(t,!0)}return 0":{dir:"parentNode",first:!0}," ":{dir:"parentNode"},"+":{dir:"previousSibling",first:!0},"~":{dir:"previousSibling"}},preFilter:{ATTR:function(e){return e[1]=e[1].replace(te,ne),e[3]=(e[3]||e[4]||e[5]||"").replace(te,ne),"~="===e[2]&&(e[3]=" "+e[3]+" "),e.slice(0,4)},CHILD:function(e){return e[1]=e[1].toLowerCase(),"nth"===e[1].slice(0,3)?(e[3]||se.error(e[0]),e[4]=+(e[4]?e[5]+(e[6]||1):2*("even"===e[3]||"odd"===e[3])),e[5]=+(e[7]+e[8]||"odd"===e[3])):e[3]&&se.error(e[0]),e},PSEUDO:function(e){var t,n=!e[6]&&e[2];return G.CHILD.test(e[0])?null:(e[3]?e[2]=e[4]||e[5]||"":n&&X.test(n)&&(t=h(n,!0))&&(t=n.indexOf(")",n.length-t)-n.length)&&(e[0]=e[0].slice(0,t),e[2]=n.slice(0,t)),e.slice(0,3))}},filter:{TAG:function(e){var t=e.replace(te,ne).toLowerCase();return"*"===e?function(){return!0}:function(e){return e.nodeName&&e.nodeName.toLowerCase()===t}},CLASS:function(e){var t=p[e+" "];return t||(t=new RegExp("(^|"+M+")"+e+"("+M+"|$)"))&&p(e,function(e){return t.test("string"==typeof e.className&&e.className||"undefined"!=typeof e.getAttribute&&e.getAttribute("class")||"")})},ATTR:function(n,r,i){return function(e){var t=se.attr(e,n);return null==t?"!="===r:!r||(t+="","="===r?t===i:"!="===r?t!==i:"^="===r?i&&0===t.indexOf(i):"*="===r?i&&-1:\x20\t\r\n\f]*)[\x20\t\r\n\f]*\/?>(?:<\/\1>|)$/i;function j(e,n,r){return m(n)?k.grep(e,function(e,t){return!!n.call(e,t,e)!==r}):n.nodeType?k.grep(e,function(e){return e===n!==r}):"string"!=typeof n?k.grep(e,function(e){return-1)[^>]*|#([\w-]+))$/;(k.fn.init=function(e,t,n){var r,i;if(!e)return this;if(n=n||q,"string"==typeof e){if(!(r="<"===e[0]&&">"===e[e.length-1]&&3<=e.length?[null,e,null]:L.exec(e))||!r[1]&&t)return!t||t.jquery?(t||n).find(e):this.constructor(t).find(e);if(r[1]){if(t=t instanceof k?t[0]:t,k.merge(this,k.parseHTML(r[1],t&&t.nodeType?t.ownerDocument||t:E,!0)),D.test(r[1])&&k.isPlainObject(t))for(r in t)m(this[r])?this[r](t[r]):this.attr(r,t[r]);return this}return(i=E.getElementById(r[2]))&&(this[0]=i,this.length=1),this}return e.nodeType?(this[0]=e,this.length=1,this):m(e)?void 0!==n.ready?n.ready(e):e(k):k.makeArray(e,this)}).prototype=k.fn,q=k(E);var H=/^(?:parents|prev(?:Until|All))/,O={children:!0,contents:!0,next:!0,prev:!0};function P(e,t){while((e=e[t])&&1!==e.nodeType);return e}k.fn.extend({has:function(e){var t=k(e,this),n=t.length;return this.filter(function(){for(var e=0;e\x20\t\r\n\f]*)/i,he=/^$|^module$|\/(?:java|ecma)script/i,ge={option:[1,""," "],thead:[1,""],col:[2,""],tr:[2,""],td:[3,""],_default:[0,"",""]};function ve(e,t){var n;return n="undefined"!=typeof e.getElementsByTagName?e.getElementsByTagName(t||"*"):"undefined"!=typeof e.querySelectorAll?e.querySelectorAll(t||"*"):[],void 0===t||t&&A(e,t)?k.merge([e],n):n}function ye(e,t){for(var n=0,r=e.length;nx",y.noCloneChecked=!!me.cloneNode(!0).lastChild.defaultValue;var Te=/^key/,Ce=/^(?:mouse|pointer|contextmenu|drag|drop)|click/,Ee=/^([^.]*)(?:\.(.+)|)/;function ke(){return!0}function Se(){return!1}function Ne(e,t){return e===function(){try{return E.activeElement}catch(e){}}()==("focus"===t)}function Ae(e,t,n,r,i,o){var a,s;if("object"==typeof t){for(s in"string"!=typeof n&&(r=r||n,n=void 0),t)Ae(e,s,n,r,t[s],o);return e}if(null==r&&null==i?(i=n,r=n=void 0):null==i&&("string"==typeof n?(i=r,r=void 0):(i=r,r=n,n=void 0)),!1===i)i=Se;else if(!i)return e;return 1===o&&(a=i,(i=function(e){return k().off(e),a.apply(this,arguments)}).guid=a.guid||(a.guid=k.guid++)),e.each(function(){k.event.add(this,t,i,r,n)})}function De(e,i,o){o?(Q.set(e,i,!1),k.event.add(e,i,{namespace:!1,handler:function(e){var t,n,r=Q.get(this,i);if(1&e.isTrigger&&this[i]){if(r.length)(k.event.special[i]||{}).delegateType&&e.stopPropagation();else if(r=s.call(arguments),Q.set(this,i,r),t=o(this,i),this[i](),r!==(n=Q.get(this,i))||t?Q.set(this,i,!1):n={},r!==n)return e.stopImmediatePropagation(),e.preventDefault(),n.value}else r.length&&(Q.set(this,i,{value:k.event.trigger(k.extend(r[0],k.Event.prototype),r.slice(1),this)}),e.stopImmediatePropagation())}})):void 0===Q.get(e,i)&&k.event.add(e,i,ke)}k.event={global:{},add:function(t,e,n,r,i){var o,a,s,u,l,c,f,p,d,h,g,v=Q.get(t);if(v){n.handler&&(n=(o=n).handler,i=o.selector),i&&k.find.matchesSelector(ie,i),n.guid||(n.guid=k.guid++),(u=v.events)||(u=v.events={}),(a=v.handle)||(a=v.handle=function(e){return"undefined"!=typeof k&&k.event.triggered!==e.type?k.event.dispatch.apply(t,arguments):void 0}),l=(e=(e||"").match(R)||[""]).length;while(l--)d=g=(s=Ee.exec(e[l])||[])[1],h=(s[2]||"").split(".").sort(),d&&(f=k.event.special[d]||{},d=(i?f.delegateType:f.bindType)||d,f=k.event.special[d]||{},c=k.extend({type:d,origType:g,data:r,handler:n,guid:n.guid,selector:i,needsContext:i&&k.expr.match.needsContext.test(i),namespace:h.join(".")},o),(p=u[d])||((p=u[d]=[]).delegateCount=0,f.setup&&!1!==f.setup.call(t,r,h,a)||t.addEventListener&&t.addEventListener(d,a)),f.add&&(f.add.call(t,c),c.handler.guid||(c.handler.guid=n.guid)),i?p.splice(p.delegateCount++,0,c):p.push(c),k.event.global[d]=!0)}},remove:function(e,t,n,r,i){var o,a,s,u,l,c,f,p,d,h,g,v=Q.hasData(e)&&Q.get(e);if(v&&(u=v.events)){l=(t=(t||"").match(R)||[""]).length;while(l--)if(d=g=(s=Ee.exec(t[l])||[])[1],h=(s[2]||"").split(".").sort(),d){f=k.event.special[d]||{},p=u[d=(r?f.delegateType:f.bindType)||d]||[],s=s[2]&&new RegExp("(^|\\.)"+h.join("\\.(?:.*\\.|)")+"(\\.|$)"),a=o=p.length;while(o--)c=p[o],!i&&g!==c.origType||n&&n.guid!==c.guid||s&&!s.test(c.namespace)||r&&r!==c.selector&&("**"!==r||!c.selector)||(p.splice(o,1),c.selector&&p.delegateCount--,f.remove&&f.remove.call(e,c));a&&!p.length&&(f.teardown&&!1!==f.teardown.call(e,h,v.handle)||k.removeEvent(e,d,v.handle),delete u[d])}else for(d in u)k.event.remove(e,d+t[l],n,r,!0);k.isEmptyObject(u)&&Q.remove(e,"handle events")}},dispatch:function(e){var t,n,r,i,o,a,s=k.event.fix(e),u=new Array(arguments.length),l=(Q.get(this,"events")||{})[s.type]||[],c=k.event.special[s.type]||{};for(u[0]=s,t=1;t\x20\t\r\n\f]*)[^>]*)\/>/gi,qe=/
+
+
+
+
+
+
+
+
+
+
+
+
+
+ aws-crt-cpp
+
+ C++ wrapper around the aws-c-* libraries. Provides Cross-Platform Transport Protocols and SSL/TLS implementations for C++.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+