This is an automated email from the ASF dual-hosted git repository.
szetszwo pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/incubator-ratis.git
The following commit(s) were added to refs/heads/master by this push:
new 05ef7de RATIS-1309. Clarify ApplyTransaction Javadoc (#416).
Contributed by Rui Wang
05ef7de is described below
commit 05ef7de0587627c8c9665af3d8265bfd1ceb38d8
Author: Rui Wang <[email protected]>
AuthorDate: Thu Feb 4 21:47:44 2021 -0800
RATIS-1309. Clarify ApplyTransaction Javadoc (#416). Contributed by Rui Wang
---
.../src/main/java/org/apache/ratis/statemachine/StateMachine.java | 8 +++++---
1 file changed, 5 insertions(+), 3 deletions(-)
diff --git
a/ratis-server-api/src/main/java/org/apache/ratis/statemachine/StateMachine.java
b/ratis-server-api/src/main/java/org/apache/ratis/statemachine/StateMachine.java
index 112c0a5..492f7bc 100644
---
a/ratis-server-api/src/main/java/org/apache/ratis/statemachine/StateMachine.java
+++
b/ratis-server-api/src/main/java/org/apache/ratis/statemachine/StateMachine.java
@@ -439,9 +439,11 @@ public interface StateMachine extends Closeable {
TransactionContext applyTransactionSerial(TransactionContext trx);
/**
- * Apply a committed log entry to the state machine. This method can be
called concurrently with
- * the other calls, and there is no guarantee that the calls will be ordered
according to the
- * log commit order.
+ * Apply a committed log entry to the state machine. This method is called
sequentially in
+ * strict serial order that the transactions have been committed in the log.
Note that this
+ * method, which returns a future, is asynchronous. The state machine
implementation may
+ * choose to apply the log entries in parallel. In that case, the order of
applying entries to
+ * state machine could possibly be different from the log commit order.
* @param trx the transaction state including the log entry that has been
committed to a quorum
* of the raft peers
*/
