Skip to content

Commit c48efc1

Browse files
API docs: document limit of SyncClient.outgoingMessageCount, fix typo
1 parent d081c1f commit c48efc1

File tree

1 file changed

+5
-2
lines changed

1 file changed

+5
-2
lines changed

objectbox/lib/src/native/sync.dart

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -429,10 +429,13 @@ class SyncClient {
429429
/// Count the number of messages in the outgoing queue, i.e. those waiting to
430430
/// be sent to the server.
431431
///
432-
/// Note: This calls uses a (read) transaction internally:
432+
/// By default, counts all messages without any limitation. For a lower number
433+
/// pass a [limit] that's enough for your app logic.
434+
///
435+
/// Note: This call uses a (read) transaction internally:
433436
/// 1) It's not just a "cheap" return of a single number. While this will
434437
/// still be fast, avoid calling this function excessively.
435-
/// 2) the result follows transaction view semantics, thus it may not always
438+
/// 2) The result follows transaction view semantics, thus it may not always
436439
/// match the actual value.
437440
int outgoingMessageCount({int limit = 0}) {
438441
final count = malloc<Uint64>();

0 commit comments

Comments
 (0)