Nicolas Noble | b7ebd3b | 2014-11-26 16:33:03 -0800 | [diff] [blame] | 1 | /* |
| 2 | * |
Craig Tiller | 0605995 | 2015-02-18 08:34:56 -0800 | [diff] [blame] | 3 | * Copyright 2015, Google Inc. |
Nicolas Noble | b7ebd3b | 2014-11-26 16:33:03 -0800 | [diff] [blame] | 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 | |
Nicolas "Pixel" Noble | 1ff52d5 | 2015-03-01 05:24:36 +0100 | [diff] [blame] | 34 | #ifndef GRPC_GRPC_H |
| 35 | #define GRPC_GRPC_H |
Nicolas Noble | b7ebd3b | 2014-11-26 16:33:03 -0800 | [diff] [blame] | 36 | |
| 37 | #include <grpc/status.h> |
| 38 | |
| 39 | #include <stddef.h> |
David Garcia Quintas | 25d02d5 | 2015-06-04 17:40:54 -0700 | [diff] [blame] | 40 | #include <grpc/byte_buffer.h> |
Nicolas Noble | b7ebd3b | 2014-11-26 16:33:03 -0800 | [diff] [blame] | 41 | #include <grpc/support/slice.h> |
| 42 | #include <grpc/support/time.h> |
| 43 | |
| 44 | #ifdef __cplusplus |
| 45 | extern "C" { |
| 46 | #endif |
| 47 | |
Nathaniel Manista | 6d41a05 | 2015-02-16 02:12:48 +0000 | [diff] [blame] | 48 | /* Completion Queues enable notification of the completion of asynchronous |
Nicolas Noble | b7ebd3b | 2014-11-26 16:33:03 -0800 | [diff] [blame] | 49 | actions. */ |
| 50 | typedef struct grpc_completion_queue grpc_completion_queue; |
| 51 | |
| 52 | /* The Channel interface allows creation of Call objects. */ |
| 53 | typedef struct grpc_channel grpc_channel; |
| 54 | |
| 55 | /* A server listens to some port and responds to request calls */ |
| 56 | typedef struct grpc_server grpc_server; |
| 57 | |
| 58 | /* A Call represents an RPC. When created, it is in a configuration state |
| 59 | allowing properties to be set until it is invoked. After invoke, the Call |
| 60 | can have messages written to it and read from it. */ |
| 61 | typedef struct grpc_call grpc_call; |
| 62 | |
| 63 | /* Type specifier for grpc_arg */ |
| 64 | typedef enum { |
| 65 | GRPC_ARG_STRING, |
| 66 | GRPC_ARG_INTEGER, |
| 67 | GRPC_ARG_POINTER |
| 68 | } grpc_arg_type; |
| 69 | |
| 70 | /* A single argument... each argument has a key and a value |
| 71 | |
| 72 | A note on naming keys: |
| 73 | Keys are namespaced into groups, usually grouped by library, and are |
| 74 | keys for module XYZ are named XYZ.key1, XYZ.key2, etc. Module names must |
| 75 | be restricted to the regex [A-Za-z][_A-Za-z0-9]{,15}. |
| 76 | Key names must be restricted to the regex [A-Za-z][_A-Za-z0-9]{,47}. |
| 77 | |
| 78 | GRPC core library keys are prefixed by grpc. |
| 79 | |
| 80 | Library authors are strongly encouraged to #define symbolic constants for |
| 81 | their keys so that it's possible to change them in the future. */ |
| 82 | typedef struct { |
| 83 | grpc_arg_type type; |
| 84 | char *key; |
| 85 | union { |
| 86 | char *string; |
| 87 | int integer; |
| 88 | struct { |
| 89 | void *p; |
| 90 | void *(*copy)(void *p); |
| 91 | void (*destroy)(void *p); |
| 92 | } pointer; |
| 93 | } value; |
| 94 | } grpc_arg; |
| 95 | |
Craig Tiller | e793ba1 | 2015-05-18 09:37:22 -0700 | [diff] [blame] | 96 | /** An array of arguments that can be passed around. |
David Garcia Quintas | 02c677c | 2015-06-02 14:40:07 -0700 | [diff] [blame] | 97 | |
Craig Tiller | e793ba1 | 2015-05-18 09:37:22 -0700 | [diff] [blame] | 98 | Used to set optional channel-level configuration. |
| 99 | These configuration options are modelled as key-value pairs as defined |
| 100 | by grpc_arg; keys are strings to allow easy backwards-compatible extension |
| 101 | by arbitrary parties. |
Masood Malekghassemi | 7128a90 | 2015-06-17 13:17:58 -0700 | [diff] [blame] | 102 | All evaluation is performed at channel creation time (i.e. the values in |
| 103 | this structure need only live through the creation invocation). */ |
Nicolas Noble | b7ebd3b | 2014-11-26 16:33:03 -0800 | [diff] [blame] | 104 | typedef struct { |
| 105 | size_t num_args; |
| 106 | grpc_arg *args; |
| 107 | } grpc_channel_args; |
| 108 | |
| 109 | /* Channel argument keys: */ |
| 110 | /* Enable census for tracing and stats collection */ |
| 111 | #define GRPC_ARG_ENABLE_CENSUS "grpc.census" |
| 112 | /* Maximum number of concurrent incoming streams to allow on a http2 |
| 113 | connection */ |
| 114 | #define GRPC_ARG_MAX_CONCURRENT_STREAMS "grpc.max_concurrent_streams" |
| 115 | /* Maximum message length that the channel can receive */ |
| 116 | #define GRPC_ARG_MAX_MESSAGE_LENGTH "grpc.max_message_length" |
Craig Tiller | 8802558 | 2015-05-04 09:41:10 -0700 | [diff] [blame] | 117 | /* Initial sequence number for http2 transports */ |
| 118 | #define GRPC_ARG_HTTP2_INITIAL_SEQUENCE_NUMBER \ |
| 119 | "grpc.http2.initial_sequence_number" |
Nicolas Noble | b7ebd3b | 2014-11-26 16:33:03 -0800 | [diff] [blame] | 120 | |
Nicolas Noble | b7ebd3b | 2014-11-26 16:33:03 -0800 | [diff] [blame] | 121 | /* Result of a grpc call. If the caller satisfies the prerequisites of a |
| 122 | particular operation, the grpc_call_error returned will be GRPC_CALL_OK. |
| 123 | Receiving any other value listed here is an indication of a bug in the |
| 124 | caller. */ |
| 125 | typedef enum grpc_call_error { |
| 126 | /* everything went ok */ |
| 127 | GRPC_CALL_OK = 0, |
| 128 | /* something failed, we don't know what */ |
| 129 | GRPC_CALL_ERROR, |
| 130 | /* this method is not available on the server */ |
| 131 | GRPC_CALL_ERROR_NOT_ON_SERVER, |
| 132 | /* this method is not available on the client */ |
| 133 | GRPC_CALL_ERROR_NOT_ON_CLIENT, |
nnoble | 0c475f0 | 2014-12-05 15:37:39 -0800 | [diff] [blame] | 134 | /* this method must be called before server_accept */ |
| 135 | GRPC_CALL_ERROR_ALREADY_ACCEPTED, |
Nicolas Noble | b7ebd3b | 2014-11-26 16:33:03 -0800 | [diff] [blame] | 136 | /* this method must be called before invoke */ |
| 137 | GRPC_CALL_ERROR_ALREADY_INVOKED, |
| 138 | /* this method must be called after invoke */ |
| 139 | GRPC_CALL_ERROR_NOT_INVOKED, |
| 140 | /* this call is already finished |
| 141 | (writes_done or write_status has already been called) */ |
| 142 | GRPC_CALL_ERROR_ALREADY_FINISHED, |
| 143 | /* there is already an outstanding read/write operation on the call */ |
| 144 | GRPC_CALL_ERROR_TOO_MANY_OPERATIONS, |
| 145 | /* the flags value was illegal for this call */ |
Craig Tiller | b96d001 | 2015-05-06 15:33:23 -0700 | [diff] [blame] | 146 | GRPC_CALL_ERROR_INVALID_FLAGS, |
| 147 | /* invalid metadata was passed to this call */ |
| 148 | GRPC_CALL_ERROR_INVALID_METADATA |
Nicolas Noble | b7ebd3b | 2014-11-26 16:33:03 -0800 | [diff] [blame] | 149 | } grpc_call_error; |
| 150 | |
Nicolas Noble | b7ebd3b | 2014-11-26 16:33:03 -0800 | [diff] [blame] | 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) |
David Garcia Quintas | 1d5aca5 | 2015-06-14 14:42:04 -0700 | [diff] [blame] | 159 | /* Mask of all valid flags. */ |
| 160 | #define GRPC_WRITE_USED_MASK (GRPC_WRITE_BUFFER_HINT | GRPC_WRITE_NO_COMPRESS) |
Nicolas Noble | b7ebd3b | 2014-11-26 16:33:03 -0800 | [diff] [blame] | 161 | |
Nicolas Noble | b7ebd3b | 2014-11-26 16:33:03 -0800 | [diff] [blame] | 162 | /* A single metadata element */ |
| 163 | typedef struct grpc_metadata { |
Craig Tiller | 4f97273 | 2015-02-05 12:40:20 -0800 | [diff] [blame] | 164 | const char *key; |
| 165 | const char *value; |
Nicolas Noble | b7ebd3b | 2014-11-26 16:33:03 -0800 | [diff] [blame] | 166 | size_t value_length; |
Craig Tiller | 6902ad2 | 2015-04-16 08:01:49 -0700 | [diff] [blame] | 167 | |
| 168 | /* The following fields are reserved for grpc internal use. |
| 169 | There is no need to initialize them, and they will be set to garbage during |
| 170 | calls to grpc. */ |
| 171 | struct { |
Craig Tiller | 9c9d4e0 | 2015-04-20 09:03:29 -0700 | [diff] [blame] | 172 | void *obfuscated[3]; |
Craig Tiller | 6902ad2 | 2015-04-16 08:01:49 -0700 | [diff] [blame] | 173 | } internal_data; |
Nicolas Noble | b7ebd3b | 2014-11-26 16:33:03 -0800 | [diff] [blame] | 174 | } grpc_metadata; |
| 175 | |
Craig Tiller | 73b66ef | 2015-05-18 20:46:47 -0700 | [diff] [blame] | 176 | /** The type of completion (for grpc_event) */ |
Nicolas Noble | b7ebd3b | 2014-11-26 16:33:03 -0800 | [diff] [blame] | 177 | typedef enum grpc_completion_type { |
Craig Tiller | e793ba1 | 2015-05-18 09:37:22 -0700 | [diff] [blame] | 178 | /** Shutting down */ |
David Garcia Quintas | 1d5aca5 | 2015-06-14 14:42:04 -0700 | [diff] [blame] | 179 | GRPC_QUEUE_SHUTDOWN, |
Craig Tiller | e793ba1 | 2015-05-18 09:37:22 -0700 | [diff] [blame] | 180 | /** No event before timeout */ |
David Garcia Quintas | 1d5aca5 | 2015-06-14 14:42:04 -0700 | [diff] [blame] | 181 | GRPC_QUEUE_TIMEOUT, |
Craig Tiller | e793ba1 | 2015-05-18 09:37:22 -0700 | [diff] [blame] | 182 | /** Operation completion */ |
David Garcia Quintas | 1d5aca5 | 2015-06-14 14:42:04 -0700 | [diff] [blame] | 183 | GRPC_OP_COMPLETE |
Nicolas Noble | b7ebd3b | 2014-11-26 16:33:03 -0800 | [diff] [blame] | 184 | } grpc_completion_type; |
| 185 | |
Craig Tiller | e793ba1 | 2015-05-18 09:37:22 -0700 | [diff] [blame] | 186 | /** The result of an operation. |
| 187 | |
| 188 | Returned by a completion queue when the operation started with tag. */ |
Nicolas Noble | b7ebd3b | 2014-11-26 16:33:03 -0800 | [diff] [blame] | 189 | typedef struct grpc_event { |
Craig Tiller | e793ba1 | 2015-05-18 09:37:22 -0700 | [diff] [blame] | 190 | /** The type of the completion. */ |
Nicolas Noble | b7ebd3b | 2014-11-26 16:33:03 -0800 | [diff] [blame] | 191 | grpc_completion_type type; |
David Garcia Quintas | 1d5aca5 | 2015-06-14 14:42:04 -0700 | [diff] [blame] | 192 | /** non-zero if the operation was successful, 0 upon failure. |
Craig Tiller | e793ba1 | 2015-05-18 09:37:22 -0700 | [diff] [blame] | 193 | Only GRPC_OP_COMPLETE can succeed or fail. */ |
Craig Tiller | 64be9f7 | 2015-05-04 14:53:51 -0700 | [diff] [blame] | 194 | int success; |
Craig Tiller | e793ba1 | 2015-05-18 09:37:22 -0700 | [diff] [blame] | 195 | /** The tag passed to grpc_call_start_batch etc to start this operation. |
| 196 | Only GRPC_OP_COMPLETE has a tag. */ |
Nicolas Noble | b7ebd3b | 2014-11-26 16:33:03 -0800 | [diff] [blame] | 197 | void *tag; |
Nicolas Noble | b7ebd3b | 2014-11-26 16:33:03 -0800 | [diff] [blame] | 198 | } grpc_event; |
| 199 | |
Craig Tiller | fef7669 | 2015-02-02 16:44:26 -0800 | [diff] [blame] | 200 | typedef struct { |
| 201 | size_t count; |
| 202 | size_t capacity; |
| 203 | grpc_metadata *metadata; |
| 204 | } grpc_metadata_array; |
| 205 | |
Craig Tiller | ea61b07 | 2015-02-03 19:19:27 -0800 | [diff] [blame] | 206 | void grpc_metadata_array_init(grpc_metadata_array *array); |
| 207 | void grpc_metadata_array_destroy(grpc_metadata_array *array); |
| 208 | |
Craig Tiller | fef7669 | 2015-02-02 16:44:26 -0800 | [diff] [blame] | 209 | typedef struct { |
Craig Tiller | ea61b07 | 2015-02-03 19:19:27 -0800 | [diff] [blame] | 210 | char *method; |
Craig Tiller | 034929c | 2015-02-02 16:56:15 -0800 | [diff] [blame] | 211 | size_t method_capacity; |
Craig Tiller | ea61b07 | 2015-02-03 19:19:27 -0800 | [diff] [blame] | 212 | char *host; |
Craig Tiller | 034929c | 2015-02-02 16:56:15 -0800 | [diff] [blame] | 213 | size_t host_capacity; |
Craig Tiller | fef7669 | 2015-02-02 16:44:26 -0800 | [diff] [blame] | 214 | gpr_timespec deadline; |
| 215 | } grpc_call_details; |
| 216 | |
Craig Tiller | ea61b07 | 2015-02-03 19:19:27 -0800 | [diff] [blame] | 217 | void grpc_call_details_init(grpc_call_details *details); |
| 218 | void grpc_call_details_destroy(grpc_call_details *details); |
| 219 | |
Craig Tiller | fef7669 | 2015-02-02 16:44:26 -0800 | [diff] [blame] | 220 | typedef enum { |
Craig Tiller | 24be0f7 | 2015-02-10 14:04:22 -0800 | [diff] [blame] | 221 | /* Send initial metadata: one and only one instance MUST be sent for each |
| 222 | call, |
Craig Tiller | b7800c1 | 2015-02-04 18:25:38 -0800 | [diff] [blame] | 223 | unless the call was cancelled - in which case this can be skipped */ |
Craig Tiller | fef7669 | 2015-02-02 16:44:26 -0800 | [diff] [blame] | 224 | GRPC_OP_SEND_INITIAL_METADATA = 0, |
Craig Tiller | b7800c1 | 2015-02-04 18:25:38 -0800 | [diff] [blame] | 225 | /* 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] | 226 | GRPC_OP_SEND_MESSAGE, |
Eric Dobson | 255971d | 2015-06-14 16:04:15 -0700 | [diff] [blame] | 227 | /* Send a close from the client: one and only one instance MUST be sent from |
Craig Tiller | 24be0f7 | 2015-02-10 14:04:22 -0800 | [diff] [blame] | 228 | the client, |
Craig Tiller | b7800c1 | 2015-02-04 18:25:38 -0800 | [diff] [blame] | 229 | unless the call was cancelled - in which case this can be skipped */ |
Craig Tiller | fef7669 | 2015-02-02 16:44:26 -0800 | [diff] [blame] | 230 | GRPC_OP_SEND_CLOSE_FROM_CLIENT, |
Craig Tiller | 24be0f7 | 2015-02-10 14:04:22 -0800 | [diff] [blame] | 231 | /* Send status from the server: one and only one instance MUST be sent from |
| 232 | the server |
Craig Tiller | b7800c1 | 2015-02-04 18:25:38 -0800 | [diff] [blame] | 233 | unless the call was cancelled - in which case this can be skipped */ |
Craig Tiller | fef7669 | 2015-02-02 16:44:26 -0800 | [diff] [blame] | 234 | GRPC_OP_SEND_STATUS_FROM_SERVER, |
Craig Tiller | b7800c1 | 2015-02-04 18:25:38 -0800 | [diff] [blame] | 235 | /* Receive initial metadata: one and only one MUST be made on the client, must |
| 236 | not be made on the server */ |
Craig Tiller | fef7669 | 2015-02-02 16:44:26 -0800 | [diff] [blame] | 237 | GRPC_OP_RECV_INITIAL_METADATA, |
Craig Tiller | b7800c1 | 2015-02-04 18:25:38 -0800 | [diff] [blame] | 238 | /* 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] | 239 | GRPC_OP_RECV_MESSAGE, |
Craig Tiller | 69eed29 | 2015-05-19 10:43:05 -0700 | [diff] [blame] | 240 | /* Receive status on the client: one and only one must be made on the client. |
| 241 | This operation always succeeds, meaning ops paired with this operation |
| 242 | will also appear to succeed, even though they may not have. In that case |
| 243 | the status will indicate some failure. |
Craig Tiller | 24be0f7 | 2015-02-10 14:04:22 -0800 | [diff] [blame] | 244 | */ |
Craig Tiller | fef7669 | 2015-02-02 16:44:26 -0800 | [diff] [blame] | 245 | GRPC_OP_RECV_STATUS_ON_CLIENT, |
Eric Dobson | 255971d | 2015-06-14 16:04:15 -0700 | [diff] [blame] | 246 | /* Receive close on the server: one and only one must be made on the server |
Craig Tiller | 24be0f7 | 2015-02-10 14:04:22 -0800 | [diff] [blame] | 247 | */ |
Craig Tiller | fef7669 | 2015-02-02 16:44:26 -0800 | [diff] [blame] | 248 | GRPC_OP_RECV_CLOSE_ON_SERVER |
| 249 | } grpc_op_type; |
| 250 | |
Craig Tiller | 24be0f7 | 2015-02-10 14:04:22 -0800 | [diff] [blame] | 251 | /* Operation data: one field for each op type (except SEND_CLOSE_FROM_CLIENT |
| 252 | which has |
Craig Tiller | b7800c1 | 2015-02-04 18:25:38 -0800 | [diff] [blame] | 253 | no arguments) */ |
Craig Tiller | fef7669 | 2015-02-02 16:44:26 -0800 | [diff] [blame] | 254 | typedef struct grpc_op { |
| 255 | grpc_op_type op; |
David Garcia Quintas | 1d5aca5 | 2015-06-14 14:42:04 -0700 | [diff] [blame] | 256 | gpr_uint32 flags; /**< Write flags bitset for grpc_begin_messages */ |
Craig Tiller | fef7669 | 2015-02-02 16:44:26 -0800 | [diff] [blame] | 257 | union { |
| 258 | struct { |
| 259 | size_t count; |
Craig Tiller | 6902ad2 | 2015-04-16 08:01:49 -0700 | [diff] [blame] | 260 | grpc_metadata *metadata; |
Craig Tiller | fef7669 | 2015-02-02 16:44:26 -0800 | [diff] [blame] | 261 | } send_initial_metadata; |
| 262 | grpc_byte_buffer *send_message; |
| 263 | struct { |
| 264 | size_t trailing_metadata_count; |
| 265 | grpc_metadata *trailing_metadata; |
| 266 | grpc_status_code status; |
| 267 | const char *status_details; |
| 268 | } send_status_from_server; |
Craig Tiller | 4f97273 | 2015-02-05 12:40:20 -0800 | [diff] [blame] | 269 | /* 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] | 270 | stays with the call object (ie key, value members are owned by the call |
| 271 | object, recv_initial_metadata->array is owned by the caller). |
| 272 | After the operation completes, call grpc_metadata_array_destroy on this |
| 273 | value, or reuse it in a future op. */ |
Craig Tiller | fef7669 | 2015-02-02 16:44:26 -0800 | [diff] [blame] | 274 | grpc_metadata_array *recv_initial_metadata; |
Masood Malekghassemi | 7128a90 | 2015-06-17 13:17:58 -0700 | [diff] [blame] | 275 | /* ownership of the byte buffer is moved to the caller; the caller must call |
| 276 | grpc_byte_buffer_destroy on this value, or reuse it in a future op. */ |
Craig Tiller | fef7669 | 2015-02-02 16:44:26 -0800 | [diff] [blame] | 277 | grpc_byte_buffer **recv_message; |
| 278 | struct { |
Craig Tiller | 24be0f7 | 2015-02-10 14:04:22 -0800 | [diff] [blame] | 279 | /* ownership of the array is with the caller, but ownership of the |
| 280 | elements |
Craig Tiller | c56b2cb | 2015-02-05 16:35:38 -0800 | [diff] [blame] | 281 | stays with the call object (ie key, value members are owned by the call |
| 282 | object, trailing_metadata->array is owned by the caller). |
| 283 | After the operation completes, call grpc_metadata_array_destroy on this |
| 284 | value, or reuse it in a future op. */ |
Craig Tiller | fef7669 | 2015-02-02 16:44:26 -0800 | [diff] [blame] | 285 | grpc_metadata_array *trailing_metadata; |
| 286 | grpc_status_code *status; |
Craig Tiller | 24be0f7 | 2015-02-10 14:04:22 -0800 | [diff] [blame] | 287 | /* status_details is a buffer owned by the application before the op |
| 288 | completes |
| 289 | and after the op has completed. During the operation status_details may |
| 290 | be |
| 291 | reallocated to a size larger than *status_details_capacity, in which |
| 292 | case |
Craig Tiller | c56b2cb | 2015-02-05 16:35:38 -0800 | [diff] [blame] | 293 | *status_details_capacity will be updated with the new array capacity. |
| 294 | |
| 295 | Pre-allocating space: |
| 296 | size_t my_capacity = 8; |
| 297 | char *my_details = gpr_malloc(my_capacity); |
| 298 | x.status_details = &my_details; |
Craig Tiller | 24be0f7 | 2015-02-10 14:04:22 -0800 | [diff] [blame] | 299 | x.status_details_capacity = &my_capacity; |
Craig Tiller | c56b2cb | 2015-02-05 16:35:38 -0800 | [diff] [blame] | 300 | |
| 301 | Not pre-allocating space: |
| 302 | size_t my_capacity = 0; |
| 303 | char *my_details = NULL; |
| 304 | x.status_details = &my_details; |
Craig Tiller | 24be0f7 | 2015-02-10 14:04:22 -0800 | [diff] [blame] | 305 | x.status_details_capacity = &my_capacity; |
Craig Tiller | c56b2cb | 2015-02-05 16:35:38 -0800 | [diff] [blame] | 306 | |
| 307 | After the call: |
| 308 | gpr_free(my_details); */ |
Craig Tiller | fef7669 | 2015-02-02 16:44:26 -0800 | [diff] [blame] | 309 | char **status_details; |
| 310 | size_t *status_details_capacity; |
| 311 | } recv_status_on_client; |
| 312 | struct { |
Craig Tiller | 24be0f7 | 2015-02-10 14:04:22 -0800 | [diff] [blame] | 313 | /* out argument, set to 1 if the call failed in any way (seen as a |
| 314 | cancellation |
Craig Tiller | 0a5bcbc | 2015-02-09 21:39:04 -0800 | [diff] [blame] | 315 | on the server), or 0 if the call succeeded */ |
Craig Tiller | fef7669 | 2015-02-02 16:44:26 -0800 | [diff] [blame] | 316 | int *cancelled; |
| 317 | } recv_close_on_server; |
| 318 | } data; |
| 319 | } grpc_op; |
| 320 | |
Craig Tiller | e793ba1 | 2015-05-18 09:37:22 -0700 | [diff] [blame] | 321 | /** Initialize the grpc library. |
Masood Malekghassemi | 7128a90 | 2015-06-17 13:17:58 -0700 | [diff] [blame] | 322 | |
Craig Tiller | e793ba1 | 2015-05-18 09:37:22 -0700 | [diff] [blame] | 323 | It is not safe to call any other grpc functions before calling this. |
| 324 | (To avoid overhead, little checking is done, and some things may work. We |
| 325 | do not warrant that they will continue to do so in future revisions of this |
| 326 | library). */ |
Craig Tiller | 32946d3 | 2015-01-15 11:37:30 -0800 | [diff] [blame] | 327 | void grpc_init(void); |
Nicolas Noble | b7ebd3b | 2014-11-26 16:33:03 -0800 | [diff] [blame] | 328 | |
Craig Tiller | e793ba1 | 2015-05-18 09:37:22 -0700 | [diff] [blame] | 329 | /** Shut down the grpc library. |
Masood Malekghassemi | 7128a90 | 2015-06-17 13:17:58 -0700 | [diff] [blame] | 330 | |
Craig Tiller | e793ba1 | 2015-05-18 09:37:22 -0700 | [diff] [blame] | 331 | No memory is used by grpc after this call returns, nor are any instructions |
| 332 | executing within the grpc library. |
| 333 | Prior to calling, all application owned grpc objects must have been |
| 334 | destroyed. */ |
Craig Tiller | 32946d3 | 2015-01-15 11:37:30 -0800 | [diff] [blame] | 335 | void grpc_shutdown(void); |
Nicolas Noble | b7ebd3b | 2014-11-26 16:33:03 -0800 | [diff] [blame] | 336 | |
Craig Tiller | e793ba1 | 2015-05-18 09:37:22 -0700 | [diff] [blame] | 337 | /** Create a completion queue */ |
Craig Tiller | 32946d3 | 2015-01-15 11:37:30 -0800 | [diff] [blame] | 338 | grpc_completion_queue *grpc_completion_queue_create(void); |
Nicolas Noble | b7ebd3b | 2014-11-26 16:33:03 -0800 | [diff] [blame] | 339 | |
Craig Tiller | e793ba1 | 2015-05-18 09:37:22 -0700 | [diff] [blame] | 340 | /** Blocks until an event is available, the completion queue is being shut down, |
| 341 | or deadline is reached. |
Nicolas Noble | b7ebd3b | 2014-11-26 16:33:03 -0800 | [diff] [blame] | 342 | |
vjpai | 1854d77 | 2015-06-08 01:12:29 -0700 | [diff] [blame] | 343 | Returns a grpc_event with type GRPC_QUEUE_TIMEOUT on timeout, |
| 344 | otherwise a grpc_event describing the event that occurred. |
Craig Tiller | e793ba1 | 2015-05-18 09:37:22 -0700 | [diff] [blame] | 345 | |
| 346 | Callers must not call grpc_completion_queue_next and |
| 347 | grpc_completion_queue_pluck simultaneously on the same completion queue. */ |
Craig Tiller | 64be9f7 | 2015-05-04 14:53:51 -0700 | [diff] [blame] | 348 | grpc_event grpc_completion_queue_next(grpc_completion_queue *cq, |
| 349 | gpr_timespec deadline); |
Nicolas Noble | b7ebd3b | 2014-11-26 16:33:03 -0800 | [diff] [blame] | 350 | |
Craig Tiller | e793ba1 | 2015-05-18 09:37:22 -0700 | [diff] [blame] | 351 | /** Blocks until an event with tag 'tag' is available, the completion queue is |
| 352 | being shutdown or deadline is reached. |
Nicolas Noble | b7ebd3b | 2014-11-26 16:33:03 -0800 | [diff] [blame] | 353 | |
vjpai | 1854d77 | 2015-06-08 01:12:29 -0700 | [diff] [blame] | 354 | Returns a grpc_event with type GRPC_QUEUE_TIMEOUT on timeout, |
| 355 | otherwise a grpc_event describing the event that occurred. |
Craig Tiller | e793ba1 | 2015-05-18 09:37:22 -0700 | [diff] [blame] | 356 | |
| 357 | Callers must not call grpc_completion_queue_next and |
| 358 | grpc_completion_queue_pluck simultaneously on the same completion queue. */ |
Craig Tiller | 64be9f7 | 2015-05-04 14:53:51 -0700 | [diff] [blame] | 359 | grpc_event grpc_completion_queue_pluck(grpc_completion_queue *cq, void *tag, |
| 360 | gpr_timespec deadline); |
Nicolas Noble | b7ebd3b | 2014-11-26 16:33:03 -0800 | [diff] [blame] | 361 | |
| 362 | /* Begin destruction of a completion queue. Once all possible events are |
Craig Tiller | 8ac56c9 | 2015-02-17 22:51:36 -0800 | [diff] [blame] | 363 | drained then grpc_completion_queue_next will start to produce |
Craig Tiller | b20111c | 2015-04-10 23:27:11 +0000 | [diff] [blame] | 364 | GRPC_QUEUE_SHUTDOWN events only. At that point it's safe to call |
| 365 | grpc_completion_queue_destroy. |
| 366 | |
Craig Tiller | 8ac56c9 | 2015-02-17 22:51:36 -0800 | [diff] [blame] | 367 | After calling this function applications should ensure that no |
| 368 | NEW work is added to be published on this completion queue. */ |
Nicolas Noble | b7ebd3b | 2014-11-26 16:33:03 -0800 | [diff] [blame] | 369 | void grpc_completion_queue_shutdown(grpc_completion_queue *cq); |
| 370 | |
| 371 | /* Destroy a completion queue. The caller must ensure that the queue is |
| 372 | drained and no threads are executing grpc_completion_queue_next */ |
| 373 | void grpc_completion_queue_destroy(grpc_completion_queue *cq); |
| 374 | |
| 375 | /* Create a call given a grpc_channel, in order to call 'method'. The request |
| 376 | is not sent until grpc_call_invoke is called. All completions are sent to |
Masood Malekghassemi | 7128a90 | 2015-06-17 13:17:58 -0700 | [diff] [blame] | 377 | 'completion_queue'. 'method' and 'host' need only live through the invocation |
| 378 | of this function. */ |
Craig Tiller | fb189f8 | 2015-02-03 12:07:07 -0800 | [diff] [blame] | 379 | grpc_call *grpc_channel_create_call(grpc_channel *channel, |
| 380 | grpc_completion_queue *completion_queue, |
| 381 | const char *method, const char *host, |
| 382 | gpr_timespec deadline); |
Craig Tiller | 034929c | 2015-02-02 16:56:15 -0800 | [diff] [blame] | 383 | |
Craig Tiller | 0845337 | 2015-04-10 16:05:38 -0700 | [diff] [blame] | 384 | /* Pre-register a method/host pair on a channel. */ |
Craig Tiller | b20111c | 2015-04-10 23:27:11 +0000 | [diff] [blame] | 385 | void *grpc_channel_register_call(grpc_channel *channel, const char *method, |
Craig Tiller | 0845337 | 2015-04-10 16:05:38 -0700 | [diff] [blame] | 386 | const char *host); |
| 387 | |
| 388 | /* Create a call given a handle returned from grpc_channel_register_call */ |
Craig Tiller | b20111c | 2015-04-10 23:27:11 +0000 | [diff] [blame] | 389 | grpc_call *grpc_channel_create_registered_call( |
| 390 | grpc_channel *channel, grpc_completion_queue *completion_queue, |
| 391 | void *registered_call_handle, gpr_timespec deadline); |
Craig Tiller | 0845337 | 2015-04-10 16:05:38 -0700 | [diff] [blame] | 392 | |
Craig Tiller | 034929c | 2015-02-02 16:56:15 -0800 | [diff] [blame] | 393 | /* Start a batch of operations defined in the array ops; when complete, post a |
Craig Tiller | 24be0f7 | 2015-02-10 14:04:22 -0800 | [diff] [blame] | 394 | completion of type 'tag' to the completion queue bound to the call. |
Craig Tiller | b7800c1 | 2015-02-04 18:25:38 -0800 | [diff] [blame] | 395 | The order of ops specified in the batch has no significance. |
| 396 | Only one operation of each type can be active at once in any given |
| 397 | batch. */ |
Craig Tiller | fef7669 | 2015-02-02 16:44:26 -0800 | [diff] [blame] | 398 | grpc_call_error grpc_call_start_batch(grpc_call *call, const grpc_op *ops, |
| 399 | size_t nops, void *tag); |
| 400 | |
Craig Tiller | 29f2b21 | 2015-02-17 17:01:24 -0800 | [diff] [blame] | 401 | /* Create a client channel to 'target'. Additional channel level configuration |
| 402 | MAY be provided by grpc_channel_args, though the expectation is that most |
Masood Malekghassemi | 7128a90 | 2015-06-17 13:17:58 -0700 | [diff] [blame] | 403 | clients will want to simply pass NULL. See grpc_channel_args definition for |
| 404 | more on this. The data in 'args' need only live through the invocation of |
| 405 | this function. */ |
Nicolas Noble | b7ebd3b | 2014-11-26 16:33:03 -0800 | [diff] [blame] | 406 | grpc_channel *grpc_channel_create(const char *target, |
| 407 | const grpc_channel_args *args); |
| 408 | |
Craig Tiller | 42bc87c | 2015-02-23 08:50:19 -0800 | [diff] [blame] | 409 | /* Create a lame client: this client fails every operation attempted on it. */ |
| 410 | grpc_channel *grpc_lame_client_channel_create(void); |
| 411 | |
Nicolas Noble | b7ebd3b | 2014-11-26 16:33:03 -0800 | [diff] [blame] | 412 | /* Close and destroy a grpc channel */ |
| 413 | void grpc_channel_destroy(grpc_channel *channel); |
| 414 | |
| 415 | /* THREAD-SAFETY for grpc_call |
| 416 | The following functions are thread-compatible for any given call: |
| 417 | grpc_call_add_metadata |
| 418 | grpc_call_invoke |
| 419 | grpc_call_start_write |
| 420 | grpc_call_writes_done |
| 421 | grpc_call_start_read |
| 422 | grpc_call_destroy |
| 423 | The function grpc_call_cancel is thread-safe, and can be called at any |
| 424 | point before grpc_call_destroy is called. */ |
| 425 | |
| 426 | /* Error handling for grpc_call |
| 427 | Most grpc_call functions return a grpc_error. If the error is not GRPC_OK |
| 428 | then the operation failed due to some unsatisfied precondition. |
| 429 | If a grpc_call fails, it's guaranteed that no change to the call state |
| 430 | has been made. */ |
| 431 | |
Nicolas Noble | b7ebd3b | 2014-11-26 16:33:03 -0800 | [diff] [blame] | 432 | /* Called by clients to cancel an RPC on the server. |
| 433 | Can be called multiple times, from any thread. */ |
| 434 | grpc_call_error grpc_call_cancel(grpc_call *call); |
| 435 | |
Craig Tiller | d248c24 | 2015-01-14 11:49:12 -0800 | [diff] [blame] | 436 | /* Called by clients to cancel an RPC on the server. |
Craig Tiller | 6046dc3 | 2015-01-14 12:55:45 -0800 | [diff] [blame] | 437 | Can be called multiple times, from any thread. |
Craig Tiller | d248c24 | 2015-01-14 11:49:12 -0800 | [diff] [blame] | 438 | 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] | 439 | and description passed in. |
Craig Tiller | d248c24 | 2015-01-14 11:49:12 -0800 | [diff] [blame] | 440 | Importantly, this function does not send status nor description to the |
| 441 | remote endpoint. */ |
Craig Tiller | 6046dc3 | 2015-01-14 12:55:45 -0800 | [diff] [blame] | 442 | grpc_call_error grpc_call_cancel_with_status(grpc_call *call, |
| 443 | grpc_status_code status, |
| 444 | const char *description); |
Craig Tiller | d248c24 | 2015-01-14 11:49:12 -0800 | [diff] [blame] | 445 | |
Nicolas Noble | b7ebd3b | 2014-11-26 16:33:03 -0800 | [diff] [blame] | 446 | /* Destroy a call. */ |
| 447 | void grpc_call_destroy(grpc_call *call); |
| 448 | |
Masood Malekghassemi | aeb1a9f | 2015-06-18 16:23:24 -0700 | [diff] [blame^] | 449 | /* Request notification of a new call. 'cq_for_notification' must |
| 450 | have been registered to the server via grpc_server_register_completion_queue. |
| 451 | */ |
Craig Tiller | fb189f8 | 2015-02-03 12:07:07 -0800 | [diff] [blame] | 452 | grpc_call_error grpc_server_request_call( |
Craig Tiller | ea61b07 | 2015-02-03 19:19:27 -0800 | [diff] [blame] | 453 | grpc_server *server, grpc_call **call, grpc_call_details *details, |
Craig Tiller | fb189f8 | 2015-02-03 12:07:07 -0800 | [diff] [blame] | 454 | grpc_metadata_array *request_metadata, |
Craig Tiller | f9e6adf | 2015-05-06 11:45:59 -0700 | [diff] [blame] | 455 | grpc_completion_queue *cq_bound_to_call, |
| 456 | grpc_completion_queue *cq_for_notification, void *tag_new); |
Craig Tiller | 034929c | 2015-02-02 16:56:15 -0800 | [diff] [blame] | 457 | |
Craig Tiller | fada7d4 | 2015-02-11 23:03:55 -0800 | [diff] [blame] | 458 | /* Registers a method in the server. |
| 459 | Methods to this (host, method) pair will not be reported by |
Craig Tiller | 0605995 | 2015-02-18 08:34:56 -0800 | [diff] [blame] | 460 | grpc_server_request_call, but instead be reported by |
Craig Tiller | fada7d4 | 2015-02-11 23:03:55 -0800 | [diff] [blame] | 461 | grpc_server_request_registered_call when passed the appropriate |
| 462 | registered_method (as returned by this function). |
| 463 | Must be called before grpc_server_start. |
| 464 | Returns NULL on failure. */ |
Craig Tiller | 24be0f7 | 2015-02-10 14:04:22 -0800 | [diff] [blame] | 465 | void *grpc_server_register_method(grpc_server *server, const char *method, |
Craig Tiller | f9e6adf | 2015-05-06 11:45:59 -0700 | [diff] [blame] | 466 | const char *host); |
Craig Tiller | 24be0f7 | 2015-02-10 14:04:22 -0800 | [diff] [blame] | 467 | |
Masood Malekghassemi | aeb1a9f | 2015-06-18 16:23:24 -0700 | [diff] [blame^] | 468 | /* Request notification of a new pre-registered call. 'cq_for_notification' must |
| 469 | have been registered to the server via grpc_server_register_completion_queue. |
| 470 | */ |
Craig Tiller | 24be0f7 | 2015-02-10 14:04:22 -0800 | [diff] [blame] | 471 | grpc_call_error grpc_server_request_registered_call( |
| 472 | grpc_server *server, void *registered_method, grpc_call **call, |
| 473 | gpr_timespec *deadline, grpc_metadata_array *request_metadata, |
| 474 | grpc_byte_buffer **optional_payload, |
Craig Tiller | f9e6adf | 2015-05-06 11:45:59 -0700 | [diff] [blame] | 475 | grpc_completion_queue *cq_bound_to_call, |
| 476 | grpc_completion_queue *cq_for_notification, void *tag_new); |
Craig Tiller | 24be0f7 | 2015-02-10 14:04:22 -0800 | [diff] [blame] | 477 | |
Craig Tiller | 29f2b21 | 2015-02-17 17:01:24 -0800 | [diff] [blame] | 478 | /* Create a server. Additional configuration for each incoming channel can |
Craig Tiller | e7163ab | 2015-02-17 20:46:08 -0800 | [diff] [blame] | 479 | be specified with args. If no additional configuration is needed, args can |
Masood Malekghassemi | 7128a90 | 2015-06-17 13:17:58 -0700 | [diff] [blame] | 480 | be NULL. See grpc_channel_args for more. The data in 'args' need only live |
| 481 | through the invocation of this function. */ |
Craig Tiller | f9e6adf | 2015-05-06 11:45:59 -0700 | [diff] [blame] | 482 | grpc_server *grpc_server_create(const grpc_channel_args *args); |
| 483 | |
Masood Malekghassemi | aeb1a9f | 2015-06-18 16:23:24 -0700 | [diff] [blame^] | 484 | /* Register a completion queue with the server. Must be done for any |
| 485 | notification completion queue that is passed to grpc_server_request_*_call |
| 486 | and to grpc_server_shutdown_and_notify. Must be performed prior to |
| 487 | grpc_server_start. */ |
Craig Tiller | f9e6adf | 2015-05-06 11:45:59 -0700 | [diff] [blame] | 488 | void grpc_server_register_completion_queue(grpc_server *server, |
| 489 | grpc_completion_queue *cq); |
Nicolas Noble | b7ebd3b | 2014-11-26 16:33:03 -0800 | [diff] [blame] | 490 | |
Craig Tiller | d251ab9 | 2015-02-17 17:22:14 -0800 | [diff] [blame] | 491 | /* Add a HTTP2 over plaintext over tcp listener. |
ctiller | 570d1f4 | 2015-01-12 16:29:52 -0800 | [diff] [blame] | 492 | Returns bound port number on success, 0 on failure. |
Nicolas Noble | b7ebd3b | 2014-11-26 16:33:03 -0800 | [diff] [blame] | 493 | REQUIRES: server not started */ |
| 494 | int grpc_server_add_http2_port(grpc_server *server, const char *addr); |
| 495 | |
Nicolas Noble | b7ebd3b | 2014-11-26 16:33:03 -0800 | [diff] [blame] | 496 | /* Start a server - tells all listeners to start listening */ |
| 497 | void grpc_server_start(grpc_server *server); |
| 498 | |
ctiller | 9a58df0 | 2014-12-11 16:26:49 -0800 | [diff] [blame] | 499 | /* Begin shutting down a server. |
| 500 | After completion, no new calls or connections will be admitted. |
Craig Tiller | aea2fc0 | 2015-02-17 16:54:53 -0800 | [diff] [blame] | 501 | Existing calls will be allowed to complete. |
Craig Tiller | ee945e8 | 2015-05-26 16:15:34 -0700 | [diff] [blame] | 502 | Send a GRPC_OP_COMPLETE event when there are no more calls being serviced. |
Craig Tiller | aea2fc0 | 2015-02-17 16:54:53 -0800 | [diff] [blame] | 503 | Shutdown is idempotent, and all tags will be notified at once if multiple |
Masood Malekghassemi | aeb1a9f | 2015-06-18 16:23:24 -0700 | [diff] [blame^] | 504 | grpc_server_shutdown_and_notify calls are made. 'cq' must have been |
| 505 | registered to this server via grpc_server_register_completion_queue. */ |
Craig Tiller | bce999f | 2015-05-27 09:55:51 -0700 | [diff] [blame] | 506 | void grpc_server_shutdown_and_notify(grpc_server *server, |
| 507 | grpc_completion_queue *cq, void *tag); |
Craig Tiller | 4ffdcd5 | 2015-01-16 11:34:55 -0800 | [diff] [blame] | 508 | |
Masood Malekghassemi | 7128a90 | 2015-06-17 13:17:58 -0700 | [diff] [blame] | 509 | /* Cancel all in-progress calls. |
Craig Tiller | ee945e8 | 2015-05-26 16:15:34 -0700 | [diff] [blame] | 510 | Only usable after shutdown. */ |
| 511 | void grpc_server_cancel_all_calls(grpc_server *server); |
| 512 | |
ctiller | 9a58df0 | 2014-12-11 16:26:49 -0800 | [diff] [blame] | 513 | /* Destroy a server. |
Craig Tiller | 6ec402b | 2015-05-28 08:36:41 -0700 | [diff] [blame] | 514 | Shutdown must have completed beforehand (i.e. all tags generated by |
| 515 | grpc_server_shutdown_and_notify must have been received, and at least |
| 516 | one call to grpc_server_shutdown_and_notify must have been made). */ |
Nicolas Noble | b7ebd3b | 2014-11-26 16:33:03 -0800 | [diff] [blame] | 517 | void grpc_server_destroy(grpc_server *server); |
| 518 | |
Craig Tiller | af7abf9 | 2015-06-03 17:18:58 -0700 | [diff] [blame] | 519 | /** Enable or disable a tracer. |
| 520 | |
| 521 | Tracers (usually controlled by the environment variable GRPC_TRACE) |
| 522 | allow printf-style debugging on GRPC internals, and are useful for |
| 523 | tracking down problems in the field. |
| 524 | |
| 525 | Use of this function is not strictly thread-safe, but the |
| 526 | thread-safety issues raised by it should not be of concern. */ |
| 527 | int grpc_tracer_set_enabled(const char *name, int enabled); |
| 528 | |
Nicolas Noble | b7ebd3b | 2014-11-26 16:33:03 -0800 | [diff] [blame] | 529 | #ifdef __cplusplus |
| 530 | } |
| 531 | #endif |
| 532 | |
Craig Tiller | b20111c | 2015-04-10 23:27:11 +0000 | [diff] [blame] | 533 | #endif /* GRPC_GRPC_H */ |