aboutsummaryrefslogtreecommitdiffhomepage
diff options
context:
space:
mode:
authorGravatar Masood Malekghassemi <soltanmm@users.noreply.github.com>2015-06-26 16:25:11 -0700
committerGravatar Masood Malekghassemi <soltanmm@users.noreply.github.com>2015-06-26 16:25:11 -0700
commitb70b70956d11ab909d92129be63fbc42ec06ff74 (patch)
tree1ff668c57aa374bd21c16b0b02517c8f9ba11bfe
parent188578dfb6406c79bd9d6b9844f6be7ddc2d583b (diff)
Clarify caller contract for grpc_call_start_batch
-rw-r--r--include/grpc/grpc.h4
1 files changed, 3 insertions, 1 deletions
diff --git a/include/grpc/grpc.h b/include/grpc/grpc.h
index 8b4676562b..637f473b82 100644
--- a/include/grpc/grpc.h
+++ b/include/grpc/grpc.h
@@ -396,7 +396,9 @@ grpc_call *grpc_channel_create_registered_call(
completion of type 'tag' to the completion queue bound to the call.
The order of ops specified in the batch has no significance.
Only one operation of each type can be active at once in any given
- batch.
+ batch. You must call grpc_completion_queue_next or
+ grpc_completion_queue_pluck on the completion queue associated with 'call'
+ for work to be performed.
THREAD SAFETY: access to grpc_call_start_batch in multi-threaded environment
needs to be synchronized. As an optimization, you may synchronize batches
containing just send operations independently from batches containing just