aboutsummaryrefslogtreecommitdiffhomepage
diff options
context:
space:
mode:
authorGravatar Craig Tiller <craig.tiller@gmail.com>2015-02-17 17:06:23 -0800
committerGravatar Craig Tiller <craig.tiller@gmail.com>2015-02-17 17:06:23 -0800
commita0e34a0b905c0d7330bdf903d976d258704871a4 (patch)
treee42883ce7f9dc9093002da8d251e45b311597685
parentb4215bba564627b62241ef7e37528fa154a79e7c (diff)
Expand init/destroy documentation
-rw-r--r--include/grpc/grpc.h12
1 files changed, 10 insertions, 2 deletions
diff --git a/include/grpc/grpc.h b/include/grpc/grpc.h
index 9807de9f4b..2bd7415e28 100644
--- a/include/grpc/grpc.h
+++ b/include/grpc/grpc.h
@@ -338,10 +338,18 @@ typedef struct grpc_op {
} data;
} grpc_op;
-/* Initialize the grpc library */
+/* Initialize the grpc library.
+ It is not safe to call any other grpc functions before calling this.
+ (To avoid overhead, little checking is done, and some things may work. We
+ do not warrant that they will continue to do so in future revisions of this
+ library). */
void grpc_init(void);
-/* Shut down the grpc library */
+/* Shut down the grpc library.
+ No memory is used by grpc after this call returns, nor are any instructions
+ executing within the grpc library.
+ Prior to calling, all application owned grpc objects must have been
+ destroyed. */
void grpc_shutdown(void);
grpc_completion_queue *grpc_completion_queue_create(void);