aboutsummaryrefslogtreecommitdiffhomepage
path: root/include/grpc/census.h
diff options
context:
space:
mode:
authorGravatar Alistair Veitch <aveitch@google.com>2016-01-20 09:17:11 -0800
committerGravatar Alistair Veitch <aveitch@google.com>2016-01-20 09:17:11 -0800
commit8e5b21fd9faf0b1ba2f74e88fe7e59bc3d5ed299 (patch)
tree56e8a033b203f2ffa79e68348bd525d12990e8bb /include/grpc/census.h
parent4bbdb825677bde8e53cbab58ad4193c505dc9a50 (diff)
comment updates
Diffstat (limited to 'include/grpc/census.h')
-rw-r--r--include/grpc/census.h10
1 files changed, 7 insertions, 3 deletions
diff --git a/include/grpc/census.h b/include/grpc/census.h
index 4b3d021410..5443488fbe 100644
--- a/include/grpc/census.h
+++ b/include/grpc/census.h
@@ -375,6 +375,8 @@ typedef struct {
} census_tag_set_create_status;
/* Create a new tag set, adding and removing tags from an existing tag set.
+ This will copy all tags from it's input parameters, so it is recommended
+ to add as many tags in a single operation as is practical for the client.
@param base Base tag set to build upon. Can be NULL.
@param tags A set of tags to be added/changed/deleted. Tags with keys that
are in 'tags', but not 'base', are added to the tag set. Keys that are in
@@ -385,8 +387,10 @@ typedef struct {
binary or non-binary tags, they will be ignored, as will deletions of
tags that don't exist.
@param ntags number of tags in 'tags'
- @param stats Information about the tag set created and actions taken during
- its creation.
+ @param status If not NULL, the pointed to structure will be filled in with
+ information about the new tag set and status of the tags used in its
+ creation.
+ @return A new, valid census_tag_set.
*/
census_tag_set *census_tag_set_create(const census_tag_set *base,
const census_tag *tags, int ntags,
@@ -396,7 +400,7 @@ census_tag_set *census_tag_set_create(const census_tag_set *base,
has been called, the tag set cannot be reused. */
void census_tag_set_destroy(census_tag_set *tags);
-/* Get the number of tags in the tag set. */
+/* Get the total number of tags in the tag set. */
int census_tag_set_ntags(const census_tag_set *tags);
/* Structure used for tag set iteration. API clients should not use or