From 1854d77da0a7b43a7c842503a7c08c39096e621d Mon Sep 17 00:00:00 2001
From: vjpai <vpai@google.com>
Date: Mon, 8 Jun 2015 01:12:29 -0700
Subject: [PATCH] Fix comments about return value of
grpc_completion_queue_{next,pluck}
---
include/grpc/grpc.h | 6 ++++--
1 file changed, 4 insertions(+), 2 deletions(-)
diff --git a/include/grpc/grpc.h b/include/grpc/grpc.h
index e95a5f2e92..2a7ddbd4f3 100644
--- a/include/grpc/grpc.h
+++ b/include/grpc/grpc.h
@@ -361,7 +361,8 @@ grpc_completion_queue *grpc_completion_queue_create(void);
/** Blocks until an event is available, the completion queue is being shut down,
or deadline is reached.
- Returns NULL on timeout, otherwise the event that occurred.
+ Returns a grpc_event with type GRPC_QUEUE_TIMEOUT on timeout,
+ otherwise a grpc_event describing the event that occurred.
Callers must not call grpc_completion_queue_next and
grpc_completion_queue_pluck simultaneously on the same completion queue. */
@@ -371,7 +372,8 @@ grpc_event grpc_completion_queue_next(grpc_completion_queue *cq,
/** Blocks until an event with tag 'tag' is available, the completion queue is
being shutdown or deadline is reached.
- Returns NULL on timeout, or a pointer to the event that occurred.
+ Returns a grpc_event with type GRPC_QUEUE_TIMEOUT on timeout,
+ otherwise a grpc_event describing the event that occurred.
Callers must not call grpc_completion_queue_next and
grpc_completion_queue_pluck simultaneously on the same completion queue. */
--
GitLab