diff options
| author |  Nathaniel Manista <nathaniel@google.com> | 2015-02-18 13:27:45 -0800 |
|---|---|---|
| committer | Nathaniel Manista <nathaniel@google.com> | 2015-02-18 13:27:45 -0800 |
| commit | befd64eace7ebfba2aefca24cf023c9979ff83cf (patch) | |
| tree | d0dff791fcf7e831a34e16a9a8e7e8dbc8c8d8c3 | |
| parent | d50bf4d98aa5a42ebcae7c1c0efc459b0eb6d531 (diff) | |
| parent | 8ac56c9607b6953576d1a2e455f52b68e64cea57 (diff) | |
Merge pull request #572 from ctiller/dox7
Clarify completion queue laws
| -rw-r--r-- | include/grpc/grpc.h | 7 |
1 files changed, 6 insertions, 1 deletions
diff --git a/include/grpc/grpc.h b/include/grpc/grpc.h index f2b84084bb..4a720d11f8 100644 --- a/include/grpc/grpc.h +++ b/include/grpc/grpc.h @@ -394,7 +394,12 @@ grpc_event *grpc_completion_queue_pluck(grpc_completion_queue *cq, void *tag, void grpc_event_finish(grpc_event *event); /* Begin destruction of a completion queue. Once all possible events are - drained it's safe to call grpc_completion_queue_destroy. */ + drained then grpc_completion_queue_next will start to produce + GRPC_QUEUE_SHUTDOWN events only. At that point it's safe to call + grpc_completion_queue_destroy. + + After calling this function applications should ensure that no + NEW work is added to be published on this completion queue. */ void grpc_completion_queue_shutdown(grpc_completion_queue *cq); /* Destroy a completion queue. The caller must ensure that the queue is |