blob: 89c822504ce9ca702b61023d351587bd1d7db4ef [file] [log] [blame]
Nicolas Nobleb7ebd3b2014-11-26 16:33:03 -08001/*
2 *
Craig Tiller06059952015-02-18 08:34:56 -08003 * Copyright 2015, Google Inc.
Nicolas Nobleb7ebd3b2014-11-26 16:33:03 -08004 * All rights reserved.
5 *
6 * Redistribution and use in source and binary forms, with or without
7 * modification, are permitted provided that the following conditions are
8 * met:
9 *
10 * * Redistributions of source code must retain the above copyright
11 * notice, this list of conditions and the following disclaimer.
12 * * Redistributions in binary form must reproduce the above
13 * copyright notice, this list of conditions and the following disclaimer
14 * in the documentation and/or other materials provided with the
15 * distribution.
16 * * Neither the name of Google Inc. nor the names of its
17 * contributors may be used to endorse or promote products derived from
18 * this software without specific prior written permission.
19 *
20 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
21 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
22 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
23 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
24 * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
25 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
26 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
27 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
28 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
29 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
30 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
31 *
32 */
33
Nicolas "Pixel" Noble1ff52d52015-03-01 05:24:36 +010034#ifndef GRPC_GRPC_H
35#define GRPC_GRPC_H
Nicolas Nobleb7ebd3b2014-11-26 16:33:03 -080036
37#include <grpc/status.h>
38
39#include <stddef.h>
40#include <grpc/support/slice.h>
41#include <grpc/support/time.h>
42
43#ifdef __cplusplus
44extern "C" {
45#endif
46
Nathaniel Manista6d41a052015-02-16 02:12:48 +000047/* Completion Queues enable notification of the completion of asynchronous
Nicolas Nobleb7ebd3b2014-11-26 16:33:03 -080048 actions. */
49typedef struct grpc_completion_queue grpc_completion_queue;
50
51/* The Channel interface allows creation of Call objects. */
52typedef struct grpc_channel grpc_channel;
53
54/* A server listens to some port and responds to request calls */
55typedef struct grpc_server grpc_server;
56
57/* A Call represents an RPC. When created, it is in a configuration state
58 allowing properties to be set until it is invoked. After invoke, the Call
59 can have messages written to it and read from it. */
60typedef struct grpc_call grpc_call;
61
62/* Type specifier for grpc_arg */
63typedef enum {
64 GRPC_ARG_STRING,
65 GRPC_ARG_INTEGER,
66 GRPC_ARG_POINTER
67} grpc_arg_type;
68
69/* A single argument... each argument has a key and a value
70
71 A note on naming keys:
72 Keys are namespaced into groups, usually grouped by library, and are
73 keys for module XYZ are named XYZ.key1, XYZ.key2, etc. Module names must
74 be restricted to the regex [A-Za-z][_A-Za-z0-9]{,15}.
75 Key names must be restricted to the regex [A-Za-z][_A-Za-z0-9]{,47}.
76
77 GRPC core library keys are prefixed by grpc.
78
79 Library authors are strongly encouraged to #define symbolic constants for
80 their keys so that it's possible to change them in the future. */
81typedef struct {
82 grpc_arg_type type;
83 char *key;
84 union {
85 char *string;
86 int integer;
87 struct {
88 void *p;
89 void *(*copy)(void *p);
90 void (*destroy)(void *p);
91 } pointer;
92 } value;
93} grpc_arg;
94
Craig Tiller29f2b212015-02-17 17:01:24 -080095/* An array of arguments that can be passed around.
96 Used to set optional channel-level configuration.
97 These configuration options are modelled as key-value pairs as defined
98 by grpc_arg; keys are strings to allow easy backwards-compatible extension
99 by arbitrary parties.
100 All evaluation is performed at channel creation time. */
Nicolas Nobleb7ebd3b2014-11-26 16:33:03 -0800101typedef struct {
102 size_t num_args;
103 grpc_arg *args;
104} grpc_channel_args;
105
106/* Channel argument keys: */
107/* Enable census for tracing and stats collection */
108#define GRPC_ARG_ENABLE_CENSUS "grpc.census"
109/* Maximum number of concurrent incoming streams to allow on a http2
110 connection */
111#define GRPC_ARG_MAX_CONCURRENT_STREAMS "grpc.max_concurrent_streams"
112/* Maximum message length that the channel can receive */
113#define GRPC_ARG_MAX_MESSAGE_LENGTH "grpc.max_message_length"
114
Nicolas Nobleb7ebd3b2014-11-26 16:33:03 -0800115/* Result of a grpc call. If the caller satisfies the prerequisites of a
116 particular operation, the grpc_call_error returned will be GRPC_CALL_OK.
117 Receiving any other value listed here is an indication of a bug in the
118 caller. */
119typedef enum grpc_call_error {
120 /* everything went ok */
121 GRPC_CALL_OK = 0,
122 /* something failed, we don't know what */
123 GRPC_CALL_ERROR,
124 /* this method is not available on the server */
125 GRPC_CALL_ERROR_NOT_ON_SERVER,
126 /* this method is not available on the client */
127 GRPC_CALL_ERROR_NOT_ON_CLIENT,
nnoble0c475f02014-12-05 15:37:39 -0800128 /* this method must be called before server_accept */
129 GRPC_CALL_ERROR_ALREADY_ACCEPTED,
Nicolas Nobleb7ebd3b2014-11-26 16:33:03 -0800130 /* this method must be called before invoke */
131 GRPC_CALL_ERROR_ALREADY_INVOKED,
132 /* this method must be called after invoke */
133 GRPC_CALL_ERROR_NOT_INVOKED,
134 /* this call is already finished
135 (writes_done or write_status has already been called) */
136 GRPC_CALL_ERROR_ALREADY_FINISHED,
137 /* there is already an outstanding read/write operation on the call */
138 GRPC_CALL_ERROR_TOO_MANY_OPERATIONS,
139 /* the flags value was illegal for this call */
140 GRPC_CALL_ERROR_INVALID_FLAGS
141} grpc_call_error;
142
143/* Result of a grpc operation */
144typedef enum grpc_op_error {
145 /* everything went ok */
146 GRPC_OP_OK = 0,
147 /* something failed, we don't know what */
148 GRPC_OP_ERROR
149} grpc_op_error;
150
151/* Write Flags: */
152/* Hint that the write may be buffered and need not go out on the wire
153 immediately. GRPC is free to buffer the message until the next non-buffered
154 write, or until writes_done, but it need not buffer completely or at all. */
155#define GRPC_WRITE_BUFFER_HINT (0x00000001u)
156/* Force compression to be disabled for a particular write
157 (start_write/add_metadata). Illegal on invoke/accept. */
158#define GRPC_WRITE_NO_COMPRESS (0x00000002u)
159
160/* A buffer of bytes */
161struct grpc_byte_buffer;
162typedef struct grpc_byte_buffer grpc_byte_buffer;
163
Nathaniel Manista6d41a052015-02-16 02:12:48 +0000164/* Sample helpers to obtain byte buffers (these will certainly move
165 someplace else) */
Nicolas Nobleb7ebd3b2014-11-26 16:33:03 -0800166grpc_byte_buffer *grpc_byte_buffer_create(gpr_slice *slices, size_t nslices);
Craig Tiller80fa15c2015-01-13 16:10:49 -0800167grpc_byte_buffer *grpc_byte_buffer_copy(grpc_byte_buffer *bb);
Nicolas Nobleb7ebd3b2014-11-26 16:33:03 -0800168size_t grpc_byte_buffer_length(grpc_byte_buffer *bb);
169void grpc_byte_buffer_destroy(grpc_byte_buffer *byte_buffer);
170
171/* Reader for byte buffers. Iterates over slices in the byte buffer */
172struct grpc_byte_buffer_reader;
173typedef struct grpc_byte_buffer_reader grpc_byte_buffer_reader;
174
175grpc_byte_buffer_reader *grpc_byte_buffer_reader_create(
176 grpc_byte_buffer *buffer);
177/* At the end of the stream, returns 0. Otherwise, returns 1 and sets slice to
178 be the returned slice. Caller is responsible for calling gpr_slice_unref on
179 the result. */
180int grpc_byte_buffer_reader_next(grpc_byte_buffer_reader *reader,
181 gpr_slice *slice);
182void grpc_byte_buffer_reader_destroy(grpc_byte_buffer_reader *reader);
183
184/* A single metadata element */
185typedef struct grpc_metadata {
Craig Tiller4f972732015-02-05 12:40:20 -0800186 const char *key;
187 const char *value;
Nicolas Nobleb7ebd3b2014-11-26 16:33:03 -0800188 size_t value_length;
189} grpc_metadata;
190
191typedef enum grpc_completion_type {
Craig Tillerfef76692015-02-02 16:44:26 -0800192 GRPC_QUEUE_SHUTDOWN, /* Shutting down */
Craig Tillerfb189f82015-02-03 12:07:07 -0800193 GRPC_OP_COMPLETE, /* operation completion */
Craig Tillerfef76692015-02-02 16:44:26 -0800194 GRPC_READ, /* A read has completed */
195 GRPC_WRITE_ACCEPTED, /* A write has been accepted by
196 flow control */
Nicolas Nobleb7ebd3b2014-11-26 16:33:03 -0800197 GRPC_FINISH_ACCEPTED, /* writes_done or write_status has been accepted */
198 GRPC_CLIENT_METADATA_READ, /* The metadata array sent by server received at
199 client */
Craig Tillerfef76692015-02-02 16:44:26 -0800200 GRPC_FINISHED, /* An RPC has finished. The event contains status.
201 On the server this will be OK or Cancelled. */
Nicolas Nobleb7ebd3b2014-11-26 16:33:03 -0800202 GRPC_SERVER_RPC_NEW, /* A new RPC has arrived at the server */
Craig Tiller4ffdcd52015-01-16 11:34:55 -0800203 GRPC_SERVER_SHUTDOWN, /* The server has finished shutting down */
Nicolas Nobleb7ebd3b2014-11-26 16:33:03 -0800204 GRPC_COMPLETION_DO_NOT_USE /* must be last, forces users to include
205 a default: case */
206} grpc_completion_type;
207
208typedef struct grpc_event {
209 grpc_completion_type type;
210 void *tag;
211 grpc_call *call;
212 /* Data associated with the completion type. Field names match the type of
213 completion as listed in grpc_completion_type. */
214 union {
215 /* Contains a pointer to the buffer that was read, or NULL at the end of a
216 stream. */
217 grpc_byte_buffer *read;
218 grpc_op_error write_accepted;
219 grpc_op_error finish_accepted;
220 grpc_op_error invoke_accepted;
Craig Tillerfb189f82015-02-03 12:07:07 -0800221 grpc_op_error op_complete;
Nicolas Nobleb7ebd3b2014-11-26 16:33:03 -0800222 struct {
223 size_t count;
224 grpc_metadata *elements;
225 } client_metadata_read;
ctiller2845cad2014-12-15 15:14:12 -0800226 struct {
227 grpc_status_code status;
228 const char *details;
229 size_t metadata_count;
230 grpc_metadata *metadata_elements;
231 } finished;
Nicolas Nobleb7ebd3b2014-11-26 16:33:03 -0800232 struct {
233 const char *method;
234 const char *host;
235 gpr_timespec deadline;
236 size_t metadata_count;
237 grpc_metadata *metadata_elements;
238 } server_rpc_new;
239 } data;
240} grpc_event;
241
Craig Tillerfef76692015-02-02 16:44:26 -0800242typedef struct {
243 size_t count;
244 size_t capacity;
245 grpc_metadata *metadata;
246} grpc_metadata_array;
247
Craig Tillerea61b072015-02-03 19:19:27 -0800248void grpc_metadata_array_init(grpc_metadata_array *array);
249void grpc_metadata_array_destroy(grpc_metadata_array *array);
250
Craig Tillerfef76692015-02-02 16:44:26 -0800251typedef struct {
Craig Tillerea61b072015-02-03 19:19:27 -0800252 char *method;
Craig Tiller034929c2015-02-02 16:56:15 -0800253 size_t method_capacity;
Craig Tillerea61b072015-02-03 19:19:27 -0800254 char *host;
Craig Tiller034929c2015-02-02 16:56:15 -0800255 size_t host_capacity;
Craig Tillerfef76692015-02-02 16:44:26 -0800256 gpr_timespec deadline;
257} grpc_call_details;
258
Craig Tillerea61b072015-02-03 19:19:27 -0800259void grpc_call_details_init(grpc_call_details *details);
260void grpc_call_details_destroy(grpc_call_details *details);
261
Craig Tillerfef76692015-02-02 16:44:26 -0800262typedef enum {
Craig Tiller24be0f72015-02-10 14:04:22 -0800263 /* Send initial metadata: one and only one instance MUST be sent for each
264 call,
Craig Tillerb7800c12015-02-04 18:25:38 -0800265 unless the call was cancelled - in which case this can be skipped */
Craig Tillerfef76692015-02-02 16:44:26 -0800266 GRPC_OP_SEND_INITIAL_METADATA = 0,
Craig Tillerb7800c12015-02-04 18:25:38 -0800267 /* Send a message: 0 or more of these operations can occur for each call */
Craig Tillerfef76692015-02-02 16:44:26 -0800268 GRPC_OP_SEND_MESSAGE,
Craig Tiller24be0f72015-02-10 14:04:22 -0800269 /* Send a close from the server: one and only one instance MUST be sent from
270 the client,
Craig Tillerb7800c12015-02-04 18:25:38 -0800271 unless the call was cancelled - in which case this can be skipped */
Craig Tillerfef76692015-02-02 16:44:26 -0800272 GRPC_OP_SEND_CLOSE_FROM_CLIENT,
Craig Tiller24be0f72015-02-10 14:04:22 -0800273 /* Send status from the server: one and only one instance MUST be sent from
274 the server
Craig Tillerb7800c12015-02-04 18:25:38 -0800275 unless the call was cancelled - in which case this can be skipped */
Craig Tillerfef76692015-02-02 16:44:26 -0800276 GRPC_OP_SEND_STATUS_FROM_SERVER,
Craig Tillerb7800c12015-02-04 18:25:38 -0800277 /* Receive initial metadata: one and only one MUST be made on the client, must
278 not be made on the server */
Craig Tillerfef76692015-02-02 16:44:26 -0800279 GRPC_OP_RECV_INITIAL_METADATA,
Craig Tillerb7800c12015-02-04 18:25:38 -0800280 /* Receive a message: 0 or more of these operations can occur for each call */
Craig Tillerfb189f82015-02-03 12:07:07 -0800281 GRPC_OP_RECV_MESSAGE,
Craig Tiller24be0f72015-02-10 14:04:22 -0800282 /* Receive status on the client: one and only one must be made on the client
283 */
Craig Tillerfef76692015-02-02 16:44:26 -0800284 GRPC_OP_RECV_STATUS_ON_CLIENT,
Craig Tiller24be0f72015-02-10 14:04:22 -0800285 /* Receive status on the server: one and only one must be made on the server
286 */
Craig Tillerfef76692015-02-02 16:44:26 -0800287 GRPC_OP_RECV_CLOSE_ON_SERVER
288} grpc_op_type;
289
Craig Tiller24be0f72015-02-10 14:04:22 -0800290/* Operation data: one field for each op type (except SEND_CLOSE_FROM_CLIENT
291 which has
Craig Tillerb7800c12015-02-04 18:25:38 -0800292 no arguments) */
Craig Tillerfef76692015-02-02 16:44:26 -0800293typedef struct grpc_op {
294 grpc_op_type op;
295 union {
296 struct {
297 size_t count;
298 const grpc_metadata *metadata;
299 } send_initial_metadata;
300 grpc_byte_buffer *send_message;
301 struct {
302 size_t trailing_metadata_count;
303 grpc_metadata *trailing_metadata;
304 grpc_status_code status;
305 const char *status_details;
306 } send_status_from_server;
Craig Tiller4f972732015-02-05 12:40:20 -0800307 /* ownership of the array is with the caller, but ownership of the elements
Craig Tillerc56b2cb2015-02-05 16:35:38 -0800308 stays with the call object (ie key, value members are owned by the call
309 object, recv_initial_metadata->array is owned by the caller).
310 After the operation completes, call grpc_metadata_array_destroy on this
311 value, or reuse it in a future op. */
Craig Tillerfef76692015-02-02 16:44:26 -0800312 grpc_metadata_array *recv_initial_metadata;
313 grpc_byte_buffer **recv_message;
314 struct {
Craig Tiller24be0f72015-02-10 14:04:22 -0800315 /* ownership of the array is with the caller, but ownership of the
316 elements
Craig Tillerc56b2cb2015-02-05 16:35:38 -0800317 stays with the call object (ie key, value members are owned by the call
318 object, trailing_metadata->array is owned by the caller).
319 After the operation completes, call grpc_metadata_array_destroy on this
320 value, or reuse it in a future op. */
Craig Tillerfef76692015-02-02 16:44:26 -0800321 grpc_metadata_array *trailing_metadata;
322 grpc_status_code *status;
Craig Tiller24be0f72015-02-10 14:04:22 -0800323 /* status_details is a buffer owned by the application before the op
324 completes
325 and after the op has completed. During the operation status_details may
326 be
327 reallocated to a size larger than *status_details_capacity, in which
328 case
Craig Tillerc56b2cb2015-02-05 16:35:38 -0800329 *status_details_capacity will be updated with the new array capacity.
330
331 Pre-allocating space:
332 size_t my_capacity = 8;
333 char *my_details = gpr_malloc(my_capacity);
334 x.status_details = &my_details;
Craig Tiller24be0f72015-02-10 14:04:22 -0800335 x.status_details_capacity = &my_capacity;
Craig Tillerc56b2cb2015-02-05 16:35:38 -0800336
337 Not pre-allocating space:
338 size_t my_capacity = 0;
339 char *my_details = NULL;
340 x.status_details = &my_details;
Craig Tiller24be0f72015-02-10 14:04:22 -0800341 x.status_details_capacity = &my_capacity;
Craig Tillerc56b2cb2015-02-05 16:35:38 -0800342
343 After the call:
344 gpr_free(my_details); */
Craig Tillerfef76692015-02-02 16:44:26 -0800345 char **status_details;
346 size_t *status_details_capacity;
347 } recv_status_on_client;
348 struct {
Craig Tiller24be0f72015-02-10 14:04:22 -0800349 /* out argument, set to 1 if the call failed in any way (seen as a
350 cancellation
Craig Tiller0a5bcbc2015-02-09 21:39:04 -0800351 on the server), or 0 if the call succeeded */
Craig Tillerfef76692015-02-02 16:44:26 -0800352 int *cancelled;
353 } recv_close_on_server;
354 } data;
355} grpc_op;
356
Craig Tillera0e34a02015-02-17 17:06:23 -0800357/* Initialize the grpc library.
358 It is not safe to call any other grpc functions before calling this.
359 (To avoid overhead, little checking is done, and some things may work. We
360 do not warrant that they will continue to do so in future revisions of this
361 library). */
Craig Tiller32946d32015-01-15 11:37:30 -0800362void grpc_init(void);
Nicolas Nobleb7ebd3b2014-11-26 16:33:03 -0800363
Craig Tillera0e34a02015-02-17 17:06:23 -0800364/* Shut down the grpc library.
365 No memory is used by grpc after this call returns, nor are any instructions
366 executing within the grpc library.
367 Prior to calling, all application owned grpc objects must have been
368 destroyed. */
Craig Tiller32946d32015-01-15 11:37:30 -0800369void grpc_shutdown(void);
Nicolas Nobleb7ebd3b2014-11-26 16:33:03 -0800370
Craig Tiller32946d32015-01-15 11:37:30 -0800371grpc_completion_queue *grpc_completion_queue_create(void);
Nicolas Nobleb7ebd3b2014-11-26 16:33:03 -0800372
Nathaniel Manista6d41a052015-02-16 02:12:48 +0000373/* Blocks until an event is available, the completion queue is being shut down,
Nicolas Nobleb7ebd3b2014-11-26 16:33:03 -0800374 or deadline is reached. Returns NULL on timeout, otherwise the event that
375 occurred. Callers should call grpc_event_finish once they have processed
376 the event.
377
378 Callers must not call grpc_completion_queue_next and
379 grpc_completion_queue_pluck simultaneously on the same completion queue. */
380grpc_event *grpc_completion_queue_next(grpc_completion_queue *cq,
381 gpr_timespec deadline);
382
383/* Blocks until an event with tag 'tag' is available, the completion queue is
384 being shutdown or deadline is reached. Returns NULL on timeout, or a pointer
385 to the event that occurred. Callers should call grpc_event_finish once they
386 have processed the event.
387
388 Callers must not call grpc_completion_queue_next and
389 grpc_completion_queue_pluck simultaneously on the same completion queue. */
390grpc_event *grpc_completion_queue_pluck(grpc_completion_queue *cq, void *tag,
391 gpr_timespec deadline);
392
Nathaniel Manista6d41a052015-02-16 02:12:48 +0000393/* Clean up any data owned by the event */
Nicolas Nobleb7ebd3b2014-11-26 16:33:03 -0800394void grpc_event_finish(grpc_event *event);
395
396/* Begin destruction of a completion queue. Once all possible events are
Craig Tiller8ac56c92015-02-17 22:51:36 -0800397 drained then grpc_completion_queue_next will start to produce
398 GRPC_QUEUE_SHUTDOWN events only. At that point it's safe to call
399 grpc_completion_queue_destroy.
400
401 After calling this function applications should ensure that no
402 NEW work is added to be published on this completion queue. */
Nicolas Nobleb7ebd3b2014-11-26 16:33:03 -0800403void grpc_completion_queue_shutdown(grpc_completion_queue *cq);
404
405/* Destroy a completion queue. The caller must ensure that the queue is
406 drained and no threads are executing grpc_completion_queue_next */
407void grpc_completion_queue_destroy(grpc_completion_queue *cq);
408
409/* Create a call given a grpc_channel, in order to call 'method'. The request
410 is not sent until grpc_call_invoke is called. All completions are sent to
411 'completion_queue'. */
Craig Tillerc4f0ebe2015-02-02 10:16:30 -0800412grpc_call *grpc_channel_create_call_old(grpc_channel *channel,
413 const char *method, const char *host,
414 gpr_timespec deadline);
Nicolas Nobleb7ebd3b2014-11-26 16:33:03 -0800415
Craig Tiller034929c2015-02-02 16:56:15 -0800416/* Create a call given a grpc_channel, in order to call 'method'. The request
417 is not sent until grpc_call_invoke is called. All completions are sent to
418 'completion_queue'. */
Craig Tillerfb189f82015-02-03 12:07:07 -0800419grpc_call *grpc_channel_create_call(grpc_channel *channel,
420 grpc_completion_queue *completion_queue,
421 const char *method, const char *host,
422 gpr_timespec deadline);
Craig Tiller034929c2015-02-02 16:56:15 -0800423
Craig Tiller08453372015-04-10 16:05:38 -0700424/* Pre-register a method/host pair on a channel. */
425void *grpc_channel_register_call(grpc_channel *channel, const char *method,
426 const char *host);
427
428/* Create a call given a handle returned from grpc_channel_register_call */
429grpc_call *grpc_channel_create_registered_call(grpc_channel *channel,
430 grpc_completion_queue *completion_queue,
431 void *registered_call_handle,
432 gpr_timespec deadline);
433
Craig Tiller034929c2015-02-02 16:56:15 -0800434/* Start a batch of operations defined in the array ops; when complete, post a
Craig Tiller24be0f72015-02-10 14:04:22 -0800435 completion of type 'tag' to the completion queue bound to the call.
Craig Tillerb7800c12015-02-04 18:25:38 -0800436 The order of ops specified in the batch has no significance.
437 Only one operation of each type can be active at once in any given
438 batch. */
Craig Tillerfef76692015-02-02 16:44:26 -0800439grpc_call_error grpc_call_start_batch(grpc_call *call, const grpc_op *ops,
440 size_t nops, void *tag);
441
Craig Tiller29f2b212015-02-17 17:01:24 -0800442/* Create a client channel to 'target'. Additional channel level configuration
443 MAY be provided by grpc_channel_args, though the expectation is that most
444 clients will want to simply pass NULL. See grpc_channel_args definition
445 for more on this. */
Nicolas Nobleb7ebd3b2014-11-26 16:33:03 -0800446grpc_channel *grpc_channel_create(const char *target,
447 const grpc_channel_args *args);
448
Craig Tiller42bc87c2015-02-23 08:50:19 -0800449/* Create a lame client: this client fails every operation attempted on it. */
450grpc_channel *grpc_lame_client_channel_create(void);
451
Nicolas Nobleb7ebd3b2014-11-26 16:33:03 -0800452/* Close and destroy a grpc channel */
453void grpc_channel_destroy(grpc_channel *channel);
454
455/* THREAD-SAFETY for grpc_call
456 The following functions are thread-compatible for any given call:
457 grpc_call_add_metadata
458 grpc_call_invoke
459 grpc_call_start_write
460 grpc_call_writes_done
461 grpc_call_start_read
462 grpc_call_destroy
463 The function grpc_call_cancel is thread-safe, and can be called at any
464 point before grpc_call_destroy is called. */
465
466/* Error handling for grpc_call
467 Most grpc_call functions return a grpc_error. If the error is not GRPC_OK
468 then the operation failed due to some unsatisfied precondition.
469 If a grpc_call fails, it's guaranteed that no change to the call state
470 has been made. */
471
472/* Add a single metadata element to the call, to be sent upon invocation.
473 flags is a bit-field combination of the write flags defined above.
yanggfb3aa262014-12-16 15:29:57 -0800474 REQUIRES: grpc_call_start_invoke/grpc_call_server_end_initial_metadata have
475 not been called on this call.
Nicolas Nobleb7ebd3b2014-11-26 16:33:03 -0800476 Produces no events. */
Craig Tillerc4f0ebe2015-02-02 10:16:30 -0800477grpc_call_error grpc_call_add_metadata_old(grpc_call *call,
478 grpc_metadata *metadata,
479 gpr_uint32 flags);
Nicolas Nobleb7ebd3b2014-11-26 16:33:03 -0800480
481/* Invoke the RPC. Starts sending metadata and request headers on the wire.
482 flags is a bit-field combination of the write flags defined above.
483 REQUIRES: Can be called at most once per call.
484 Can only be called on the client.
Nicolas Nobleb7ebd3b2014-11-26 16:33:03 -0800485 Produces a GRPC_CLIENT_METADATA_READ event with metadata_read_tag when
486 the servers initial metadata has been read.
487 Produces a GRPC_FINISHED event with finished_tag when the call has been
488 completed (there may be other events for the call pending at this
489 time) */
Craig Tillerc4f0ebe2015-02-02 10:16:30 -0800490grpc_call_error grpc_call_invoke_old(grpc_call *call, grpc_completion_queue *cq,
491 void *metadata_read_tag,
492 void *finished_tag, gpr_uint32 flags);
Nicolas Nobleb7ebd3b2014-11-26 16:33:03 -0800493
nnoble0c475f02014-12-05 15:37:39 -0800494/* Accept an incoming RPC, binding a completion queue to it.
495 To be called before sending or receiving messages.
nnoble0c475f02014-12-05 15:37:39 -0800496 REQUIRES: Can be called at most once per call.
497 Can only be called on the server.
498 Produces a GRPC_FINISHED event with finished_tag when the call has been
499 completed (there may be other events for the call pending at this
500 time) */
Craig Tillerc4f0ebe2015-02-02 10:16:30 -0800501grpc_call_error grpc_call_server_accept_old(grpc_call *call,
502 grpc_completion_queue *cq,
503 void *finished_tag);
nnoble0c475f02014-12-05 15:37:39 -0800504
yanggfb3aa262014-12-16 15:29:57 -0800505/* Start sending metadata.
nnoble0c475f02014-12-05 15:37:39 -0800506 To be called before sending messages.
507 flags is a bit-field combination of the write flags defined above.
508 REQUIRES: Can be called at most once per call.
509 Can only be called on the server.
510 Must be called after grpc_call_server_accept */
Craig Tillerc4f0ebe2015-02-02 10:16:30 -0800511grpc_call_error grpc_call_server_end_initial_metadata_old(grpc_call *call,
512 gpr_uint32 flags);
nnoble0c475f02014-12-05 15:37:39 -0800513
Nicolas Nobleb7ebd3b2014-11-26 16:33:03 -0800514/* Called by clients to cancel an RPC on the server.
515 Can be called multiple times, from any thread. */
516grpc_call_error grpc_call_cancel(grpc_call *call);
517
Craig Tillerd248c242015-01-14 11:49:12 -0800518/* Called by clients to cancel an RPC on the server.
Craig Tiller6046dc32015-01-14 12:55:45 -0800519 Can be called multiple times, from any thread.
Craig Tillerd248c242015-01-14 11:49:12 -0800520 If a status has not been received for the call, set it to the status code
Craig Tiller6046dc32015-01-14 12:55:45 -0800521 and description passed in.
Craig Tillerd248c242015-01-14 11:49:12 -0800522 Importantly, this function does not send status nor description to the
523 remote endpoint. */
Craig Tiller6046dc32015-01-14 12:55:45 -0800524grpc_call_error grpc_call_cancel_with_status(grpc_call *call,
525 grpc_status_code status,
526 const char *description);
Craig Tillerd248c242015-01-14 11:49:12 -0800527
Nicolas Nobleb7ebd3b2014-11-26 16:33:03 -0800528/* Queue a byte buffer for writing.
529 flags is a bit-field combination of the write flags defined above.
530 A write with byte_buffer null is allowed, and will not send any bytes on the
531 wire. If this is performed without GRPC_WRITE_BUFFER_HINT flag it provides
532 a mechanism to flush any previously buffered writes to outgoing flow control.
533 REQUIRES: No other writes are pending on the call. It is only safe to
534 start the next write after the corresponding write_accepted event
535 is received.
536 GRPC_INVOKE_ACCEPTED must have been received by the application
537 prior to calling this on the client. On the server,
nnoble0c475f02014-12-05 15:37:39 -0800538 grpc_call_server_end_of_initial_metadata must have been called
539 successfully.
Nicolas Nobleb7ebd3b2014-11-26 16:33:03 -0800540 Produces a GRPC_WRITE_ACCEPTED event. */
Craig Tillerc4f0ebe2015-02-02 10:16:30 -0800541grpc_call_error grpc_call_start_write_old(grpc_call *call,
542 grpc_byte_buffer *byte_buffer,
543 void *tag, gpr_uint32 flags);
Nicolas Nobleb7ebd3b2014-11-26 16:33:03 -0800544
545/* Queue a status for writing.
546 REQUIRES: No other writes are pending on the call.
yanggfb3aa262014-12-16 15:29:57 -0800547 grpc_call_server_end_initial_metadata must have been called on the
548 call prior to calling this.
Nicolas Nobleb7ebd3b2014-11-26 16:33:03 -0800549 Only callable on the server.
550 Produces a GRPC_FINISH_ACCEPTED event when the status is sent. */
Craig Tillerc4f0ebe2015-02-02 10:16:30 -0800551grpc_call_error grpc_call_start_write_status_old(grpc_call *call,
552 grpc_status_code status_code,
553 const char *status_message,
554 void *tag);
Nicolas Nobleb7ebd3b2014-11-26 16:33:03 -0800555
556/* No more messages to send.
557 REQUIRES: No other writes are pending on the call.
558 Only callable on the client.
559 Produces a GRPC_FINISH_ACCEPTED event when all bytes for the call have passed
560 outgoing flow control. */
Craig Tillerc4f0ebe2015-02-02 10:16:30 -0800561grpc_call_error grpc_call_writes_done_old(grpc_call *call, void *tag);
Nicolas Nobleb7ebd3b2014-11-26 16:33:03 -0800562
563/* Initiate a read on a call. Output event contains a byte buffer with the
564 result of the read.
565 REQUIRES: No other reads are pending on the call. It is only safe to start
566 the next read after the corresponding read event is received.
nnoble0c475f02014-12-05 15:37:39 -0800567 On the client:
568 GRPC_INVOKE_ACCEPTED must have been received by the application
569 prior to calling this.
570 On the server:
571 grpc_call_server_accept must be called before calling this.
Nicolas Nobleb7ebd3b2014-11-26 16:33:03 -0800572 Produces a single GRPC_READ event. */
Craig Tillerc4f0ebe2015-02-02 10:16:30 -0800573grpc_call_error grpc_call_start_read_old(grpc_call *call, void *tag);
Nicolas Nobleb7ebd3b2014-11-26 16:33:03 -0800574
575/* Destroy a call. */
576void grpc_call_destroy(grpc_call *call);
577
578/* Request a call on a server.
579 Allows the server to create a single GRPC_SERVER_RPC_NEW event, with tag
580 tag_new.
581 If the call is subsequently cancelled, the cancellation will occur with tag
582 tag_cancel.
583 REQUIRES: Server must not have been shutdown.
584 NOTE: calling this is the only way to obtain GRPC_SERVER_RPC_NEW events. */
Craig Tillerc4f0ebe2015-02-02 10:16:30 -0800585grpc_call_error grpc_server_request_call_old(grpc_server *server,
586 void *tag_new);
Nicolas Nobleb7ebd3b2014-11-26 16:33:03 -0800587
Craig Tillerfada7d42015-02-11 23:03:55 -0800588/* Request notification of a new call */
Craig Tillerfb189f82015-02-03 12:07:07 -0800589grpc_call_error grpc_server_request_call(
Craig Tillerea61b072015-02-03 19:19:27 -0800590 grpc_server *server, grpc_call **call, grpc_call_details *details,
Craig Tillerfb189f82015-02-03 12:07:07 -0800591 grpc_metadata_array *request_metadata,
Craig Tiller06059952015-02-18 08:34:56 -0800592 grpc_completion_queue *cq_bound_to_call,
Craig Tiller8e8fd892015-02-10 17:02:08 -0800593 void *tag_new);
Craig Tiller034929c2015-02-02 16:56:15 -0800594
Craig Tillerfada7d42015-02-11 23:03:55 -0800595/* Registers a method in the server.
596 Methods to this (host, method) pair will not be reported by
Craig Tiller06059952015-02-18 08:34:56 -0800597 grpc_server_request_call, but instead be reported by
Craig Tillerfada7d42015-02-11 23:03:55 -0800598 grpc_server_request_registered_call when passed the appropriate
599 registered_method (as returned by this function).
600 Must be called before grpc_server_start.
601 Returns NULL on failure. */
Craig Tiller24be0f72015-02-10 14:04:22 -0800602void *grpc_server_register_method(grpc_server *server, const char *method,
Craig Tiller06059952015-02-18 08:34:56 -0800603 const char *host,
Craig Tiller20bc56d2015-02-12 09:02:56 -0800604 grpc_completion_queue *new_call_cq);
Craig Tiller24be0f72015-02-10 14:04:22 -0800605
Craig Tillerfada7d42015-02-11 23:03:55 -0800606/* Request notification of a new pre-registered call */
Craig Tiller24be0f72015-02-10 14:04:22 -0800607grpc_call_error grpc_server_request_registered_call(
608 grpc_server *server, void *registered_method, grpc_call **call,
609 gpr_timespec *deadline, grpc_metadata_array *request_metadata,
610 grpc_byte_buffer **optional_payload,
Craig Tiller8e8fd892015-02-10 17:02:08 -0800611 grpc_completion_queue *cq_bound_to_call, void *tag_new);
Craig Tiller24be0f72015-02-10 14:04:22 -0800612
Craig Tiller29f2b212015-02-17 17:01:24 -0800613/* Create a server. Additional configuration for each incoming channel can
Craig Tillere7163ab2015-02-17 20:46:08 -0800614 be specified with args. If no additional configuration is needed, args can
615 be NULL. See grpc_channel_args for more. */
Nicolas Nobleb7ebd3b2014-11-26 16:33:03 -0800616grpc_server *grpc_server_create(grpc_completion_queue *cq,
617 const grpc_channel_args *args);
618
Craig Tillerd251ab92015-02-17 17:22:14 -0800619/* Add a HTTP2 over plaintext over tcp listener.
ctiller570d1f42015-01-12 16:29:52 -0800620 Returns bound port number on success, 0 on failure.
Nicolas Nobleb7ebd3b2014-11-26 16:33:03 -0800621 REQUIRES: server not started */
622int grpc_server_add_http2_port(grpc_server *server, const char *addr);
623
Nicolas Nobleb7ebd3b2014-11-26 16:33:03 -0800624/* Start a server - tells all listeners to start listening */
625void grpc_server_start(grpc_server *server);
626
ctiller9a58df02014-12-11 16:26:49 -0800627/* Begin shutting down a server.
628 After completion, no new calls or connections will be admitted.
Craig Tilleraea2fc02015-02-17 16:54:53 -0800629 Existing calls will be allowed to complete.
630 Shutdown is idempotent. */
Nicolas Nobleb7ebd3b2014-11-26 16:33:03 -0800631void grpc_server_shutdown(grpc_server *server);
632
Craig Tiller4ffdcd52015-01-16 11:34:55 -0800633/* As per grpc_server_shutdown, but send a GRPC_SERVER_SHUTDOWN event when
Craig Tilleraea2fc02015-02-17 16:54:53 -0800634 there are no more calls being serviced.
635 Shutdown is idempotent, and all tags will be notified at once if multiple
636 grpc_server_shutdown_and_notify calls are made. */
Craig Tiller4ffdcd52015-01-16 11:34:55 -0800637void grpc_server_shutdown_and_notify(grpc_server *server, void *tag);
638
ctiller9a58df02014-12-11 16:26:49 -0800639/* Destroy a server.
Craig Tilleraea2fc02015-02-17 16:54:53 -0800640 Forcefully cancels all existing calls.
641 Implies grpc_server_shutdown() if one was not previously performed. */
Nicolas Nobleb7ebd3b2014-11-26 16:33:03 -0800642void grpc_server_destroy(grpc_server *server);
643
644#ifdef __cplusplus
645}
646#endif
647
Nicolas "Pixel" Noble1ff52d52015-03-01 05:24:36 +0100648#endif /* GRPC_GRPC_H */