javadoc

confluentinc · Oct 22, 2021 · 2237d63 · 2237d63
1 parent 36656a9
commit 2237d63
Showing 1 changed file with 6 additions and 0 deletions.
diff --git a/ksqldb-common/src/main/java/io/confluent/ksql/util/ConsistencyOffsetVector.java b/ksqldb-common/src/main/java/io/confluent/ksql/util/ConsistencyOffsetVector.java
@@ -30,9 +30,15 @@
 import java.util.concurrent.locks.ReadWriteLock;
 import java.util.concurrent.locks.ReentrantReadWriteLock;
 
+/**
+ * Represents a consistency token that is communicated between the client and server.
+ * This token is used to ensure monotonic reads for table pull queries as in: once a client has
+ * received a row with an offset x, subsequent reads will only return rows of offsets > x.
+ */
 public class ConsistencyOffsetVector implements OffsetVector, Serializable {
 
   private int version;
+  // Topic -> Partition -> Offset
   private Map<String, Map<Integer, Long>> offsetVector;
   private ReadWriteLock rwLock;