aboutsummaryrefslogtreecommitdiffhomepage
path: root/include/grpc/census.h
diff options
context:
space:
mode:
authorGravatar Alistair Veitch <aveitch@google.com>2016-01-15 13:15:03 -0800
committerGravatar Alistair Veitch <aveitch@google.com>2016-01-15 13:15:03 -0800
commit04de8c16d2f1fc4f9c97e460ea1f450872981d58 (patch)
treeec1cb51a9995e5e9f054a1902c8d87809b098543 /include/grpc/census.h
parenta88a22166d768fbfc2da14d88fada058cfad7735 (diff)
add comments
Diffstat (limited to 'include/grpc/census.h')
-rw-r--r--include/grpc/census.h6
1 files changed, 5 insertions, 1 deletions
diff --git a/include/grpc/census.h b/include/grpc/census.h
index 04b2c9db5f..7b769c62ee 100644
--- a/include/grpc/census.h
+++ b/include/grpc/census.h
@@ -329,7 +329,7 @@ void census_trace_scan_end();
a tag set. All contexts have an associated tag set. */
typedef struct census_tag_set census_tag_set;
-/* A tag is a key:value pair. The key is a printable, nil-terminate
+/* A tag is a key:value pair. The key is a non-empty, printable, nil-terminated
string. The value is a binary string, that may be printable. There are no
limits on the sizes of either keys or values, but code authors should
remember that systems may have inbuilt limits (e.g. for propagated tags,
@@ -422,6 +422,10 @@ int census_tag_set_next_tag(census_tag_set_iterator *iterator, census_tag *tag);
int census_tag_set_get_tag_by_key(const census_tag_set *tags, const char *key,
census_tag *tag);
+/* Tag set encode/decode functionality. These functionas are intended
+ for use by RPC systems only, for purposes of transmitting/receiving tag
+ sets. */
+
/* Encode to-be-propagated non-binary tags from a tag set into a memory
buffer. The total number of bytes used in the buffer is returned. If the
buffer is too small to contain the encoded tag set, then 0 is returned. */