GRPC C++  1.26.0
grpc_types.h
Go to the documentation of this file.
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 
23 
28 
29 #include <stddef.h>
30 
31 #ifdef __cplusplus
32 extern "C" {
33 #endif
34 
35 typedef enum {
39 
40 typedef struct grpc_byte_buffer {
41  void* reserved;
44  struct /* internal */ {
45  void* reserved[8];
50  } raw;
51  } data;
53 
57 
59 typedef struct grpc_alarm grpc_alarm;
60 
62 typedef struct grpc_channel grpc_channel;
63 
65 typedef struct grpc_server grpc_server;
66 
70 typedef struct grpc_call grpc_call;
71 
74 
77 
79 typedef enum {
84 
85 typedef struct grpc_arg_pointer_vtable {
86  void* (*copy)(void* p);
87  void (*destroy)(void* p);
88  int (*cmp)(void* p, void* q);
90 
103 typedef struct {
105  char* key;
107  char* string;
108  int integer;
110  void* p;
112  } pointer;
113  } value;
114 } grpc_arg;
115 
132 typedef struct {
133  size_t num_args;
136 
142 #define GRPC_ARG_ENABLE_CENSUS "grpc.census"
144 #define GRPC_ARG_ENABLE_LOAD_REPORTING "grpc.loadreporting"
147 #define GRPC_ARG_MINIMAL_STACK "grpc.minimal_stack"
150 #define GRPC_ARG_MAX_CONCURRENT_STREAMS "grpc.max_concurrent_streams"
153 #define GRPC_ARG_MAX_RECEIVE_MESSAGE_LENGTH "grpc.max_receive_message_length"
156 #define GRPC_ARG_MAX_MESSAGE_LENGTH GRPC_ARG_MAX_RECEIVE_MESSAGE_LENGTH
159 #define GRPC_ARG_MAX_SEND_MESSAGE_LENGTH "grpc.max_send_message_length"
163 #define GRPC_ARG_MAX_CONNECTION_IDLE_MS "grpc.max_connection_idle_ms"
166 #define GRPC_ARG_MAX_CONNECTION_AGE_MS "grpc.max_connection_age_ms"
169 #define GRPC_ARG_MAX_CONNECTION_AGE_GRACE_MS "grpc.max_connection_age_grace_ms"
173 #define GRPC_ARG_CLIENT_IDLE_TIMEOUT_MS "grpc.client_idle_timeout_ms"
176 #define GRPC_ARG_ENABLE_PER_MESSAGE_COMPRESSION "grpc.per_message_compression"
179 #define GRPC_ARG_ENABLE_DEADLINE_CHECKS "grpc.enable_deadline_checking"
181 #define GRPC_ARG_HTTP2_INITIAL_SEQUENCE_NUMBER \
182  "grpc.http2.initial_sequence_number"
187 #define GRPC_ARG_HTTP2_STREAM_LOOKAHEAD_BYTES "grpc.http2.lookahead_bytes"
189 #define GRPC_ARG_HTTP2_HPACK_TABLE_SIZE_DECODER \
190  "grpc.http2.hpack_table_size.decoder"
192 #define GRPC_ARG_HTTP2_HPACK_TABLE_SIZE_ENCODER \
193  "grpc.http2.hpack_table_size.encoder"
197 #define GRPC_ARG_HTTP2_MAX_FRAME_SIZE "grpc.http2.max_frame_size"
199 #define GRPC_ARG_HTTP2_BDP_PROBE "grpc.http2.bdp_probe"
202 #define GRPC_ARG_HTTP2_MIN_SENT_PING_INTERVAL_WITHOUT_DATA_MS \
203  "grpc.http2.min_time_between_pings_ms"
206 #define GRPC_ARG_HTTP2_MIN_RECV_PING_INTERVAL_WITHOUT_DATA_MS \
207  "grpc.http2.min_ping_interval_without_data_ms"
209 #define GRPC_ARG_HTTP2_SCHEME "grpc.http2_scheme"
213 #define GRPC_ARG_HTTP2_MAX_PINGS_WITHOUT_DATA \
214  "grpc.http2.max_pings_without_data"
218 #define GRPC_ARG_HTTP2_MAX_PING_STRIKES "grpc.http2.max_ping_strikes"
221 #define GRPC_ARG_HTTP2_WRITE_BUFFER_SIZE "grpc.http2.write_buffer_size"
224 #define GRPC_ARG_HTTP2_ENABLE_TRUE_BINARY "grpc.http2.true_binary"
227 #define GRPC_ARG_KEEPALIVE_TIME_MS "grpc.keepalive_time_ms"
231 #define GRPC_ARG_KEEPALIVE_TIMEOUT_MS "grpc.keepalive_timeout_ms"
234 #define GRPC_ARG_KEEPALIVE_PERMIT_WITHOUT_CALLS \
235  "grpc.keepalive_permit_without_calls"
238 #define GRPC_ARG_DEFAULT_AUTHORITY "grpc.default_authority"
241 #define GRPC_ARG_PRIMARY_USER_AGENT_STRING "grpc.primary_user_agent"
244 #define GRPC_ARG_SECONDARY_USER_AGENT_STRING "grpc.secondary_user_agent"
246 #define GRPC_ARG_MIN_RECONNECT_BACKOFF_MS "grpc.min_reconnect_backoff_ms"
248 #define GRPC_ARG_MAX_RECONNECT_BACKOFF_MS "grpc.max_reconnect_backoff_ms"
250 #define GRPC_ARG_INITIAL_RECONNECT_BACKOFF_MS \
251  "grpc.initial_reconnect_backoff_ms"
253 #define GRPC_ARG_DNS_MIN_TIME_BETWEEN_RESOLUTIONS_MS \
254  "grpc.dns_min_time_between_resolutions_ms"
257 #define GRPC_ARG_SERVER_HANDSHAKE_TIMEOUT_MS "grpc.server_handshake_timeout_ms"
265 #define GRPC_SSL_TARGET_NAME_OVERRIDE_ARG "grpc.ssl_target_name_override"
269 #define GRPC_SSL_SESSION_CACHE_ARG "grpc.ssl_session_cache"
277 #define GRPC_ARG_TSI_MAX_FRAME_SIZE "grpc.tsi.max_frame_size"
280 #define GRPC_ARG_MAX_METADATA_SIZE "grpc.max_metadata_size"
282 #define GRPC_ARG_ALLOW_REUSEPORT "grpc.so_reuseport"
286 #define GRPC_ARG_RESOURCE_QUOTA "grpc.resource_quota"
288 #define GRPC_ARG_EXPAND_WILDCARD_ADDRS "grpc.expand_wildcard_addrs"
291 #define GRPC_ARG_SERVICE_CONFIG "grpc.service_config"
293 #define GRPC_ARG_SERVICE_CONFIG_DISABLE_RESOLUTION \
294  "grpc.service_config_disable_resolution"
296 #define GRPC_ARG_LB_POLICY_NAME "grpc.lb_policy_name"
298 #define GRPC_ARG_SOCKET_MUTATOR "grpc.socket_mutator"
300 #define GRPC_ARG_SOCKET_FACTORY "grpc.socket_factory"
305 #define GRPC_ARG_MAX_CHANNEL_TRACE_EVENT_MEMORY_PER_NODE \
306  "grpc.max_channel_trace_event_memory_per_node"
310 #define GRPC_ARG_ENABLE_CHANNELZ "grpc.enable_channelz"
313 #define GRPC_ARG_USE_CRONET_PACKET_COALESCING \
314  "grpc.use_cronet_packet_coalescing"
317 #define GRPC_ARG_TCP_READ_CHUNK_SIZE "grpc.experimental.tcp_read_chunk_size"
321 #define GRPC_TCP_DEFAULT_READ_SLICE_SIZE 8192
322 #define GRPC_ARG_TCP_MIN_READ_CHUNK_SIZE \
323  "grpc.experimental.tcp_min_read_chunk_size"
324 #define GRPC_ARG_TCP_MAX_READ_CHUNK_SIZE \
325  "grpc.experimental.tcp_max_read_chunk_size"
326 /* Timeout in milliseconds to use for calls to the grpclb load balancer.
327  If 0 or unset, the balancer calls will have no deadline. */
328 #define GRPC_ARG_GRPCLB_CALL_TIMEOUT_MS "grpc.grpclb_call_timeout_ms"
329 /* Timeout in milliseconds to wait for the serverlist from the grpclb load
330  balancer before using fallback backend addresses from the resolver.
331  If 0, enter fallback mode immediately. Default value is 10000. */
332 #define GRPC_ARG_GRPCLB_FALLBACK_TIMEOUT_MS "grpc.grpclb_fallback_timeout_ms"
333 /* Timeout in milliseconds to wait for the serverlist from the xDS load
334  balancer before using fallback backend addresses from the resolver.
335  If 0, enter fallback mode immediately. Default value is 10000. */
336 #define GRPC_ARG_XDS_FALLBACK_TIMEOUT_MS "grpc.xds_fallback_timeout_ms"
337 /* Time in milliseconds to wait before a locality is deleted after it's removed
338  from the received EDS update. If 0, delete the locality immediately. Default
339  value is 15 minutes. */
340 #define GRPC_ARG_LOCALITY_RETENTION_INTERVAL_MS \
341  "grpc.xds_locality_retention_interval_ms"
342 /* Timeout in milliseconds to wait for the localities of a specific priority to
343  complete their initial connection attempt before xDS fails over to the next
344  priority. Specifically, the connection attempt of a priority is considered
345  completed when any locality of that priority is ready or all the localities
346  of that priority fail to connect. If 0, failover happens immediately. Default
347  value is 10 seconds. */
348 #define GRPC_ARG_XDS_FAILOVER_TIMEOUT_MS "grpc.xds_failover_timeout_ms"
350 #define GRPC_ARG_WORKAROUND_CRONET_COMPRESSION \
351  "grpc.workaround.cronet_compression"
359 #define GRPC_ARG_OPTIMIZATION_TARGET "grpc.optimization_target"
365 #define GRPC_ARG_ENABLE_RETRIES "grpc.enable_retries"
367 #define GRPC_ARG_PER_RPC_RETRY_BUFFER_SIZE "grpc.per_rpc_retry_buffer_size"
370 #define GRPC_ARG_MOBILE_LOG_CONTEXT "grpc.mobile_log_context"
372 #define GRPC_ARG_DISABLE_CLIENT_AUTHORITY_FILTER \
373  "grpc.disable_client_authority_filter"
375 #define GRPC_ARG_ENABLE_HTTP_PROXY "grpc.enable_http_proxy"
378 #define GRPC_ARG_SURFACE_USER_AGENT "grpc.surface_user_agent"
381 #define GRPC_ARG_INHIBIT_HEALTH_CHECKING "grpc.inhibit_health_checking"
386 #define GRPC_ARG_DNS_ENABLE_SRV_QUERIES "grpc.dns_enable_srv_queries"
393 #define GRPC_ARG_DNS_ARES_QUERY_TIMEOUT_MS "grpc.dns_ares_query_timeout"
396 #define GRPC_ARG_USE_LOCAL_SUBCHANNEL_POOL "grpc.use_local_subchannel_pool"
398 #define GRPC_ARG_CHANNEL_POOL_DOMAIN "grpc.channel_pooling_domain"
400 #define GRPC_ARG_CHANNEL_ID "grpc.channel_id"
407 typedef enum grpc_call_error {
443 
446 #define GRPC_DEFAULT_MAX_SEND_MESSAGE_LENGTH -1
447 #define GRPC_DEFAULT_MAX_RECV_MESSAGE_LENGTH (4 * 1024 * 1024)
448 
453 #define GRPC_WRITE_BUFFER_HINT (0x00000001u)
456 #define GRPC_WRITE_NO_COMPRESS (0x00000002u)
458 #define GRPC_WRITE_THROUGH (0x00000004u)
460 #define GRPC_WRITE_USED_MASK \
461  (GRPC_WRITE_BUFFER_HINT | GRPC_WRITE_NO_COMPRESS | GRPC_WRITE_THROUGH)
462 
465 #define GRPC_INITIAL_METADATA_IDEMPOTENT_REQUEST (0x00000010u)
467 #define GRPC_INITIAL_METADATA_WAIT_FOR_READY (0x00000020u)
469 #define GRPC_INITIAL_METADATA_CACHEABLE_REQUEST (0x00000040u)
472 #define GRPC_INITIAL_METADATA_WAIT_FOR_READY_EXPLICITLY_SET (0x00000080u)
474 #define GRPC_INITIAL_METADATA_CORKED (0x00000100u)
475 
477 #define GRPC_INITIAL_METADATA_USED_MASK \
478  (GRPC_INITIAL_METADATA_IDEMPOTENT_REQUEST | \
479  GRPC_INITIAL_METADATA_WAIT_FOR_READY | \
480  GRPC_INITIAL_METADATA_CACHEABLE_REQUEST | \
481  GRPC_INITIAL_METADATA_WAIT_FOR_READY_EXPLICITLY_SET | \
482  GRPC_INITIAL_METADATA_CORKED | GRPC_WRITE_THROUGH)
483 
485 typedef struct grpc_metadata {
490 
491  uint32_t flags;
492 
496  struct /* internal */ {
497  void* obfuscated[4];
500 
502 typedef enum grpc_completion_type {
510 
514 typedef struct grpc_event {
522  int success;
526  void* tag;
528 
529 typedef struct {
530  size_t count;
531  size_t capacity;
534 
535 typedef struct {
539  uint32_t flags;
540  void* reserved;
542 
543 typedef enum {
585 
586 struct grpc_byte_buffer;
587 
590 typedef struct grpc_op {
594  uint32_t flags;
596  void* reserved;
597  union grpc_op_data {
599  struct /* internal */ {
600  void* reserved[8];
603  size_t count;
608  uint8_t is_set;
657  const char** error_string;
662  int* cancelled;
664  } data;
666 
668 typedef struct {
676 
678 
688 typedef enum {
692 
697 
704 
706 typedef enum {
709 
712 
716 
728 
732 
737 
738 /* The upgrade to version 2 is currently experimental. */
739 
740 #define GRPC_CQ_CURRENT_VERSION 2
741 #define GRPC_CQ_VERSION_MINIMUM_FOR_CALLBACKABLE 2
745  int version;
748 
750 
751  /* END OF VERSION 1 CQ ATTRIBUTES */
752 
753  /* EXPERIMENTAL: START OF VERSION 2 CQ ATTRIBUTES */
757 
758  /* END OF VERSION 2 CQ ATTRIBUTES */
760 
763 
764 #ifdef __cplusplus
765 }
766 #endif
767 
768 #endif /* GRPC_IMPL_CODEGEN_GRPC_TYPES_H */
grpc_compression_level
Compression levels allow a party with knowledge of its peer's accepted encodings to request compressi...
Definition: compression_types.h:71
grpc_compression_algorithm
The various compression algorithms supported by gRPC (not sorted by compression level)
Definition: compression_types.h:57
grpc_status_code
Definition: status.h:26
struct grpc_op grpc_op
Operation data: one field for each op type (except SEND_CLOSE_FROM_CLIENT which has no arguments)
struct grpc_alarm grpc_alarm
An alarm associated with a completion queue.
Definition: grpc_types.h:59
grpc_arg_type
Type specifier for grpc_arg.
Definition: grpc_types.h:79
@ GRPC_ARG_POINTER
Definition: grpc_types.h:82
@ GRPC_ARG_STRING
Definition: grpc_types.h:80
@ GRPC_ARG_INTEGER
Definition: grpc_types.h:81
grpc_call_error
Result of a grpc call.
Definition: grpc_types.h:407
@ GRPC_CALL_ERROR_ALREADY_INVOKED
this method must be called before invoke
Definition: grpc_types.h:419
@ GRPC_CALL_ERROR_INVALID_METADATA
invalid metadata was passed to this call
Definition: grpc_types.h:430
@ GRPC_CALL_ERROR_NOT_ON_SERVER
this method is not available on the server
Definition: grpc_types.h:413
@ GRPC_CALL_ERROR_ALREADY_FINISHED
this call is already finished (writes_done or write_status has already been called)
Definition: grpc_types.h:424
@ GRPC_CALL_ERROR_COMPLETION_QUEUE_SHUTDOWN
completion queue has been shutdown
Definition: grpc_types.h:441
@ GRPC_CALL_ERROR_ALREADY_ACCEPTED
this method must be called before server_accept
Definition: grpc_types.h:417
@ GRPC_CALL_OK
everything went ok
Definition: grpc_types.h:409
@ GRPC_CALL_ERROR_PAYLOAD_TYPE_MISMATCH
payload type requested is not the type registered
Definition: grpc_types.h:439
@ GRPC_CALL_ERROR_NOT_INVOKED
this method must be called after invoke
Definition: grpc_types.h:421
@ GRPC_CALL_ERROR_NOT_ON_CLIENT
this method is not available on the client
Definition: grpc_types.h:415
@ GRPC_CALL_ERROR_INVALID_MESSAGE
invalid message was passed to this call
Definition: grpc_types.h:432
@ GRPC_CALL_ERROR_TOO_MANY_OPERATIONS
there is already an outstanding read/write operation on the call
Definition: grpc_types.h:426
@ GRPC_CALL_ERROR
something failed, we don't know what
Definition: grpc_types.h:411
@ GRPC_CALL_ERROR_BATCH_TOO_BIG
this batch of operations leads to more operations than allowed
Definition: grpc_types.h:437
@ GRPC_CALL_ERROR_NOT_SERVER_COMPLETION_QUEUE
completion queue for notification has not been registered with the server
Definition: grpc_types.h:435
@ GRPC_CALL_ERROR_INVALID_FLAGS
the flags value was illegal for this call
Definition: grpc_types.h:428
struct grpc_call grpc_call
A Call represents an RPC.
Definition: grpc_types.h:70
struct grpc_metadata grpc_metadata
A single metadata element.
struct grpc_resource_quota grpc_resource_quota
Definition: grpc_types.h:677
grpc_cq_completion_type
Specifies the type of APIs to use to pop events from the completion queue.
Definition: grpc_types.h:706
@ GRPC_CQ_NEXT
Events are popped out by calling grpc_completion_queue_next() API ONLY.
Definition: grpc_types.h:708
@ GRPC_CQ_PLUCK
Events are popped out by calling grpc_completion_queue_pluck() API ONLY.
Definition: grpc_types.h:711
@ GRPC_CQ_CALLBACK
EXPERIMENTAL: Events trigger a callback specified as the tag.
Definition: grpc_types.h:714
struct grpc_server grpc_server
A server listens to some port and responds to request calls.
Definition: grpc_types.h:65
grpc_op_type
Definition: grpc_types.h:543
@ GRPC_OP_SEND_STATUS_FROM_SERVER
Send status from the server: one and only one instance MUST be sent from the server unless the call w...
Definition: grpc_types.h:562
@ GRPC_OP_RECV_STATUS_ON_CLIENT
Receive status on the client: one and only one must be made on the client.
Definition: grpc_types.h:577
@ GRPC_OP_SEND_CLOSE_FROM_CLIENT
Send a close from the client: one and only one instance MUST be sent from the client,...
Definition: grpc_types.h:557
@ GRPC_OP_RECV_CLOSE_ON_SERVER
Receive close on the server: one and only one must be made on the server.
Definition: grpc_types.h:583
@ GRPC_OP_SEND_MESSAGE
Send a message: 0 or more of these operations can occur for each call.
Definition: grpc_types.h:552
@ GRPC_OP_RECV_INITIAL_METADATA
Receive initial metadata: one and only one MUST be made on the client, must not be made on the server...
Definition: grpc_types.h:567
@ GRPC_OP_SEND_INITIAL_METADATA
Send initial metadata: one and only one instance MUST be sent for each call, unless the call was canc...
Definition: grpc_types.h:548
@ GRPC_OP_RECV_MESSAGE
Receive a message: 0 or more of these operations can occur for each call.
Definition: grpc_types.h:571
struct grpc_channel grpc_channel
The Channel interface allows creation of Call objects.
Definition: grpc_types.h:62
struct grpc_completion_queue_attributes grpc_completion_queue_attributes
struct grpc_byte_buffer grpc_byte_buffer
struct grpc_socket_factory grpc_socket_factory
The Socket Factory interface creates and binds sockets.
Definition: grpc_types.h:76
grpc_cq_polling_type
Completion queues internally MAY maintain a set of file descriptors in a structure called 'pollset'.
Definition: grpc_types.h:688
@ GRPC_CQ_NON_POLLING
The completion queue will not have an associated pollset.
Definition: grpc_types.h:702
@ GRPC_CQ_NON_LISTENING
Similar to GRPC_CQ_DEFAULT_POLLING except that the completion queues will not contain any 'listening ...
Definition: grpc_types.h:696
@ GRPC_CQ_DEFAULT_POLLING
The completion queue will have an associated pollset and there is no restriction on the type of file ...
Definition: grpc_types.h:691
struct grpc_socket_mutator grpc_socket_mutator
The Socket Mutator interface allows changes on socket options.
Definition: grpc_types.h:73
struct grpc_completion_queue_factory grpc_completion_queue_factory
The completion queue factory structure is opaque to the callers of grpc.
Definition: grpc_types.h:762
struct grpc_completion_queue grpc_completion_queue
Completion Queues enable notification of the completion of asynchronous actions.
Definition: grpc_types.h:56
struct grpc_arg_pointer_vtable grpc_arg_pointer_vtable
struct grpc_experimental_completion_queue_functor grpc_experimental_completion_queue_functor
EXPERIMENTAL: Specifies an interface class to be used as a tag for callback-based completion queues.
grpc_completion_type
The type of completion (for grpc_event)
Definition: grpc_types.h:502
@ GRPC_OP_COMPLETE
Operation completion.
Definition: grpc_types.h:508
@ GRPC_QUEUE_TIMEOUT
No event before timeout.
Definition: grpc_types.h:506
@ GRPC_QUEUE_SHUTDOWN
Shutting down.
Definition: grpc_types.h:504
grpc_byte_buffer_type
Definition: grpc_types.h:35
@ GRPC_BB_RAW
Future types may include GRPC_BB_PROTOBUF, etc.
Definition: grpc_types.h:36
struct grpc_event grpc_event
The result of an operation.
Analogous to struct timespec.
Definition: gpr_types.h:47
Definition: grpc_types.h:109
const grpc_arg_pointer_vtable * vtable
Definition: grpc_types.h:111
void * p
Definition: grpc_types.h:110
Definition: grpc_types.h:85
int(* cmp)(void *p, void *q)
Definition: grpc_types.h:88
void(* destroy)(void *p)
Definition: grpc_types.h:87
A single argument...
Definition: grpc_types.h:103
grpc_arg_type type
Definition: grpc_types.h:104
char * key
Definition: grpc_types.h:105
grpc_compression_algorithm compression
Definition: grpc_types.h:48
grpc_slice_buffer slice_buffer
Definition: grpc_types.h:49
Definition: grpc_types.h:40
void * reserved
Definition: grpc_types.h:41
union grpc_byte_buffer::grpc_byte_buffer_data data
grpc_byte_buffer_type type
Definition: grpc_types.h:42
Definition: grpc_types.h:535
void * reserved
Definition: grpc_types.h:540
gpr_timespec deadline
Definition: grpc_types.h:538
grpc_slice method
Definition: grpc_types.h:536
uint32_t flags
Definition: grpc_types.h:539
grpc_slice host
Definition: grpc_types.h:537
An array of arguments that can be passed around.
Definition: grpc_types.h:132
grpc_arg * args
Definition: grpc_types.h:134
size_t num_args
Definition: grpc_types.h:133
Information requested from the channel.
Definition: grpc_types.h:668
char ** service_config_json
If non-NULL, will be set to point to a string containing the service config used by the channel in JS...
Definition: grpc_types.h:674
char ** lb_policy_name
If non-NULL, will be set to point to a string indicating the LB policy name.
Definition: grpc_types.h:671
Definition: grpc_types.h:742
grpc_cq_completion_type cq_completion_type
Set to GRPC_CQ_CURRENT_VERSION.
Definition: grpc_types.h:747
grpc_experimental_completion_queue_functor * cq_shutdown_cb
When creating a callbackable CQ, pass in a functor to get invoked when shutdown is complete.
Definition: grpc_types.h:756
int version
The version number of this structure.
Definition: grpc_types.h:745
grpc_cq_polling_type cq_polling_type
Definition: grpc_types.h:749
The result of an operation.
Definition: grpc_types.h:514
void * tag
The tag passed to grpc_call_start_batch etc to start this operation.
Definition: grpc_types.h:526
grpc_completion_type type
The type of the completion.
Definition: grpc_types.h:516
int success
If the grpc_completion_type is GRPC_OP_COMPLETE, this field indicates whether the operation was succe...
Definition: grpc_types.h:522
EXPERIMENTAL: Specifies an interface class to be used as a tag for callback-based completion queues.
Definition: grpc_types.h:722
int internal_success
The following fields are not API.
Definition: grpc_types.h:734
void(* functor_run)(struct grpc_experimental_completion_queue_functor *, int)
The run member specifies a function that will be called when this tag is extracted from the completio...
Definition: grpc_types.h:727
int inlineable
The inlineable member specifies whether this functor can be run inline.
Definition: grpc_types.h:731
struct grpc_experimental_completion_queue_functor * internal_next
Definition: grpc_types.h:735
Definition: grpc_types.h:529
size_t count
Definition: grpc_types.h:530
size_t capacity
Definition: grpc_types.h:531
grpc_metadata * metadata
Definition: grpc_types.h:532
A single metadata element.
Definition: grpc_types.h:485
uint32_t flags
Definition: grpc_types.h:491
void * obfuscated[4]
Definition: grpc_types.h:497
struct grpc_metadata::@1 internal_data
The following fields are reserved for grpc internal use.
grpc_slice key
the key, value values are expected to line up with grpc_mdelem: if changing them, update metadata....
Definition: grpc_types.h:488
grpc_slice value
Definition: grpc_types.h:489
int * cancelled
out argument, set to 1 if the call failed in any way (seen as a cancellation on the server),...
Definition: grpc_types.h:662
ownership of the array is with the caller, but ownership of the elements stays with the call object (...
Definition: grpc_types.h:634
grpc_metadata_array * recv_initial_metadata
Definition: grpc_types.h:635
ownership of the byte buffer is moved to the caller; the caller must call grpc_byte_buffer_destroy on...
Definition: grpc_types.h:642
struct grpc_byte_buffer ** recv_message
Definition: grpc_types.h:643
grpc_status_code * status
Definition: grpc_types.h:652
const char ** error_string
If this is not nullptr, it will be populated with the full fidelity error string for debugging purpos...
Definition: grpc_types.h:657
grpc_slice * status_details
Definition: grpc_types.h:653
grpc_metadata_array * trailing_metadata
ownership of the array is with the caller, but ownership of the elements stays with the call object (...
Definition: grpc_types.h:651
If is_set, compression_level will be used for the call.
Definition: grpc_types.h:607
struct grpc_op::grpc_op_data::grpc_op_send_initial_metadata::grpc_op_send_initial_metadata_maybe_compression_level maybe_compression_level
grpc_metadata * metadata
Definition: grpc_types.h:604
size_t count
Definition: grpc_types.h:603
struct grpc_byte_buffer * send_message
This op takes ownership of the slices in send_message.
Definition: grpc_types.h:618
grpc_metadata * trailing_metadata
Definition: grpc_types.h:622
grpc_slice * status_details
optional: set to NULL if no details need sending, non-NULL if they do pointer will not be retained pa...
Definition: grpc_types.h:627
size_t trailing_metadata_count
Definition: grpc_types.h:621
grpc_status_code status
Definition: grpc_types.h:623
Operation data: one field for each op type (except SEND_CLOSE_FROM_CLIENT which has no arguments)
Definition: grpc_types.h:590
union grpc_op::grpc_op_data data
void * reserved
Reserved for future usage.
Definition: grpc_types.h:596
uint32_t flags
Write flags bitset for grpc_begin_messages.
Definition: grpc_types.h:594
grpc_op_type op
Operation type, as defined by grpc_op_type.
Definition: grpc_types.h:592
Represents an expandable array of slices, to be interpreted as a single item.
Definition: slice.h:78
A grpc_slice s, if initialized, represents the byte range s.bytes[0..s.length-1].
Definition: slice.h:60
Definition: grpc_types.h:106
int integer
Definition: grpc_types.h:108
char * string
Definition: grpc_types.h:107
Definition: grpc_types.h:43
void * reserved[8]
Definition: grpc_types.h:45
struct grpc_byte_buffer::grpc_byte_buffer_data::grpc_compressed_buffer raw
Definition: grpc_types.h:597
struct grpc_op::grpc_op_data::grpc_op_recv_message recv_message
struct grpc_op::grpc_op_data::grpc_op_recv_initial_metadata recv_initial_metadata
struct grpc_op::grpc_op_data::grpc_op_send_initial_metadata send_initial_metadata
struct grpc_op::grpc_op_data::grpc_op_send_message send_message
struct grpc_op::grpc_op_data::grpc_op_recv_close_on_server recv_close_on_server
struct grpc_op::grpc_op_data::grpc_op_recv_status_on_client recv_status_on_client
struct grpc_op::grpc_op_data::grpc_op_send_status_from_server send_status_from_server
void * reserved[8]
Definition: grpc_types.h:600