From 025632a138d20a03323f24b728869e77d6a966b3 Mon Sep 17 00:00:00 2001 From: "David G. Quintas" Date: Thu, 20 Aug 2015 14:16:42 -0700 Subject: [PATCH 1/3] Expanded grpc_server_request_call's docstring --- include/grpc/grpc.h | 10 +++++++--- 1 file changed, 7 insertions(+), 3 deletions(-) diff --git a/include/grpc/grpc.h b/include/grpc/grpc.h index 7869e9272e2..2f43199f5ad 100644 --- a/include/grpc/grpc.h +++ b/include/grpc/grpc.h @@ -589,9 +589,13 @@ grpc_call_error grpc_call_cancel_with_status(grpc_call *call, THREAD SAFETY: grpc_call_destroy is thread-compatible */ void grpc_call_destroy(grpc_call *call); -/** Request notification of a new call. 'cq_for_notification' must - have been registered to the server via - grpc_server_register_completion_queue. */ +/** Request notification of a new call. + Once a call with the given \a tag_new (or NULL for any tag) is received in + \a cq_bound_to_call, a notification is added to \a cq_for_notification and + \a call, \a details and \a request_metadata are updated with the appropriate + call information. + Note that \a cq_for_notification must have been registered to the server via + \a grpc_server_register_completion_queue. */ grpc_call_error grpc_server_request_call( grpc_server *server, grpc_call **call, grpc_call_details *details, grpc_metadata_array *request_metadata, From b2a1c599a75cf326f3efe9c278f8977250844c82 Mon Sep 17 00:00:00 2001 From: "David G. Quintas" Date: Thu, 20 Aug 2015 14:44:27 -0700 Subject: [PATCH 2/3] Update grpc.h --- include/grpc/grpc.h | 13 ++++++------- 1 file changed, 6 insertions(+), 7 deletions(-) diff --git a/include/grpc/grpc.h b/include/grpc/grpc.h index 2f43199f5ad..860048711f0 100644 --- a/include/grpc/grpc.h +++ b/include/grpc/grpc.h @@ -589,13 +589,12 @@ grpc_call_error grpc_call_cancel_with_status(grpc_call *call, THREAD SAFETY: grpc_call_destroy is thread-compatible */ void grpc_call_destroy(grpc_call *call); -/** Request notification of a new call. - Once a call with the given \a tag_new (or NULL for any tag) is received in - \a cq_bound_to_call, a notification is added to \a cq_for_notification and - \a call, \a details and \a request_metadata are updated with the appropriate - call information. - Note that \a cq_for_notification must have been registered to the server via - \a grpc_server_register_completion_queue. */ +/** Request notification of a new call. + Once a call is received in \a cq_bound_to_call, a notification tagged with + \a tag_new is added to \a cq_for_notification. \a call, \a details and \a + request_metadata are updated with the appropriate call information. + Note that \a cq_for_notification must have been registered to the server via + \a grpc_server_register_completion_queue. */ grpc_call_error grpc_server_request_call( grpc_server *server, grpc_call **call, grpc_call_details *details, grpc_metadata_array *request_metadata, From 1359a126a7d91ad827ccc39baad8ebf30d06c0f6 Mon Sep 17 00:00:00 2001 From: Craig Tiller Date: Mon, 24 Aug 2015 14:43:32 -0700 Subject: [PATCH 3/3] Added some clarification --- include/grpc/grpc.h | 8 +++++--- 1 file changed, 5 insertions(+), 3 deletions(-) diff --git a/include/grpc/grpc.h b/include/grpc/grpc.h index 860048711f0..101fc88d8f6 100644 --- a/include/grpc/grpc.h +++ b/include/grpc/grpc.h @@ -590,9 +590,11 @@ grpc_call_error grpc_call_cancel_with_status(grpc_call *call, void grpc_call_destroy(grpc_call *call); /** Request notification of a new call. - Once a call is received in \a cq_bound_to_call, a notification tagged with - \a tag_new is added to \a cq_for_notification. \a call, \a details and \a - request_metadata are updated with the appropriate call information. + Once a call is received, a notification tagged with \a tag_new is added to + \a cq_for_notification. \a call, \a details and \a request_metadata are + updated with the appropriate call information. \a cq_bound_to_call is bound + to \a call, and batch operation notifications for that call will be posted + to \a cq_bound_to_call. Note that \a cq_for_notification must have been registered to the server via \a grpc_server_register_completion_queue. */ grpc_call_error grpc_server_request_call(