1 // Copyright 2023 gRPC authors. 2 // 3 // Licensed under the Apache License, Version 2.0 (the "License"); 4 // you may not use this file except in compliance with the License. 5 // You may obtain a copy of the License at 6 // 7 // http://www.apache.org/licenses/LICENSE-2.0 8 // 9 // Unless required by applicable law or agreed to in writing, software 10 // distributed under the License is distributed on an "AS IS" BASIS, 11 // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 12 // See the License for the specific language governing permissions and 13 // limitations under the License. 14 15 #ifndef GRPC_IMPL_CHANNEL_ARG_NAMES_H 16 #define GRPC_IMPL_CHANNEL_ARG_NAMES_H 17 18 // IWYU pragma: private, include <grpc/grpc.h> 19 // IWYU pragma: friend "src/.*" 20 // IWYU pragma: friend "test/.*" 21 22 /** \defgroup grpc_arg_keys 23 * Channel argument keys. 24 * \{ 25 */ 26 /** If non-zero, enable census for tracing and stats collection. */ 27 #define GRPC_ARG_ENABLE_CENSUS "grpc.census" 28 /** If non-zero, enable load reporting. */ 29 #define GRPC_ARG_ENABLE_LOAD_REPORTING "grpc.loadreporting" 30 /** If non-zero, call metric recording is enabled. */ 31 #define GRPC_ARG_SERVER_CALL_METRIC_RECORDING \ 32 "grpc.server_call_metric_recording" 33 /** Request that optional features default to off (regardless of what they 34 usually default to) - to enable tight control over what gets enabled */ 35 #define GRPC_ARG_MINIMAL_STACK "grpc.minimal_stack" 36 /** Maximum number of concurrent incoming streams to allow on a http2 37 connection. Int valued. */ 38 #define GRPC_ARG_MAX_CONCURRENT_STREAMS "grpc.max_concurrent_streams" 39 /** Maximum message length that the channel can receive. Int valued, bytes. 40 -1 means unlimited. */ 41 #define GRPC_ARG_MAX_RECEIVE_MESSAGE_LENGTH "grpc.max_receive_message_length" 42 /** \deprecated For backward compatibility. 43 * Use GRPC_ARG_MAX_RECEIVE_MESSAGE_LENGTH instead. */ 44 #define GRPC_ARG_MAX_MESSAGE_LENGTH GRPC_ARG_MAX_RECEIVE_MESSAGE_LENGTH 45 /** Maximum message length that the channel can send. Int valued, bytes. 46 -1 means unlimited. */ 47 #define GRPC_ARG_MAX_SEND_MESSAGE_LENGTH "grpc.max_send_message_length" 48 /** Maximum time that a channel may have no outstanding rpcs, after which the 49 * server will close the connection. Int valued, milliseconds. INT_MAX means 50 * unlimited. */ 51 #define GRPC_ARG_MAX_CONNECTION_IDLE_MS "grpc.max_connection_idle_ms" 52 /** Maximum time that a channel may exist. Int valued, milliseconds. 53 * INT_MAX means unlimited. */ 54 #define GRPC_ARG_MAX_CONNECTION_AGE_MS "grpc.max_connection_age_ms" 55 /** Grace period after the channel reaches its max age. Int valued, 56 milliseconds. INT_MAX means unlimited. */ 57 #define GRPC_ARG_MAX_CONNECTION_AGE_GRACE_MS "grpc.max_connection_age_grace_ms" 58 /** Timeout after the last RPC finishes on the client channel at which the 59 * channel goes back into IDLE state. Int valued, milliseconds. INT_MAX means 60 * unlimited. The default value is 30 minutes and the min value is 1 second. */ 61 #define GRPC_ARG_CLIENT_IDLE_TIMEOUT_MS "grpc.client_idle_timeout_ms" 62 /** Enable/disable support for per-message compression. Defaults to 1, unless 63 GRPC_ARG_MINIMAL_STACK is enabled, in which case it defaults to 0. */ 64 #define GRPC_ARG_ENABLE_PER_MESSAGE_COMPRESSION "grpc.per_message_compression" 65 /** Experimental Arg. Enable/disable support for per-message decompression. 66 Defaults to 1. If disabled, decompression will not be performed and the 67 application will see the compressed message in the byte buffer. */ 68 #define GRPC_ARG_ENABLE_PER_MESSAGE_DECOMPRESSION \ 69 "grpc.per_message_decompression" 70 /** Enable/disable support for deadline checking. Defaults to 1, unless 71 GRPC_ARG_MINIMAL_STACK is enabled, in which case it defaults to 0 */ 72 #define GRPC_ARG_ENABLE_DEADLINE_CHECKS "grpc.enable_deadline_checking" 73 /** Initial stream ID for http2 transports. Int valued. */ 74 #define GRPC_ARG_HTTP2_INITIAL_SEQUENCE_NUMBER \ 75 "grpc.http2.initial_sequence_number" 76 /** Amount to read ahead on individual streams. Defaults to 64kb, larger 77 values can help throughput on high-latency connections. 78 NOTE: at some point we'd like to auto-tune this, and this parameter 79 will become a no-op. Int valued, bytes. */ 80 #define GRPC_ARG_HTTP2_STREAM_LOOKAHEAD_BYTES "grpc.http2.lookahead_bytes" 81 /** How much memory to use for hpack decoding. Int valued, bytes. */ 82 #define GRPC_ARG_HTTP2_HPACK_TABLE_SIZE_DECODER \ 83 "grpc.http2.hpack_table_size.decoder" 84 /** How much memory to use for hpack encoding. Int valued, bytes. */ 85 #define GRPC_ARG_HTTP2_HPACK_TABLE_SIZE_ENCODER \ 86 "grpc.http2.hpack_table_size.encoder" 87 /** How big a frame are we willing to receive via HTTP2. 88 Min 16384, max 16777215. Larger values give lower CPU usage for large 89 messages, but more head of line blocking for small messages. */ 90 #define GRPC_ARG_HTTP2_MAX_FRAME_SIZE "grpc.http2.max_frame_size" 91 /** Should BDP probing be performed? */ 92 #define GRPC_ARG_HTTP2_BDP_PROBE "grpc.http2.bdp_probe" 93 /** (DEPRECATED) Does not have any effect. 94 Earlier, this arg configured the minimum time between successive ping frames 95 without receiving any data/header frame, Int valued, milliseconds. This put 96 unnecessary constraints on the configuration of keepalive pings, 97 requiring users to set this channel arg along with 98 GRPC_ARG_KEEPALIVE_TIME_MS. This arg also limited the activity of the other 99 source of pings in gRPC Core - BDP pings, but BDP pings are only sent when 100 there is receive-side data activity, making this arg unuseful for BDP pings 101 too. */ 102 #define GRPC_ARG_HTTP2_MIN_SENT_PING_INTERVAL_WITHOUT_DATA_MS \ 103 "grpc.http2.min_time_between_pings_ms" 104 /** Minimum allowed time between a server receiving successive ping frames 105 without sending any data/header frame. Int valued, milliseconds 106 */ 107 #define GRPC_ARG_HTTP2_MIN_RECV_PING_INTERVAL_WITHOUT_DATA_MS \ 108 "grpc.http2.min_ping_interval_without_data_ms" 109 /** Maximum time to allow a request to be: 110 (1) received by the server, but 111 (2) not requested by a RequestCall (in the completion queue based API) 112 before the request is cancelled */ 113 #define GRPC_ARG_SERVER_MAX_UNREQUESTED_TIME_IN_SERVER_SECONDS \ 114 "grpc.server_max_unrequested_time_in_server" 115 /** Channel arg to override the http2 :scheme header */ 116 #define GRPC_ARG_HTTP2_SCHEME "grpc.http2_scheme" 117 /** How many pings can the client send before needing to send a 118 data/header frame? (0 indicates that an infinite number of 119 pings can be sent without sending a data frame or header frame) */ 120 #define GRPC_ARG_HTTP2_MAX_PINGS_WITHOUT_DATA \ 121 "grpc.http2.max_pings_without_data" 122 /** How many misbehaving pings the server can bear before sending goaway and 123 closing the transport? (0 indicates that the server can bear an infinite 124 number of misbehaving pings) */ 125 #define GRPC_ARG_HTTP2_MAX_PING_STRIKES "grpc.http2.max_ping_strikes" 126 /** How much data are we willing to queue up per stream if 127 GRPC_WRITE_BUFFER_HINT is set? This is an upper bound */ 128 #define GRPC_ARG_HTTP2_WRITE_BUFFER_SIZE "grpc.http2.write_buffer_size" 129 /** Should we allow receipt of true-binary data on http2 connections? 130 Defaults to on (1) */ 131 #define GRPC_ARG_HTTP2_ENABLE_TRUE_BINARY "grpc.http2.true_binary" 132 /** An experimental channel arg which determines whether the preferred crypto 133 * frame size http2 setting sent to the peer at startup. If set to 0 (false 134 * - default), the preferred frame size is not sent to the peer. Otherwise it 135 * sends a default preferred crypto frame size value of 4GB to the peer at 136 * the startup of each connection. */ 137 #define GRPC_ARG_EXPERIMENTAL_HTTP2_PREFERRED_CRYPTO_FRAME_SIZE \ 138 "grpc.experimental.http2.enable_preferred_frame_size" 139 /** After a duration of this time the client/server pings its peer to see if the 140 transport is still alive. Int valued, milliseconds. */ 141 #define GRPC_ARG_KEEPALIVE_TIME_MS "grpc.keepalive_time_ms" 142 /** After waiting for a duration of this time, if the keepalive ping sender does 143 not receive the ping ack, it will close the transport. Int valued, 144 milliseconds. */ 145 #define GRPC_ARG_KEEPALIVE_TIMEOUT_MS "grpc.keepalive_timeout_ms" 146 /** Is it permissible to send keepalive pings from the client without any 147 outstanding streams. Int valued, 0(false)/1(true). */ 148 #define GRPC_ARG_KEEPALIVE_PERMIT_WITHOUT_CALLS \ 149 "grpc.keepalive_permit_without_calls" 150 /** Default authority to pass if none specified on call construction. A string. 151 * */ 152 #define GRPC_ARG_DEFAULT_AUTHORITY "grpc.default_authority" 153 /** Primary user agent: goes at the start of the user-agent metadata 154 sent on each request. A string. */ 155 #define GRPC_ARG_PRIMARY_USER_AGENT_STRING "grpc.primary_user_agent" 156 /** Secondary user agent: goes at the end of the user-agent metadata 157 sent on each request. A string. */ 158 #define GRPC_ARG_SECONDARY_USER_AGENT_STRING "grpc.secondary_user_agent" 159 /** The minimum time between subsequent connection attempts, in ms */ 160 #define GRPC_ARG_MIN_RECONNECT_BACKOFF_MS "grpc.min_reconnect_backoff_ms" 161 /** The maximum time between subsequent connection attempts, in ms */ 162 #define GRPC_ARG_MAX_RECONNECT_BACKOFF_MS "grpc.max_reconnect_backoff_ms" 163 /** The time between the first and second connection attempts, in ms */ 164 #define GRPC_ARG_INITIAL_RECONNECT_BACKOFF_MS \ 165 "grpc.initial_reconnect_backoff_ms" 166 /** Minimum amount of time between DNS resolutions, in ms */ 167 #define GRPC_ARG_DNS_MIN_TIME_BETWEEN_RESOLUTIONS_MS \ 168 "grpc.dns_min_time_between_resolutions_ms" 169 /** The timeout used on servers for finishing handshaking on an incoming 170 connection. Defaults to 120 seconds. */ 171 #define GRPC_ARG_SERVER_HANDSHAKE_TIMEOUT_MS "grpc.server_handshake_timeout_ms" 172 /** This *should* be used for testing only. 173 The caller of the secure_channel_create functions may override the target 174 name used for SSL host name checking using this channel argument which is of 175 type \a GRPC_ARG_STRING. If this argument is not specified, the name used 176 for SSL host name checking will be the target parameter (assuming that the 177 secure channel is an SSL channel). If this parameter is specified and the 178 underlying is not an SSL channel, it will just be ignored. */ 179 #define GRPC_SSL_TARGET_NAME_OVERRIDE_ARG "grpc.ssl_target_name_override" 180 /** If non-zero, a pointer to a session cache (a pointer of type 181 grpc_ssl_session_cache*). (use grpc_ssl_session_cache_arg_vtable() to fetch 182 an appropriate pointer arg vtable) */ 183 #define GRPC_SSL_SESSION_CACHE_ARG "grpc.ssl_session_cache" 184 /** If non-zero, it will determine the maximum frame size used by TSI's frame 185 * protector. 186 */ 187 #define GRPC_ARG_TSI_MAX_FRAME_SIZE "grpc.tsi.max_frame_size" 188 /** Maximum metadata size (soft limit), in bytes. Note this limit applies to the 189 max sum of all metadata key-value entries in a batch of headers. Some random 190 sample of requests between this limit and 191 `GRPC_ARG_ABSOLUTE_MAX_METADATA_SIZE` will be rejected. Defaults to maximum 192 of 8 KB and `GRPC_ARG_ABSOLUTE_MAX_METADATA_SIZE` * 0.8 (if set). 193 */ 194 #define GRPC_ARG_MAX_METADATA_SIZE "grpc.max_metadata_size" 195 /** Maximum metadata size (hard limit), in bytes. Note this limit applies to the 196 max sum of all metadata key-value entries in a batch of headers. All requests 197 exceeding this limit will be rejected. Defaults to maximum of 16 KB and 198 `GRPC_ARG_MAX_METADATA_SIZE` * 1.25 (if set). */ 199 #define GRPC_ARG_ABSOLUTE_MAX_METADATA_SIZE "grpc.absolute_max_metadata_size" 200 /** If non-zero, allow the use of SO_REUSEPORT if it's available (default 1) */ 201 #define GRPC_ARG_ALLOW_REUSEPORT "grpc.so_reuseport" 202 /** If non-zero, a pointer to a buffer pool (a pointer of type 203 * grpc_resource_quota*). (use grpc_resource_quota_arg_vtable() to fetch an 204 * appropriate pointer arg vtable) */ 205 #define GRPC_ARG_RESOURCE_QUOTA "grpc.resource_quota" 206 /** If non-zero, expand wildcard addresses to a list of local addresses. */ 207 #define GRPC_ARG_EXPAND_WILDCARD_ADDRS "grpc.expand_wildcard_addrs" 208 /** Service config data in JSON form. 209 This value will be ignored if the name resolver returns a service config. */ 210 #define GRPC_ARG_SERVICE_CONFIG "grpc.service_config" 211 /** Disable looking up the service config via the name resolver. */ 212 #define GRPC_ARG_SERVICE_CONFIG_DISABLE_RESOLUTION \ 213 "grpc.service_config_disable_resolution" 214 /** LB policy name. */ 215 #define GRPC_ARG_LB_POLICY_NAME "grpc.lb_policy_name" 216 /** Cap for ring size in the ring_hash LB policy. The min and max ring size 217 values set in the LB policy config will be capped to this value. 218 Default is 4096. */ 219 #define GRPC_ARG_RING_HASH_LB_RING_SIZE_CAP "grpc.lb.ring_hash.ring_size_cap" 220 /** The grpc_socket_mutator instance that set the socket options. A pointer. */ 221 #define GRPC_ARG_SOCKET_MUTATOR "grpc.socket_mutator" 222 /** The grpc_socket_factory instance to create and bind sockets. A pointer. */ 223 #define GRPC_ARG_SOCKET_FACTORY "grpc.socket_factory" 224 /** The maximum amount of memory used by trace events per channel trace node. 225 * Once the maximum is reached, subsequent events will evict the oldest events 226 * from the buffer. The unit for this knob is bytes. Setting it to zero causes 227 * channel tracing to be disabled. */ 228 #define GRPC_ARG_MAX_CHANNEL_TRACE_EVENT_MEMORY_PER_NODE \ 229 "grpc.max_channel_trace_event_memory_per_node" 230 /** If non-zero, gRPC library will track stats and information at at per channel 231 * level. Disabling channelz naturally disables channel tracing. The default 232 * is for channelz to be enabled. */ 233 #define GRPC_ARG_ENABLE_CHANNELZ "grpc.enable_channelz" 234 /** If non-zero, Cronet transport will coalesce packets to fewer frames 235 * when possible. */ 236 #define GRPC_ARG_USE_CRONET_PACKET_COALESCING \ 237 "grpc.use_cronet_packet_coalescing" 238 /** Channel arg (integer) setting how large a slice to try and read from the 239 wire each time recvmsg (or equivalent) is called **/ 240 #define GRPC_ARG_TCP_READ_CHUNK_SIZE "grpc.experimental.tcp_read_chunk_size" 241 /** Note this is not a "channel arg" key. This is the default slice size to use 242 * when trying to read from the wire if the GRPC_ARG_TCP_READ_CHUNK_SIZE 243 * channel arg is unspecified. */ 244 #define GRPC_TCP_DEFAULT_READ_SLICE_SIZE 8192 245 #define GRPC_ARG_TCP_MIN_READ_CHUNK_SIZE \ 246 "grpc.experimental.tcp_min_read_chunk_size" 247 #define GRPC_ARG_TCP_MAX_READ_CHUNK_SIZE \ 248 "grpc.experimental.tcp_max_read_chunk_size" 249 /* TCP TX Zerocopy enable state: zero is disabled, non-zero is enabled. By 250 default, it is disabled. */ 251 #define GRPC_ARG_TCP_TX_ZEROCOPY_ENABLED \ 252 "grpc.experimental.tcp_tx_zerocopy_enabled" 253 /* TCP TX Zerocopy send threshold: only zerocopy if >= this many bytes sent. By 254 default, this is set to 16KB. */ 255 #define GRPC_ARG_TCP_TX_ZEROCOPY_SEND_BYTES_THRESHOLD \ 256 "grpc.experimental.tcp_tx_zerocopy_send_bytes_threshold" 257 /* TCP TX Zerocopy max simultaneous sends: limit for maximum number of pending 258 calls to tcp_write() using zerocopy. A tcp_write() is considered pending 259 until the kernel performs the zerocopy-done callback for all sendmsg() calls 260 issued by the tcp_write(). By default, this is set to 4. */ 261 #define GRPC_ARG_TCP_TX_ZEROCOPY_MAX_SIMULT_SENDS \ 262 "grpc.experimental.tcp_tx_zerocopy_max_simultaneous_sends" 263 /* Overrides the TCP socket recieve buffer size, SO_RCVBUF. */ 264 #define GRPC_ARG_TCP_RECEIVE_BUFFER_SIZE "grpc.tcp_receive_buffer_size" 265 /* Timeout in milliseconds to use for calls to the grpclb load balancer. 266 If 0 or unset, the balancer calls will have no deadline. */ 267 #define GRPC_ARG_GRPCLB_CALL_TIMEOUT_MS "grpc.grpclb_call_timeout_ms" 268 /* Specifies the xDS bootstrap config as a JSON string. 269 FOR TESTING PURPOSES ONLY -- DO NOT USE IN PRODUCTION. 270 This option allows controlling the bootstrap configuration on a 271 per-channel basis, which is useful in tests. However, this results 272 in having a separate xDS client instance per channel rather than 273 using the global instance, which is not the intended way to use xDS. 274 Currently, this will (a) add unnecessary load on the xDS server and 275 (b) break use of CSDS, and there may be additional side effects in 276 the future. */ 277 #define GRPC_ARG_TEST_ONLY_DO_NOT_USE_IN_PROD_XDS_BOOTSTRAP_CONFIG \ 278 "grpc.TEST_ONLY_DO_NOT_USE_IN_PROD.xds_bootstrap_config" 279 /* Timeout in milliseconds to wait for the serverlist from the grpclb load 280 balancer before using fallback backend addresses from the resolver. 281 If 0, enter fallback mode immediately. Default value is 10000. */ 282 #define GRPC_ARG_GRPCLB_FALLBACK_TIMEOUT_MS "grpc.grpclb_fallback_timeout_ms" 283 /* Experimental Arg. Channel args to be used for the control-plane channel 284 * created to the grpclb load balancers. This is a pointer arg whose value is a 285 * grpc_channel_args object. If unset, most channel args from the parent channel 286 * will be propagated to the grpclb channel. */ 287 #define GRPC_ARG_EXPERIMENTAL_GRPCLB_CHANNEL_ARGS \ 288 "grpc.experimental.grpclb_channel_args" 289 /* Timeout in milliseconds to wait for the child of a specific priority to 290 complete its initial connection attempt before the priority LB policy fails 291 over to the next priority. Default value is 10 seconds. */ 292 #define GRPC_ARG_PRIORITY_FAILOVER_TIMEOUT_MS \ 293 "grpc.priority_failover_timeout_ms" 294 /** If non-zero, grpc server's cronet compression workaround will be enabled */ 295 #define GRPC_ARG_WORKAROUND_CRONET_COMPRESSION \ 296 "grpc.workaround.cronet_compression" 297 /** String defining the optimization target for a channel. 298 Can be: "latency" - attempt to minimize latency at the cost of throughput 299 "blend" - try to balance latency and throughput 300 "throughput" - attempt to maximize throughput at the expense of 301 latency 302 Defaults to "blend". In the current implementation "blend" is equivalent to 303 "latency". */ 304 #define GRPC_ARG_OPTIMIZATION_TARGET "grpc.optimization_target" 305 /** Enables retry functionality. Defaults to true. When enabled, 306 transparent retries will be performed as appropriate, and configurable 307 retries are enabled when they are configured via the service config. 308 For details, see: 309 https://github.com/grpc/proposal/blob/master/A6-client-retries.md 310 NOTE: Hedging functionality is not yet implemented, so those 311 fields in the service config will currently be ignored. See 312 also the GRPC_ARG_EXPERIMENTAL_ENABLE_HEDGING arg below. 313 */ 314 #define GRPC_ARG_ENABLE_RETRIES "grpc.enable_retries" 315 /** Enables hedging functionality, as described in: 316 https://github.com/grpc/proposal/blob/master/A6-client-retries.md 317 Default is currently false, since this functionality is not yet 318 fully implemented. 319 NOTE: This channel arg is experimental and will eventually be removed. 320 Once hedging functionality has been implemented and proves stable, 321 this arg will be removed, and the hedging functionality will 322 be enabled via the GRPC_ARG_ENABLE_RETRIES arg above. */ 323 #define GRPC_ARG_EXPERIMENTAL_ENABLE_HEDGING "grpc.experimental.enable_hedging" 324 /** Per-RPC retry buffer size, in bytes. Default is 256 KiB. */ 325 #define GRPC_ARG_PER_RPC_RETRY_BUFFER_SIZE "grpc.per_rpc_retry_buffer_size" 326 /** Channel arg that carries the bridged objective c object for custom metrics 327 * logging filter. */ 328 #define GRPC_ARG_MOBILE_LOG_CONTEXT "grpc.mobile_log_context" 329 /** If non-zero, client authority filter is disabled for the channel */ 330 #define GRPC_ARG_DISABLE_CLIENT_AUTHORITY_FILTER \ 331 "grpc.disable_client_authority_filter" 332 /** If set to zero, disables use of http proxies. Enabled by default. */ 333 #define GRPC_ARG_ENABLE_HTTP_PROXY "grpc.enable_http_proxy" 334 /** Channel arg to set http proxy per channel. If set, the channel arg 335 * value will be preferred over the environment variable settings. */ 336 #define GRPC_ARG_HTTP_PROXY "grpc.http_proxy" 337 /** Specifies an HTTP proxy to use for individual addresses. 338 * The proxy must be specified as an IP address, not a DNS name. 339 * If set, the channel arg value will be preferred over the environment 340 * variable settings. */ 341 #define GRPC_ARG_ADDRESS_HTTP_PROXY "grpc.address_http_proxy" 342 /** Comma separated list of addresses or address ranges that are behind the 343 * address HTTP proxy. 344 */ 345 #define GRPC_ARG_ADDRESS_HTTP_PROXY_ENABLED_ADDRESSES \ 346 "grpc.address_http_proxy_enabled_addresses" 347 /** If set to non zero, surfaces the user agent string to the server. User 348 agent is surfaced by default. */ 349 #define GRPC_ARG_SURFACE_USER_AGENT "grpc.surface_user_agent" 350 /** If set, inhibits health checking (which may be enabled via the 351 * service config.) */ 352 #define GRPC_ARG_INHIBIT_HEALTH_CHECKING "grpc.inhibit_health_checking" 353 /** If enabled, the channel's DNS resolver queries for SRV records. 354 * This is useful only when using the "grpclb" load balancing policy, 355 * as described in the following documents: 356 * https://github.com/grpc/proposal/blob/master/A5-grpclb-in-dns.md 357 * https://github.com/grpc/proposal/blob/master/A24-lb-policy-config.md 358 * https://github.com/grpc/proposal/blob/master/A26-grpclb-selection.md 359 * Note that this works only with the "ares" DNS resolver; it isn't supported 360 * by the "native" DNS resolver. */ 361 #define GRPC_ARG_DNS_ENABLE_SRV_QUERIES "grpc.dns_enable_srv_queries" 362 /** If set, determines an upper bound on the number of milliseconds that the 363 * c-ares based DNS resolver will wait on queries before cancelling them. 364 * The default value is 120,000. Setting this to "0" will disable the 365 * overall timeout entirely. Note that this doesn't include internal c-ares 366 * timeouts/backoff/retry logic, and so the actual DNS resolution may time out 367 * sooner than the value specified here. */ 368 #define GRPC_ARG_DNS_ARES_QUERY_TIMEOUT_MS "grpc.dns_ares_query_timeout" 369 /** If set, uses a local subchannel pool within the channel. Otherwise, uses the 370 * global subchannel pool. */ 371 #define GRPC_ARG_USE_LOCAL_SUBCHANNEL_POOL "grpc.use_local_subchannel_pool" 372 /** gRPC Objective-C channel pooling domain string. */ 373 #define GRPC_ARG_CHANNEL_POOL_DOMAIN "grpc.channel_pooling_domain" 374 /** gRPC Objective-C channel pooling id. */ 375 #define GRPC_ARG_CHANNEL_ID "grpc.channel_id" 376 /** Channel argument for grpc_authorization_policy_provider. If present, enables 377 gRPC authorization check. */ 378 #define GRPC_ARG_AUTHORIZATION_POLICY_PROVIDER \ 379 "grpc.authorization_policy_provider" 380 /** EXPERIMENTAL. Updates to a server's configuration from a config fetcher (for 381 * example, listener updates from xDS) cause all older connections to be 382 * gracefully shut down (i.e., "drained") with a grace period configured by this 383 * channel arg. Int valued, milliseconds. Defaults to 10 minutes.*/ 384 #define GRPC_ARG_SERVER_CONFIG_CHANGE_DRAIN_GRACE_TIME_MS \ 385 "grpc.experimental.server_config_change_drain_grace_time_ms" 386 /** Configure the Differentiated Services Code Point used on outgoing packets. 387 * Integer value ranging from 0 to 63. */ 388 #define GRPC_ARG_DSCP "grpc.dscp" 389 /** Connection Attempt Delay for use in Happy Eyeballs, in milliseconds. 390 * Defaults to 250ms. */ 391 #define GRPC_ARG_HAPPY_EYEBALLS_CONNECTION_ATTEMPT_DELAY_MS \ 392 "grpc.happy_eyeballs_connection_attempt_delay_ms" 393 /** It accepts a MemoryAllocatorFactory as input and If specified, it forces 394 * the default event engine to use memory allocators created using the provided 395 * factory. */ 396 #define GRPC_ARG_EVENT_ENGINE_USE_MEMORY_ALLOCATOR_FACTORY \ 397 "grpc.event_engine_use_memory_allocator_factory" 398 /** Configure the max number of allowed incoming connections to the server. 399 * If unspecified, it is unlimited */ 400 #define GRPC_ARG_MAX_ALLOWED_INCOMING_CONNECTIONS \ 401 "grpc.max_allowed_incoming_connections" 402 /** \} */ 403 404 #endif /* GRPC_IMPL_CHANNEL_ARG_NAMES_H */ 405