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

#include <MqttRequestResponseClient.h>

Public Member Functions

RequestResponseClientOptionsWithMaxRequestResponseSubscriptions (uint32_t maxRequestResponseSubscriptions)
 
RequestResponseClientOptionsWithMaxStreamingSubscriptions (uint32_t maxStreamingSubscriptions)
 
RequestResponseClientOptionsWithOperationTimeoutInSeconds (uint32_t operationTimeoutInSeconds)
 
uint32_t GetMaxRequestResponseSubscriptions () const
 
uint32_t GetMaxStreamingSubscriptions () const
 
uint32_t GetOperationTimeoutInSeconds () const
 

Detailed Description

MQTT-based request-response client configuration options

Member Function Documentation

uint32_t Aws::Iot::RequestResponse::RequestResponseClientOptions::GetMaxRequestResponseSubscriptions ( ) const
inline

Gets the maximum number of request-response subscriptions the client allows to be concurrently active.

Returns
the maximum number of request-response subscriptions the client allows to be concurrently active
uint32_t Aws::Iot::RequestResponse::RequestResponseClientOptions::GetMaxStreamingSubscriptions ( ) const
inline

Gets the maximum number of concurrent streaming operation subscriptions that the client will allow.

Returns
the maximum number of concurrent streaming operation subscriptions that the client will allow
uint32_t Aws::Iot::RequestResponse::RequestResponseClientOptions::GetOperationTimeoutInSeconds ( ) const
inline

Gets the timeout value, in seconds, for a request-response operation.

Returns
the timeout value, in seconds, for a request-response operation
RequestResponseClientOptions& Aws::Iot::RequestResponse::RequestResponseClientOptions::WithMaxRequestResponseSubscriptions ( uint32_t  maxRequestResponseSubscriptions)
inline

Sets the maximum number of request-response subscriptions the client allows to be concurrently active at any one point in time. When the client hits this threshold, requests will be delayed until earlier requests complete and release their subscriptions. Each in-progress request will use either 1 or 2 MQTT subscriptions until completion.

Parameters
maxRequestResponseSubscriptionsmaximum number of concurrent subscriptions that the client will use for request-response operations
Returns
reference to this
RequestResponseClientOptions& Aws::Iot::RequestResponse::RequestResponseClientOptions::WithMaxStreamingSubscriptions ( uint32_t  maxStreamingSubscriptions)
inline

Sets the maximum number of concurrent streaming operation subscriptions that the client will allow. Each "unique" (different topic filter) streaming operation will use 1 MQTT subscription. When the client hits this threshold, attempts to open new streaming operations will fail.

Parameters
maxStreamingSubscriptionsmaximum number of current subscriptions that the client will use for streaming operations
Returns
reference to this
RequestResponseClientOptions& Aws::Iot::RequestResponse::RequestResponseClientOptions::WithOperationTimeoutInSeconds ( uint32_t  operationTimeoutInSeconds)
inline

Sets the timeout value, in seconds, for a request-response operation. If a request is not complete by this time interval, the client will complete it as failed. This time interval starts the instant the request is submitted to the client.

Parameters
operationTimeoutInSecondsrequest timeout in seconds
Returns
reference to this

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