Aws::Iot::RequestResponse Namespace Reference

Classes
class	IMqttRequestResponseClient
class	IncomingPublishEvent
struct	IncompleteRequest
class	IStreamingOperation
class	MqttRequestResponseClient
class	MqttRequestResponseClientImpl
class	RequestResponseClientOptions
class	Result
class	StreamingOperation
class	StreamingOperationImpl
struct	StreamingOperationImplHandle
class	StreamingOperationOptions
struct	StreamingOperationOptionsInternal
class	StreamReadLock
class	StreamWriteLock
class	SubscriptionStatusEvent
class	UnmodeledResponse

Typedefs
using	SubscriptionStatusEventHandler = std::function< void(SubscriptionStatusEvent &&)>
using	IncomingPublishEventHandler = std::function< void(IncomingPublishEvent &&)>
using	UnmodeledResult = Result< UnmodeledResponse, int >
using	UnmodeledResultHandler = std::function< void(UnmodeledResult &&)>

Enumerations
enum	SubscriptionStatusEventType { SubscriptionStatusEventType::SubscriptionEstablished = ARRSSET_SUBSCRIPTION_ESTABLISHED, SubscriptionStatusEventType::SubscriptionLost = ARRSSET_SUBSCRIPTION_LOST, SubscriptionStatusEventType::SubscriptionHalted = ARRSSET_SUBSCRIPTION_HALTED }

Functions
AWS_CRT_CPP_API std::shared_ptr< IMqttRequestResponseClient >	NewClientFrom5 (const Aws::Crt::Mqtt5::Mqtt5Client &protocolClient, const RequestResponseClientOptions &options, Aws::Crt::Allocator *allocator=Aws::Crt::ApiAllocator())
AWS_CRT_CPP_API std::shared_ptr< IMqttRequestResponseClient >	NewClientFrom311 (const Aws::Crt::Mqtt::MqttConnection &protocolClient, const RequestResponseClientOptions &options, Aws::Crt::Allocator *allocator=Aws::Crt::ApiAllocator())
static void	s_completeRequestWithError (struct IncompleteRequest *incompleteRequest, int errorCode)
static void	s_completeRequestWithSuccess (struct IncompleteRequest *incompleteRequest, const struct aws_byte_cursor *response_topic, const struct aws_byte_cursor *payload)
static void	s_onRequestComplete (const struct aws_byte_cursor *response_topic, const struct aws_byte_cursor *payload, int error_code, void *user_data)
static void	s_onClientTermination (void *user_data)

Typedef Documentation

IncomingPublishEventHandler

using Aws::Iot::RequestResponse::IncomingPublishEventHandler = typedef std::function<void(IncomingPublishEvent &&)>

Function signature of an IncomingPublishEvent event handler

SubscriptionStatusEventHandler

using Aws::Iot::RequestResponse::SubscriptionStatusEventHandler = typedef std::function<void(SubscriptionStatusEvent &&)>

Function signature of a SubscriptionStatusEvent event handler

UnmodeledResult

using Aws::Iot::RequestResponse::UnmodeledResult = typedef Result<UnmodeledResponse, int>

Type definition for a request result where a response has not yet been deserialized into a specific response type.

UnmodeledResultHandler

using Aws::Iot::RequestResponse::UnmodeledResultHandler = typedef std::function<void(UnmodeledResult &&)>

Signature of a function object that handles unmodeled results. In general, these handlers will be built by service clients and are responsible for transforming an unmodeled response into a modeled response.

Enumeration Type Documentation

SubscriptionStatusEventType

enum Aws::Iot::RequestResponse::SubscriptionStatusEventType

strong

The type of change to the state of a streaming operation subscription

Enumerator
SubscriptionEstablished	The streaming operation is successfully subscribed to its topic (filter)
SubscriptionLost	The streaming operation has temporarily lost its subscription to its topic (filter)
SubscriptionHalted	The streaming operation has entered a terminal state where it has given up trying to subscribe to its topic (filter). This is always due to user error (bad topic filter or IoT Core permission policy).

Function Documentation

NewClientFrom311()

std::shared_ptr< IMqttRequestResponseClient > Aws::Iot::RequestResponse::NewClientFrom311	(	const Aws::Crt::Mqtt::MqttConnection &	protocolClient,
		const RequestResponseClientOptions &	options,
		Aws::Crt::Allocator *	allocator = Aws::Crt::ApiAllocator()
	)

Creates a new request-response client using an MQTT311 client for protocol transport

Parameters

protocolClient	MQTT client to use for transport
options	request-response client configuration options
allocator	allocator to use to create the client

Returns

a new request-response client if successful, otherwise nullptr

NewClientFrom5()

std::shared_ptr< IMqttRequestResponseClient > Aws::Iot::RequestResponse::NewClientFrom5	(	const Aws::Crt::Mqtt5::Mqtt5Client &	protocolClient,
		const RequestResponseClientOptions &	options,
		Aws::Crt::Allocator *	allocator = Aws::Crt::ApiAllocator()
	)

Creates a new request-response client using an MQTT5 client for protocol transport

Parameters

protocolClient	MQTT client to use for transport
options	request-response client configuration options
allocator	allocator to use to create the client

Returns

a new request-response client if successful, otherwise nullptr

s_completeRequestWithError()

static void Aws::Iot::RequestResponse::s_completeRequestWithError ( struct IncompleteRequest *  incompleteRequest, int  errorCode  )

static

s_completeRequestWithSuccess()

static void Aws::Iot::RequestResponse::s_completeRequestWithSuccess ( struct IncompleteRequest *  incompleteRequest, const struct aws_byte_cursor *  response_topic, const struct aws_byte_cursor *  payload  )

static

s_onClientTermination()

static void Aws::Iot::RequestResponse::s_onClientTermination ( void *  user_data )

static

s_onRequestComplete()

static void Aws::Iot::RequestResponse::s_onRequestComplete ( const struct aws_byte_cursor *  response_topic, const struct aws_byte_cursor *  payload, int  error_code, void *  user_data  )

static