From ba093412e553d76d19938ae812ee1d5a403f3f05 Mon Sep 17 00:00:00 2001 From: TheR1sing3un Date: Mon, 28 Aug 2023 00:04:24 +0800 Subject: [PATCH 1/2] fix(core): remove unused param 1. remove unused param --- .../io/openmessaging/storage/dledger/common/WriteClosure.java | 2 +- .../test/java/io/openmessaging/storage/dledger/WriteTest.java | 2 +- .../storage/dledger/statemachine/StateMachineCallerTest.java | 2 +- 3 files changed, 3 insertions(+), 3 deletions(-) diff --git a/dledger/src/main/java/io/openmessaging/storage/dledger/common/WriteClosure.java b/dledger/src/main/java/io/openmessaging/storage/dledger/common/WriteClosure.java index 2cbed550..9f82c9b3 100644 --- a/dledger/src/main/java/io/openmessaging/storage/dledger/common/WriteClosure.java +++ b/dledger/src/main/java/io/openmessaging/storage/dledger/common/WriteClosure.java @@ -19,5 +19,5 @@ public abstract class WriteClosure extends Closure { public abstract void setResp(T t); - public abstract T getResp(T t); + public abstract T getResp(); } diff --git a/dledger/src/test/java/io/openmessaging/storage/dledger/WriteTest.java b/dledger/src/test/java/io/openmessaging/storage/dledger/WriteTest.java index dc1c4d4d..0506ca6d 100644 --- a/dledger/src/test/java/io/openmessaging/storage/dledger/WriteTest.java +++ b/dledger/src/test/java/io/openmessaging/storage/dledger/WriteTest.java @@ -43,7 +43,7 @@ public void setResp(Long aLong) { } @Override - public Long getResp(Long aLong) { + public Long getResp() { return totalEntries; } } diff --git a/dledger/src/test/java/io/openmessaging/storage/dledger/statemachine/StateMachineCallerTest.java b/dledger/src/test/java/io/openmessaging/storage/dledger/statemachine/StateMachineCallerTest.java index 34bd3cd1..b9e5a0ac 100644 --- a/dledger/src/test/java/io/openmessaging/storage/dledger/statemachine/StateMachineCallerTest.java +++ b/dledger/src/test/java/io/openmessaging/storage/dledger/statemachine/StateMachineCallerTest.java @@ -203,7 +203,7 @@ public void setResp(Object o) { } @Override - public Object getResp(Object o) { + public Object getResp() { return totalEntries; } From 6e5ee148ca0ba73614f0ff11719ed14e5abdee69 Mon Sep 17 00:00:00 2001 From: TheR1sing3un Date: Mon, 28 Aug 2023 00:21:05 +0800 Subject: [PATCH 2/2] fix(core): fix comments to pass generating java doc 1. fix comments to pass generating java doc --- .../openmessaging/storage/dledger/DLedgerEntryPusher.java | 3 +++ .../storage/dledger/DLedgerRpcNettyService.java | 4 ---- .../io/openmessaging/storage/dledger/DLedgerServer.java | 4 ---- .../io/openmessaging/storage/dledger/MemberState.java | 2 ++ .../storage/dledger/snapshot/SnapshotManager.java | 2 +- .../storage/dledger/statemachine/StateMachine.java | 1 + .../storage/dledger/store/file/MmapFile.java | 8 ++++---- 7 files changed, 11 insertions(+), 13 deletions(-) diff --git a/dledger/src/main/java/io/openmessaging/storage/dledger/DLedgerEntryPusher.java b/dledger/src/main/java/io/openmessaging/storage/dledger/DLedgerEntryPusher.java index 322f663d..5682fd57 100644 --- a/dledger/src/main/java/io/openmessaging/storage/dledger/DLedgerEntryPusher.java +++ b/dledger/src/main/java/io/openmessaging/storage/dledger/DLedgerEntryPusher.java @@ -192,6 +192,7 @@ public void wakeUpDispatchers() { * Complete the TimeoutFuture in pendingAppendResponsesByTerm (CurrentTerm, index). * Called by statemachineCaller when a committed entry (CurrentTerm, index) was applying to statemachine done. * + * @param task committed entry * @return true if complete success */ public boolean completeResponseFuture(final ApplyEntry task) { @@ -215,6 +216,8 @@ public boolean completeResponseFuture(final ApplyEntry task) { /** * Check responseFutures timeout from {beginIndex} in currentTerm + * + * @param beginIndex the beginning index to check */ public void checkResponseFuturesTimeout(final long beginIndex) { final long term = this.memberState.currTerm(); diff --git a/dledger/src/main/java/io/openmessaging/storage/dledger/DLedgerRpcNettyService.java b/dledger/src/main/java/io/openmessaging/storage/dledger/DLedgerRpcNettyService.java index 97e51b0d..c53fda36 100644 --- a/dledger/src/main/java/io/openmessaging/storage/dledger/DLedgerRpcNettyService.java +++ b/dledger/src/main/java/io/openmessaging/storage/dledger/DLedgerRpcNettyService.java @@ -367,10 +367,6 @@ private void writeResponse(RequestOrResponse storeResp, Throwable t, RemotingCom * CompletableFuture is an excellent choice, whenCompleteAsync will handle the response asynchronously. With an * independent thread-pool, it will improve performance and reduce blocking points. * - * @param ctx - * @param request - * @return - * @throws Exception */ public RemotingCommand processRequest(ChannelHandlerContext ctx, RemotingCommand request) throws Exception { DLedgerRequestCode requestCode = DLedgerRequestCode.valueOf(request.getCode()); diff --git a/dledger/src/main/java/io/openmessaging/storage/dledger/DLedgerServer.java b/dledger/src/main/java/io/openmessaging/storage/dledger/DLedgerServer.java index 6d875412..f0391f3e 100644 --- a/dledger/src/main/java/io/openmessaging/storage/dledger/DLedgerServer.java +++ b/dledger/src/main/java/io/openmessaging/storage/dledger/DLedgerServer.java @@ -291,10 +291,6 @@ public CompletableFuture handleVote(VoteRequest request) throws Ex /** * Handle the append requests: 1.append the entry to local store 2.submit the future to entry pusher and wait the * quorum ack 3.if the pending requests are full, then reject it immediately - * - * @param request - * @return - * @throws IOException */ @Override public CompletableFuture handleAppend(AppendEntryRequest request) throws IOException { diff --git a/dledger/src/main/java/io/openmessaging/storage/dledger/MemberState.java b/dledger/src/main/java/io/openmessaging/storage/dledger/MemberState.java index ed6c3404..975c0133 100644 --- a/dledger/src/main/java/io/openmessaging/storage/dledger/MemberState.java +++ b/dledger/src/main/java/io/openmessaging/storage/dledger/MemberState.java @@ -275,9 +275,11 @@ public long getCommittedIndex() { /** * update committedIndex + * * @param term term of the entry which is committed. Very importantly, we can only commit the entry with current term, which also means that * we can't commit the entry with old term. * @param committedIndex the index of the entry which is committed. + * @return true if the committedIndex is updated, otherwise false. */ public boolean leaderUpdateCommittedIndex(long term, long committedIndex) { if (!this.isLeader()) return false; diff --git a/dledger/src/main/java/io/openmessaging/storage/dledger/snapshot/SnapshotManager.java b/dledger/src/main/java/io/openmessaging/storage/dledger/snapshot/SnapshotManager.java index 554667d6..fa5acaf1 100644 --- a/dledger/src/main/java/io/openmessaging/storage/dledger/snapshot/SnapshotManager.java +++ b/dledger/src/main/java/io/openmessaging/storage/dledger/snapshot/SnapshotManager.java @@ -40,7 +40,7 @@ import java.util.concurrent.CompletableFuture; /** - * snapshot dir tree (here is an example) + * snapshot dir tree (here is an example) * 
  *   snapshot
  *     - tmp  (saving snapshot now, but has not been renamed to a snapshot dir)
diff --git a/dledger/src/main/java/io/openmessaging/storage/dledger/statemachine/StateMachine.java b/dledger/src/main/java/io/openmessaging/storage/dledger/statemachine/StateMachine.java
index c8d5a88d..46ef9f22 100644
--- a/dledger/src/main/java/io/openmessaging/storage/dledger/statemachine/StateMachine.java
+++ b/dledger/src/main/java/io/openmessaging/storage/dledger/statemachine/StateMachine.java
@@ -38,6 +38,7 @@ public interface StateMachine {
      * User defined snapshot generate function.
      *
      * @param writer snapshot writer
+     * @return true on success
      */
     boolean onSnapshotSave(final SnapshotWriter writer);
 
diff --git a/dledger/src/main/java/io/openmessaging/storage/dledger/store/file/MmapFile.java b/dledger/src/main/java/io/openmessaging/storage/dledger/store/file/MmapFile.java
index 9f554865..60364a07 100644
--- a/dledger/src/main/java/io/openmessaging/storage/dledger/store/file/MmapFile.java
+++ b/dledger/src/main/java/io/openmessaging/storage/dledger/store/file/MmapFile.java
@@ -242,10 +242,10 @@ public interface MmapFile {
     /**
      * get the data from file channel
      *
-     * @param pos
-     * @param size
-     * @param byteBuffer
-     * @return
+     * @param pos the start position of the data
+     * @param size the size of the data
+     * @param byteBuffer the buffer to store the data
+     * @return true if success; false otherwise.
      */
     boolean getData(int pos, int size, ByteBuffer byteBuffer);
 }