Skip to content

Commit

Permalink
Merge pull request #2262 from ably/feature/REA-1868-cursors-batching
Browse files Browse the repository at this point in the history
Change the description of outboundBatchInterval to reflect last Spaces SDK changes
  • Loading branch information
m-hulbert authored Sep 18, 2024
2 parents 2c69210 + db39e60 commit 6228795
Showing 1 changed file with 1 addition and 1 deletion.
2 changes: 1 addition & 1 deletion content/spaces/cursors.textile
Original file line number Diff line number Diff line change
Expand Up @@ -113,7 +113,7 @@ The following cursor options can be set:

h3(#batch). outboundBatchInterval

The @outboundBatchInterval@ is the interval at which a batch of cursor positions are published, in milliseconds, for each client. This is multiplied by the number of members in a space.
The @outboundBatchInterval@ is the interval at which a batch of cursor positions are published, in milliseconds, for each client. This interval increases as the number of members in a space grows, adjusting based on groups of 100 members.

The default value is 25ms which is optimal for the majority of use cases. If you wish to optimize the interval further, then decreasing the value will improve performance by further 'smoothing' the movement of cursors at the cost of increasing the number of events sent. Be aware that at a certain point the rate at which a browser is able to render the changes will impact optimizations.

Expand Down

0 comments on commit 6228795

Please sign in to comment.