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 | |
| 47 | /* Completion Channels enable notification of the completion of asynchronous |
| 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 | |
| 159 | /* Sample helpers to obtain byte buffers (these will certainly move place */ |
| 160 | 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] | 161 | grpc_byte_buffer *grpc_byte_buffer_copy(grpc_byte_buffer *bb); |
Nicolas Noble | b7ebd3b | 2014-11-26 16:33:03 -0800 | [diff] [blame] | 162 | size_t grpc_byte_buffer_length(grpc_byte_buffer *bb); |
| 163 | void grpc_byte_buffer_destroy(grpc_byte_buffer *byte_buffer); |
| 164 | |
| 165 | /* Reader for byte buffers. Iterates over slices in the byte buffer */ |
| 166 | struct grpc_byte_buffer_reader; |
| 167 | typedef struct grpc_byte_buffer_reader grpc_byte_buffer_reader; |
| 168 | |
| 169 | grpc_byte_buffer_reader *grpc_byte_buffer_reader_create( |
| 170 | grpc_byte_buffer *buffer); |
| 171 | /* At the end of the stream, returns 0. Otherwise, returns 1 and sets slice to |
| 172 | be the returned slice. Caller is responsible for calling gpr_slice_unref on |
| 173 | the result. */ |
| 174 | int grpc_byte_buffer_reader_next(grpc_byte_buffer_reader *reader, |
| 175 | gpr_slice *slice); |
| 176 | void grpc_byte_buffer_reader_destroy(grpc_byte_buffer_reader *reader); |
| 177 | |
| 178 | /* A single metadata element */ |
| 179 | typedef struct grpc_metadata { |
| 180 | char *key; |
| 181 | char *value; |
| 182 | size_t value_length; |
| 183 | } grpc_metadata; |
| 184 | |
| 185 | typedef enum grpc_completion_type { |
Craig Tiller | fef7669 | 2015-02-02 16:44:26 -0800 | [diff] [blame] | 186 | GRPC_QUEUE_SHUTDOWN, /* Shutting down */ |
| 187 | GRPC_IOREQ, /* grpc_call_ioreq completion */ |
| 188 | GRPC_READ, /* A read has completed */ |
| 189 | GRPC_WRITE_ACCEPTED, /* A write has been accepted by |
| 190 | flow control */ |
Nicolas Noble | b7ebd3b | 2014-11-26 16:33:03 -0800 | [diff] [blame] | 191 | GRPC_FINISH_ACCEPTED, /* writes_done or write_status has been accepted */ |
| 192 | GRPC_CLIENT_METADATA_READ, /* The metadata array sent by server received at |
| 193 | client */ |
Craig Tiller | fef7669 | 2015-02-02 16:44:26 -0800 | [diff] [blame] | 194 | GRPC_FINISHED, /* An RPC has finished. The event contains status. |
| 195 | On the server this will be OK or Cancelled. */ |
Nicolas Noble | b7ebd3b | 2014-11-26 16:33:03 -0800 | [diff] [blame] | 196 | GRPC_SERVER_RPC_NEW, /* A new RPC has arrived at the server */ |
Craig Tiller | 4ffdcd5 | 2015-01-16 11:34:55 -0800 | [diff] [blame] | 197 | GRPC_SERVER_SHUTDOWN, /* The server has finished shutting down */ |
Nicolas Noble | b7ebd3b | 2014-11-26 16:33:03 -0800 | [diff] [blame] | 198 | GRPC_COMPLETION_DO_NOT_USE /* must be last, forces users to include |
| 199 | a default: case */ |
| 200 | } grpc_completion_type; |
| 201 | |
| 202 | typedef struct grpc_event { |
| 203 | grpc_completion_type type; |
| 204 | void *tag; |
| 205 | grpc_call *call; |
| 206 | /* Data associated with the completion type. Field names match the type of |
| 207 | completion as listed in grpc_completion_type. */ |
| 208 | union { |
| 209 | /* Contains a pointer to the buffer that was read, or NULL at the end of a |
| 210 | stream. */ |
| 211 | grpc_byte_buffer *read; |
| 212 | grpc_op_error write_accepted; |
| 213 | grpc_op_error finish_accepted; |
| 214 | grpc_op_error invoke_accepted; |
Craig Tiller | fef7669 | 2015-02-02 16:44:26 -0800 | [diff] [blame] | 215 | grpc_op_error ioreq; |
Nicolas Noble | b7ebd3b | 2014-11-26 16:33:03 -0800 | [diff] [blame] | 216 | struct { |
| 217 | size_t count; |
| 218 | grpc_metadata *elements; |
| 219 | } client_metadata_read; |
ctiller | 2845cad | 2014-12-15 15:14:12 -0800 | [diff] [blame] | 220 | struct { |
| 221 | grpc_status_code status; |
| 222 | const char *details; |
| 223 | size_t metadata_count; |
| 224 | grpc_metadata *metadata_elements; |
| 225 | } finished; |
Nicolas Noble | b7ebd3b | 2014-11-26 16:33:03 -0800 | [diff] [blame] | 226 | struct { |
| 227 | const char *method; |
| 228 | const char *host; |
| 229 | gpr_timespec deadline; |
| 230 | size_t metadata_count; |
| 231 | grpc_metadata *metadata_elements; |
| 232 | } server_rpc_new; |
| 233 | } data; |
| 234 | } grpc_event; |
| 235 | |
Craig Tiller | fef7669 | 2015-02-02 16:44:26 -0800 | [diff] [blame] | 236 | typedef struct { |
| 237 | size_t count; |
| 238 | size_t capacity; |
| 239 | grpc_metadata *metadata; |
| 240 | } grpc_metadata_array; |
| 241 | |
| 242 | typedef struct { |
| 243 | const char *method; |
Craig Tiller | 034929c | 2015-02-02 16:56:15 -0800 | [diff] [blame^] | 244 | size_t method_capacity; |
Craig Tiller | fef7669 | 2015-02-02 16:44:26 -0800 | [diff] [blame] | 245 | const char *host; |
Craig Tiller | 034929c | 2015-02-02 16:56:15 -0800 | [diff] [blame^] | 246 | size_t host_capacity; |
Craig Tiller | fef7669 | 2015-02-02 16:44:26 -0800 | [diff] [blame] | 247 | gpr_timespec deadline; |
| 248 | } grpc_call_details; |
| 249 | |
| 250 | typedef enum { |
| 251 | GRPC_OP_SEND_INITIAL_METADATA = 0, |
| 252 | GRPC_OP_SEND_MESSAGE, |
| 253 | GRPC_OP_SEND_CLOSE_FROM_CLIENT, |
| 254 | GRPC_OP_SEND_STATUS_FROM_SERVER, |
| 255 | GRPC_OP_RECV_INITIAL_METADATA, |
| 256 | GRPC_OP_RECV_MESSAGES, |
| 257 | GRPC_OP_RECV_STATUS_ON_CLIENT, |
| 258 | GRPC_OP_RECV_CLOSE_ON_SERVER |
| 259 | } grpc_op_type; |
| 260 | |
| 261 | typedef struct grpc_op { |
| 262 | grpc_op_type op; |
| 263 | union { |
| 264 | struct { |
| 265 | size_t count; |
| 266 | const grpc_metadata *metadata; |
| 267 | } send_initial_metadata; |
| 268 | grpc_byte_buffer *send_message; |
| 269 | struct { |
| 270 | size_t trailing_metadata_count; |
| 271 | grpc_metadata *trailing_metadata; |
| 272 | grpc_status_code status; |
| 273 | const char *status_details; |
| 274 | } send_status_from_server; |
| 275 | grpc_metadata_array *recv_initial_metadata; |
| 276 | grpc_byte_buffer **recv_message; |
| 277 | struct { |
| 278 | grpc_metadata_array *trailing_metadata; |
| 279 | grpc_status_code *status; |
| 280 | char **status_details; |
| 281 | size_t *status_details_capacity; |
| 282 | } recv_status_on_client; |
| 283 | struct { |
| 284 | int *cancelled; |
| 285 | } recv_close_on_server; |
| 286 | } data; |
| 287 | } grpc_op; |
| 288 | |
Nicolas Noble | b7ebd3b | 2014-11-26 16:33:03 -0800 | [diff] [blame] | 289 | /* Initialize the grpc library */ |
Craig Tiller | 32946d3 | 2015-01-15 11:37:30 -0800 | [diff] [blame] | 290 | void grpc_init(void); |
Nicolas Noble | b7ebd3b | 2014-11-26 16:33:03 -0800 | [diff] [blame] | 291 | |
| 292 | /* Shutdown the grpc library */ |
Craig Tiller | 32946d3 | 2015-01-15 11:37:30 -0800 | [diff] [blame] | 293 | void grpc_shutdown(void); |
Nicolas Noble | b7ebd3b | 2014-11-26 16:33:03 -0800 | [diff] [blame] | 294 | |
Craig Tiller | 32946d3 | 2015-01-15 11:37:30 -0800 | [diff] [blame] | 295 | grpc_completion_queue *grpc_completion_queue_create(void); |
Nicolas Noble | b7ebd3b | 2014-11-26 16:33:03 -0800 | [diff] [blame] | 296 | |
| 297 | /* Blocks until an event is available, the completion queue is being shutdown, |
| 298 | or deadline is reached. Returns NULL on timeout, otherwise the event that |
| 299 | occurred. Callers should call grpc_event_finish once they have processed |
| 300 | the event. |
| 301 | |
| 302 | Callers must not call grpc_completion_queue_next and |
| 303 | grpc_completion_queue_pluck simultaneously on the same completion queue. */ |
| 304 | grpc_event *grpc_completion_queue_next(grpc_completion_queue *cq, |
| 305 | gpr_timespec deadline); |
| 306 | |
| 307 | /* Blocks until an event with tag 'tag' is available, the completion queue is |
| 308 | being shutdown or deadline is reached. Returns NULL on timeout, or a pointer |
| 309 | to the event that occurred. Callers should call grpc_event_finish once they |
| 310 | have processed the event. |
| 311 | |
| 312 | Callers must not call grpc_completion_queue_next and |
| 313 | grpc_completion_queue_pluck simultaneously on the same completion queue. */ |
| 314 | grpc_event *grpc_completion_queue_pluck(grpc_completion_queue *cq, void *tag, |
| 315 | gpr_timespec deadline); |
| 316 | |
| 317 | /* Cleanup any data owned by the event */ |
| 318 | void grpc_event_finish(grpc_event *event); |
| 319 | |
| 320 | /* Begin destruction of a completion queue. Once all possible events are |
| 321 | drained it's safe to call grpc_completion_queue_destroy. */ |
| 322 | void grpc_completion_queue_shutdown(grpc_completion_queue *cq); |
| 323 | |
| 324 | /* Destroy a completion queue. The caller must ensure that the queue is |
| 325 | drained and no threads are executing grpc_completion_queue_next */ |
| 326 | void grpc_completion_queue_destroy(grpc_completion_queue *cq); |
| 327 | |
| 328 | /* Create a call given a grpc_channel, in order to call 'method'. The request |
| 329 | is not sent until grpc_call_invoke is called. All completions are sent to |
| 330 | 'completion_queue'. */ |
Craig Tiller | c4f0ebe | 2015-02-02 10:16:30 -0800 | [diff] [blame] | 331 | grpc_call *grpc_channel_create_call_old(grpc_channel *channel, |
| 332 | const char *method, const char *host, |
| 333 | gpr_timespec deadline); |
Nicolas Noble | b7ebd3b | 2014-11-26 16:33:03 -0800 | [diff] [blame] | 334 | |
Craig Tiller | 034929c | 2015-02-02 16:56:15 -0800 | [diff] [blame^] | 335 | /* Create a call given a grpc_channel, in order to call 'method'. The request |
| 336 | is not sent until grpc_call_invoke is called. All completions are sent to |
| 337 | 'completion_queue'. */ |
| 338 | grpc_call *grpc_channel_create_call_old(grpc_channel *channel, |
| 339 | grpc_completion_queue *completion_queue, |
| 340 | const char *method, const char *host, |
| 341 | gpr_timespec deadline); |
| 342 | |
| 343 | /* Start a batch of operations defined in the array ops; when complete, post a |
| 344 | * completion of type 'tag' to the completion queue bound to the call. */ |
Craig Tiller | fef7669 | 2015-02-02 16:44:26 -0800 | [diff] [blame] | 345 | grpc_call_error grpc_call_start_batch(grpc_call *call, const grpc_op *ops, |
| 346 | size_t nops, void *tag); |
| 347 | |
Nicolas Noble | b7ebd3b | 2014-11-26 16:33:03 -0800 | [diff] [blame] | 348 | /* Create a client channel */ |
| 349 | grpc_channel *grpc_channel_create(const char *target, |
| 350 | const grpc_channel_args *args); |
| 351 | |
| 352 | /* Close and destroy a grpc channel */ |
| 353 | void grpc_channel_destroy(grpc_channel *channel); |
| 354 | |
| 355 | /* THREAD-SAFETY for grpc_call |
| 356 | The following functions are thread-compatible for any given call: |
| 357 | grpc_call_add_metadata |
| 358 | grpc_call_invoke |
| 359 | grpc_call_start_write |
| 360 | grpc_call_writes_done |
| 361 | grpc_call_start_read |
| 362 | grpc_call_destroy |
| 363 | The function grpc_call_cancel is thread-safe, and can be called at any |
| 364 | point before grpc_call_destroy is called. */ |
| 365 | |
| 366 | /* Error handling for grpc_call |
| 367 | Most grpc_call functions return a grpc_error. If the error is not GRPC_OK |
| 368 | then the operation failed due to some unsatisfied precondition. |
| 369 | If a grpc_call fails, it's guaranteed that no change to the call state |
| 370 | has been made. */ |
| 371 | |
| 372 | /* Add a single metadata element to the call, to be sent upon invocation. |
| 373 | flags is a bit-field combination of the write flags defined above. |
yangg | fb3aa26 | 2014-12-16 15:29:57 -0800 | [diff] [blame] | 374 | REQUIRES: grpc_call_start_invoke/grpc_call_server_end_initial_metadata have |
| 375 | not been called on this call. |
Nicolas Noble | b7ebd3b | 2014-11-26 16:33:03 -0800 | [diff] [blame] | 376 | Produces no events. */ |
Craig Tiller | c4f0ebe | 2015-02-02 10:16:30 -0800 | [diff] [blame] | 377 | grpc_call_error grpc_call_add_metadata_old(grpc_call *call, |
| 378 | grpc_metadata *metadata, |
| 379 | gpr_uint32 flags); |
Nicolas Noble | b7ebd3b | 2014-11-26 16:33:03 -0800 | [diff] [blame] | 380 | |
| 381 | /* Invoke the RPC. Starts sending metadata and request headers on the wire. |
| 382 | flags is a bit-field combination of the write flags defined above. |
| 383 | REQUIRES: Can be called at most once per call. |
| 384 | Can only be called on the client. |
Nicolas Noble | b7ebd3b | 2014-11-26 16:33:03 -0800 | [diff] [blame] | 385 | Produces a GRPC_CLIENT_METADATA_READ event with metadata_read_tag when |
| 386 | the servers initial metadata has been read. |
| 387 | Produces a GRPC_FINISHED event with finished_tag when the call has been |
| 388 | completed (there may be other events for the call pending at this |
| 389 | time) */ |
Craig Tiller | c4f0ebe | 2015-02-02 10:16:30 -0800 | [diff] [blame] | 390 | grpc_call_error grpc_call_invoke_old(grpc_call *call, grpc_completion_queue *cq, |
| 391 | void *metadata_read_tag, |
| 392 | void *finished_tag, gpr_uint32 flags); |
Nicolas Noble | b7ebd3b | 2014-11-26 16:33:03 -0800 | [diff] [blame] | 393 | |
nnoble | 0c475f0 | 2014-12-05 15:37:39 -0800 | [diff] [blame] | 394 | /* Accept an incoming RPC, binding a completion queue to it. |
| 395 | To be called before sending or receiving messages. |
nnoble | 0c475f0 | 2014-12-05 15:37:39 -0800 | [diff] [blame] | 396 | REQUIRES: Can be called at most once per call. |
| 397 | Can only be called on the server. |
| 398 | Produces a GRPC_FINISHED event with finished_tag when the call has been |
| 399 | completed (there may be other events for the call pending at this |
| 400 | time) */ |
Craig Tiller | c4f0ebe | 2015-02-02 10:16:30 -0800 | [diff] [blame] | 401 | grpc_call_error grpc_call_server_accept_old(grpc_call *call, |
| 402 | grpc_completion_queue *cq, |
| 403 | void *finished_tag); |
nnoble | 0c475f0 | 2014-12-05 15:37:39 -0800 | [diff] [blame] | 404 | |
yangg | fb3aa26 | 2014-12-16 15:29:57 -0800 | [diff] [blame] | 405 | /* Start sending metadata. |
nnoble | 0c475f0 | 2014-12-05 15:37:39 -0800 | [diff] [blame] | 406 | To be called before sending messages. |
| 407 | flags is a bit-field combination of the write flags defined above. |
| 408 | REQUIRES: Can be called at most once per call. |
| 409 | Can only be called on the server. |
| 410 | Must be called after grpc_call_server_accept */ |
Craig Tiller | c4f0ebe | 2015-02-02 10:16:30 -0800 | [diff] [blame] | 411 | grpc_call_error grpc_call_server_end_initial_metadata_old(grpc_call *call, |
| 412 | gpr_uint32 flags); |
nnoble | 0c475f0 | 2014-12-05 15:37:39 -0800 | [diff] [blame] | 413 | |
Nicolas Noble | b7ebd3b | 2014-11-26 16:33:03 -0800 | [diff] [blame] | 414 | /* Called by clients to cancel an RPC on the server. |
| 415 | Can be called multiple times, from any thread. */ |
| 416 | grpc_call_error grpc_call_cancel(grpc_call *call); |
| 417 | |
Craig Tiller | d248c24 | 2015-01-14 11:49:12 -0800 | [diff] [blame] | 418 | /* Called by clients to cancel an RPC on the server. |
Craig Tiller | 6046dc3 | 2015-01-14 12:55:45 -0800 | [diff] [blame] | 419 | Can be called multiple times, from any thread. |
Craig Tiller | d248c24 | 2015-01-14 11:49:12 -0800 | [diff] [blame] | 420 | 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] | 421 | and description passed in. |
Craig Tiller | d248c24 | 2015-01-14 11:49:12 -0800 | [diff] [blame] | 422 | Importantly, this function does not send status nor description to the |
| 423 | remote endpoint. */ |
Craig Tiller | 6046dc3 | 2015-01-14 12:55:45 -0800 | [diff] [blame] | 424 | grpc_call_error grpc_call_cancel_with_status(grpc_call *call, |
| 425 | grpc_status_code status, |
| 426 | const char *description); |
Craig Tiller | d248c24 | 2015-01-14 11:49:12 -0800 | [diff] [blame] | 427 | |
Nicolas Noble | b7ebd3b | 2014-11-26 16:33:03 -0800 | [diff] [blame] | 428 | /* Queue a byte buffer for writing. |
| 429 | flags is a bit-field combination of the write flags defined above. |
| 430 | A write with byte_buffer null is allowed, and will not send any bytes on the |
| 431 | wire. If this is performed without GRPC_WRITE_BUFFER_HINT flag it provides |
| 432 | a mechanism to flush any previously buffered writes to outgoing flow control. |
| 433 | REQUIRES: No other writes are pending on the call. It is only safe to |
| 434 | start the next write after the corresponding write_accepted event |
| 435 | is received. |
| 436 | GRPC_INVOKE_ACCEPTED must have been received by the application |
| 437 | prior to calling this on the client. On the server, |
nnoble | 0c475f0 | 2014-12-05 15:37:39 -0800 | [diff] [blame] | 438 | grpc_call_server_end_of_initial_metadata must have been called |
| 439 | successfully. |
Nicolas Noble | b7ebd3b | 2014-11-26 16:33:03 -0800 | [diff] [blame] | 440 | Produces a GRPC_WRITE_ACCEPTED event. */ |
Craig Tiller | c4f0ebe | 2015-02-02 10:16:30 -0800 | [diff] [blame] | 441 | grpc_call_error grpc_call_start_write_old(grpc_call *call, |
| 442 | grpc_byte_buffer *byte_buffer, |
| 443 | void *tag, gpr_uint32 flags); |
Nicolas Noble | b7ebd3b | 2014-11-26 16:33:03 -0800 | [diff] [blame] | 444 | |
| 445 | /* Queue a status for writing. |
| 446 | REQUIRES: No other writes are pending on the call. |
yangg | fb3aa26 | 2014-12-16 15:29:57 -0800 | [diff] [blame] | 447 | grpc_call_server_end_initial_metadata must have been called on the |
| 448 | call prior to calling this. |
Nicolas Noble | b7ebd3b | 2014-11-26 16:33:03 -0800 | [diff] [blame] | 449 | Only callable on the server. |
| 450 | Produces a GRPC_FINISH_ACCEPTED event when the status is sent. */ |
Craig Tiller | c4f0ebe | 2015-02-02 10:16:30 -0800 | [diff] [blame] | 451 | grpc_call_error grpc_call_start_write_status_old(grpc_call *call, |
| 452 | grpc_status_code status_code, |
| 453 | const char *status_message, |
| 454 | void *tag); |
Nicolas Noble | b7ebd3b | 2014-11-26 16:33:03 -0800 | [diff] [blame] | 455 | |
| 456 | /* No more messages to send. |
| 457 | REQUIRES: No other writes are pending on the call. |
| 458 | Only callable on the client. |
| 459 | Produces a GRPC_FINISH_ACCEPTED event when all bytes for the call have passed |
| 460 | outgoing flow control. */ |
Craig Tiller | c4f0ebe | 2015-02-02 10:16:30 -0800 | [diff] [blame] | 461 | 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] | 462 | |
| 463 | /* Initiate a read on a call. Output event contains a byte buffer with the |
| 464 | result of the read. |
| 465 | REQUIRES: No other reads are pending on the call. It is only safe to start |
| 466 | the next read after the corresponding read event is received. |
nnoble | 0c475f0 | 2014-12-05 15:37:39 -0800 | [diff] [blame] | 467 | On the client: |
| 468 | GRPC_INVOKE_ACCEPTED must have been received by the application |
| 469 | prior to calling this. |
| 470 | On the server: |
| 471 | grpc_call_server_accept must be called before calling this. |
Nicolas Noble | b7ebd3b | 2014-11-26 16:33:03 -0800 | [diff] [blame] | 472 | Produces a single GRPC_READ event. */ |
Craig Tiller | c4f0ebe | 2015-02-02 10:16:30 -0800 | [diff] [blame] | 473 | 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] | 474 | |
| 475 | /* Destroy a call. */ |
| 476 | void grpc_call_destroy(grpc_call *call); |
| 477 | |
| 478 | /* Request a call on a server. |
| 479 | Allows the server to create a single GRPC_SERVER_RPC_NEW event, with tag |
| 480 | tag_new. |
| 481 | If the call is subsequently cancelled, the cancellation will occur with tag |
| 482 | tag_cancel. |
| 483 | REQUIRES: Server must not have been shutdown. |
| 484 | 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] | 485 | grpc_call_error grpc_server_request_call_old(grpc_server *server, |
| 486 | void *tag_new); |
Nicolas Noble | b7ebd3b | 2014-11-26 16:33:03 -0800 | [diff] [blame] | 487 | |
Craig Tiller | 034929c | 2015-02-02 16:56:15 -0800 | [diff] [blame^] | 488 | grpc_call_error grpc_server_request_call(grpc_server *server, |
| 489 | grpc_call_details *details, |
| 490 | grpc_metadata_array *request_metadata, |
| 491 | grpc_completion_queue *completion_queue, |
| 492 | void *tag_new); |
| 493 | |
Nicolas Noble | b7ebd3b | 2014-11-26 16:33:03 -0800 | [diff] [blame] | 494 | /* Create a server */ |
| 495 | grpc_server *grpc_server_create(grpc_completion_queue *cq, |
| 496 | const grpc_channel_args *args); |
| 497 | |
ctiller | 570d1f4 | 2015-01-12 16:29:52 -0800 | [diff] [blame] | 498 | /* Add a http2 over tcp listener. |
| 499 | Returns bound port number on success, 0 on failure. |
Nicolas Noble | b7ebd3b | 2014-11-26 16:33:03 -0800 | [diff] [blame] | 500 | REQUIRES: server not started */ |
| 501 | int grpc_server_add_http2_port(grpc_server *server, const char *addr); |
| 502 | |
murgatroid99 | c896e19 | 2015-01-21 11:36:23 -0800 | [diff] [blame] | 503 | /* Add a secure port to server. |
| 504 | Returns bound port number on success, 0 on failure. |
Nicolas Noble | b7ebd3b | 2014-11-26 16:33:03 -0800 | [diff] [blame] | 505 | REQUIRES: server not started */ |
| 506 | int grpc_server_add_secure_http2_port(grpc_server *server, const char *addr); |
| 507 | |
| 508 | /* Start a server - tells all listeners to start listening */ |
| 509 | void grpc_server_start(grpc_server *server); |
| 510 | |
ctiller | 9a58df0 | 2014-12-11 16:26:49 -0800 | [diff] [blame] | 511 | /* Begin shutting down a server. |
| 512 | After completion, no new calls or connections will be admitted. |
| 513 | Existing calls will be allowed to complete. */ |
Nicolas Noble | b7ebd3b | 2014-11-26 16:33:03 -0800 | [diff] [blame] | 514 | void grpc_server_shutdown(grpc_server *server); |
| 515 | |
Craig Tiller | 4ffdcd5 | 2015-01-16 11:34:55 -0800 | [diff] [blame] | 516 | /* As per grpc_server_shutdown, but send a GRPC_SERVER_SHUTDOWN event when |
| 517 | there are no more calls being serviced. */ |
| 518 | void grpc_server_shutdown_and_notify(grpc_server *server, void *tag); |
| 519 | |
ctiller | 9a58df0 | 2014-12-11 16:26:49 -0800 | [diff] [blame] | 520 | /* Destroy a server. |
| 521 | Forcefully cancels all existing calls. */ |
Nicolas Noble | b7ebd3b | 2014-11-26 16:33:03 -0800 | [diff] [blame] | 522 | void grpc_server_destroy(grpc_server *server); |
| 523 | |
| 524 | #ifdef __cplusplus |
| 525 | } |
| 526 | #endif |
| 527 | |
Craig Tiller | b5dcec5 | 2015-01-13 11:13:42 -0800 | [diff] [blame] | 528 | #endif /* __GRPC_GRPC_H__ */ |