aboutsummaryrefslogtreecommitdiffhomepage
path: root/include/grpc/grpc_security.h
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/grpc_security.h
parentb09c58c3402747d94cf74c11294a73c700c93902 (diff)
Add details about API gaurantees
Diffstat (limited to 'include/grpc/grpc_security.h')
-rw-r--r--include/grpc/grpc_security.h8
1 files changed, 7 insertions, 1 deletions
diff --git a/include/grpc/grpc_security.h b/include/grpc/grpc_security.h
index bae07ac309..08776337cc 100644
--- a/include/grpc/grpc_security.h
+++ b/include/grpc/grpc_security.h
@@ -300,7 +300,13 @@ GRPCAPI grpc_call_credentials* grpc_metadata_credentials_create_from_plugin(
/** --- Secure channel creation. --- */
-/** Creates a secure channel using the passed-in credentials. */
+/** Creates a secure channel using the passed-in credentials. Additional
+ channel level configuration MAY be provided by grpc_channel_args, though
+ the expectation is that most 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_secure_channel_create(
grpc_channel_credentials* creds, const char* target,
const grpc_channel_args* args, void* reserved);