com.microsoft.azure.sdk.iot.service.messaging

Classes

ErrorContext

The context for a given connection loss event for MessageFeedbackProcessorClient, FileUploadNotificationProcessorClient, and MessagingClient. The context includes the cause of the connection loss and makes a distinction between network level issues (no internet) and IoT Hub level issues (resource not found, throttling, internal server error, etc.).

FeedbackBatch

Data structure for feedback messages received in Json array Provide getters and setters for batch properties and messages

FeedbackBatchMessage

Provide static function to parse Json string to FeedbackBatch object.

FeedbackRecord

Data structure for feedback record received Provide getters and setters for feedback record batch properties

FileUploadNotification
FileUploadNotificationProcessorClient

A client for handling file upload notifications. For more details on what file upload notifications are, see this document.

This client relies on a persistent amqp/amqp_ws connection to IoT Hub that may break due to network instability. While optional to monitor, users are highly encouraged to utilize the errorProcessorHandler defined in the FileUploadNotificationProcessorClientOptions when constructing this client in order to monitor the connection state and to re-open the connection when needed. See the message feedback processor client sample in this repo for best practices for monitoring and handling disconnection events.

FileUploadNotificationProcessorClientOptions

The optional parameters that can be configured for an FileUploadNotificationProcessorClient instance.

Message

IotHub specific message container

MessageFeedbackProcessorClient

A client for handling cloud to device message feedback. For more details on what cloud to device message feedback is, see this document.

This client relies on a persistent amqp/amqp_ws connection to IoT Hub that may break due to network instability. While optional to monitor, users are highly encouraged to utilize the errorProcessorHandler defined in the MessageFeedbackProcessorClientOptions when constructing this client in order to monitor the connection state and to re-open the connection when needed. See the message feedback processor client sample in this repo for best practices for monitoring and handling disconnection events.

MessageFeedbackProcessorClientOptions

The optional parameters that can be configured for an MessageFeedbackProcessorClient instance.

MessagingClient

A client for sending cloud to device and cloud to module messages. For more details on what cloud to device messages are, see this document.

This client relies on a persistent amqp/amqp_ws connection to IoT Hub that may break due to network instability. While optional to monitor, users are highly encouraged to utilize the errorProcessorHandler defined in the MessagingClientOptions when constructing this client in order to monitor the connection state and to re-open the connection when needed. See the messaging client sample in this repo for best practices for monitoring and handling disconnection events.

MessagingClientOptions

The optional parameters that can be configured for an MessagingClient instance.

SendResult

The result of sending a cloud to device or cloud to module message.

Enums

AcknowledgementType

The possible acknowledgement types for a received file upload notification and/or for a received cloud to device feedback message.

DeliveryAcknowledgement
FeedbackStatusCode

Enum for feedback status codes

IotHubServiceClientProtocol

The application-layer protocol used by the service client to communicate with an IoT Hub.