From: Florian Forster <octo@collectd.org>
Date: Thu, 11 Aug 2016 06:34:31 +0000 (+0200)
Subject: proto/collectd.proto: Improve documentation.
X-Git-Tag: collectd-5.6.0~54^2
X-Git-Url: https://git.octo.it/?a=commitdiff_plain;h=d89ee2e3fb86b7fdd293bff48a31c68aeadd6670;hp=-c;p=collectd.git

proto/collectd.proto: Improve documentation.

DispatchValues' documentation is now written from the POV of the server,
not the caller as it was previously worded.
---

d89ee2e3fb86b7fdd293bff48a31c68aeadd6670
diff --git a/proto/collectd.proto b/proto/collectd.proto
index 37df5b66..917c5deb 100644
--- a/proto/collectd.proto
+++ b/proto/collectd.proto
@@ -30,16 +30,22 @@ option go_package = "collectd.org/rpc/proto";
 import "types.proto";
 
 service Collectd {
-  // Query a list of values available from collectd's value cache.
-  rpc QueryValues(QueryValuesRequest) returns (stream QueryValuesResponse);
-
-  // DispatchValues sends a stream of ValueLists to the server.
+  // DispatchValues reads the value lists from the DispatchValuesRequest stream.
+  // The gRPC server embedded into collectd will inject them into the system
+  // just like the network plugin.
   rpc DispatchValues(stream DispatchValuesRequest)
       returns (DispatchValuesResponse);
+
+  // QueryValues returns a stream of matching value lists from collectd's
+  // internal cache.
+  rpc QueryValues(QueryValuesRequest) returns (stream QueryValuesResponse);
 }
 
 // The arguments to DispatchValues.
-message DispatchValuesRequest { collectd.types.ValueList value_list = 1; }
+message DispatchValuesRequest {
+  // value_list is the metric to be sent to the server.
+  collectd.types.ValueList value_list = 1;
+}
 
 // The response from DispatchValues.
 message DispatchValuesResponse {}