Skip to content

Commit 9e474a1

Browse files
authored
doc: Clarify async updates are supported but clusterin isn't (#5359)
1 parent 6de327b commit 9e474a1

File tree

1 file changed

+7
-5
lines changed

1 file changed

+7
-5
lines changed

articles/flow/ui-state/shared-signals.adoc

Lines changed: 7 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -205,22 +205,24 @@ Signal.effect(component, () -> {
205205
----
206206

207207

208-
=== Getting Cluster-Confirmed Values
208+
=== Getting Confirmed Values Asynchronously
209209

210-
The `peekConfirmed()` method returns the last value that has been confirmed by the cluster. This is useful in distributed scenarios where you need to know the definitive server-confirmed state:
210+
The `peekConfirmed()` method returns the last value that has been asynchronously confirmed. This is useful in distributed scenarios where you need to know the definitive server-confirmed state:
211211

212212
[source,java]
213213
----
214214
SharedValueSignal<String> signal = new SharedValueSignal<>(String.class);
215215
216-
// Get the locally-known value (may include optimistic updates)
216+
// Get the locally known value (may include optimistic updates)
217217
String optimistic = signal.peek();
218218
219-
// Get only the cluster-confirmed value
219+
// Get only the asynchronously confirmed value
220220
String confirmed = signal.peekConfirmed();
221221
----
222222

223-
In single-server deployments, `peekConfirmed()` typically returns the same value as `peek()`. In clustered environments, there may be a brief delay between optimistic local updates and cluster confirmation.
223+
Shared signals currently support asynchronously confirmed updates only in single JVM environments but don't yet provide an implementation for asynchronous updates and confirmations in a cluster environment.
224+
225+
In single JVM deployments, `peekConfirmed()` typically returns the same value as `peek()`. In clustered environments, there may be a brief delay between optimistic local updates and cluster confirmation.
224226

225227

226228
== Writing Values

0 commit comments

Comments
 (0)