GRPC C++  1.50.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 
22 // IWYU pragma: private, include <grpc/grpc.h>
23 // IWYU pragma: friend "src/.*"
24 
26 
27 #include <stddef.h>
28 
33 
34 #ifdef __cplusplus
35 extern "C" {
36 #endif
37 
38 typedef enum {
42 
43 typedef struct grpc_byte_buffer {
44  void* reserved;
47  struct /* internal */ {
48  void* reserved[8];
49  } reserved;
53  } raw;
54  } data;
56 
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"
143 
144 #define GRPC_ARG_ENABLE_LOAD_REPORTING "grpc.loadreporting"
145 
147 #define GRPC_ARG_MINIMAL_STACK "grpc.minimal_stack"
148 
150 #define GRPC_ARG_MAX_CONCURRENT_STREAMS "grpc.max_concurrent_streams"
151 
153 #define GRPC_ARG_MAX_RECEIVE_MESSAGE_LENGTH "grpc.max_receive_message_length"
154 
156 #define GRPC_ARG_MAX_MESSAGE_LENGTH GRPC_ARG_MAX_RECEIVE_MESSAGE_LENGTH
157 
159 #define GRPC_ARG_MAX_SEND_MESSAGE_LENGTH "grpc.max_send_message_length"
160 
163 #define GRPC_ARG_MAX_CONNECTION_IDLE_MS "grpc.max_connection_idle_ms"
164 
166 #define GRPC_ARG_MAX_CONNECTION_AGE_MS "grpc.max_connection_age_ms"
167 
169 #define GRPC_ARG_MAX_CONNECTION_AGE_GRACE_MS "grpc.max_connection_age_grace_ms"
170 
173 #define GRPC_ARG_CLIENT_IDLE_TIMEOUT_MS "grpc.client_idle_timeout_ms"
174 
176 #define GRPC_ARG_ENABLE_PER_MESSAGE_COMPRESSION "grpc.per_message_compression"
177 
180 #define GRPC_ARG_ENABLE_PER_MESSAGE_DECOMPRESSION \
181  "grpc.per_message_decompression"
182 
184 #define GRPC_ARG_ENABLE_DEADLINE_CHECKS "grpc.enable_deadline_checking"
185 
186 #define GRPC_ARG_HTTP2_INITIAL_SEQUENCE_NUMBER \
187  "grpc.http2.initial_sequence_number"
188 
192 #define GRPC_ARG_HTTP2_STREAM_LOOKAHEAD_BYTES "grpc.http2.lookahead_bytes"
193 
194 #define GRPC_ARG_HTTP2_HPACK_TABLE_SIZE_DECODER \
195  "grpc.http2.hpack_table_size.decoder"
196 
197 #define GRPC_ARG_HTTP2_HPACK_TABLE_SIZE_ENCODER \
198  "grpc.http2.hpack_table_size.encoder"
199 
202 #define GRPC_ARG_HTTP2_MAX_FRAME_SIZE "grpc.http2.max_frame_size"
203 
204 #define GRPC_ARG_HTTP2_BDP_PROBE "grpc.http2.bdp_probe"
205 
214 #define GRPC_ARG_HTTP2_MIN_SENT_PING_INTERVAL_WITHOUT_DATA_MS \
215  "grpc.http2.min_time_between_pings_ms"
216 
219 #define GRPC_ARG_HTTP2_MIN_RECV_PING_INTERVAL_WITHOUT_DATA_MS \
220  "grpc.http2.min_ping_interval_without_data_ms"
221 
222 #define GRPC_ARG_HTTP2_SCHEME "grpc.http2_scheme"
223 
226 #define GRPC_ARG_HTTP2_MAX_PINGS_WITHOUT_DATA \
227  "grpc.http2.max_pings_without_data"
228 
231 #define GRPC_ARG_HTTP2_MAX_PING_STRIKES "grpc.http2.max_ping_strikes"
232 
234 #define GRPC_ARG_HTTP2_WRITE_BUFFER_SIZE "grpc.http2.write_buffer_size"
235 
237 #define GRPC_ARG_HTTP2_ENABLE_TRUE_BINARY "grpc.http2.true_binary"
238 
240 #define GRPC_ARG_KEEPALIVE_TIME_MS "grpc.keepalive_time_ms"
241 
244 #define GRPC_ARG_KEEPALIVE_TIMEOUT_MS "grpc.keepalive_timeout_ms"
245 
247 #define GRPC_ARG_KEEPALIVE_PERMIT_WITHOUT_CALLS \
248  "grpc.keepalive_permit_without_calls"
249 
251 #define GRPC_ARG_DEFAULT_AUTHORITY "grpc.default_authority"
252 
254 #define GRPC_ARG_PRIMARY_USER_AGENT_STRING "grpc.primary_user_agent"
255 
257 #define GRPC_ARG_SECONDARY_USER_AGENT_STRING "grpc.secondary_user_agent"
258 
259 #define GRPC_ARG_MIN_RECONNECT_BACKOFF_MS "grpc.min_reconnect_backoff_ms"
260 
261 #define GRPC_ARG_MAX_RECONNECT_BACKOFF_MS "grpc.max_reconnect_backoff_ms"
262 
263 #define GRPC_ARG_INITIAL_RECONNECT_BACKOFF_MS \
264  "grpc.initial_reconnect_backoff_ms"
265 
266 #define GRPC_ARG_DNS_MIN_TIME_BETWEEN_RESOLUTIONS_MS \
267  "grpc.dns_min_time_between_resolutions_ms"
268 
270 #define GRPC_ARG_SERVER_HANDSHAKE_TIMEOUT_MS "grpc.server_handshake_timeout_ms"
271 
278 #define GRPC_SSL_TARGET_NAME_OVERRIDE_ARG "grpc.ssl_target_name_override"
279 
282 #define GRPC_SSL_SESSION_CACHE_ARG "grpc.ssl_session_cache"
283 
290 #define GRPC_ARG_TSI_MAX_FRAME_SIZE "grpc.tsi.max_frame_size"
291 
293 #define GRPC_ARG_MAX_METADATA_SIZE "grpc.max_metadata_size"
294 
295 #define GRPC_ARG_ALLOW_REUSEPORT "grpc.so_reuseport"
296 
299 #define GRPC_ARG_RESOURCE_QUOTA "grpc.resource_quota"
300 
301 #define GRPC_ARG_EXPAND_WILDCARD_ADDRS "grpc.expand_wildcard_addrs"
302 
304 #define GRPC_ARG_SERVICE_CONFIG "grpc.service_config"
305 
306 #define GRPC_ARG_SERVICE_CONFIG_DISABLE_RESOLUTION \
307  "grpc.service_config_disable_resolution"
308 
309 #define GRPC_ARG_LB_POLICY_NAME "grpc.lb_policy_name"
310 
311 #define GRPC_ARG_SOCKET_MUTATOR "grpc.socket_mutator"
312 
313 #define GRPC_ARG_SOCKET_FACTORY "grpc.socket_factory"
314 
318 #define GRPC_ARG_MAX_CHANNEL_TRACE_EVENT_MEMORY_PER_NODE \
319  "grpc.max_channel_trace_event_memory_per_node"
320 
323 #define GRPC_ARG_ENABLE_CHANNELZ "grpc.enable_channelz"
324 
326 #define GRPC_ARG_USE_CRONET_PACKET_COALESCING \
327  "grpc.use_cronet_packet_coalescing"
328 
330 #define GRPC_ARG_TCP_READ_CHUNK_SIZE "grpc.experimental.tcp_read_chunk_size"
331 
334 #define GRPC_TCP_DEFAULT_READ_SLICE_SIZE 8192
335 #define GRPC_ARG_TCP_MIN_READ_CHUNK_SIZE \
336  "grpc.experimental.tcp_min_read_chunk_size"
337 #define GRPC_ARG_TCP_MAX_READ_CHUNK_SIZE \
338  "grpc.experimental.tcp_max_read_chunk_size"
339 /* TCP TX Zerocopy enable state: zero is disabled, non-zero is enabled. By
340  default, it is disabled. */
341 #define GRPC_ARG_TCP_TX_ZEROCOPY_ENABLED \
342  "grpc.experimental.tcp_tx_zerocopy_enabled"
343 /* TCP TX Zerocopy send threshold: only zerocopy if >= this many bytes sent. By
344  default, this is set to 16KB. */
345 #define GRPC_ARG_TCP_TX_ZEROCOPY_SEND_BYTES_THRESHOLD \
346  "grpc.experimental.tcp_tx_zerocopy_send_bytes_threshold"
347 /* TCP TX Zerocopy max simultaneous sends: limit for maximum number of pending
348  calls to tcp_write() using zerocopy. A tcp_write() is considered pending
349  until the kernel performs the zerocopy-done callback for all sendmsg() calls
350  issued by the tcp_write(). By default, this is set to 4. */
351 #define GRPC_ARG_TCP_TX_ZEROCOPY_MAX_SIMULT_SENDS \
352  "grpc.experimental.tcp_tx_zerocopy_max_simultaneous_sends"
353 /* Timeout in milliseconds to use for calls to the grpclb load balancer.
354  If 0 or unset, the balancer calls will have no deadline. */
355 #define GRPC_ARG_GRPCLB_CALL_TIMEOUT_MS "grpc.grpclb_call_timeout_ms"
356 /* Specifies the xDS bootstrap config as a JSON string.
357  FOR TESTING PURPOSES ONLY -- DO NOT USE IN PRODUCTION.
358  This option allows controlling the bootstrap configuration on a
359  per-channel basis, which is useful in tests. However, this results
360  in having a separate xDS client instance per channel rather than
361  using the global instance, which is not the intended way to use xDS.
362  Currently, this will (a) add unnecessary load on the xDS server and
363  (b) break use of CSDS, and there may be additional side effects in
364  the future. */
365 #define GRPC_ARG_TEST_ONLY_DO_NOT_USE_IN_PROD_XDS_BOOTSTRAP_CONFIG \
366  "grpc.TEST_ONLY_DO_NOT_USE_IN_PROD.xds_bootstrap_config"
367 /* Timeout in milliseconds to wait for the serverlist from the grpclb load
368  balancer before using fallback backend addresses from the resolver.
369  If 0, enter fallback mode immediately. Default value is 10000. */
370 #define GRPC_ARG_GRPCLB_FALLBACK_TIMEOUT_MS "grpc.grpclb_fallback_timeout_ms"
371 /* Experimental Arg. Channel args to be used for the control-plane channel
372  * created to the grpclb load balancers. This is a pointer arg whose value is a
373  * grpc_channel_args object. If unset, most channel args from the parent channel
374  * will be propagated to the grpclb channel. */
375 #define GRPC_ARG_EXPERIMENTAL_GRPCLB_CHANNEL_ARGS \
376  "grpc.experimental.grpclb_channel_args"
377 /* Timeout in milliseconds to wait for the child of a specific priority to
378  complete its initial connection attempt before the priority LB policy fails
379  over to the next priority. Default value is 10 seconds. */
380 #define GRPC_ARG_PRIORITY_FAILOVER_TIMEOUT_MS \
381  "grpc.priority_failover_timeout_ms"
382 
383 #define GRPC_ARG_WORKAROUND_CRONET_COMPRESSION \
384  "grpc.workaround.cronet_compression"
385 
392 #define GRPC_ARG_OPTIMIZATION_TARGET "grpc.optimization_target"
393 
402 #define GRPC_ARG_ENABLE_RETRIES "grpc.enable_retries"
403 
411 #define GRPC_ARG_EXPERIMENTAL_ENABLE_HEDGING "grpc.experimental.enable_hedging"
412 
413 #define GRPC_ARG_PER_RPC_RETRY_BUFFER_SIZE "grpc.per_rpc_retry_buffer_size"
414 
416 #define GRPC_ARG_MOBILE_LOG_CONTEXT "grpc.mobile_log_context"
417 
418 #define GRPC_ARG_DISABLE_CLIENT_AUTHORITY_FILTER \
419  "grpc.disable_client_authority_filter"
420 
421 #define GRPC_ARG_ENABLE_HTTP_PROXY "grpc.enable_http_proxy"
422 
424 #define GRPC_ARG_HTTP_PROXY "grpc.http_proxy"
425 
427 #define GRPC_ARG_SURFACE_USER_AGENT "grpc.surface_user_agent"
428 
430 #define GRPC_ARG_INHIBIT_HEALTH_CHECKING "grpc.inhibit_health_checking"
431 
439 #define GRPC_ARG_DNS_ENABLE_SRV_QUERIES "grpc.dns_enable_srv_queries"
440 
446 #define GRPC_ARG_DNS_ARES_QUERY_TIMEOUT_MS "grpc.dns_ares_query_timeout"
447 
449 #define GRPC_ARG_USE_LOCAL_SUBCHANNEL_POOL "grpc.use_local_subchannel_pool"
450 
451 #define GRPC_ARG_CHANNEL_POOL_DOMAIN "grpc.channel_pooling_domain"
452 
453 #define GRPC_ARG_CHANNEL_ID "grpc.channel_id"
454 
456 #define GRPC_ARG_AUTHORIZATION_POLICY_PROVIDER \
457  "grpc.authorization_policy_provider"
458 
462 #define GRPC_ARG_SERVER_CONFIG_CHANGE_DRAIN_GRACE_TIME_MS \
463  "grpc.experimental.server_config_change_drain_grace_time_ms"
464 
470 typedef enum grpc_call_error {
506 
509 #define GRPC_DEFAULT_MAX_SEND_MESSAGE_LENGTH (-1)
510 #define GRPC_DEFAULT_MAX_RECV_MESSAGE_LENGTH (4 * 1024 * 1024)
511 
516 #define GRPC_WRITE_BUFFER_HINT (0x00000001u)
517 
519 #define GRPC_WRITE_NO_COMPRESS (0x00000002u)
520 
521 #define GRPC_WRITE_THROUGH (0x00000004u)
522 
523 #define GRPC_WRITE_USED_MASK \
524  (GRPC_WRITE_BUFFER_HINT | GRPC_WRITE_NO_COMPRESS | GRPC_WRITE_THROUGH)
525 
529 #define GRPC_INITIAL_METADATA_WAIT_FOR_READY (0x00000020u)
530 
532 #define GRPC_INITIAL_METADATA_WAIT_FOR_READY_EXPLICITLY_SET (0x00000080u)
533 
535 #define GRPC_INITIAL_METADATA_USED_MASK \
536  (GRPC_INITIAL_METADATA_WAIT_FOR_READY_EXPLICITLY_SET | \
537  GRPC_INITIAL_METADATA_WAIT_FOR_READY | GRPC_WRITE_THROUGH)
538 
540 typedef struct grpc_metadata {
545 
549  struct /* internal */ {
550  void* obfuscated[4];
551  } internal_data;
552 } grpc_metadata;
553 
555 typedef enum grpc_completion_type {
563 
567 typedef struct grpc_event {
575  int success;
579  void* tag;
580 } grpc_event;
581 
582 typedef struct {
583  size_t count;
584  size_t capacity;
587 
588 typedef struct {
593 
594 typedef enum {
635 } grpc_op_type;
636 
637 struct grpc_byte_buffer;
638 
641 typedef struct grpc_op {
645  uint32_t flags;
647  void* reserved;
648  union grpc_op_data {
650  struct /* internal */ {
651  void* reserved[8];
652  } reserved;
654  size_t count;
659  uint8_t is_set;
670  } send_message;
695  } recv_message;
708  const char** error_string;
715  int* cancelled;
717  } data;
718 } grpc_op;
719 
721 typedef struct {
729 
731 
741 typedef enum {
745 
750 
757 
759 typedef enum {
762 
765 
769 
780 
784 
789 
790 #define GRPC_CQ_CURRENT_VERSION 2
791 #define GRPC_CQ_VERSION_MINIMUM_FOR_CALLBACKABLE 2
795  int version;
798 
800 
801  /* END OF VERSION 1 CQ ATTRIBUTES */
802 
803  /* START OF VERSION 2 CQ ATTRIBUTES */
807 
808  /* END OF VERSION 2 CQ ATTRIBUTES */
810 
813 
814 #ifdef __cplusplus
815 }
816 #endif
817 
818 #endif /* GRPC_IMPL_CODEGEN_GRPC_TYPES_H */
grpc_arg
A single argument...
Definition: grpc_types.h:103
grpc_op::grpc_op_data::grpc_op_send_message::send_message
struct grpc_byte_buffer * send_message
This op takes ownership of the slices in send_message.
Definition: grpc_types.h:669
grpc_op::flags
uint32_t flags
Write flags bitset for grpc_begin_messages.
Definition: grpc_types.h:645
grpc_call_error
grpc_call_error
Result of a grpc call.
Definition: grpc_types.h:470
GRPC_CALL_ERROR_ALREADY_INVOKED
@ GRPC_CALL_ERROR_ALREADY_INVOKED
this method must be called before invoke
Definition: grpc_types.h:482
grpc_metadata_array::metadata
grpc_metadata * metadata
Definition: grpc_types.h:585
grpc_op::grpc_op_data::grpc_op_recv_status_on_client::trailing_metadata
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:702
grpc_completion_type
grpc_completion_type
The type of completion (for grpc_event)
Definition: grpc_types.h:555
grpc_op::grpc_op_data::grpc_op_send_initial_metadata
Definition: grpc_types.h:653
grpc_metadata
struct grpc_metadata grpc_metadata
A single metadata element.
grpc_op::grpc_op_data::grpc_op_recv_status_on_client::status
grpc_status_code * status
Definition: grpc_types.h:703
grpc_arg_type
grpc_arg_type
Type specifier for grpc_arg.
Definition: grpc_types.h:79
status.h
GRPC_CALL_ERROR_TOO_MANY_OPERATIONS
@ GRPC_CALL_ERROR_TOO_MANY_OPERATIONS
there is already an outstanding read/write operation on the call
Definition: grpc_types.h:489
GRPC_ARG_INTEGER
@ GRPC_ARG_INTEGER
Definition: grpc_types.h:81
GRPC_CQ_NEXT
@ GRPC_CQ_NEXT
Events are popped out by calling grpc_completion_queue_next() API ONLY.
Definition: grpc_types.h:761
grpc_op::grpc_op_data::grpc_op_send_initial_metadata::grpc_op_send_initial_metadata_maybe_compression_level
If is_set, compression_level will be used for the call.
Definition: grpc_types.h:658
grpc_status_code
grpc_status_code
Definition: status.h:28
grpc_op::grpc_op_data::grpc_op_send_status_from_server
Definition: grpc_types.h:671
grpc_socket_mutator
struct grpc_socket_mutator grpc_socket_mutator
The Socket Mutator interface allows changes on socket options.
Definition: grpc_types.h:73
grpc_resource_quota
struct grpc_resource_quota grpc_resource_quota
Definition: grpc_types.h:730
GRPC_CALL_ERROR
@ GRPC_CALL_ERROR
something failed, we don't know what
Definition: grpc_types.h:474
GRPC_CALL_ERROR_INVALID_MESSAGE
@ GRPC_CALL_ERROR_INVALID_MESSAGE
invalid message was passed to this call
Definition: grpc_types.h:495
grpc_op::grpc_op_data::grpc_op_send_initial_metadata::grpc_op_send_initial_metadata_maybe_compression_level::level
grpc_compression_level level
Definition: grpc_types.h:660
GRPC_ARG_STRING
@ GRPC_ARG_STRING
Definition: grpc_types.h:80
grpc_cq_polling_type
grpc_cq_polling_type
Completion queues internally MAY maintain a set of file descriptors in a structure called 'pollset'.
Definition: grpc_types.h:741
grpc_op::grpc_op_data::send_initial_metadata
struct grpc_op::grpc_op_data::grpc_op_send_initial_metadata send_initial_metadata
grpc_byte_buffer
struct grpc_byte_buffer grpc_byte_buffer
grpc_completion_queue_functor::internal_success
int internal_success
The following fields are not API.
Definition: grpc_types.h:786
grpc_op
struct grpc_op grpc_op
Operation data: one field for each op type (except SEND_CLOSE_FROM_CLIENT which has no arguments)
grpc_metadata_array
Definition: grpc_types.h:582
grpc_byte_buffer::grpc_byte_buffer_data::raw
struct grpc_byte_buffer::grpc_byte_buffer_data::grpc_compressed_buffer raw
grpc_call_details
Definition: grpc_types.h:588
grpc_op::reserved
void * reserved
Reserved for future usage.
Definition: grpc_types.h:647
grpc_compression_algorithm
grpc_compression_algorithm
The various compression algorithms supported by gRPC (not sorted by compression level)
Definition: compression_types.h:60
grpc_cq_completion_type
grpc_cq_completion_type
Specifies the type of APIs to use to pop events from the completion queue.
Definition: grpc_types.h:759
GRPC_CALL_ERROR_NOT_ON_CLIENT
@ GRPC_CALL_ERROR_NOT_ON_CLIENT
this method is not available on the client
Definition: grpc_types.h:478
grpc_op::grpc_op_data::grpc_op_send_message
Definition: grpc_types.h:663
grpc_byte_buffer::grpc_byte_buffer_data
Definition: grpc_types.h:46
GRPC_CALL_ERROR_COMPLETION_QUEUE_SHUTDOWN
@ GRPC_CALL_ERROR_COMPLETION_QUEUE_SHUTDOWN
completion queue has been shutdown
Definition: grpc_types.h:504
GRPC_QUEUE_SHUTDOWN
@ GRPC_QUEUE_SHUTDOWN
Shutting down.
Definition: grpc_types.h:557
grpc_byte_buffer::reserved
void * reserved
Definition: grpc_types.h:44
GRPC_OP_COMPLETE
@ GRPC_OP_COMPLETE
Operation completion.
Definition: grpc_types.h:561
GRPC_CALL_OK
@ GRPC_CALL_OK
everything went ok
Definition: grpc_types.h:472
grpc_event
struct grpc_event grpc_event
The result of an operation.
grpc_metadata_array::count
size_t count
Definition: grpc_types.h:583
grpc_call_details::method
grpc_slice method
Definition: grpc_types.h:589
GRPC_CALL_ERROR_INVALID_METADATA
@ GRPC_CALL_ERROR_INVALID_METADATA
invalid metadata was passed to this call
Definition: grpc_types.h:493
GRPC_CALL_ERROR_NOT_ON_SERVER
@ GRPC_CALL_ERROR_NOT_ON_SERVER
this method is not available on the server
Definition: grpc_types.h:476
grpc_metadata_array::capacity
size_t capacity
Definition: grpc_types.h:584
grpc_arg_pointer_vtable
Definition: grpc_types.h:85
grpc_channel_args
An array of arguments that can be passed around.
Definition: grpc_types.h:132
grpc_op::grpc_op_data::recv_message
struct grpc_op::grpc_op_data::grpc_op_recv_message recv_message
GRPC_BB_RAW
@ GRPC_BB_RAW
Future types may include GRPC_BB_PROTOBUF, etc.
Definition: grpc_types.h:39
GRPC_CQ_NON_POLLING
@ GRPC_CQ_NON_POLLING
The completion queue will not have an associated pollset.
Definition: grpc_types.h:755
grpc_op::data
union grpc_op::grpc_op_data data
grpc_metadata::obfuscated
void * obfuscated[4]
Definition: grpc_types.h:550
grpc_op::grpc_op_data::grpc_op_recv_status_on_client
Definition: grpc_types.h:696
grpc_byte_buffer::type
grpc_byte_buffer_type type
Definition: grpc_types.h:45
grpc_completion_queue_functor
struct grpc_completion_queue_functor grpc_completion_queue_functor
Specifies an interface class to be used as a tag for callback-based completion queues.
grpc_op::grpc_op_data::grpc_op_recv_message::recv_message
struct grpc_byte_buffer ** recv_message
Definition: grpc_types.h:694
grpc_metadata
A single metadata element.
Definition: grpc_types.h:540
GRPC_CQ_DEFAULT_POLLING
@ 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:744
GRPC_OP_RECV_INITIAL_METADATA
@ 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:618
grpc_arg::grpc_arg_value::string
char * string
Definition: grpc_types.h:107
grpc_metadata::internal_data
struct grpc_metadata::@1 internal_data
The following fields are reserved for grpc internal use.
grpc_completion_queue_functor::functor_run
void(* functor_run)(struct grpc_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:779
GRPC_CALL_ERROR_NOT_INVOKED
@ GRPC_CALL_ERROR_NOT_INVOKED
this method must be called after invoke
Definition: grpc_types.h:484
GRPC_CQ_NON_LISTENING
@ GRPC_CQ_NON_LISTENING
Similar to GRPC_CQ_DEFAULT_POLLING except that the completion queues will not contain any 'listening ...
Definition: grpc_types.h:749
GRPC_OP_SEND_STATUS_FROM_SERVER
@ 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:613
grpc_arg::grpc_arg_value::grpc_arg_pointer::vtable
const grpc_arg_pointer_vtable * vtable
Definition: grpc_types.h:111
GRPC_CALL_ERROR_INVALID_FLAGS
@ GRPC_CALL_ERROR_INVALID_FLAGS
the flags value was illegal for this call
Definition: grpc_types.h:491
grpc_op::grpc_op_data::grpc_op_send_status_from_server::status
grpc_status_code status
Definition: grpc_types.h:674
grpc_op::grpc_op_data::reserved
void * reserved[8]
Definition: grpc_types.h:651
grpc_arg::grpc_arg_value::grpc_arg_pointer
Definition: grpc_types.h:109
grpc_op::grpc_op_data::grpc_op_recv_status_on_client::error_string
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:708
grpc_event
The result of an operation.
Definition: grpc_types.h:567
grpc_op_type
grpc_op_type
Definition: grpc_types.h:594
grpc_metadata::value
grpc_slice value
Definition: grpc_types.h:544
grpc_call
struct grpc_call grpc_call
A Call represents an RPC.
Definition: grpc_types.h:70
grpc_byte_buffer
Definition: grpc_types.h:43
grpc_op
Operation data: one field for each op type (except SEND_CLOSE_FROM_CLIENT which has no arguments)
Definition: grpc_types.h:641
GRPC_OP_SEND_MESSAGE
@ GRPC_OP_SEND_MESSAGE
Send a message: 0 or more of these operations can occur for each call.
Definition: grpc_types.h:603
grpc_channel_args::num_args
size_t num_args
Definition: grpc_types.h:133
grpc_completion_queue_functor::internal_next
struct grpc_completion_queue_functor * internal_next
Definition: grpc_types.h:787
grpc_op::grpc_op_data::grpc_op_recv_close_on_server
Definition: grpc_types.h:710
grpc_op::grpc_op_data::grpc_op_send_status_from_server::trailing_metadata
grpc_metadata * trailing_metadata
Definition: grpc_types.h:673
grpc_slice
A grpc_slice s, if initialized, represents the byte range s.bytes[0..s.length-1].
Definition: slice.h:65
grpc_arg::grpc_arg_value::grpc_arg_pointer::p
void * p
Definition: grpc_types.h:110
grpc_socket_factory
struct grpc_socket_factory grpc_socket_factory
The Socket Factory interface creates and binds sockets.
Definition: grpc_types.h:76
grpc_server
struct grpc_server grpc_server
A server listens to some port and responds to request calls.
Definition: grpc_types.h:65
grpc_op::grpc_op_data::grpc_op_recv_initial_metadata
ownership of the array is with the caller, but ownership of the elements stays with the call object (...
Definition: grpc_types.h:685
grpc_arg_pointer_vtable
struct grpc_arg_pointer_vtable grpc_arg_pointer_vtable
grpc_arg_pointer_vtable::destroy
void(* destroy)(void *p)
Definition: grpc_types.h:87
GRPC_CQ_PLUCK
@ GRPC_CQ_PLUCK
Events are popped out by calling grpc_completion_queue_pluck() API ONLY.
Definition: grpc_types.h:764
grpc_completion_queue_attributes
Definition: grpc_types.h:792
grpc_completion_queue_attributes::version
int version
The version number of this structure.
Definition: grpc_types.h:795
grpc_op::op
grpc_op_type op
Operation type, as defined by grpc_op_type.
Definition: grpc_types.h:643
grpc_op::grpc_op_data::grpc_op_send_initial_metadata::count
size_t count
Definition: grpc_types.h:654
gpr_types.h
grpc_op::grpc_op_data::grpc_op_recv_status_on_client::status_details
grpc_slice * status_details
Definition: grpc_types.h:704
grpc_byte_buffer::data
union grpc_byte_buffer::grpc_byte_buffer_data data
compression_types.h
grpc_completion_queue_factory
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:812
grpc_op::grpc_op_data::recv_close_on_server
struct grpc_op::grpc_op_data::grpc_op_recv_close_on_server recv_close_on_server
GRPC_OP_RECV_MESSAGE
@ GRPC_OP_RECV_MESSAGE
Receive a message: 0 or more of these operations can occur for each call.
Definition: grpc_types.h:622
GRPC_CALL_ERROR_ALREADY_ACCEPTED
@ GRPC_CALL_ERROR_ALREADY_ACCEPTED
this method must be called before server_accept
Definition: grpc_types.h:480
grpc_completion_queue_attributes::cq_shutdown_cb
grpc_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:806
grpc_channel_info::service_config_json
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:727
grpc_op::grpc_op_data::send_status_from_server
struct grpc_op::grpc_op_data::grpc_op_send_status_from_server send_status_from_server
GRPC_CALL_ERROR_PAYLOAD_TYPE_MISMATCH
@ GRPC_CALL_ERROR_PAYLOAD_TYPE_MISMATCH
payload type requested is not the type registered
Definition: grpc_types.h:502
grpc_call_details::host
grpc_slice host
Definition: grpc_types.h:590
GRPC_OP_SEND_INITIAL_METADATA
@ 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:599
grpc_channel_info::lb_policy_name
char ** lb_policy_name
If non-NULL, will be set to point to a string indicating the LB policy name.
Definition: grpc_types.h:724
grpc_op::grpc_op_data::send_message
struct grpc_op::grpc_op_data::grpc_op_send_message send_message
grpc_byte_buffer::grpc_byte_buffer_data::grpc_compressed_buffer::compression
grpc_compression_algorithm compression
Definition: grpc_types.h:51
port_platform.h
grpc_byte_buffer_type
grpc_byte_buffer_type
Definition: grpc_types.h:38
grpc_op::grpc_op_data::grpc_op_send_initial_metadata::metadata
grpc_metadata * metadata
Definition: grpc_types.h:655
GRPC_CALL_ERROR_BATCH_TOO_BIG
@ GRPC_CALL_ERROR_BATCH_TOO_BIG
this batch of operations leads to more operations than allowed
Definition: grpc_types.h:500
grpc_op::grpc_op_data::recv_status_on_client
struct grpc_op::grpc_op_data::grpc_op_recv_status_on_client recv_status_on_client
grpc_compression_level
grpc_compression_level
Compression levels allow a party with knowledge of its peer's accepted encodings to request compressi...
Definition: compression_types.h:72
grpc_op::grpc_op_data::grpc_op_send_status_from_server::trailing_metadata_count
size_t trailing_metadata_count
Definition: grpc_types.h:672
grpc_op::grpc_op_data::grpc_op_send_initial_metadata::maybe_compression_level
struct grpc_op::grpc_op_data::grpc_op_send_initial_metadata::grpc_op_send_initial_metadata_maybe_compression_level maybe_compression_level
grpc_arg::key
char * key
Definition: grpc_types.h:105
grpc_op::grpc_op_data
Definition: grpc_types.h:648
grpc_byte_buffer::grpc_byte_buffer_data::grpc_compressed_buffer
Definition: grpc_types.h:50
grpc_completion_queue
struct grpc_completion_queue grpc_completion_queue
Completion Queues enable notification of the completion of asynchronous actions.
Definition: grpc_types.h:59
grpc_op::grpc_op_data::grpc_op_recv_message
ownership of the byte buffer is moved to the caller; the caller must call grpc_byte_buffer_destroy on...
Definition: grpc_types.h:693
grpc_completion_queue_functor
Specifies an interface class to be used as a tag for callback-based completion queues.
Definition: grpc_types.h:774
grpc_op::grpc_op_data::grpc_op_send_initial_metadata::grpc_op_send_initial_metadata_maybe_compression_level::is_set
uint8_t is_set
Definition: grpc_types.h:659
grpc_completion_queue_attributes::cq_completion_type
grpc_cq_completion_type cq_completion_type
Set to GRPC_CQ_CURRENT_VERSION.
Definition: grpc_types.h:797
grpc_channel
struct grpc_channel grpc_channel
The Channel interface allows creation of Call objects.
Definition: grpc_types.h:62
grpc_byte_buffer::grpc_byte_buffer_data::grpc_compressed_buffer::slice_buffer
grpc_slice_buffer slice_buffer
Definition: grpc_types.h:52
GRPC_OP_RECV_CLOSE_ON_SERVER
@ 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:634
grpc_completion_queue_attributes
struct grpc_completion_queue_attributes grpc_completion_queue_attributes
GRPC_CALL_ERROR_ALREADY_FINISHED
@ GRPC_CALL_ERROR_ALREADY_FINISHED
this call is already finished (writes_done or write_status has already been called)
Definition: grpc_types.h:487
grpc_completion_queue_attributes::cq_polling_type
grpc_cq_polling_type cq_polling_type
Definition: grpc_types.h:799
grpc_slice_buffer
Represents an expandable array of slices, to be interpreted as a single item.
Definition: slice.h:83
grpc_op::grpc_op_data::recv_initial_metadata
struct grpc_op::grpc_op_data::grpc_op_recv_initial_metadata recv_initial_metadata
GRPC_ARG_POINTER
@ GRPC_ARG_POINTER
Definition: grpc_types.h:82
grpc_op::grpc_op_data::grpc_op_send_status_from_server::status_details
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:678
GRPC_CQ_CALLBACK
@ GRPC_CQ_CALLBACK
Events trigger a callback specified as the tag.
Definition: grpc_types.h:767
gpr_timespec
Analogous to struct timespec.
Definition: gpr_types.h:50
grpc_event::type
grpc_completion_type type
The type of the completion.
Definition: grpc_types.h:569
grpc_arg::grpc_arg_value::integer
int integer
Definition: grpc_types.h:108
grpc_byte_buffer::grpc_byte_buffer_data::reserved
void * reserved[8]
Definition: grpc_types.h:48
GRPC_OP_RECV_STATUS_ON_CLIENT
@ 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:628
grpc_op::grpc_op_data::grpc_op_recv_initial_metadata::recv_initial_metadata
grpc_metadata_array * recv_initial_metadata
Definition: grpc_types.h:686
grpc_arg::type
grpc_arg_type type
Definition: grpc_types.h:104
grpc_arg_pointer_vtable::cmp
int(* cmp)(void *p, void *q)
Definition: grpc_types.h:88
grpc_channel_info
Information requested from the channel.
Definition: grpc_types.h:721
grpc_channel_args::args
grpc_arg * args
Definition: grpc_types.h:134
grpc_call_details::deadline
gpr_timespec deadline
Definition: grpc_types.h:591
grpc_event::success
int success
If the grpc_completion_type is GRPC_OP_COMPLETE, this field indicates whether the operation was succe...
Definition: grpc_types.h:575
GRPC_CALL_ERROR_NOT_SERVER_COMPLETION_QUEUE
@ GRPC_CALL_ERROR_NOT_SERVER_COMPLETION_QUEUE
completion queue for notification has not been registered with the server
Definition: grpc_types.h:498
GRPC_QUEUE_TIMEOUT
@ GRPC_QUEUE_TIMEOUT
No event before timeout.
Definition: grpc_types.h:559
grpc_event::tag
void * tag
The tag passed to grpc_call_start_batch etc to start this operation.
Definition: grpc_types.h:579
grpc_op::grpc_op_data::grpc_op_recv_close_on_server::cancelled
int * cancelled
out argument, set to 1 if the call failed at the server for a reason other than a non-OK status (canc...
Definition: grpc_types.h:715
grpc_metadata::key
grpc_slice key
the key, value values are expected to line up with grpc_mdelem: if changing them, update metadata....
Definition: grpc_types.h:543
GRPC_OP_SEND_CLOSE_FROM_CLIENT
@ 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:608
slice.h
grpc_arg::grpc_arg_value
Definition: grpc_types.h:106
grpc_completion_queue_functor::inlineable
int inlineable
The inlineable member specifies whether this functor can be run inline.
Definition: grpc_types.h:783