Skip to content

Document failure behaviour for register ops #132173

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Jul 30, 2025
Merged

Document failure behaviour for register ops #132173

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 10 additions & 1 deletion server/src/main/java/org/elasticsearch/common/blobstore/BlobContainer.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -308,6 +308,9 @@ default void copyBlob(
* <p>
* This operation, together with {@link #compareAndSetRegister}, must have linearizable semantics: a collection of such operations must
* act as if they operate serially, with each operation taking place at some instant in between its invocation and its completion.
* <p>
* If the listener completes exceptionally then the write operation should be considered as continuing to run and may therefore appear
* to occur at some later point in time.
*
* @param purpose The purpose of the operation
* @param key key of the value to update
Expand All @@ -330,6 +333,9 @@ void compareAndExchangeRegister(
* <p>
* This operation, together with {@link #compareAndExchangeRegister}, must have linearizable semantics: a collection of such operations
* must act as if they operate serially, with each operation taking place at some instant in between its invocation and its completion.
* <p>
* If the listener completes exceptionally then the write operation should be considered as continuing to run and may therefore appear
* to occur at some later point in time.
*
* @param purpose The purpose of the operation
* @param key key of the value to update
Expand Down Expand Up @@ -361,7 +367,10 @@ default void compareAndSetRegister(
* This operation has read-after-write consistency with respect to writes performed using {@link #compareAndExchangeRegister} and
* {@link #compareAndSetRegister}, but does not guarantee full linearizability. In particular, a {@code getRegister} performed during
* one of these write operations may return either the old or the new value, and a caller may therefore observe the old value
* <i>after</i> observing the new value, as long as both such read operations take place before the write operation completes.
* <i>after</i> observing the new value, as long as both such read operations take place before the success of the write operation.
* <p>
* Write operations which complete exceptionally may behave as if they continue to run, thus yielding old or new values for an extended
* period of time. If multiple writes fail then {@code getRegister} may return any of the written values.
*
* @param purpose The purpose of the operation
* @param key key of the value to get
Expand Down