aboutsummaryrefslogtreecommitdiffhomepage
path: root/src/core/lib/surface
diff options
context:
space:
mode:
authorGravatar David Garcia Quintas <dgq@google.com>2016-08-09 15:20:48 -0700
committerGravatar David Garcia Quintas <dgq@google.com>2016-08-09 15:20:48 -0700
commit15eba13927e1c5e3eff416a22bf53bff20e07c77 (patch)
tree47fb7c940559160b0b42f4cc6596a70ad4a0af4d /src/core/lib/surface
parent328f7bfe185a700951a160e6d8657591b6db4cf3 (diff)
Improved some docstrings for grpc_call creation
Diffstat (limited to 'src/core/lib/surface')
-rw-r--r--src/core/lib/surface/channel.h8
1 files changed, 8 insertions, 0 deletions
diff --git a/src/core/lib/surface/channel.h b/src/core/lib/surface/channel.h
index 7eff7b8883..4c62974346 100644
--- a/src/core/lib/surface/channel.h
+++ b/src/core/lib/surface/channel.h
@@ -42,6 +42,14 @@ grpc_channel *grpc_channel_create(grpc_exec_ctx *exec_ctx, const char *target,
grpc_channel_stack_type channel_stack_type,
grpc_transport *optional_transport);
+/** Create a call given a grpc_channel, in order to call \a method.
+ Progress is tied to activity on \a pollset_set. The returned call object is
+ meant to be used with \a grpc_call_start_batch_and_execute, which relies on
+ callbacks to signal completions. \a method and \a host need
+ only live through the invocation of this function. If \a parent_call is
+ non-NULL, it must be a server-side call. It will be used to propagate
+ properties from the server call to this new client call, depending on the
+ value of \a propagation_mask (see propagation_bits.h for possible values) */
grpc_call *grpc_channel_create_pollset_set_call(
grpc_channel *channel, grpc_call *parent_call, uint32_t propagation_mask,
grpc_pollset_set *pollset_set, const char *method, const char *host,