Skip to content

Commit f5e9d0d

Browse files
committed
Acrolinx changes to improve score
1 parent 5e751af commit f5e9d0d

File tree

1 file changed

+16
-16
lines changed

1 file changed

+16
-16
lines changed

articles/iot-hub/iot-hub-devguide-messages-c2d.md

Lines changed: 16 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@ Each device queue holds, at most, 50 cloud-to-device messages. An error occurs i
2626

2727
## The cloud-to-device message life cycle
2828

29-
To guarantee at-least-once message delivery, your IoT hub persists cloud-to-device messages in per-device queues. For the IoT hub to remove the messages from the queue, the devices must explicitly acknowledge *completion*. This approach guarantees resiliency against connectivity and device failures.
29+
To guarantee at-least-once message delivery, your IoT hub persists cloud-to-device messages in per-device queues. Devices must explicitly acknowledge *completion* of a message before the IoT hub removes the message from the queue. This approach guarantees resiliency against connectivity and device failures.
3030

3131
The life-cycle state graph is displayed in the following diagram:
3232

@@ -46,20 +46,20 @@ The **max delivery count** property on the IoT hub determines the maximum number
4646

4747
The [How to send cloud-to-device messages with IoT Hub](iot-hub-csharp-csharp-c2d.md) article shows you how to send cloud-to-device messages from the cloud and receive them on a device.
4848

49-
A device ordinarily completes a cloud-to-device message when the loss of the message doesn't affect the application logic. An example of this might be when the device has persisted the message content locally or has successfully executed an operation. The message could also carry transient information, whose loss wouldn't impact the functionality of the application. Sometimes, for long-running tasks, you can:
49+
A device ordinarily completes a cloud-to-device message when the loss of the message doesn't affect the application logic. An example of this completion might be when the device has persisted the message content locally or has successfully executed an operation. The message could also carry transient information, whose loss wouldn't impact the functionality of the application. Sometimes, for long-running tasks, you can:
5050

5151
* Complete the cloud-to-device message after the device has persisted the task description in local storage.
5252

5353
* Notify the solution back end with one or more device-to-cloud messages at various stages of progress of the task.
5454

5555
## Message expiration (time to live)
5656

57-
Every cloud-to-device message has an expiration time. This time is set by either of the following:
57+
Every cloud-to-device message has an expiration time. This time is set by either of the following options:
5858

5959
* The **ExpiryTimeUtc** property in the service
6060
* The IoT hub, by using the default *time to live* that's specified as an IoT hub property
6161

62-
For more information, see [Cloud-to-device configuration options](#cloud-to-device-configuration-options).
62+
For more information about message expiration, see [Cloud-to-device configuration options](#cloud-to-device-configuration-options).
6363

6464
A common way to take advantage of a message expiration and to avoid sending messages to disconnected devices is to set short *time to live* values. This approach achieves the same result as maintaining the device connection state, but it is more efficient. When you request message acknowledgments, the IoT hub notifies you which devices are:
6565

@@ -68,7 +68,7 @@ A common way to take advantage of a message expiration and to avoid sending mess
6868

6969
## Message feedback
7070

71-
When you send a cloud-to-device message, the service can request the delivery of per-message feedback about the final state of that message. You do this by setting the **iothub-ack** application property in the cloud-to-device message that's being sent to one of the following four values:
71+
When you send a cloud-to-device message, the service can request the delivery of per-message feedback about the final state of that message. You can configure message feedback by setting the **iothub-ack** application property in the cloud-to-device message that's being sent to one of the following four values:
7272

7373
| Ack property value | Behavior |
7474
| ------------ | -------- |
@@ -83,7 +83,7 @@ As explained in [Endpoints](iot-hub-devguide-endpoints.md), the IoT hub delivers
8383

8484
| Property | Description |
8585
| ------------ | ----------- |
86-
| EnqueuedTime | A timestamp that indicates when the feedback message was received by the hub |
86+
| EnqueuedTime | A timestamp that indicates when the feedback message was received by the hub. |
8787
| UserId | `{iot hub name}` |
8888
| ContentType | `application/vnd.microsoft.iothub.feedback.json` |
8989

@@ -93,14 +93,14 @@ The body is a JSON-serialized array of records, each with the following properti
9393

9494
| Property | Description |
9595
| ------------------ | ----------- |
96-
| enqueuedTimeUtc | A timestamp that indicates when the outcome of the message happened (for example, the hub received the feedback message or the original message expired) |
97-
| originalMessageId | The *MessageId* of the cloud-to-device message to which this feedback information relates |
96+
| enqueuedTimeUtc | A timestamp that indicates when the outcome of the message happened. For example, a timestamp that indicates when the hub received the feedback message or the original message expired. |
97+
| originalMessageId | The *MessageId* of the cloud-to-device message to which this feedback information relates. |
9898
| statusCode | A required string, used in feedback messages that are generated by the IoT hub: <br/> *Success* <br/> *Expired* <br/> *DeliveryCountExceeded* <br/> *Rejected* <br/> *Purged* |
99-
| description | String values for *StatusCode* |
100-
| deviceId | The *DeviceId* of the target device of the cloud-to-device message to which this piece of feedback relates |
101-
| deviceGenerationId | The *DeviceGenerationId* of the target device of the cloud-to-device message to which this piece of feedback relates |
99+
| description | String values for *StatusCode*. |
100+
| deviceId | The *DeviceId* of the target device of the cloud-to-device message to which this piece of feedback relates. |
101+
| deviceGenerationId | The *DeviceGenerationId* of the target device of the cloud-to-device message to which this piece of feedback relates. |
102102

103-
For the cloud-to-device message to correlate its feedback with the original message, the service must specify a *MessageId*.
103+
The service must specify a *MessageId* so that the cloud-to-device message can correlate its feedback with the original message.
104104

105105
The body of a feedback message is shown in the following code example:
106106

@@ -123,7 +123,7 @@ The body of a feedback message is shown in the following code example:
123123

124124
**Pending feedback for deleted devices**
125125

126-
When a device is deleted, any pending feedback is deleted as well. Device feedback is sent in batches. If a device is deleted in the narrow window (often less than 1 second) between when the device confirms receipt of the message and when the next feedback batch is prepared, the feedback will not occur.
126+
When a device is deleted, any pending feedback is deleted as well. Device feedback is sent in batches. A narrow window, often less than one second, can occur between when a device confirms receipt of the message and when the next feedback batch is prepared. If a device is deleted in that narrow window, the feedback doesn't occur.
127127

128128
You can address this behavior by waiting a period of time for pending feedback to arrive before deleting your device. Related message feedback should be assumed lost once a device is deleted.
129129

@@ -133,11 +133,11 @@ Each IoT hub exposes the following configuration options for cloud-to-device mes
133133

134134
| Property | Description | Range and default |
135135
| ------------------------- | ----------- | ----------------- |
136-
| defaultTtlAsIso8601 | Default TTL for cloud-to-device messages | ISO_8601 interval up to 2 days (minimum 1 minute); default: 1 hour |
136+
| defaultTtlAsIso8601 | Default TTL for cloud-to-device messages | ISO_8601 interval up to two days (minimum one minute); default: one hour |
137137
| maxDeliveryCount | Maximum delivery count for cloud-to-device per-device queues | 1 to 100; default: 10 |
138-
| feedback.ttlAsIso8601 | Retention for service-bound feedback messages | ISO_8601 interval up to 2 days (minimum 1 minute); default: 1 hour |
138+
| feedback.ttlAsIso8601 | Retention for service-bound feedback messages | ISO_8601 interval up to two days (minimum one minute); default: one hour |
139139
| feedback.maxDeliveryCount | Maximum delivery count for the feedback queue | 1 to 100; default: 10 |
140-
| feedback.lockDurationAsIso8601 | Lock duration for the feedback queue | ISO_8601 interval from 5 to 300 seconds (minimum 5 seconds); default: 60 seconds. |
140+
| feedback.lockDurationAsIso8601 | Lock duration for the feedback queue | ISO_8601 interval from 5 to 300 seconds (minimum five seconds); default: 60 seconds. |
141141

142142
You can set the configuration options in one of the following ways:
143143

0 commit comments

Comments
 (0)