Nicolas Noble | b7ebd3b | 2014-11-26 16:33:03 -0800 | [diff] [blame] | 1 | /* |
| 2 | * |
| 3 | * Copyright 2014, Google Inc. |
| 4 | * 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 | |
| 34 | #ifndef __GRPC_GRPC_H__ |
| 35 | #define __GRPC_GRPC_H__ |
| 36 | |
| 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 |
| 44 | extern "C" { |
| 45 | #endif |
| 46 | |
Nathaniel Manista | 6d41a05 | 2015-02-16 02:12:48 +0000 | [diff] [blame] | 47 | /* Completion Queues enable notification of the completion of asynchronous |
Nicolas Noble | b7ebd3b | 2014-11-26 16:33:03 -0800 | [diff] [blame] | 48 | actions. */ |
| 49 | typedef struct grpc_completion_queue grpc_completion_queue; |
| 50 | |
| 51 | /* The Channel interface allows creation of Call objects. */ |
| 52 | typedef struct grpc_channel grpc_channel; |
| 53 | |
| 54 | /* A server listens to some port and responds to request calls */ |
| 55 | typedef 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. */ |
| 60 | typedef struct grpc_call grpc_call; |
| 61 | |
| 62 | /* Type specifier for grpc_arg */ |
| 63 | typedef 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. */ |
| 81 | typedef 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 | |
| 95 | /* An array of arguments that can be passed around */ |
| 96 | typedef struct { |
| 97 | size_t num_args; |
| 98 | grpc_arg *args; |
| 99 | } grpc_channel_args; |
| 100 | |
| 101 | /* Channel argument keys: */ |
| 102 | /* Enable census for tracing and stats collection */ |
| 103 | #define GRPC_ARG_ENABLE_CENSUS "grpc.census" |
| 104 | /* Maximum number of concurrent incoming streams to allow on a http2 |
| 105 | connection */ |
| 106 | #define GRPC_ARG_MAX_CONCURRENT_STREAMS "grpc.max_concurrent_streams" |
| 107 | /* Maximum message length that the channel can receive */ |
| 108 | #define GRPC_ARG_MAX_MESSAGE_LENGTH "grpc.max_message_length" |
| 109 | |
Nicolas Noble | b7ebd3b | 2014-11-26 16:33:03 -0800 | [diff] [blame] | 110 | /* Result of a grpc call. If the caller satisfies the prerequisites of a |
| 111 | particular operation, the grpc_call_error returned will be GRPC_CALL_OK. |
| 112 | Receiving any other value listed here is an indication of a bug in the |
| 113 | caller. */ |
| 114 | typedef enum grpc_call_error { |
| 115 | /* everything went ok */ |
| 116 | GRPC_CALL_OK = 0, |
| 117 | /* something failed, we don't know what */ |
| 118 | GRPC_CALL_ERROR, |
| 119 | /* this method is not available on the server */ |
| 120 | GRPC_CALL_ERROR_NOT_ON_SERVER, |
| 121 | /* this method is not available on the client */ |
| 122 | GRPC_CALL_ERROR_NOT_ON_CLIENT, |
nnoble | 0c475f0 | 2014-12-05 15:37:39 -0800 | [diff] [blame] | 123 | /* this method must be called before server_accept */ |
| 124 | GRPC_CALL_ERROR_ALREADY_ACCEPTED, |
Nicolas Noble | b7ebd3b | 2014-11-26 16:33:03 -0800 | [diff] [blame] | 125 | /* this method must be called before invoke */ |
| 126 | GRPC_CALL_ERROR_ALREADY_INVOKED, |
| 127 | /* this method must be called after invoke */ |
| 128 | GRPC_CALL_ERROR_NOT_INVOKED, |
| 129 | /* this call is already finished |
| 130 | (writes_done or write_status has already been called) */ |
| 131 | GRPC_CALL_ERROR_ALREADY_FINISHED, |
| 132 | /* there is already an outstanding read/write operation on the call */ |
| 133 | GRPC_CALL_ERROR_TOO_MANY_OPERATIONS, |
| 134 | /* the flags value was illegal for this call */ |
| 135 | GRPC_CALL_ERROR_INVALID_FLAGS |
| 136 | } grpc_call_error; |
| 137 | |
| 138 | /* Result of a grpc operation */ |
| 139 | typedef enum grpc_op_error { |
| 140 | /* everything went ok */ |
| 141 | GRPC_OP_OK = 0, |
| 142 | /* something failed, we don't know what */ |
| 143 | GRPC_OP_ERROR |
| 144 | } grpc_op_error; |
| 145 | |
| 146 | /* Write Flags: */ |
| 147 | /* Hint that the write may be buffered and need not go out on the wire |
| 148 | immediately. GRPC is free to buffer the message until the next non-buffered |
| 149 | write, or until writes_done, but it need not buffer completely or at all. */ |
| 150 | #define GRPC_WRITE_BUFFER_HINT (0x00000001u) |
| 151 | /* Force compression to be disabled for a particular write |
| 152 | (start_write/add_metadata). Illegal on invoke/accept. */ |
| 153 | #define GRPC_WRITE_NO_COMPRESS (0x00000002u) |
| 154 | |
| 155 | /* A buffer of bytes */ |
| 156 | struct grpc_byte_buffer; |
| 157 | typedef struct grpc_byte_buffer grpc_byte_buffer; |
| 158 | |
Nathaniel Manista | 6d41a05 | 2015-02-16 02:12:48 +0000 | [diff] [blame] | 159 | /* Sample helpers to obtain byte buffers (these will certainly move |
| 160 | someplace else) */ |
Nicolas Noble | b7ebd3b | 2014-11-26 16:33:03 -0800 | [diff] [blame] | 161 | grpc_byte_buffer *grpc_byte_buffer_create(gpr_slice *slices, size_t nslices); |
Craig Tiller | 80fa15c | 2015-01-13 16:10:49 -0800 | [diff] [blame] | 162 | grpc_byte_buffer *grpc_byte_buffer_copy(grpc_byte_buffer *bb); |
Nicolas Noble | b7ebd3b | 2014-11-26 16:33:03 -0800 | [diff] [blame] | 163 | size_t grpc_byte_buffer_length(grpc_byte_buffer *bb); |
| 164 | void grpc_byte_buffer_destroy(grpc_byte_buffer *byte_buffer); |
| 165 | |
| 166 | /* Reader for byte buffers. Iterates over slices in the byte buffer */ |
| 167 | struct grpc_byte_buffer_reader; |
| 168 | typedef struct grpc_byte_buffer_reader grpc_byte_buffer_reader; |
| 169 | |
| 170 | grpc_byte_buffer_reader *grpc_byte_buffer_reader_create( |
| 171 | grpc_byte_buffer *buffer); |
| 172 | /* At the end of the stream, returns 0. Otherwise, returns 1 and sets slice to |
| 173 | be the returned slice. Caller is responsible for calling gpr_slice_unref on |
| 174 | the result. */ |
| 175 | int grpc_byte_buffer_reader_next(grpc_byte_buffer_reader *reader, |
| 176 | gpr_slice *slice); |
| 177 | void grpc_byte_buffer_reader_destroy(grpc_byte_buffer_reader *reader); |
| 178 | |
| 179 | /* A single metadata element */ |
| 180 | typedef struct grpc_metadata { |
Craig Tiller | 4f97273 | 2015-02-05 12:40:20 -0800 | [diff] [blame] | 181 | const char *key; |
| 182 | const char *value; |
Nicolas Noble | b7ebd3b | 2014-11-26 16:33:03 -0800 | [diff] [blame] | 183 | size_t value_length; |
| 184 | } grpc_metadata; |
| 185 | |
| 186 | typedef enum grpc_completion_type { |
Craig Tiller | fef7669 | 2015-02-02 16:44:26 -0800 | [diff] [blame] | 187 | GRPC_QUEUE_SHUTDOWN, /* Shutting down */ |
Craig Tiller | fb189f8 | 2015-02-03 12:07:07 -0800 | [diff] [blame] | 188 | GRPC_OP_COMPLETE, /* operation completion */ |
Craig Tiller | fef7669 | 2015-02-02 16:44:26 -0800 | [diff] [blame] | 189 | GRPC_READ, /* A read has completed */ |
| 190 | GRPC_WRITE_ACCEPTED, /* A write has been accepted by |
| 191 | flow control */ |
Nicolas Noble | b7ebd3b | 2014-11-26 16:33:03 -0800 | [diff] [blame] | 192 | GRPC_FINISH_ACCEPTED, /* writes_done or write_status has been accepted */ |
| 193 | GRPC_CLIENT_METADATA_READ, /* The metadata array sent by server received at |
| 194 | client */ |
Craig Tiller | fef7669 | 2015-02-02 16:44:26 -0800 | [diff] [blame] | 195 | GRPC_FINISHED, /* An RPC has finished. The event contains status. |
| 196 | On the server this will be OK or Cancelled. */ |
Nicolas Noble | b7ebd3b | 2014-11-26 16:33:03 -0800 | [diff] [blame] | 197 | GRPC_SERVER_RPC_NEW, /* A new RPC has arrived at the server */ |
Craig Tiller | 4ffdcd5 | 2015-01-16 11:34:55 -0800 | [diff] [blame] | 198 | GRPC_SERVER_SHUTDOWN, /* The server has finished shutting down */ |
Nicolas Noble | b7ebd3b | 2014-11-26 16:33:03 -0800 | [diff] [blame] | 199 | GRPC_COMPLETION_DO_NOT_USE /* must be last, forces users to include |
| 200 | a default: case */ |
| 201 | } grpc_completion_type; |
| 202 | |
| 203 | typedef struct grpc_event { |
| 204 | grpc_completion_type type; |
| 205 | void *tag; |
| 206 | grpc_call *call; |
| 207 | /* Data associated with the completion type. Field names match the type of |
| 208 | completion as listed in grpc_completion_type. */ |
| 209 | union { |
| 210 | /* Contains a pointer to the buffer that was read, or NULL at the end of a |
| 211 | stream. */ |
| 212 | grpc_byte_buffer *read; |
| 213 | grpc_op_error write_accepted; |
| 214 | grpc_op_error finish_accepted; |
| 215 | grpc_op_error invoke_accepted; |
Craig Tiller | fb189f8 | 2015-02-03 12:07:07 -0800 | [diff] [blame] | 216 | grpc_op_error op_complete; |
Nicolas Noble | b7ebd3b | 2014-11-26 16:33:03 -0800 | [diff] [blame] | 217 | struct { |
| 218 | size_t count; |
| 219 | grpc_metadata *elements; |
| 220 | } client_metadata_read; |
ctiller | 2845cad | 2014-12-15 15:14:12 -0800 | [diff] [blame] | 221 | struct { |
| 222 | grpc_status_code status; |
| 223 | const char *details; |
| 224 | size_t metadata_count; |
| 225 | grpc_metadata *metadata_elements; |
| 226 | } finished; |
Nicolas Noble | b7ebd3b | 2014-11-26 16:33:03 -0800 | [diff] [blame] | 227 | struct { |
| 228 | const char *method; |
| 229 | const char *host; |
| 230 | gpr_timespec deadline; |
| 231 | size_t metadata_count; |
| 232 | grpc_metadata *metadata_elements; |
| 233 | } server_rpc_new; |
| 234 | } data; |
| 235 | } grpc_event; |
| 236 | |
Craig Tiller | fef7669 | 2015-02-02 16:44:26 -0800 | [diff] [blame] | 237 | typedef struct { |
| 238 | size_t count; |
| 239 | size_t capacity; |
| 240 | grpc_metadata *metadata; |
| 241 | } grpc_metadata_array; |
| 242 | |
Craig Tiller | ea61b07 | 2015-02-03 19:19:27 -0800 | [diff] [blame] | 243 | void grpc_metadata_array_init(grpc_metadata_array *array); |
| 244 | void grpc_metadata_array_destroy(grpc_metadata_array *array); |
| 245 | |
Craig Tiller | fef7669 | 2015-02-02 16:44:26 -0800 | [diff] [blame] | 246 | typedef struct { |
Craig Tiller | ea61b07 | 2015-02-03 19:19:27 -0800 | [diff] [blame] | 247 | char *method; |
Craig Tiller | 034929c | 2015-02-02 16:56:15 -0800 | [diff] [blame] | 248 | size_t method_capacity; |
Craig Tiller | ea61b07 | 2015-02-03 19:19:27 -0800 | [diff] [blame] | 249 | char *host; |
Craig Tiller | 034929c | 2015-02-02 16:56:15 -0800 | [diff] [blame] | 250 | size_t host_capacity; |
Craig Tiller | fef7669 | 2015-02-02 16:44:26 -0800 | [diff] [blame] | 251 | gpr_timespec deadline; |
| 252 | } grpc_call_details; |
| 253 | |
Craig Tiller | ea61b07 | 2015-02-03 19:19:27 -0800 | [diff] [blame] | 254 | void grpc_call_details_init(grpc_call_details *details); |
| 255 | void grpc_call_details_destroy(grpc_call_details *details); |
| 256 | |
Craig Tiller | fef7669 | 2015-02-02 16:44:26 -0800 | [diff] [blame] | 257 | typedef enum { |
Craig Tiller | b7800c1 | 2015-02-04 18:25:38 -0800 | [diff] [blame] | 258 | /* Send initial metadata: one and only one instance MUST be sent for each call, |
| 259 | unless the call was cancelled - in which case this can be skipped */ |
Craig Tiller | fef7669 | 2015-02-02 16:44:26 -0800 | [diff] [blame] | 260 | GRPC_OP_SEND_INITIAL_METADATA = 0, |
Craig Tiller | b7800c1 | 2015-02-04 18:25:38 -0800 | [diff] [blame] | 261 | /* Send a message: 0 or more of these operations can occur for each call */ |
Craig Tiller | fef7669 | 2015-02-02 16:44:26 -0800 | [diff] [blame] | 262 | GRPC_OP_SEND_MESSAGE, |
Craig Tiller | b7800c1 | 2015-02-04 18:25:38 -0800 | [diff] [blame] | 263 | /* Send a close from the server: one and only one instance MUST be sent from the client, |
| 264 | unless the call was cancelled - in which case this can be skipped */ |
Craig Tiller | fef7669 | 2015-02-02 16:44:26 -0800 | [diff] [blame] | 265 | GRPC_OP_SEND_CLOSE_FROM_CLIENT, |
Craig Tiller | b7800c1 | 2015-02-04 18:25:38 -0800 | [diff] [blame] | 266 | /* Send status from the server: one and only one instance MUST be sent from the server |
| 267 | unless the call was cancelled - in which case this can be skipped */ |
Craig Tiller | fef7669 | 2015-02-02 16:44:26 -0800 | [diff] [blame] | 268 | GRPC_OP_SEND_STATUS_FROM_SERVER, |
Craig Tiller | b7800c1 | 2015-02-04 18:25:38 -0800 | [diff] [blame] | 269 | /* Receive initial metadata: one and only one MUST be made on the client, must |
| 270 | not be made on the server */ |
Craig Tiller | fef7669 | 2015-02-02 16:44:26 -0800 | [diff] [blame] | 271 | GRPC_OP_RECV_INITIAL_METADATA, |
Craig Tiller | b7800c1 | 2015-02-04 18:25:38 -0800 | [diff] [blame] | 272 | /* Receive a message: 0 or more of these operations can occur for each call */ |
Craig Tiller | fb189f8 | 2015-02-03 12:07:07 -0800 | [diff] [blame] | 273 | GRPC_OP_RECV_MESSAGE, |
Craig Tiller | b7800c1 | 2015-02-04 18:25:38 -0800 | [diff] [blame] | 274 | /* Receive status on the client: one and only one must be made on the client */ |
Craig Tiller | fef7669 | 2015-02-02 16:44:26 -0800 | [diff] [blame] | 275 | GRPC_OP_RECV_STATUS_ON_CLIENT, |
Craig Tiller | b7800c1 | 2015-02-04 18:25:38 -0800 | [diff] [blame] | 276 | /* Receive status on the server: one and only one must be made on the server */ |
Craig Tiller | fef7669 | 2015-02-02 16:44:26 -0800 | [diff] [blame] | 277 | GRPC_OP_RECV_CLOSE_ON_SERVER |
| 278 | } grpc_op_type; |
| 279 | |
Craig Tiller | b7800c1 | 2015-02-04 18:25:38 -0800 | [diff] [blame] | 280 | /* Operation data: one field for each op type (except SEND_CLOSE_FROM_CLIENT which has |
| 281 | no arguments) */ |
Craig Tiller | fef7669 | 2015-02-02 16:44:26 -0800 | [diff] [blame] | 282 | typedef struct grpc_op { |
| 283 | grpc_op_type op; |
| 284 | union { |
| 285 | struct { |
| 286 | size_t count; |
| 287 | const grpc_metadata *metadata; |
| 288 | } send_initial_metadata; |
| 289 | grpc_byte_buffer *send_message; |
| 290 | struct { |
| 291 | size_t trailing_metadata_count; |
| 292 | grpc_metadata *trailing_metadata; |
| 293 | grpc_status_code status; |
| 294 | const char *status_details; |
| 295 | } send_status_from_server; |
Craig Tiller | 4f97273 | 2015-02-05 12:40:20 -0800 | [diff] [blame] | 296 | /* ownership of the array is with the caller, but ownership of the elements |
Craig Tiller | c56b2cb | 2015-02-05 16:35:38 -0800 | [diff] [blame] | 297 | stays with the call object (ie key, value members are owned by the call |
| 298 | object, recv_initial_metadata->array is owned by the caller). |
| 299 | After the operation completes, call grpc_metadata_array_destroy on this |
| 300 | value, or reuse it in a future op. */ |
Craig Tiller | fef7669 | 2015-02-02 16:44:26 -0800 | [diff] [blame] | 301 | grpc_metadata_array *recv_initial_metadata; |
| 302 | grpc_byte_buffer **recv_message; |
| 303 | struct { |
Craig Tiller | 4f97273 | 2015-02-05 12:40:20 -0800 | [diff] [blame] | 304 | /* ownership of the array is with the caller, but ownership of the elements |
Craig Tiller | c56b2cb | 2015-02-05 16:35:38 -0800 | [diff] [blame] | 305 | stays with the call object (ie key, value members are owned by the call |
| 306 | object, trailing_metadata->array is owned by the caller). |
| 307 | After the operation completes, call grpc_metadata_array_destroy on this |
| 308 | value, or reuse it in a future op. */ |
Craig Tiller | fef7669 | 2015-02-02 16:44:26 -0800 | [diff] [blame] | 309 | grpc_metadata_array *trailing_metadata; |
| 310 | grpc_status_code *status; |
Craig Tiller | c56b2cb | 2015-02-05 16:35:38 -0800 | [diff] [blame] | 311 | /* status_details is a buffer owned by the application before the op completes |
| 312 | and after the op has completed. During the operation status_details may be |
| 313 | reallocated to a size larger than *status_details_capacity, in which case |
| 314 | *status_details_capacity will be updated with the new array capacity. |
| 315 | |
| 316 | Pre-allocating space: |
| 317 | size_t my_capacity = 8; |
| 318 | char *my_details = gpr_malloc(my_capacity); |
| 319 | x.status_details = &my_details; |
| 320 | x.status_details_capacity = &my_capacity; |
| 321 | |
| 322 | Not pre-allocating space: |
| 323 | size_t my_capacity = 0; |
| 324 | char *my_details = NULL; |
| 325 | x.status_details = &my_details; |
| 326 | x.status_details_capacity = &my_capacity; |
| 327 | |
| 328 | After the call: |
| 329 | gpr_free(my_details); */ |
Craig Tiller | fef7669 | 2015-02-02 16:44:26 -0800 | [diff] [blame] | 330 | char **status_details; |
| 331 | size_t *status_details_capacity; |
| 332 | } recv_status_on_client; |
| 333 | struct { |
Craig Tiller | 0a5bcbc | 2015-02-09 21:39:04 -0800 | [diff] [blame] | 334 | /* out argument, set to 1 if the call failed in any way (seen as a cancellation |
| 335 | on the server), or 0 if the call succeeded */ |
Craig Tiller | fef7669 | 2015-02-02 16:44:26 -0800 | [diff] [blame] | 336 | int *cancelled; |
| 337 | } recv_close_on_server; |
| 338 | } data; |
| 339 | } grpc_op; |
| 340 | |
Nicolas Noble | b7ebd3b | 2014-11-26 16:33:03 -0800 | [diff] [blame] | 341 | /* Initialize the grpc library */ |
Craig Tiller | 32946d3 | 2015-01-15 11:37:30 -0800 | [diff] [blame] | 342 | void grpc_init(void); |
Nicolas Noble | b7ebd3b | 2014-11-26 16:33:03 -0800 | [diff] [blame] | 343 | |
Nathaniel Manista | 6d41a05 | 2015-02-16 02:12:48 +0000 | [diff] [blame] | 344 | /* Shut down the grpc library */ |
Craig Tiller | 32946d3 | 2015-01-15 11:37:30 -0800 | [diff] [blame] | 345 | void grpc_shutdown(void); |
Nicolas Noble | b7ebd3b | 2014-11-26 16:33:03 -0800 | [diff] [blame] | 346 | |
Craig Tiller | 32946d3 | 2015-01-15 11:37:30 -0800 | [diff] [blame] | 347 | grpc_completion_queue *grpc_completion_queue_create(void); |
Nicolas Noble | b7ebd3b | 2014-11-26 16:33:03 -0800 | [diff] [blame] | 348 | |
Nathaniel Manista | 6d41a05 | 2015-02-16 02:12:48 +0000 | [diff] [blame] | 349 | /* Blocks until an event is available, the completion queue is being shut down, |
Nicolas Noble | b7ebd3b | 2014-11-26 16:33:03 -0800 | [diff] [blame] | 350 | or deadline is reached. Returns NULL on timeout, otherwise the event that |
| 351 | occurred. Callers should call grpc_event_finish once they have processed |
| 352 | the event. |
| 353 | |
| 354 | Callers must not call grpc_completion_queue_next and |
| 355 | grpc_completion_queue_pluck simultaneously on the same completion queue. */ |
| 356 | grpc_event *grpc_completion_queue_next(grpc_completion_queue *cq, |
| 357 | gpr_timespec deadline); |
| 358 | |
| 359 | /* Blocks until an event with tag 'tag' is available, the completion queue is |
| 360 | being shutdown or deadline is reached. Returns NULL on timeout, or a pointer |
| 361 | to the event that occurred. Callers should call grpc_event_finish once they |
| 362 | have processed the event. |
| 363 | |
| 364 | Callers must not call grpc_completion_queue_next and |
| 365 | grpc_completion_queue_pluck simultaneously on the same completion queue. */ |
| 366 | grpc_event *grpc_completion_queue_pluck(grpc_completion_queue *cq, void *tag, |
| 367 | gpr_timespec deadline); |
| 368 | |
Nathaniel Manista | 6d41a05 | 2015-02-16 02:12:48 +0000 | [diff] [blame] | 369 | /* Clean up any data owned by the event */ |
Nicolas Noble | b7ebd3b | 2014-11-26 16:33:03 -0800 | [diff] [blame] | 370 | void grpc_event_finish(grpc_event *event); |
| 371 | |
| 372 | /* Begin destruction of a completion queue. Once all possible events are |
| 373 | drained it's safe to call grpc_completion_queue_destroy. */ |
| 374 | void grpc_completion_queue_shutdown(grpc_completion_queue *cq); |
| 375 | |
| 376 | /* Destroy a completion queue. The caller must ensure that the queue is |
| 377 | drained and no threads are executing grpc_completion_queue_next */ |
| 378 | void grpc_completion_queue_destroy(grpc_completion_queue *cq); |
| 379 | |
| 380 | /* Create a call given a grpc_channel, in order to call 'method'. The request |
| 381 | is not sent until grpc_call_invoke is called. All completions are sent to |
| 382 | 'completion_queue'. */ |
Craig Tiller | c4f0ebe | 2015-02-02 10:16:30 -0800 | [diff] [blame] | 383 | grpc_call *grpc_channel_create_call_old(grpc_channel *channel, |
| 384 | const char *method, const char *host, |
| 385 | gpr_timespec deadline); |
Nicolas Noble | b7ebd3b | 2014-11-26 16:33:03 -0800 | [diff] [blame] | 386 | |
Craig Tiller | 034929c | 2015-02-02 16:56:15 -0800 | [diff] [blame] | 387 | /* Create a call given a grpc_channel, in order to call 'method'. The request |
| 388 | is not sent until grpc_call_invoke is called. All completions are sent to |
| 389 | 'completion_queue'. */ |
Craig Tiller | fb189f8 | 2015-02-03 12:07:07 -0800 | [diff] [blame] | 390 | grpc_call *grpc_channel_create_call(grpc_channel *channel, |
| 391 | grpc_completion_queue *completion_queue, |
| 392 | const char *method, const char *host, |
| 393 | gpr_timespec deadline); |
Craig Tiller | 034929c | 2015-02-02 16:56:15 -0800 | [diff] [blame] | 394 | |
| 395 | /* Start a batch of operations defined in the array ops; when complete, post a |
Craig Tiller | b7800c1 | 2015-02-04 18:25:38 -0800 | [diff] [blame] | 396 | completion of type 'tag' to the completion queue bound to the call. |
| 397 | The order of ops specified in the batch has no significance. |
| 398 | Only one operation of each type can be active at once in any given |
| 399 | batch. */ |
Craig Tiller | fef7669 | 2015-02-02 16:44:26 -0800 | [diff] [blame] | 400 | grpc_call_error grpc_call_start_batch(grpc_call *call, const grpc_op *ops, |
| 401 | size_t nops, void *tag); |
| 402 | |
Nicolas Noble | b7ebd3b | 2014-11-26 16:33:03 -0800 | [diff] [blame] | 403 | /* Create a client channel */ |
| 404 | grpc_channel *grpc_channel_create(const char *target, |
| 405 | const grpc_channel_args *args); |
| 406 | |
| 407 | /* Close and destroy a grpc channel */ |
| 408 | void grpc_channel_destroy(grpc_channel *channel); |
| 409 | |
| 410 | /* THREAD-SAFETY for grpc_call |
| 411 | The following functions are thread-compatible for any given call: |
| 412 | grpc_call_add_metadata |
| 413 | grpc_call_invoke |
| 414 | grpc_call_start_write |
| 415 | grpc_call_writes_done |
| 416 | grpc_call_start_read |
| 417 | grpc_call_destroy |
| 418 | The function grpc_call_cancel is thread-safe, and can be called at any |
| 419 | point before grpc_call_destroy is called. */ |
| 420 | |
| 421 | /* Error handling for grpc_call |
| 422 | Most grpc_call functions return a grpc_error. If the error is not GRPC_OK |
| 423 | then the operation failed due to some unsatisfied precondition. |
| 424 | If a grpc_call fails, it's guaranteed that no change to the call state |
| 425 | has been made. */ |
| 426 | |
| 427 | /* Add a single metadata element to the call, to be sent upon invocation. |
| 428 | flags is a bit-field combination of the write flags defined above. |
yangg | fb3aa26 | 2014-12-16 15:29:57 -0800 | [diff] [blame] | 429 | REQUIRES: grpc_call_start_invoke/grpc_call_server_end_initial_metadata have |
| 430 | not been called on this call. |
Nicolas Noble | b7ebd3b | 2014-11-26 16:33:03 -0800 | [diff] [blame] | 431 | Produces no events. */ |
Craig Tiller | c4f0ebe | 2015-02-02 10:16:30 -0800 | [diff] [blame] | 432 | grpc_call_error grpc_call_add_metadata_old(grpc_call *call, |
| 433 | grpc_metadata *metadata, |
| 434 | gpr_uint32 flags); |
Nicolas Noble | b7ebd3b | 2014-11-26 16:33:03 -0800 | [diff] [blame] | 435 | |
| 436 | /* Invoke the RPC. Starts sending metadata and request headers on the wire. |
| 437 | flags is a bit-field combination of the write flags defined above. |
| 438 | REQUIRES: Can be called at most once per call. |
| 439 | Can only be called on the client. |
Nicolas Noble | b7ebd3b | 2014-11-26 16:33:03 -0800 | [diff] [blame] | 440 | Produces a GRPC_CLIENT_METADATA_READ event with metadata_read_tag when |
| 441 | the servers initial metadata has been read. |
| 442 | Produces a GRPC_FINISHED event with finished_tag when the call has been |
| 443 | completed (there may be other events for the call pending at this |
| 444 | time) */ |
Craig Tiller | c4f0ebe | 2015-02-02 10:16:30 -0800 | [diff] [blame] | 445 | grpc_call_error grpc_call_invoke_old(grpc_call *call, grpc_completion_queue *cq, |
| 446 | void *metadata_read_tag, |
| 447 | void *finished_tag, gpr_uint32 flags); |
Nicolas Noble | b7ebd3b | 2014-11-26 16:33:03 -0800 | [diff] [blame] | 448 | |
nnoble | 0c475f0 | 2014-12-05 15:37:39 -0800 | [diff] [blame] | 449 | /* Accept an incoming RPC, binding a completion queue to it. |
| 450 | To be called before sending or receiving messages. |
nnoble | 0c475f0 | 2014-12-05 15:37:39 -0800 | [diff] [blame] | 451 | REQUIRES: Can be called at most once per call. |
| 452 | Can only be called on the server. |
| 453 | Produces a GRPC_FINISHED event with finished_tag when the call has been |
| 454 | completed (there may be other events for the call pending at this |
| 455 | time) */ |
Craig Tiller | c4f0ebe | 2015-02-02 10:16:30 -0800 | [diff] [blame] | 456 | grpc_call_error grpc_call_server_accept_old(grpc_call *call, |
| 457 | grpc_completion_queue *cq, |
| 458 | void *finished_tag); |
nnoble | 0c475f0 | 2014-12-05 15:37:39 -0800 | [diff] [blame] | 459 | |
yangg | fb3aa26 | 2014-12-16 15:29:57 -0800 | [diff] [blame] | 460 | /* Start sending metadata. |
nnoble | 0c475f0 | 2014-12-05 15:37:39 -0800 | [diff] [blame] | 461 | To be called before sending messages. |
| 462 | flags is a bit-field combination of the write flags defined above. |
| 463 | REQUIRES: Can be called at most once per call. |
| 464 | Can only be called on the server. |
| 465 | Must be called after grpc_call_server_accept */ |
Craig Tiller | c4f0ebe | 2015-02-02 10:16:30 -0800 | [diff] [blame] | 466 | grpc_call_error grpc_call_server_end_initial_metadata_old(grpc_call *call, |
| 467 | gpr_uint32 flags); |
nnoble | 0c475f0 | 2014-12-05 15:37:39 -0800 | [diff] [blame] | 468 | |
Nicolas Noble | b7ebd3b | 2014-11-26 16:33:03 -0800 | [diff] [blame] | 469 | /* Called by clients to cancel an RPC on the server. |
| 470 | Can be called multiple times, from any thread. */ |
| 471 | grpc_call_error grpc_call_cancel(grpc_call *call); |
| 472 | |
Craig Tiller | d248c24 | 2015-01-14 11:49:12 -0800 | [diff] [blame] | 473 | /* Called by clients to cancel an RPC on the server. |
Craig Tiller | 6046dc3 | 2015-01-14 12:55:45 -0800 | [diff] [blame] | 474 | Can be called multiple times, from any thread. |
Craig Tiller | d248c24 | 2015-01-14 11:49:12 -0800 | [diff] [blame] | 475 | If a status has not been received for the call, set it to the status code |
Craig Tiller | 6046dc3 | 2015-01-14 12:55:45 -0800 | [diff] [blame] | 476 | and description passed in. |
Craig Tiller | d248c24 | 2015-01-14 11:49:12 -0800 | [diff] [blame] | 477 | Importantly, this function does not send status nor description to the |
| 478 | remote endpoint. */ |
Craig Tiller | 6046dc3 | 2015-01-14 12:55:45 -0800 | [diff] [blame] | 479 | grpc_call_error grpc_call_cancel_with_status(grpc_call *call, |
| 480 | grpc_status_code status, |
| 481 | const char *description); |
Craig Tiller | d248c24 | 2015-01-14 11:49:12 -0800 | [diff] [blame] | 482 | |
Nicolas Noble | b7ebd3b | 2014-11-26 16:33:03 -0800 | [diff] [blame] | 483 | /* Queue a byte buffer for writing. |
| 484 | flags is a bit-field combination of the write flags defined above. |
| 485 | A write with byte_buffer null is allowed, and will not send any bytes on the |
| 486 | wire. If this is performed without GRPC_WRITE_BUFFER_HINT flag it provides |
| 487 | a mechanism to flush any previously buffered writes to outgoing flow control. |
| 488 | REQUIRES: No other writes are pending on the call. It is only safe to |
| 489 | start the next write after the corresponding write_accepted event |
| 490 | is received. |
| 491 | GRPC_INVOKE_ACCEPTED must have been received by the application |
| 492 | prior to calling this on the client. On the server, |
nnoble | 0c475f0 | 2014-12-05 15:37:39 -0800 | [diff] [blame] | 493 | grpc_call_server_end_of_initial_metadata must have been called |
| 494 | successfully. |
Nicolas Noble | b7ebd3b | 2014-11-26 16:33:03 -0800 | [diff] [blame] | 495 | Produces a GRPC_WRITE_ACCEPTED event. */ |
Craig Tiller | c4f0ebe | 2015-02-02 10:16:30 -0800 | [diff] [blame] | 496 | grpc_call_error grpc_call_start_write_old(grpc_call *call, |
| 497 | grpc_byte_buffer *byte_buffer, |
| 498 | void *tag, gpr_uint32 flags); |
Nicolas Noble | b7ebd3b | 2014-11-26 16:33:03 -0800 | [diff] [blame] | 499 | |
| 500 | /* Queue a status for writing. |
| 501 | REQUIRES: No other writes are pending on the call. |
yangg | fb3aa26 | 2014-12-16 15:29:57 -0800 | [diff] [blame] | 502 | grpc_call_server_end_initial_metadata must have been called on the |
| 503 | call prior to calling this. |
Nicolas Noble | b7ebd3b | 2014-11-26 16:33:03 -0800 | [diff] [blame] | 504 | Only callable on the server. |
| 505 | Produces a GRPC_FINISH_ACCEPTED event when the status is sent. */ |
Craig Tiller | c4f0ebe | 2015-02-02 10:16:30 -0800 | [diff] [blame] | 506 | grpc_call_error grpc_call_start_write_status_old(grpc_call *call, |
| 507 | grpc_status_code status_code, |
| 508 | const char *status_message, |
| 509 | void *tag); |
Nicolas Noble | b7ebd3b | 2014-11-26 16:33:03 -0800 | [diff] [blame] | 510 | |
| 511 | /* No more messages to send. |
| 512 | REQUIRES: No other writes are pending on the call. |
| 513 | Only callable on the client. |
| 514 | Produces a GRPC_FINISH_ACCEPTED event when all bytes for the call have passed |
| 515 | outgoing flow control. */ |
Craig Tiller | c4f0ebe | 2015-02-02 10:16:30 -0800 | [diff] [blame] | 516 | grpc_call_error grpc_call_writes_done_old(grpc_call *call, void *tag); |
Nicolas Noble | b7ebd3b | 2014-11-26 16:33:03 -0800 | [diff] [blame] | 517 | |
| 518 | /* Initiate a read on a call. Output event contains a byte buffer with the |
| 519 | result of the read. |
| 520 | REQUIRES: No other reads are pending on the call. It is only safe to start |
| 521 | the next read after the corresponding read event is received. |
nnoble | 0c475f0 | 2014-12-05 15:37:39 -0800 | [diff] [blame] | 522 | On the client: |
| 523 | GRPC_INVOKE_ACCEPTED must have been received by the application |
| 524 | prior to calling this. |
| 525 | On the server: |
| 526 | grpc_call_server_accept must be called before calling this. |
Nicolas Noble | b7ebd3b | 2014-11-26 16:33:03 -0800 | [diff] [blame] | 527 | Produces a single GRPC_READ event. */ |
Craig Tiller | c4f0ebe | 2015-02-02 10:16:30 -0800 | [diff] [blame] | 528 | grpc_call_error grpc_call_start_read_old(grpc_call *call, void *tag); |
Nicolas Noble | b7ebd3b | 2014-11-26 16:33:03 -0800 | [diff] [blame] | 529 | |
| 530 | /* Destroy a call. */ |
| 531 | void grpc_call_destroy(grpc_call *call); |
| 532 | |
| 533 | /* Request a call on a server. |
| 534 | Allows the server to create a single GRPC_SERVER_RPC_NEW event, with tag |
| 535 | tag_new. |
| 536 | If the call is subsequently cancelled, the cancellation will occur with tag |
| 537 | tag_cancel. |
| 538 | REQUIRES: Server must not have been shutdown. |
| 539 | NOTE: calling this is the only way to obtain GRPC_SERVER_RPC_NEW events. */ |
Craig Tiller | c4f0ebe | 2015-02-02 10:16:30 -0800 | [diff] [blame] | 540 | grpc_call_error grpc_server_request_call_old(grpc_server *server, |
| 541 | void *tag_new); |
Nicolas Noble | b7ebd3b | 2014-11-26 16:33:03 -0800 | [diff] [blame] | 542 | |
Craig Tiller | fb189f8 | 2015-02-03 12:07:07 -0800 | [diff] [blame] | 543 | grpc_call_error grpc_server_request_call( |
Craig Tiller | ea61b07 | 2015-02-03 19:19:27 -0800 | [diff] [blame] | 544 | grpc_server *server, grpc_call **call, grpc_call_details *details, |
Craig Tiller | fb189f8 | 2015-02-03 12:07:07 -0800 | [diff] [blame] | 545 | grpc_metadata_array *request_metadata, |
| 546 | grpc_completion_queue *completion_queue, void *tag_new); |
Craig Tiller | 034929c | 2015-02-02 16:56:15 -0800 | [diff] [blame] | 547 | |
Nicolas Noble | b7ebd3b | 2014-11-26 16:33:03 -0800 | [diff] [blame] | 548 | /* Create a server */ |
| 549 | grpc_server *grpc_server_create(grpc_completion_queue *cq, |
| 550 | const grpc_channel_args *args); |
| 551 | |
Craig Tiller | d251ab9 | 2015-02-17 17:22:14 -0800 | [diff] [blame^] | 552 | /* Add a HTTP2 over plaintext over tcp listener. |
ctiller | 570d1f4 | 2015-01-12 16:29:52 -0800 | [diff] [blame] | 553 | Returns bound port number on success, 0 on failure. |
Nicolas Noble | b7ebd3b | 2014-11-26 16:33:03 -0800 | [diff] [blame] | 554 | REQUIRES: server not started */ |
| 555 | int grpc_server_add_http2_port(grpc_server *server, const char *addr); |
| 556 | |
Nicolas Noble | b7ebd3b | 2014-11-26 16:33:03 -0800 | [diff] [blame] | 557 | /* Start a server - tells all listeners to start listening */ |
| 558 | void grpc_server_start(grpc_server *server); |
| 559 | |
ctiller | 9a58df0 | 2014-12-11 16:26:49 -0800 | [diff] [blame] | 560 | /* Begin shutting down a server. |
| 561 | After completion, no new calls or connections will be admitted. |
| 562 | Existing calls will be allowed to complete. */ |
Nicolas Noble | b7ebd3b | 2014-11-26 16:33:03 -0800 | [diff] [blame] | 563 | void grpc_server_shutdown(grpc_server *server); |
| 564 | |
Craig Tiller | 4ffdcd5 | 2015-01-16 11:34:55 -0800 | [diff] [blame] | 565 | /* As per grpc_server_shutdown, but send a GRPC_SERVER_SHUTDOWN event when |
| 566 | there are no more calls being serviced. */ |
| 567 | void grpc_server_shutdown_and_notify(grpc_server *server, void *tag); |
| 568 | |
ctiller | 9a58df0 | 2014-12-11 16:26:49 -0800 | [diff] [blame] | 569 | /* Destroy a server. |
| 570 | Forcefully cancels all existing calls. */ |
Nicolas Noble | b7ebd3b | 2014-11-26 16:33:03 -0800 | [diff] [blame] | 571 | void grpc_server_destroy(grpc_server *server); |
| 572 | |
| 573 | #ifdef __cplusplus |
| 574 | } |
| 575 | #endif |
| 576 | |
Craig Tiller | b5dcec5 | 2015-01-13 11:13:42 -0800 | [diff] [blame] | 577 | #endif /* __GRPC_GRPC_H__ */ |