Alawn/Chronicle-Map
1
0
Fork 0
mirror of https://github.com/OpenHFT/Chronicle-Map.git synced 2021-09-13 01:26:12 +00:00
Code Releases Activity

Link ReplicableEntry and ChronicleHashBuilder.cleanupRemovedEntries() in Javadoc

Browse Source
This commit is contained in:
leventov
2015-10-02 05:50:12 +03:00
parent c2e634fa13
commit 9ef7c514a3
2 changed files with 13 additions and 3 deletions
Download Patch File Download Diff File Expand all files Collapse all files
src/main/java/net/openhft/chronicle/hash/ChronicleHashBuilder.java
+6 -1
View File
@@ -16,6 +16,7 @@
package net.openhft.chronicle.hash;
import net.openhft.chronicle.hash.replication.ReplicableEntry;
import net.openhft.chronicle.hash.replication.SingleChronicleHashReplication;
import net.openhft.chronicle.hash.replication.TcpTransportAndNetworkConfig;
import net.openhft.chronicle.hash.replication.TimeProvider;
@@ -405,7 +406,7 @@ public interface ChronicleHashBuilder<K, H extends ChronicleHash<K, ?, ?, ?>,
* is not immediately erased from the data structure, to let the distributed system eventually
* converge on some value for this key (or converge on the fact, that this key is removed).
* Chronicle Hash watch in runtime after the entries, and if one is removed and not updated
* in anyway for this {@code removedEntryCleanupTimeout}, Chronicle is allowed to remove this
* in any way for this {@code removedEntryCleanupTimeout}, Chronicle is allowed to remove this
* entry completely from the data structure. This timeout should depend on your distributed
* system topology, and typical replication latencies, that should be determined experimentally.
*
@@ -416,6 +417,8 @@ public interface ChronicleHashBuilder<K, H extends ChronicleHash<K, ?, ?, ?>,
* @param unit time unit, in which the timeout is given
* @return this builder back
* @throws IllegalArgumentException is the specified timeout is less than 1 millisecond
* @see #cleanupRemovedEntries(boolean)
* @see ReplicableEntry#doRemoveCompletely()
*/
B removedEntryCleanupTimeout(long removedEntryCleanupTimeout, TimeUnit unit);
@@ -428,6 +431,8 @@ public interface ChronicleHashBuilder<K, H extends ChronicleHash<K, ?, ?, ?>,
*
* @param cleanupRemovedEntries if stale removed entries should be purged from Chronicle Hash
* @return this builder back
* @see #removedEntryCleanupTimeout(long, TimeUnit)
* @see ReplicableEntry#doRemoveCompletely()
*/
B cleanupRemovedEntries(boolean cleanupRemovedEntries);
src/main/java/net/openhft/chronicle/hash/replication/ReplicableEntry.java
+7 -2
View File
@@ -26,9 +26,11 @@ import net.openhft.chronicle.map.Replica;
import net.openhft.chronicle.map.replication.MapRemoteOperations;
import net.openhft.chronicle.set.replication.SetRemoteOperations;
import java.util.concurrent.TimeUnit;
/**
* Abstracts a replicable entry in the replicated {@link ChronicleHash}. A {@link HashAbsentEntry}
* might be a {@code ReplicableEntry} as well as {@link HashEntry}.
* Abstracts a replicable entry in the replicated {@link ChronicleHash}. Both {@link HashEntry} and
* {@link HashAbsentEntry} could implement {@code ReplicableEntry} interface.
*/
public interface ReplicableEntry {
/**
@@ -104,6 +106,9 @@ public interface ReplicableEntry {
* processed, as the entry have never been present in the Chronicle hash. After calling this
* method any subsequent call of any method of {@code ReplicableEntry} class throws {@code
* IllegalStateException}.
*
* @see ChronicleHashBuilder#cleanupRemovedEntries(boolean)
* @see ChronicleHashBuilder#removedEntryCleanupTimeout(long, TimeUnit)
*/
void doRemoveCompletely();
}