Skip to content

Commit

Permalink
publish size limit update
Browse files Browse the repository at this point in the history
  • Loading branch information
rickkas7 committed Feb 3, 2025
1 parent 3e2c8b4 commit 3675258
Show file tree
Hide file tree
Showing 2 changed files with 5 additions and 3 deletions.
2 changes: 1 addition & 1 deletion config/sitemap.json
Original file line number Diff line number Diff line change
Expand Up @@ -9447,7 +9447,7 @@
"date": "2025-01-15"
},
"reference/device-os/typed-publish.md": {
"hash": "bbdcb45a25346f581601af47715b8d2b14dbc117250518eecb0499dc57765360",
"hash": "6b9b0938647551d13cdb8293d30a17d42b23b12cfb767ce9e6b054ebb3a982aa",
"date": "2025-02-03"
},
"troubleshooting/led.md": {
Expand Down
6 changes: 4 additions & 2 deletions src/content/reference/device-os/typed-publish.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,13 +24,15 @@ Large events count as 1 data operation for each 1024 bytes of data, rounded up.

Prior to Device OS 6.3.0, there was a rate limit of approximately 1 publish for second, with greater bursts.

With Device OS 6.3.0 and extended publish, there is a limit of approximately 16 Kbytes of data in transit at a time. This could be
16 events of 1024 bytes, or a single event with 16,384 bytes of data.
With Device OS 6.3.0 and extended publish, there is a limit of approximately 32 Kbytes of data in transit at a time. It is no longer necessary
to wait a specific amount of time.

The [canPublish](/reference/device-os/api/cloudevent/publish-status-cloudevent/#canpublish-cloudevent) method can be used to check
if a publish of a given size would be allowed at the current time. It it returns false, you should wait and check again later
after the queued data has been sent.

More specifically, the limit is 32 logical blocks of data, rounded up to 1024 bytes. An event without payload data takes 1 block, 1024 bytes of payload data is still 1 block, 1025 bytes is 2 blocks, and so on. If there are 32 logical data blocks in flight already, canPublish will return false or an attempt to publish without checking will fail.

## Data types

There are currently five data types, including the following:
Expand Down

0 comments on commit 3675258

Please sign in to comment.