Skip to content

Commit

Permalink
Add proto comments
Browse files Browse the repository at this point in the history
  • Loading branch information
samsondav committed Jul 2, 2024
1 parent 0cbd3e0 commit b143823
Showing 1 changed file with 5 additions and 2 deletions.
7 changes: 5 additions & 2 deletions llo/plugin_codecs.proto
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,10 @@ message LLOObservationProto {
bool shouldRetire = 2;
int64 unixTimestampNanoseconds = 3;
repeated uint32 removeChannelIDs = 4;
// Maps are safe to use here because Observation serialization does not
// need to be deterministic. Non-deterministic map serialization is
// marginally more efficient than converting to tuples and guarantees
// uniqueness.
map<uint32, LLOChannelDefinitionProto> updateChannelDefinitions = 5;
map<uint32, bytes> streamValues = 6;
}
Expand All @@ -28,8 +32,7 @@ message LLOStreamObservationProto {
bytes value = 2;
}

// NOTE: Use of repeated tuple instead of maps for more reliable determinstic
// serialization
// NOTE: Outcome must serialize deterministically, hence use of repeated tuple instead of maps
message LLOOutcomeProto {
string lifeCycleStage = 1;
int64 ObservationsTimestampNanoseconds = 2;
Expand Down

0 comments on commit b143823

Please sign in to comment.