aboutsummaryrefslogtreecommitdiffhomepage
path: root/include/grpc/impl/codegen
diff options
context:
space:
mode:
authorGravatar ncteisen <ncteisen@gmail.com>2018-02-12 07:25:53 -0800
committerGravatar ncteisen <ncteisen@gmail.com>2018-02-12 13:28:36 -0800
commite83c2349408cc6668020e5bdd7edf547607395a7 (patch)
treef3c5ba3c781c9000953bf17301a9d876ee5c1ebe /include/grpc/impl/codegen
parentb09c58c3402747d94cf74c11294a73c700c93902 (diff)
Add details about API gaurantees
Diffstat (limited to 'include/grpc/impl/codegen')
-rw-r--r--include/grpc/impl/codegen/grpc_types.h7
1 files changed, 6 insertions, 1 deletions
diff --git a/include/grpc/impl/codegen/grpc_types.h b/include/grpc/impl/codegen/grpc_types.h
index d64b23f332..a372dbba73 100644
--- a/include/grpc/impl/codegen/grpc_types.h
+++ b/include/grpc/impl/codegen/grpc_types.h
@@ -119,9 +119,14 @@ typedef struct {
These configuration options are modelled as key-value pairs as defined
by grpc_arg; keys are strings to allow easy backwards-compatible extension
by arbitrary parties. All evaluation is performed at channel creation
- time (i.e. the values in this structure need only live through the
+ time (i.e. the keys and values in this structure need only live through the
creation invocation).
+ However, if one of the args has grpc_arg_type==GRPC_ARG_POINTER, then the
+ grpc_arg_pointer_vtable must live until the channel args are done being
+ used by core (i.e. when the object for use with which they were passed
+ is destroyed).
+
See the description of the \ref grpc_arg_keys "available args" for more
details. */
typedef struct {