Skip to content

Commit dedfd5f

Browse files
committed
update docs
1 parent a5fad96 commit dedfd5f

File tree

2 files changed

+10
-1
lines changed

2 files changed

+10
-1
lines changed

docs/source/tutorials/streaming.md

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -176,6 +176,16 @@ dormant. These intervals are configurable via the settings `data_ttl` and
176176
`seq_ttl` respectively under `streaming_cach` configuration. (In the `tiled
177177
serve` CLI they are `--cache-data-ttl` and `--cache-seq-ttl`.)
178178

179+
## Handling Large Data
180+
181+
By default, WebSocket messages are limited to 1 MB. For larger updates,
182+
increase the `max_size` parameter when subscribing:
183+
184+
```py
185+
# Accept updates as large as 1 GB
186+
sub = client.subscribe(max_size=1_000_000_000)
187+
```
188+
179189
## Performance Optimization: Non-persistent Updates
180190

181191
To rapidly stream large arrays of transitory data, it might be unnecessary

tiled/client/container.py

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1219,7 +1219,6 @@ def subscribe(
12191219
a concurrent.futures.ThreadPoolExecutor is used.
12201220
max_size : int, optional
12211221
Maximum size in bytes for incoming WebSocket messages. Default is 1 MB.
1222-
Increase this for large array updates (e.g., 1_000_000_000 for 1 GB).
12231222
12241223
Returns
12251224
-------

0 commit comments

Comments
 (0)