[GitHub] [incubator-ratis] szetszwo commented on a change in pull request #416: RATIS-1309. Clarify ApplyTransaction Javadoc

[GitBox <gi...@apache.org>]

szetszwo commented on a change in pull request #416:
URL: https://github.com/apache/incubator-ratis/pull/416#discussion_r570681945



##########
File path: ratis-server-api/src/main/java/org/apache/ratis/statemachine/StateMachine.java
##########
@@ -439,9 +439,10 @@ default FollowerEventApi followerEvent() {
   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. However,
+   * due to this call returning a future, depending on implementations, the order of applying
+   * entries to state machine is not guaranteed to be the same as the log commit order.

Review comment:
       > However, due to this call returning a future, depending on implementations, the order of applying entries to state machine is not guaranteed to be the same as the log commit order.
   
   How about we rewrite the sentence above as below?
   
   > 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.
   




----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

For queries about this service, please contact Infrastructure at:
users@infra.apache.org