diff options
author | 2018-02-12 07:25:53 -0800 | |
---|---|---|
committer | 2018-02-12 13:28:36 -0800 | |
commit | e83c2349408cc6668020e5bdd7edf547607395a7 (patch) | |
tree | f3c5ba3c781c9000953bf17301a9d876ee5c1ebe /include/grpc/grpc.h | |
parent | b09c58c3402747d94cf74c11294a73c700c93902 (diff) |
Add details about API gaurantees
Diffstat (limited to 'include/grpc/grpc.h')
-rw-r--r-- | include/grpc/grpc.h | 15 |
1 files changed, 10 insertions, 5 deletions
diff --git a/include/grpc/grpc.h b/include/grpc/grpc.h index 47d749c728..aec78be31b 100644 --- a/include/grpc/grpc.h +++ b/include/grpc/grpc.h @@ -269,9 +269,11 @@ GRPCAPI void grpc_channel_get_info(grpc_channel* channel, /** Create a client channel to 'target'. Additional channel level configuration MAY be provided by grpc_channel_args, though the expectation is that most - clients will want to simply pass NULL. See grpc_channel_args definition for - more on this. The data in 'args' need only live through the invocation of - this function. */ + clients will want to simply pass NULL. The user data in 'args' need only + live through the invocation of this function. However, if any args of the + 'pointer' type are passed, then the referenced vtable must be maintained + by the caller until grpc_channel_destroy terminates. See grpc_channel_args + definition for more on this. */ GRPCAPI grpc_channel* grpc_insecure_channel_create( const char* target, const grpc_channel_args* args, void* reserved); @@ -364,8 +366,11 @@ GRPCAPI grpc_call_error grpc_server_request_registered_call( /** Create a server. Additional configuration for each incoming channel can be specified with args. If no additional configuration is needed, args can - be NULL. See grpc_channel_args for more. The data in 'args' need only live - through the invocation of this function. */ + be NULL. The user data in 'args' need only live through the invocation of + this function. However, if any args of the 'pointer' type are passed, then + the referenced vtable must be maintained by the caller until + grpc_server_destroy terminates. See grpc_channel_args definition for more + on this. */ GRPCAPI grpc_server* grpc_server_create(const grpc_channel_args* args, void* reserved); |