1/*
2 *
3 * Copyright 2015 gRPC authors.
4 *
5 * Licensed under the Apache License, Version 2.0 (the "License");
6 * you may not use this file except in compliance with the License.
7 * You may obtain a copy of the License at
8 *
9 * http://www.apache.org/licenses/LICENSE-2.0
10 *
11 * Unless required by applicable law or agreed to in writing, software
12 * distributed under the License is distributed on an "AS IS" BASIS,
13 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14 * See the License for the specific language governing permissions and
15 * limitations under the License.
16 *
17 */
18
19#ifndef GRPC_IMPL_CODEGEN_GRPC_TYPES_H
20#define GRPC_IMPL_CODEGEN_GRPC_TYPES_H
21
22#include <grpc/impl/codegen/port_platform.h>
23
24#include <grpc/impl/codegen/compression_types.h>
25#include <grpc/impl/codegen/gpr_types.h>
26#include <grpc/impl/codegen/slice.h>
27#include <grpc/impl/codegen/status.h>
28
29#include <stddef.h>
30
31#ifdef __cplusplus
32extern "C" {
33#endif
34
35typedef enum {
36 GRPC_BB_RAW
37 /** Future types may include GRPC_BB_PROTOBUF, etc. */
38} grpc_byte_buffer_type;
39
40typedef struct grpc_byte_buffer {
41 void* reserved;
42 grpc_byte_buffer_type type;
43 union grpc_byte_buffer_data {
44 struct /* internal */ {
45 void* reserved[8];
46 } reserved;
47 struct grpc_compressed_buffer {
48 grpc_compression_algorithm compression;
49 grpc_slice_buffer slice_buffer;
50 } raw;
51 } data;
52} grpc_byte_buffer;
53
54/** Completion Queues enable notification of the completion of
55 * asynchronous actions. */
56typedef struct grpc_completion_queue grpc_completion_queue;
57
58/** An alarm associated with a completion queue. */
59typedef struct grpc_alarm grpc_alarm;
60
61/** The Channel interface allows creation of Call objects. */
62typedef struct grpc_channel grpc_channel;
63
64/** A server listens to some port and responds to request calls */
65typedef struct grpc_server grpc_server;
66
67/** A Call represents an RPC. When created, it is in a configuration state
68 allowing properties to be set until it is invoked. After invoke, the Call
69 can have messages written to it and read from it. */
70typedef struct grpc_call grpc_call;
71
72/** The Socket Mutator interface allows changes on socket options */
73typedef struct grpc_socket_mutator grpc_socket_mutator;
74
75/** The Socket Factory interface creates and binds sockets */
76typedef struct grpc_socket_factory grpc_socket_factory;
77
78/** Type specifier for grpc_arg */
79typedef enum {
80 GRPC_ARG_STRING,
81 GRPC_ARG_INTEGER,
82 GRPC_ARG_POINTER
83} grpc_arg_type;
84
85typedef struct grpc_arg_pointer_vtable {
86 void* (*copy)(void* p);
87 void (*destroy)(void* p);
88 int (*cmp)(void* p, void* q);
89} grpc_arg_pointer_vtable;
90
91/** A single argument... each argument has a key and a value
92
93 A note on naming keys:
94 Keys are namespaced into groups, usually grouped by library, and are
95 keys for module XYZ are named XYZ.key1, XYZ.key2, etc. Module names must
96 be restricted to the regex [A-Za-z][_A-Za-z0-9]{,15}.
97 Key names must be restricted to the regex [A-Za-z][_A-Za-z0-9]{,47}.
98
99 GRPC core library keys are prefixed by grpc.
100
101 Library authors are strongly encouraged to \#define symbolic constants for
102 their keys so that it's possible to change them in the future. */
103typedef struct {
104 grpc_arg_type type;
105 char* key;
106 union grpc_arg_value {
107 char* string;
108 int integer;
109 struct grpc_arg_pointer {
110 void* p;
111 const grpc_arg_pointer_vtable* vtable;
112 } pointer;
113 } value;
114} grpc_arg;
115
116/** An array of arguments that can be passed around.
117
118 Used to set optional channel-level configuration.
119 These configuration options are modelled as key-value pairs as defined
120 by grpc_arg; keys are strings to allow easy backwards-compatible extension
121 by arbitrary parties. All evaluation is performed at channel creation
122 time (i.e. the keys and values in this structure need only live through the
123 creation invocation).
124
125 However, if one of the args has grpc_arg_type==GRPC_ARG_POINTER, then the
126 grpc_arg_pointer_vtable must live until the channel args are done being
127 used by core (i.e. when the object for use with which they were passed
128 is destroyed).
129
130 See the description of the \ref grpc_arg_keys "available args" for more
131 details. */
132typedef struct {
133 size_t num_args;
134 grpc_arg* args;
135} grpc_channel_args;
136
137/** \defgroup grpc_arg_keys
138 * Channel argument keys.
139 * \{
140 */
141/** If non-zero, enable census for tracing and stats collection. */
142#define GRPC_ARG_ENABLE_CENSUS "grpc.census"
143/** If non-zero, enable load reporting. */
144#define GRPC_ARG_ENABLE_LOAD_REPORTING "grpc.loadreporting"
145/** Request that optional features default to off (regardless of what they
146 usually default to) - to enable tight control over what gets enabled */
147#define GRPC_ARG_MINIMAL_STACK "grpc.minimal_stack"
148/** Maximum number of concurrent incoming streams to allow on a http2
149 connection. Int valued. */
150#define GRPC_ARG_MAX_CONCURRENT_STREAMS "grpc.max_concurrent_streams"
151/** Maximum message length that the channel can receive. Int valued, bytes.
152 -1 means unlimited. */
153#define GRPC_ARG_MAX_RECEIVE_MESSAGE_LENGTH "grpc.max_receive_message_length"
154/** \deprecated For backward compatibility.
155 * Use GRPC_ARG_MAX_RECEIVE_MESSAGE_LENGTH instead. */
156#define GRPC_ARG_MAX_MESSAGE_LENGTH GRPC_ARG_MAX_RECEIVE_MESSAGE_LENGTH
157/** Maximum message length that the channel can send. Int valued, bytes.
158 -1 means unlimited. */
159#define GRPC_ARG_MAX_SEND_MESSAGE_LENGTH "grpc.max_send_message_length"
160/** Maximum time that a channel may have no outstanding rpcs, after which the
161 * server will close the connection. Int valued, milliseconds. INT_MAX means
162 * unlimited. */
163#define GRPC_ARG_MAX_CONNECTION_IDLE_MS "grpc.max_connection_idle_ms"
164/** Maximum time that a channel may exist. Int valued, milliseconds.
165 * INT_MAX means unlimited. */
166#define GRPC_ARG_MAX_CONNECTION_AGE_MS "grpc.max_connection_age_ms"
167/** Grace period after the channel reaches its max age. Int valued,
168 milliseconds. INT_MAX means unlimited. */
169#define GRPC_ARG_MAX_CONNECTION_AGE_GRACE_MS "grpc.max_connection_age_grace_ms"
170/** Timeout after the last RPC finishes on the client channel at which the
171 * channel goes back into IDLE state. Int valued, milliseconds. INT_MAX means
172 * unlimited. The default value is 30 minutes and the min value is 1 second. */
173#define GRPC_ARG_CLIENT_IDLE_TIMEOUT_MS "grpc.client_idle_timeout_ms"
174/** Enable/disable support for per-message compression. Defaults to 1, unless
175 GRPC_ARG_MINIMAL_STACK is enabled, in which case it defaults to 0. */
176#define GRPC_ARG_ENABLE_PER_MESSAGE_COMPRESSION "grpc.per_message_compression"
177/** Experimental Arg. Enable/disable support for per-message decompression.
178 Defaults to 1. If disabled, decompression will not be performed and the
179 application will see the compressed message in the byte buffer. */
180#define GRPC_ARG_ENABLE_PER_MESSAGE_DECOMPRESSION \
181 "grpc.per_message_decompression"
182/** Enable/disable support for deadline checking. Defaults to 1, unless
183 GRPC_ARG_MINIMAL_STACK is enabled, in which case it defaults to 0 */
184#define GRPC_ARG_ENABLE_DEADLINE_CHECKS "grpc.enable_deadline_checking"
185/** Initial stream ID for http2 transports. Int valued. */
186#define GRPC_ARG_HTTP2_INITIAL_SEQUENCE_NUMBER \
187 "grpc.http2.initial_sequence_number"
188/** Amount to read ahead on individual streams. Defaults to 64kb, larger
189 values can help throughput on high-latency connections.
190 NOTE: at some point we'd like to auto-tune this, and this parameter
191 will become a no-op. Int valued, bytes. */
192#define GRPC_ARG_HTTP2_STREAM_LOOKAHEAD_BYTES "grpc.http2.lookahead_bytes"
193/** How much memory to use for hpack decoding. Int valued, bytes. */
194#define GRPC_ARG_HTTP2_HPACK_TABLE_SIZE_DECODER \
195 "grpc.http2.hpack_table_size.decoder"
196/** How much memory to use for hpack encoding. Int valued, bytes. */
197#define GRPC_ARG_HTTP2_HPACK_TABLE_SIZE_ENCODER \
198 "grpc.http2.hpack_table_size.encoder"
199/** How big a frame are we willing to receive via HTTP2.
200 Min 16384, max 16777215. Larger values give lower CPU usage for large
201 messages, but more head of line blocking for small messages. */
202#define GRPC_ARG_HTTP2_MAX_FRAME_SIZE "grpc.http2.max_frame_size"
203/** Should BDP probing be performed? */
204#define GRPC_ARG_HTTP2_BDP_PROBE "grpc.http2.bdp_probe"
205/** Minimum time between sending successive ping frames without receiving any
206 data/header/window_update frame, Int valued, milliseconds. */
207#define GRPC_ARG_HTTP2_MIN_SENT_PING_INTERVAL_WITHOUT_DATA_MS \
208 "grpc.http2.min_time_between_pings_ms"
209/** Minimum allowed time between a server receiving successive ping frames
210 without sending any data/header/window_update frame. Int valued, milliseconds
211 */
212#define GRPC_ARG_HTTP2_MIN_RECV_PING_INTERVAL_WITHOUT_DATA_MS \
213 "grpc.http2.min_ping_interval_without_data_ms"
214/** Channel arg to override the http2 :scheme header */
215#define GRPC_ARG_HTTP2_SCHEME "grpc.http2_scheme"
216/** How many pings can we send before needing to send a
217 data/header/window_update frame? (0 indicates that an infinite number of
218 pings can be sent without sending a data frame or header frame) */
219#define GRPC_ARG_HTTP2_MAX_PINGS_WITHOUT_DATA \
220 "grpc.http2.max_pings_without_data"
221/** How many misbehaving pings the server can bear before sending goaway and
222 closing the transport? (0 indicates that the server can bear an infinite
223 number of misbehaving pings) */
224#define GRPC_ARG_HTTP2_MAX_PING_STRIKES "grpc.http2.max_ping_strikes"
225/** How much data are we willing to queue up per stream if
226 GRPC_WRITE_BUFFER_HINT is set? This is an upper bound */
227#define GRPC_ARG_HTTP2_WRITE_BUFFER_SIZE "grpc.http2.write_buffer_size"
228/** Should we allow receipt of true-binary data on http2 connections?
229 Defaults to on (1) */
230#define GRPC_ARG_HTTP2_ENABLE_TRUE_BINARY "grpc.http2.true_binary"
231/** After a duration of this time the client/server pings its peer to see if the
232 transport is still alive. Int valued, milliseconds. */
233#define GRPC_ARG_KEEPALIVE_TIME_MS "grpc.keepalive_time_ms"
234/** After waiting for a duration of this time, if the keepalive ping sender does
235 not receive the ping ack, it will close the transport. Int valued,
236 milliseconds. */
237#define GRPC_ARG_KEEPALIVE_TIMEOUT_MS "grpc.keepalive_timeout_ms"
238/** Is it permissible to send keepalive pings without any outstanding streams.
239 Int valued, 0(false)/1(true). */
240#define GRPC_ARG_KEEPALIVE_PERMIT_WITHOUT_CALLS \
241 "grpc.keepalive_permit_without_calls"
242/** Default authority to pass if none specified on call construction. A string.
243 * */
244#define GRPC_ARG_DEFAULT_AUTHORITY "grpc.default_authority"
245/** Primary user agent: goes at the start of the user-agent metadata
246 sent on each request. A string. */
247#define GRPC_ARG_PRIMARY_USER_AGENT_STRING "grpc.primary_user_agent"
248/** Secondary user agent: goes at the end of the user-agent metadata
249 sent on each request. A string. */
250#define GRPC_ARG_SECONDARY_USER_AGENT_STRING "grpc.secondary_user_agent"
251/** The minimum time between subsequent connection attempts, in ms */
252#define GRPC_ARG_MIN_RECONNECT_BACKOFF_MS "grpc.min_reconnect_backoff_ms"
253/** The maximum time between subsequent connection attempts, in ms */
254#define GRPC_ARG_MAX_RECONNECT_BACKOFF_MS "grpc.max_reconnect_backoff_ms"
255/** The time between the first and second connection attempts, in ms */
256#define GRPC_ARG_INITIAL_RECONNECT_BACKOFF_MS \
257 "grpc.initial_reconnect_backoff_ms"
258/** Minimum amount of time between DNS resolutions, in ms */
259#define GRPC_ARG_DNS_MIN_TIME_BETWEEN_RESOLUTIONS_MS \
260 "grpc.dns_min_time_between_resolutions_ms"
261/** The timeout used on servers for finishing handshaking on an incoming
262 connection. Defaults to 120 seconds. */
263#define GRPC_ARG_SERVER_HANDSHAKE_TIMEOUT_MS "grpc.server_handshake_timeout_ms"
264/** This *should* be used for testing only.
265 The caller of the secure_channel_create functions may override the target
266 name used for SSL host name checking using this channel argument which is of
267 type \a GRPC_ARG_STRING. If this argument is not specified, the name used
268 for SSL host name checking will be the target parameter (assuming that the
269 secure channel is an SSL channel). If this parameter is specified and the
270 underlying is not an SSL channel, it will just be ignored. */
271#define GRPC_SSL_TARGET_NAME_OVERRIDE_ARG "grpc.ssl_target_name_override"
272/** If non-zero, a pointer to a session cache (a pointer of type
273 grpc_ssl_session_cache*). (use grpc_ssl_session_cache_arg_vtable() to fetch
274 an appropriate pointer arg vtable) */
275#define GRPC_SSL_SESSION_CACHE_ARG "grpc.ssl_session_cache"
276/** If non-zero, it will determine the maximum frame size used by TSI's frame
277 * protector.
278 *
279 * NOTE: Be aware that using a large "max_frame_size" is memory inefficient
280 * for non-zerocopy protectors. Also, increasing this value above 1MiB
281 * can break old binaries that don't support larger than 1MiB frame
282 * size. */
283#define GRPC_ARG_TSI_MAX_FRAME_SIZE "grpc.tsi.max_frame_size"
284/** Maximum metadata size, in bytes. Note this limit applies to the max sum of
285 all metadata key-value entries in a batch of headers. */
286#define GRPC_ARG_MAX_METADATA_SIZE "grpc.max_metadata_size"
287/** If non-zero, allow the use of SO_REUSEPORT if it's available (default 1) */
288#define GRPC_ARG_ALLOW_REUSEPORT "grpc.so_reuseport"
289/** If non-zero, a pointer to a buffer pool (a pointer of type
290 * grpc_resource_quota*). (use grpc_resource_quota_arg_vtable() to fetch an
291 * appropriate pointer arg vtable) */
292#define GRPC_ARG_RESOURCE_QUOTA "grpc.resource_quota"
293/** If non-zero, expand wildcard addresses to a list of local addresses. */
294#define GRPC_ARG_EXPAND_WILDCARD_ADDRS "grpc.expand_wildcard_addrs"
295/** Service config data in JSON form.
296 This value will be ignored if the name resolver returns a service config. */
297#define GRPC_ARG_SERVICE_CONFIG "grpc.service_config"
298/** Disable looking up the service config via the name resolver. */
299#define GRPC_ARG_SERVICE_CONFIG_DISABLE_RESOLUTION \
300 "grpc.service_config_disable_resolution"
301/** LB policy name. */
302#define GRPC_ARG_LB_POLICY_NAME "grpc.lb_policy_name"
303/** The grpc_socket_mutator instance that set the socket options. A pointer. */
304#define GRPC_ARG_SOCKET_MUTATOR "grpc.socket_mutator"
305/** The grpc_socket_factory instance to create and bind sockets. A pointer. */
306#define GRPC_ARG_SOCKET_FACTORY "grpc.socket_factory"
307/** The maximum amount of memory used by trace events per channel trace node.
308 * Once the maximum is reached, subsequent events will evict the oldest events
309 * from the buffer. The unit for this knob is bytes. Setting it to zero causes
310 * channel tracing to be disabled. */
311#define GRPC_ARG_MAX_CHANNEL_TRACE_EVENT_MEMORY_PER_NODE \
312 "grpc.max_channel_trace_event_memory_per_node"
313/** If non-zero, gRPC library will track stats and information at at per channel
314 * level. Disabling channelz naturally disables channel tracing. The default
315 * is for channelz to be enabled. */
316#define GRPC_ARG_ENABLE_CHANNELZ "grpc.enable_channelz"
317/** If non-zero, Cronet transport will coalesce packets to fewer frames
318 * when possible. */
319#define GRPC_ARG_USE_CRONET_PACKET_COALESCING \
320 "grpc.use_cronet_packet_coalescing"
321/** Channel arg (integer) setting how large a slice to try and read from the
322 wire each time recvmsg (or equivalent) is called **/
323#define GRPC_ARG_TCP_READ_CHUNK_SIZE "grpc.experimental.tcp_read_chunk_size"
324/** Note this is not a "channel arg" key. This is the default slice size to use
325 * when trying to read from the wire if the GRPC_ARG_TCP_READ_CHUNK_SIZE
326 * channel arg is unspecified. */
327#define GRPC_TCP_DEFAULT_READ_SLICE_SIZE 8192
328#define GRPC_ARG_TCP_MIN_READ_CHUNK_SIZE \
329 "grpc.experimental.tcp_min_read_chunk_size"
330#define GRPC_ARG_TCP_MAX_READ_CHUNK_SIZE \
331 "grpc.experimental.tcp_max_read_chunk_size"
332/* TCP TX Zerocopy enable state: zero is disabled, non-zero is enabled. By
333 default, it is disabled. */
334#define GRPC_ARG_TCP_TX_ZEROCOPY_ENABLED \
335 "grpc.experimental.tcp_tx_zerocopy_enabled"
336/* TCP TX Zerocopy send threshold: only zerocopy if >= this many bytes sent. By
337 default, this is set to 16KB. */
338#define GRPC_ARG_TCP_TX_ZEROCOPY_SEND_BYTES_THRESHOLD \
339 "grpc.experimental.tcp_tx_zerocopy_send_bytes_threshold"
340/* TCP TX Zerocopy max simultaneous sends: limit for maximum number of pending
341 calls to tcp_write() using zerocopy. A tcp_write() is considered pending
342 until the kernel performs the zerocopy-done callback for all sendmsg() calls
343 issued by the tcp_write(). By default, this is set to 4. */
344#define GRPC_ARG_TCP_TX_ZEROCOPY_MAX_SIMULT_SENDS \
345 "grpc.experimental.tcp_tx_zerocopy_max_simultaneous_sends"
346/* Timeout in milliseconds to use for calls to the grpclb load balancer.
347 If 0 or unset, the balancer calls will have no deadline. */
348#define GRPC_ARG_GRPCLB_CALL_TIMEOUT_MS "grpc.grpclb_call_timeout_ms"
349/* Timeout in milliseconds to wait for the serverlist from the grpclb load
350 balancer before using fallback backend addresses from the resolver.
351 If 0, enter fallback mode immediately. Default value is 10000. */
352#define GRPC_ARG_GRPCLB_FALLBACK_TIMEOUT_MS "grpc.grpclb_fallback_timeout_ms"
353/* Timeout in milliseconds to wait for the child of a specific priority to
354 complete its initial connection attempt before the priority LB policy fails
355 over to the next priority. Default value is 10 seconds. */
356#define GRPC_ARG_PRIORITY_FAILOVER_TIMEOUT_MS \
357 "grpc.priority_failover_timeout_ms"
358/* Timeout in milliseconds to wait for a resource to be returned from
359 * the xds server before assuming that it does not exist.
360 * The default is 15 seconds. */
361#define GRPC_ARG_XDS_RESOURCE_DOES_NOT_EXIST_TIMEOUT_MS \
362 "grpc.xds_resource_does_not_exist_timeout_ms"
363/** If non-zero, grpc server's cronet compression workaround will be enabled */
364#define GRPC_ARG_WORKAROUND_CRONET_COMPRESSION \
365 "grpc.workaround.cronet_compression"
366/** String defining the optimization target for a channel.
367 Can be: "latency" - attempt to minimize latency at the cost of throughput
368 "blend" - try to balance latency and throughput
369 "throughput" - attempt to maximize throughput at the expense of
370 latency
371 Defaults to "blend". In the current implementation "blend" is equivalent to
372 "latency". */
373#define GRPC_ARG_OPTIMIZATION_TARGET "grpc.optimization_target"
374/** If set to zero, disables retry behavior. Otherwise, transparent retries
375 are enabled for all RPCs, and configurable retries are enabled when they
376 are configured via the service config. For details, see:
377 https://github.com/grpc/proposal/blob/master/A6-client-retries.md
378 */
379#define GRPC_ARG_ENABLE_RETRIES "grpc.enable_retries"
380/** Per-RPC retry buffer size, in bytes. Default is 256 KiB. */
381#define GRPC_ARG_PER_RPC_RETRY_BUFFER_SIZE "grpc.per_rpc_retry_buffer_size"
382/** Channel arg that carries the bridged objective c object for custom metrics
383 * logging filter. */
384#define GRPC_ARG_MOBILE_LOG_CONTEXT "grpc.mobile_log_context"
385/** If non-zero, client authority filter is disabled for the channel */
386#define GRPC_ARG_DISABLE_CLIENT_AUTHORITY_FILTER \
387 "grpc.disable_client_authority_filter"
388/** If set to zero, disables use of http proxies. Enabled by default. */
389#define GRPC_ARG_ENABLE_HTTP_PROXY "grpc.enable_http_proxy"
390/** Channel arg to set http proxy per channel. If set, the channel arg
391 * value will be prefered over the envrionment variable settings. */
392#define GRPC_ARG_HTTP_PROXY "grpc.http_proxy"
393/** If set to non zero, surfaces the user agent string to the server. User
394 agent is surfaced by default. */
395#define GRPC_ARG_SURFACE_USER_AGENT "grpc.surface_user_agent"
396/** If set, inhibits health checking (which may be enabled via the
397 * service config.) */
398#define GRPC_ARG_INHIBIT_HEALTH_CHECKING "grpc.inhibit_health_checking"
399/** If set, the channel's resolver is allowed to query for SRV records.
400 * For example, this is useful as a way to enable the "grpclb"
401 * load balancing policy. Note that this only works with the "ares"
402 * DNS resolver, and isn't supported by the "native" DNS resolver. */
403#define GRPC_ARG_DNS_ENABLE_SRV_QUERIES "grpc.dns_enable_srv_queries"
404/** If set, determines an upper bound on the number of milliseconds that the
405 * c-ares based DNS resolver will wait on queries before cancelling them.
406 * The default value is 120,000. Setting this to "0" will disable the
407 * overall timeout entirely. Note that this doesn't include internal c-ares
408 * timeouts/backoff/retry logic, and so the actual DNS resolution may time out
409 * sooner than the value specified here. */
410#define GRPC_ARG_DNS_ARES_QUERY_TIMEOUT_MS "grpc.dns_ares_query_timeout"
411/** If set, uses a local subchannel pool within the channel. Otherwise, uses the
412 * global subchannel pool. */
413#define GRPC_ARG_USE_LOCAL_SUBCHANNEL_POOL "grpc.use_local_subchannel_pool"
414/** gRPC Objective-C channel pooling domain string. */
415#define GRPC_ARG_CHANNEL_POOL_DOMAIN "grpc.channel_pooling_domain"
416/** gRPC Objective-C channel pooling id. */
417#define GRPC_ARG_CHANNEL_ID "grpc.channel_id"
418/** \} */
419
420/** Result of a grpc call. If the caller satisfies the prerequisites of a
421 particular operation, the grpc_call_error returned will be GRPC_CALL_OK.
422 Receiving any other value listed here is an indication of a bug in the
423 caller. */
424typedef enum grpc_call_error {
425 /** everything went ok */
426 GRPC_CALL_OK = 0,
427 /** something failed, we don't know what */
428 GRPC_CALL_ERROR,
429 /** this method is not available on the server */
430 GRPC_CALL_ERROR_NOT_ON_SERVER,
431 /** this method is not available on the client */
432 GRPC_CALL_ERROR_NOT_ON_CLIENT,
433 /** this method must be called before server_accept */
434 GRPC_CALL_ERROR_ALREADY_ACCEPTED,
435 /** this method must be called before invoke */
436 GRPC_CALL_ERROR_ALREADY_INVOKED,
437 /** this method must be called after invoke */
438 GRPC_CALL_ERROR_NOT_INVOKED,
439 /** this call is already finished
440 (writes_done or write_status has already been called) */
441 GRPC_CALL_ERROR_ALREADY_FINISHED,
442 /** there is already an outstanding read/write operation on the call */
443 GRPC_CALL_ERROR_TOO_MANY_OPERATIONS,
444 /** the flags value was illegal for this call */
445 GRPC_CALL_ERROR_INVALID_FLAGS,
446 /** invalid metadata was passed to this call */
447 GRPC_CALL_ERROR_INVALID_METADATA,
448 /** invalid message was passed to this call */
449 GRPC_CALL_ERROR_INVALID_MESSAGE,
450 /** completion queue for notification has not been registered
451 * with the server */
452 GRPC_CALL_ERROR_NOT_SERVER_COMPLETION_QUEUE,
453 /** this batch of operations leads to more operations than allowed */
454 GRPC_CALL_ERROR_BATCH_TOO_BIG,
455 /** payload type requested is not the type registered */
456 GRPC_CALL_ERROR_PAYLOAD_TYPE_MISMATCH,
457 /** completion queue has been shutdown */
458 GRPC_CALL_ERROR_COMPLETION_QUEUE_SHUTDOWN
459} grpc_call_error;
460
461/** Default send/receive message size limits in bytes. -1 for unlimited. */
462/** TODO(roth) Make this match the default receive limit after next release */
463#define GRPC_DEFAULT_MAX_SEND_MESSAGE_LENGTH -1
464#define GRPC_DEFAULT_MAX_RECV_MESSAGE_LENGTH (4 * 1024 * 1024)
465
466/** Write Flags: */
467/** Hint that the write may be buffered and need not go out on the wire
468 immediately. GRPC is free to buffer the message until the next non-buffered
469 write, or until writes_done, but it need not buffer completely or at all. */
470#define GRPC_WRITE_BUFFER_HINT (0x00000001u)
471/** Force compression to be disabled for a particular write
472 (start_write/add_metadata). Illegal on invoke/accept. */
473#define GRPC_WRITE_NO_COMPRESS (0x00000002u)
474/** Force this message to be written to the socket before completing it */
475#define GRPC_WRITE_THROUGH (0x00000004u)
476/** Mask of all valid flags. */
477#define GRPC_WRITE_USED_MASK \
478 (GRPC_WRITE_BUFFER_HINT | GRPC_WRITE_NO_COMPRESS | GRPC_WRITE_THROUGH)
479
480/** Initial metadata flags */
481/** Signal that the call is idempotent */
482#define GRPC_INITIAL_METADATA_IDEMPOTENT_REQUEST (0x00000010u)
483/** Signal that the call should not return UNAVAILABLE before it has started */
484#define GRPC_INITIAL_METADATA_WAIT_FOR_READY (0x00000020u)
485/** Signal that the call is cacheable. GRPC is free to use GET verb */
486#define GRPC_INITIAL_METADATA_CACHEABLE_REQUEST (0x00000040u)
487/** Signal that GRPC_INITIAL_METADATA_WAIT_FOR_READY was explicitly set
488 by the calling application. */
489#define GRPC_INITIAL_METADATA_WAIT_FOR_READY_EXPLICITLY_SET (0x00000080u)
490/** Signal that the initial metadata should be corked */
491#define GRPC_INITIAL_METADATA_CORKED (0x00000100u)
492
493/** Mask of all valid flags */
494#define GRPC_INITIAL_METADATA_USED_MASK \
495 (GRPC_INITIAL_METADATA_IDEMPOTENT_REQUEST | \
496 GRPC_INITIAL_METADATA_WAIT_FOR_READY | \
497 GRPC_INITIAL_METADATA_CACHEABLE_REQUEST | \
498 GRPC_INITIAL_METADATA_WAIT_FOR_READY_EXPLICITLY_SET | \
499 GRPC_INITIAL_METADATA_CORKED | GRPC_WRITE_THROUGH)
500
501/** A single metadata element */
502typedef struct grpc_metadata {
503 /** the key, value values are expected to line up with grpc_mdelem: if
504 changing them, update metadata.h at the same time. */
505 grpc_slice key;
506 grpc_slice value;
507
508 uint32_t flags;
509
510 /** The following fields are reserved for grpc internal use.
511 There is no need to initialize them, and they will be set to garbage
512 during calls to grpc. */
513 struct /* internal */ {
514 void* obfuscated[4];
515 } internal_data;
516} grpc_metadata;
517
518/** The type of completion (for grpc_event) */
519typedef enum grpc_completion_type {
520 /** Shutting down */
521 GRPC_QUEUE_SHUTDOWN,
522 /** No event before timeout */
523 GRPC_QUEUE_TIMEOUT,
524 /** Operation completion */
525 GRPC_OP_COMPLETE
526} grpc_completion_type;
527
528/** The result of an operation.
529
530 Returned by a completion queue when the operation started with tag. */
531typedef struct grpc_event {
532 /** The type of the completion. */
533 grpc_completion_type type;
534 /** If the grpc_completion_type is GRPC_OP_COMPLETE, this field indicates
535 whether the operation was successful or not; 0 in case of failure and
536 non-zero in case of success.
537 If grpc_completion_type is GRPC_QUEUE_SHUTDOWN or GRPC_QUEUE_TIMEOUT, this
538 field is guaranteed to be 0 */
539 int success;
540 /** The tag passed to grpc_call_start_batch etc to start this operation.
541 *Only* GRPC_OP_COMPLETE has a tag. For all other grpc_completion_type
542 values, tag is uninitialized. */
543 void* tag;
544} grpc_event;
545
546typedef struct {
547 size_t count;
548 size_t capacity;
549 grpc_metadata* metadata;
550} grpc_metadata_array;
551
552typedef struct {
553 grpc_slice method;
554 grpc_slice host;
555 gpr_timespec deadline;
556 uint32_t flags;
557 void* reserved;
558} grpc_call_details;
559
560typedef enum {
561 /** Send initial metadata: one and only one instance MUST be sent for each
562 call, unless the call was cancelled - in which case this can be skipped.
563 This op completes after all bytes of metadata have been accepted by
564 outgoing flow control. */
565 GRPC_OP_SEND_INITIAL_METADATA = 0,
566 /** Send a message: 0 or more of these operations can occur for each call.
567 This op completes after all bytes for the message have been accepted by
568 outgoing flow control. */
569 GRPC_OP_SEND_MESSAGE,
570 /** Send a close from the client: one and only one instance MUST be sent from
571 the client, unless the call was cancelled - in which case this can be
572 skipped. This op completes after all bytes for the call
573 (including the close) have passed outgoing flow control. */
574 GRPC_OP_SEND_CLOSE_FROM_CLIENT,
575 /** Send status from the server: one and only one instance MUST be sent from
576 the server unless the call was cancelled - in which case this can be
577 skipped. This op completes after all bytes for the call
578 (including the status) have passed outgoing flow control. */
579 GRPC_OP_SEND_STATUS_FROM_SERVER,
580 /** Receive initial metadata: one and only one MUST be made on the client,
581 must not be made on the server.
582 This op completes after all initial metadata has been read from the
583 peer. */
584 GRPC_OP_RECV_INITIAL_METADATA,
585 /** Receive a message: 0 or more of these operations can occur for each call.
586 This op completes after all bytes of the received message have been
587 read, or after a half-close has been received on this call. */
588 GRPC_OP_RECV_MESSAGE,
589 /** Receive status on the client: one and only one must be made on the client.
590 This operation always succeeds, meaning ops paired with this operation
591 will also appear to succeed, even though they may not have. In that case
592 the status will indicate some failure.
593 This op completes after all activity on the call has completed. */
594 GRPC_OP_RECV_STATUS_ON_CLIENT,
595 /** Receive close on the server: one and only one must be made on the
596 server. This op completes after the close has been received by the
597 server. This operation always succeeds, meaning ops paired with
598 this operation will also appear to succeed, even though they may not
599 have. */
600 GRPC_OP_RECV_CLOSE_ON_SERVER
601} grpc_op_type;
602
603struct grpc_byte_buffer;
604
605/** Operation data: one field for each op type (except SEND_CLOSE_FROM_CLIENT
606 which has no arguments) */
607typedef struct grpc_op {
608 /** Operation type, as defined by grpc_op_type */
609 grpc_op_type op;
610 /** Write flags bitset for grpc_begin_messages */
611 uint32_t flags;
612 /** Reserved for future usage */
613 void* reserved;
614 union grpc_op_data {
615 /** Reserved for future usage */
616 struct /* internal */ {
617 void* reserved[8];
618 } reserved;
619 struct grpc_op_send_initial_metadata {
620 size_t count;
621 grpc_metadata* metadata;
622 /** If \a is_set, \a compression_level will be used for the call.
623 * Otherwise, \a compression_level won't be considered */
624 struct grpc_op_send_initial_metadata_maybe_compression_level {
625 uint8_t is_set;
626 grpc_compression_level level;
627 } maybe_compression_level;
628 } send_initial_metadata;
629 struct grpc_op_send_message {
630 /** This op takes ownership of the slices in send_message. After
631 * a call completes, the contents of send_message are not guaranteed
632 * and likely empty. The original owner should still call
633 * grpc_byte_buffer_destroy() on this object however.
634 */
635 struct grpc_byte_buffer* send_message;
636 } send_message;
637 struct grpc_op_send_status_from_server {
638 size_t trailing_metadata_count;
639 grpc_metadata* trailing_metadata;
640 grpc_status_code status;
641 /** optional: set to NULL if no details need sending, non-NULL if they do
642 * pointer will not be retained past the start_batch call
643 */
644 grpc_slice* status_details;
645 } send_status_from_server;
646 /** ownership of the array is with the caller, but ownership of the elements
647 stays with the call object (ie key, value members are owned by the call
648 object, recv_initial_metadata->array is owned by the caller).
649 After the operation completes, call grpc_metadata_array_destroy on this
650 value, or reuse it in a future op. */
651 struct grpc_op_recv_initial_metadata {
652 grpc_metadata_array* recv_initial_metadata;
653 } recv_initial_metadata;
654 /** ownership of the byte buffer is moved to the caller; the caller must
655 call grpc_byte_buffer_destroy on this value, or reuse it in a future op.
656 The returned byte buffer will be NULL if trailing metadata was
657 received instead of a message.
658 */
659 struct grpc_op_recv_message {
660 struct grpc_byte_buffer** recv_message;
661 } recv_message;
662 struct grpc_op_recv_status_on_client {
663 /** ownership of the array is with the caller, but ownership of the
664 elements stays with the call object (ie key, value members are owned
665 by the call object, trailing_metadata->array is owned by the caller).
666 After the operation completes, call grpc_metadata_array_destroy on
667 this value, or reuse it in a future op. */
668 grpc_metadata_array* trailing_metadata;
669 grpc_status_code* status;
670 grpc_slice* status_details;
671 /** If this is not nullptr, it will be populated with the full fidelity
672 * error string for debugging purposes. The application is responsible
673 * for freeing the data by using gpr_free(). */
674 const char** error_string;
675 } recv_status_on_client;
676 struct grpc_op_recv_close_on_server {
677 /** out argument, set to 1 if the call failed in any way (seen as a
678 cancellation on the server), or 0 if the call succeeded */
679 int* cancelled;
680 } recv_close_on_server;
681 } data;
682} grpc_op;
683
684/** Information requested from the channel. */
685typedef struct {
686 /** If non-NULL, will be set to point to a string indicating the LB
687 * policy name. Caller takes ownership. */
688 char** lb_policy_name;
689 /** If non-NULL, will be set to point to a string containing the
690 * service config used by the channel in JSON form. */
691 char** service_config_json;
692} grpc_channel_info;
693
694typedef struct grpc_resource_quota grpc_resource_quota;
695
696/** Completion queues internally MAY maintain a set of file descriptors in a
697 structure called 'pollset'. This enum specifies if a completion queue has an
698 associated pollset and any restrictions on the type of file descriptors that
699 can be present in the pollset.
700
701 I/O progress can only be made when grpc_completion_queue_next() or
702 grpc_completion_queue_pluck() are called on the completion queue (unless the
703 grpc_cq_polling_type is GRPC_CQ_NON_POLLING) and hence it is very important
704 to actively call these APIs */
705typedef enum {
706 /** The completion queue will have an associated pollset and there is no
707 restriction on the type of file descriptors the pollset may contain */
708 GRPC_CQ_DEFAULT_POLLING,
709
710 /** Similar to GRPC_CQ_DEFAULT_POLLING except that the completion queues will
711 not contain any 'listening file descriptors' (i.e file descriptors used to
712 listen to incoming channels) */
713 GRPC_CQ_NON_LISTENING,
714
715 /** The completion queue will not have an associated pollset. Note that
716 grpc_completion_queue_next() or grpc_completion_queue_pluck() MUST still
717 be called to pop events from the completion queue; it is not required to
718 call them actively to make I/O progress */
719 GRPC_CQ_NON_POLLING
720} grpc_cq_polling_type;
721
722/** Specifies the type of APIs to use to pop events from the completion queue */
723typedef enum {
724 /** Events are popped out by calling grpc_completion_queue_next() API ONLY */
725 GRPC_CQ_NEXT,
726
727 /** Events are popped out by calling grpc_completion_queue_pluck() API ONLY*/
728 GRPC_CQ_PLUCK,
729
730 /** EXPERIMENTAL: Events trigger a callback specified as the tag */
731 GRPC_CQ_CALLBACK
732} grpc_cq_completion_type;
733
734/** EXPERIMENTAL: Specifies an interface class to be used as a tag
735 for callback-based completion queues. This can be used directly,
736 as the first element of a struct in C, or as a base class in C++.
737 Its "run" value should be assigned to some non-member function, such as
738 a static method. */
739typedef struct grpc_experimental_completion_queue_functor {
740 /** The run member specifies a function that will be called when this
741 tag is extracted from the completion queue. Its arguments will be a
742 pointer to this functor and a boolean that indicates whether the
743 operation succeeded (non-zero) or failed (zero) */
744 void (*functor_run)(struct grpc_experimental_completion_queue_functor*, int);
745
746 /** The inlineable member specifies whether this functor can be run inline.
747 This should only be used for trivial internally-defined functors. */
748 int inlineable;
749
750 /** The following fields are not API. They are meant for internal use. */
751 int internal_success;
752 struct grpc_experimental_completion_queue_functor* internal_next;
753} grpc_experimental_completion_queue_functor;
754
755/* The upgrade to version 2 is currently experimental. */
756
757#define GRPC_CQ_CURRENT_VERSION 2
758#define GRPC_CQ_VERSION_MINIMUM_FOR_CALLBACKABLE 2
759typedef struct grpc_completion_queue_attributes {
760 /** The version number of this structure. More fields might be added to this
761 structure in future. */
762 int version; /** Set to GRPC_CQ_CURRENT_VERSION */
763
764 grpc_cq_completion_type cq_completion_type;
765
766 grpc_cq_polling_type cq_polling_type;
767
768 /* END OF VERSION 1 CQ ATTRIBUTES */
769
770 /* EXPERIMENTAL: START OF VERSION 2 CQ ATTRIBUTES */
771 /** When creating a callbackable CQ, pass in a functor to get invoked when
772 * shutdown is complete */
773 grpc_experimental_completion_queue_functor* cq_shutdown_cb;
774
775 /* END OF VERSION 2 CQ ATTRIBUTES */
776} grpc_completion_queue_attributes;
777
778/** The completion queue factory structure is opaque to the callers of grpc */
779typedef struct grpc_completion_queue_factory grpc_completion_queue_factory;
780
781#ifdef __cplusplus
782}
783#endif
784
785#endif /* GRPC_IMPL_CODEGEN_GRPC_TYPES_H */
786

source code of include/grpc/impl/codegen/grpc_types.h