| commit | 686fa187850b781a5eecfd0b1ea6e868fda85880 | [log] [tgz] |
|---|---|---|
| author | Madan Jampani <madan@onlab.us> | Tue Nov 04 23:16:27 2014 -0800 |
| committer | Madan Jampani <madan@onlab.us> | Tue Nov 04 23:16:27 2014 -0800 |
| tree | 77cbd4e16eb07c304ab01f4546801002893a7404 | |
| parent | beada93656a546f12b18ae68e63d64292775c12a [diff] |
Javadoc improvements
diff --git a/core/store/dist/src/main/java/org/onlab/onos/store/service/impl/DatabaseClient.java b/core/store/dist/src/main/java/org/onlab/onos/store/service/impl/DatabaseClient.java index d07d1d3..8af567e 100644 --- a/core/store/dist/src/main/java/org/onlab/onos/store/service/impl/DatabaseClient.java +++ b/core/store/dist/src/main/java/org/onlab/onos/store/service/impl/DatabaseClient.java
@@ -15,6 +15,9 @@ import org.onlab.onos.store.service.ReadRequest; import org.onlab.onos.store.service.WriteRequest; +/** + * Client for interacting with the Copycat Raft cluster. + */ public class DatabaseClient { private final ProtocolClient client;
diff --git a/core/store/dist/src/main/java/org/onlab/onos/store/service/impl/DatabaseStateMachine.java b/core/store/dist/src/main/java/org/onlab/onos/store/service/impl/DatabaseStateMachine.java index c974486..ad6773e 100644 --- a/core/store/dist/src/main/java/org/onlab/onos/store/service/impl/DatabaseStateMachine.java +++ b/core/store/dist/src/main/java/org/onlab/onos/store/service/impl/DatabaseStateMachine.java
@@ -19,6 +19,13 @@ import com.google.common.collect.Maps; +/** + * StateMachine whose transitions are coordinated/replicated + * by Raft consensus. + * Each Raft cluster member has a instance of this state machine that is + * independently updated in lock step once there is consensus + * on the next transition. + */ public class DatabaseStateMachine implements StateMachine { public static final KryoSerializer SERIALIZER = new KryoSerializer() {
diff --git a/core/store/dist/src/main/java/org/onlab/onos/store/service/impl/InternalReadResult.java b/core/store/dist/src/main/java/org/onlab/onos/store/service/impl/InternalReadResult.java index f6fcf51..aadbcfb 100644 --- a/core/store/dist/src/main/java/org/onlab/onos/store/service/impl/InternalReadResult.java +++ b/core/store/dist/src/main/java/org/onlab/onos/store/service/impl/InternalReadResult.java
@@ -2,6 +2,9 @@ import org.onlab.onos.store.service.ReadResult; +/** + * Result of a read operation executed on the DatabaseStateMachine. + */ public class InternalReadResult { public enum Status {
diff --git a/core/store/dist/src/main/java/org/onlab/onos/store/service/impl/InternalWriteResult.java b/core/store/dist/src/main/java/org/onlab/onos/store/service/impl/InternalWriteResult.java index e6dbb1f..d757dfb 100644 --- a/core/store/dist/src/main/java/org/onlab/onos/store/service/impl/InternalWriteResult.java +++ b/core/store/dist/src/main/java/org/onlab/onos/store/service/impl/InternalWriteResult.java
@@ -2,6 +2,9 @@ import org.onlab.onos.store.service.WriteResult; +/** + * Result of a write operation executed on the DatabaseStateMachine. + */ public class InternalWriteResult { public enum Status {