Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add comments to clarify the record history on a server. #120

Merged
merged 1 commit into from
Aug 18, 2023
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
23 changes: 19 additions & 4 deletions acctz/acctz.proto
Original file line number Diff line number Diff line change
Expand Up @@ -53,8 +53,13 @@ service Acctz {
//
// A RecordRequest contains a timestamp indicating the last message
// received. The Collector's expectation is that all messages after the
// timestamp will be streamed. Any history for replay of records is subject
// to the implementation support and may or may not be configurable.
// timestamp will be streamed. If this results in no records to send, the
// server should return an OK error and zero records.
//
// Any history for replay of records or size of the history is subject to
// implementation support and may or may not be configurable. The history
// should be global to the device or virtual tenant, such that new and
// re-connecting clients can access the history.
//
// At connection initiation the Collector may send either the current
// time or a zero time. A zero time indicates that all messages stored on the
Expand Down Expand Up @@ -198,10 +203,20 @@ message RecordResponse {
// since the unix epoch.
google.protobuf.Timestamp timestamp = 2;

// True, if the server's history does not include a message with the given
// RecordRequest.timestamp or an older record, indicating that history
// truncation has occurred relative to the timestamp reference point and
// records might have been missed.
// If RecordRequest.timestamp was not equal to a previously received
// RecordResponse.timestamp received, instead randomly chosen, the Collector
// can not know if it missed records.
// If RecordRequest.timestamp = 0, this must be false.
bool history_istruncated = 3;

// Service request details of the accounting record.
oneof service_request {
CommandService cmd_service = 3;
GrpcService grpc_service = 4;
CommandService cmd_service = 4;
GrpcService grpc_service = 5;
}

// Authentication related details
Expand Down