aboutsummaryrefslogtreecommitdiffhomepage
path: root/src/core/ext/load_reporting/load_reporting.h
diff options
context:
space:
mode:
authorGravatar David Garcia Quintas <dgq@google.com>2016-10-11 16:33:31 -0700
committerGravatar David Garcia Quintas <dgq@google.com>2016-10-11 16:33:31 -0700
commitc5986021b98cf9bc95496f6d7af9b39864483c2c (patch)
treebb65bf642f27e74f154288b8ba6696805a3619cf /src/core/ext/load_reporting/load_reporting.h
parenta3654db631f02eb7f566ea775d78f3ff2b27830a (diff)
Removed outdated TODOs and improved docstrings
Diffstat (limited to 'src/core/ext/load_reporting/load_reporting.h')
-rw-r--r--src/core/ext/load_reporting/load_reporting.h16
1 files changed, 12 insertions, 4 deletions
diff --git a/src/core/ext/load_reporting/load_reporting.h b/src/core/ext/load_reporting/load_reporting.h
index a0db780c3a..e13097654d 100644
--- a/src/core/ext/load_reporting/load_reporting.h
+++ b/src/core/ext/load_reporting/load_reporting.h
@@ -37,12 +37,20 @@
#include <grpc/impl/codegen/grpc_types.h>
#include "src/core/lib/channel/channel_stack.h"
-/** Metadata key for initial metadata coming from clients */
-/* TODO(dgq): change to the final value TBD */
+/** Metadata key for the gRPC LB load balancer token.
+ *
+ * The value corresponding to this key is an opaque token that is given to the
+ * frontend as part of each pick; the frontend sends this token to the backend
+ * in each request it sends when using that pick. The token is used by the
+ * backend to verify the request and to allow the backend to report load to the
+ * gRPC LB system. */
#define GRPC_LB_TOKEN_MD_KEY "lb-token"
-/** Metadata key for trailing metadata from servers */
-/* TODO(dgq): change to the final value TBD */
+/** Metadata key for gRPC LB cost reporting.
+ *
+ * The value corresponding to this key is an opaque binary blob reported by the
+ * backend as part of its trailing metadata containing cost information for the
+ * call. */
#define GRPC_LB_COST_MD_KEY "lb-cost"
/** Identifiers for the invocation point of the users LR callback */