channel_arg_names.h File Reference

Go to the source code of this file.

Macros
#define	GRPC_ARG_ENABLE_CENSUS   "grpc.census"
	If non-zero, enable census for tracing and stats collection. More...
#define	GRPC_ARG_ENABLE_LOAD_REPORTING   "grpc.loadreporting"
	If non-zero, enable load reporting. More...
#define	GRPC_ARG_SERVER_CALL_METRIC_RECORDING   "grpc.server_call_metric_recording"
	If non-zero, call metric recording is enabled. More...
#define	GRPC_ARG_MINIMAL_STACK   "grpc.minimal_stack"
	Request that optional features default to off (regardless of what they usually default to) - to enable tight control over what gets enabled Boolean valued. More...
#define	GRPC_ARG_MAX_CONCURRENT_STREAMS   "grpc.max_concurrent_streams"
	Maximum number of concurrent incoming streams to allow on a http2 connection. More...
#define	GRPC_ARG_MAX_RECEIVE_MESSAGE_LENGTH   "grpc.max_receive_message_length"
	Maximum message length that the channel can receive. More...
#define	GRPC_ARG_MAX_MESSAGE_LENGTH   GRPC_ARG_MAX_RECEIVE_MESSAGE_LENGTH
#define	GRPC_ARG_MAX_SEND_MESSAGE_LENGTH   "grpc.max_send_message_length"
	Maximum message length that the channel can send. More...
#define	GRPC_ARG_MAX_CONNECTION_IDLE_MS   "grpc.max_connection_idle_ms"
	Maximum time that a channel may have no outstanding rpcs, after which the server will close the connection. More...
#define	GRPC_ARG_MAX_CONNECTION_AGE_MS   "grpc.max_connection_age_ms"
	Maximum amount of time in milliseconds that a connection may exist before it will be gracefully shut down. More...
#define	GRPC_ARG_MAX_CONNECTION_AGE_GRACE_MS   "grpc.max_connection_age_grace_ms"
	Grace period in milliseconds after connection reaches its max age for outstanding RPCs to complete. More...
#define	GRPC_ARG_CLIENT_IDLE_TIMEOUT_MS   "grpc.client_idle_timeout_ms"
	Timeout after the last RPC finishes on the client channel at which the channel goes back into IDLE state. More...
#define	GRPC_ARG_ENABLE_PER_MESSAGE_COMPRESSION   "grpc.per_message_compression"
	Enable/disable support for per-message compression. More...
#define	GRPC_ARG_ENABLE_PER_MESSAGE_DECOMPRESSION   "grpc.per_message_decompression"
	Experimental Arg. More...
#define	GRPC_ARG_HTTP2_INITIAL_SEQUENCE_NUMBER   "grpc.http2.initial_sequence_number"
	Initial stream ID for http2 transports. More...
#define	GRPC_ARG_HTTP2_STREAM_LOOKAHEAD_BYTES   "grpc.http2.lookahead_bytes"
	Amount to read ahead on individual streams. More...
#define	GRPC_ARG_HTTP2_HPACK_TABLE_SIZE_DECODER   "grpc.http2.hpack_table_size.decoder"
	How much memory to use for hpack decoding. More...
#define	GRPC_ARG_HTTP2_HPACK_TABLE_SIZE_ENCODER   "grpc.http2.hpack_table_size.encoder"
	How much memory to use for hpack encoding. More...
#define	GRPC_ARG_HTTP2_MAX_FRAME_SIZE   "grpc.http2.max_frame_size"
	How big a frame are we willing to receive via HTTP2. More...
#define	GRPC_ARG_HTTP2_BDP_PROBE   "grpc.http2.bdp_probe"
	Should BDP probing be performed? Boolean valued. More...
#define	GRPC_ARG_HTTP2_MIN_SENT_PING_INTERVAL_WITHOUT_DATA_MS   "grpc.http2.min_time_between_pings_ms"
	(DEPRECATED) Does not have any effect. More...
#define	GRPC_ARG_HTTP2_MIN_RECV_PING_INTERVAL_WITHOUT_DATA_MS   "grpc.http2.min_ping_interval_without_data_ms"
	Minimum allowed time between a server receiving successive ping frames without sending any data/header frame. More...
#define	GRPC_ARG_SERVER_MAX_UNREQUESTED_TIME_IN_SERVER_SECONDS   "grpc.server_max_unrequested_time_in_server"
	Maximum time to allow a request to be: (1) received by the server, but (2) not requested by a RequestCall (in the completion queue based API) before the request is cancelled. More...
#define	GRPC_ARG_HTTP2_SCHEME   "grpc.http2_scheme"
	Channel arg to override the http2 :scheme header. More...
#define	GRPC_ARG_HTTP2_MAX_PINGS_WITHOUT_DATA   "grpc.http2.max_pings_without_data"
	How many pings can the client send before needing to send a data/header frame? (0 indicates that an infinite number of pings can be sent without sending a data frame or header frame). More...
#define	GRPC_ARG_HTTP2_MAX_PING_STRIKES   "grpc.http2.max_ping_strikes"
	How many misbehaving pings the server can bear before sending goaway and closing the transport? (0 indicates that the server can bear an infinite number of misbehaving pings) Integer valued. More...
#define	GRPC_ARG_HTTP2_WRITE_BUFFER_SIZE   "grpc.http2.write_buffer_size"
	How much data are we willing to queue up per stream if GRPC_WRITE_BUFFER_HINT is set? This is an upper bound Integer valued, bytes. More...
#define	GRPC_ARG_HTTP2_ENABLE_TRUE_BINARY   "grpc.http2.true_binary"
	Should we allow receipt of true-binary data on http2 connections? Defaults to on (1) More...
#define	GRPC_ARG_EXPERIMENTAL_HTTP2_PREFERRED_CRYPTO_FRAME_SIZE   "grpc.experimental.http2.enable_preferred_frame_size"
	An experimental channel arg which determines whether the preferred crypto frame size http2 setting sent to the peer at startup. More...
#define	GRPC_ARG_KEEPALIVE_TIME_MS   "grpc.keepalive_time_ms"
	After a duration of this time the client/server pings its peer to see if the transport is still alive. More...
#define	GRPC_ARG_KEEPALIVE_TIMEOUT_MS   "grpc.keepalive_timeout_ms"
	After waiting for a duration of this time, if the keepalive ping sender does not receive the ping ack, it will close the transport. More...
#define	GRPC_ARG_KEEPALIVE_PERMIT_WITHOUT_CALLS   "grpc.keepalive_permit_without_calls"
	Is it permissible to send keepalive pings from the client without any outstanding streams. More...
#define	GRPC_ARG_DEFAULT_AUTHORITY   "grpc.default_authority"
	Default authority to pass if none specified on call construction. More...
#define	GRPC_ARG_PRIMARY_USER_AGENT_STRING   "grpc.primary_user_agent"
	Primary user agent: goes at the start of the user-agent metadata sent on each request. More...
#define	GRPC_ARG_SECONDARY_USER_AGENT_STRING   "grpc.secondary_user_agent"
	Secondary user agent: goes at the end of the user-agent metadata sent on each request. More...
#define	GRPC_ARG_MIN_RECONNECT_BACKOFF_MS   "grpc.min_reconnect_backoff_ms"
	The minimum time between subsequent connection attempts, in ms. More...
#define	GRPC_ARG_MAX_RECONNECT_BACKOFF_MS   "grpc.max_reconnect_backoff_ms"
	The maximum time between subsequent connection attempts, in ms. More...
#define	GRPC_ARG_INITIAL_RECONNECT_BACKOFF_MS   "grpc.initial_reconnect_backoff_ms"
	The time between the first and second connection attempts, in ms. More...
#define	GRPC_ARG_DNS_MIN_TIME_BETWEEN_RESOLUTIONS_MS   "grpc.dns_min_time_between_resolutions_ms"
	Minimum amount of time between DNS resolutions, in ms. More...
#define	GRPC_ARG_SERVER_HANDSHAKE_TIMEOUT_MS   "grpc.server_handshake_timeout_ms"
	The timeout used on servers for finishing handshaking on an incoming connection. More...
#define	GRPC_SSL_TARGET_NAME_OVERRIDE_ARG   "grpc.ssl_target_name_override"
	This should be used for testing only. More...
#define	GRPC_SSL_SESSION_CACHE_ARG   "grpc.ssl_session_cache"
	If non-zero, a pointer to a session cache (a pointer of type grpc_ssl_session_cache*). More...
#define	GRPC_ARG_TSI_MAX_FRAME_SIZE   "grpc.tsi.max_frame_size"
	If non-zero, it will determine the maximum frame size used by TSI's frame protector. More...
#define	GRPC_ARG_MAX_METADATA_SIZE   "grpc.max_metadata_size"
	Maximum metadata size (soft limit), in bytes. More...
#define	GRPC_ARG_ABSOLUTE_MAX_METADATA_SIZE   "grpc.absolute_max_metadata_size"
	Maximum metadata size (hard limit), in bytes. More...
#define	GRPC_ARG_ALLOW_REUSEPORT   "grpc.so_reuseport"
	If non-zero, allow the use of SO_REUSEPORT if it's available (default 1) More...
#define	GRPC_ARG_RESOURCE_QUOTA   "grpc.resource_quota"
	If non-zero, a pointer to a buffer pool (a pointer of type grpc_resource_quota*). More...
#define	GRPC_ARG_EXPAND_WILDCARD_ADDRS   "grpc.expand_wildcard_addrs"
	If non-zero, expand wildcard addresses to a list of local addresses. More...
#define	GRPC_ARG_SERVICE_CONFIG   "grpc.service_config"
	Service config data in JSON form. More...
#define	GRPC_ARG_SERVICE_CONFIG_DISABLE_RESOLUTION   "grpc.service_config_disable_resolution"
	Disable looking up the service config via the name resolver. More...
#define	GRPC_ARG_LB_POLICY_NAME   "grpc.lb_policy_name"
	LB policy name. More...
#define	GRPC_ARG_RING_HASH_LB_RING_SIZE_CAP   "grpc.lb.ring_hash.ring_size_cap"
	Cap for ring size in the ring_hash LB policy. More...
#define	GRPC_ARG_SOCKET_MUTATOR   "grpc.socket_mutator"
	The grpc_socket_mutator instance that set the socket options. More...
#define	GRPC_ARG_SOCKET_FACTORY   "grpc.socket_factory"
	The grpc_socket_factory instance to create and bind sockets. More...
#define	GRPC_ARG_MAX_CHANNEL_TRACE_EVENT_MEMORY_PER_NODE   "grpc.max_channel_trace_event_memory_per_node"
	The maximum amount of memory used by trace events per channel trace node. More...
#define	GRPC_ARG_ENABLE_CHANNELZ   "grpc.enable_channelz"
	If non-zero, gRPC library will track stats and information at at per channel level. More...
#define	GRPC_ARG_TCP_READ_CHUNK_SIZE   "grpc.experimental.tcp_read_chunk_size"
	Channel arg (integer) setting how large a slice to try and read from the wire each time recvmsg (or equivalent). More...
#define	GRPC_TCP_DEFAULT_READ_SLICE_SIZE   8192
	Note this is not a "channel arg" key. More...
#define	GRPC_ARG_TCP_MIN_READ_CHUNK_SIZE   "grpc.experimental.tcp_min_read_chunk_size"
	Minimum read chunk size defaults to 256 bytes. More...
#define	GRPC_ARG_TCP_MAX_READ_CHUNK_SIZE   "grpc.experimental.tcp_max_read_chunk_size"
#define	GRPC_ARG_TCP_TX_ZEROCOPY_ENABLED   "grpc.experimental.tcp_tx_zerocopy_enabled"
#define	GRPC_ARG_TCP_TX_ZEROCOPY_SEND_BYTES_THRESHOLD   "grpc.experimental.tcp_tx_zerocopy_send_bytes_threshold"
#define	GRPC_ARG_TCP_TX_ZEROCOPY_MAX_SIMULT_SENDS   "grpc.experimental.tcp_tx_zerocopy_max_simultaneous_sends"
#define	GRPC_ARG_TCP_RECEIVE_BUFFER_SIZE   "grpc.tcp_receive_buffer_size"
#define	GRPC_ARG_GRPCLB_CALL_TIMEOUT_MS   "grpc.grpclb_call_timeout_ms"
#define	GRPC_ARG_TEST_ONLY_DO_NOT_USE_IN_PROD_XDS_BOOTSTRAP_CONFIG   "grpc.TEST_ONLY_DO_NOT_USE_IN_PROD.xds_bootstrap_config"
#define	GRPC_ARG_GRPCLB_FALLBACK_TIMEOUT_MS   "grpc.grpclb_fallback_timeout_ms"
#define	GRPC_ARG_EXPERIMENTAL_GRPCLB_CHANNEL_ARGS   "grpc.experimental.grpclb_channel_args"
#define	GRPC_ARG_PRIORITY_FAILOVER_TIMEOUT_MS   "grpc.priority_failover_timeout_ms"
#define	GRPC_ARG_OPTIMIZATION_TARGET   "grpc.optimization_target"
	String defining the optimization target for a channel. More...
#define	GRPC_ARG_ENABLE_RETRIES   "grpc.enable_retries"
	Enables retry functionality. More...
#define	GRPC_ARG_EXPERIMENTAL_ENABLE_HEDGING   "grpc.experimental.enable_hedging"
	Enables hedging functionality, as described in: https://github.com/grpc/proposal/blob/master/A6-client-retries.md Default is currently false, since this functionality is not yet fully implemented. More...
#define	GRPC_ARG_PER_RPC_RETRY_BUFFER_SIZE   "grpc.per_rpc_retry_buffer_size"
	Per-RPC retry buffer size, in bytes. More...
#define	GRPC_ARG_MOBILE_LOG_CONTEXT   "grpc.mobile_log_context"
	Channel arg that carries the bridged objective c object for custom metrics logging filter. More...
#define	GRPC_ARG_DISABLE_CLIENT_AUTHORITY_FILTER   "grpc.disable_client_authority_filter"
	If non-zero, client authority filter is disabled for the channel. More...
#define	GRPC_ARG_ENABLE_HTTP_PROXY   "grpc.enable_http_proxy"
	If set to zero, disables use of http proxies. More...
#define	GRPC_ARG_HTTP_PROXY   "grpc.http_proxy"
	Channel arg to set http proxy per channel. More...
#define	GRPC_ARG_ADDRESS_HTTP_PROXY   "grpc.address_http_proxy"
	Specifies an HTTP proxy to use for individual addresses. More...
#define	GRPC_ARG_ADDRESS_HTTP_PROXY_ENABLED_ADDRESSES   "grpc.address_http_proxy_enabled_addresses"
	Comma separated list of addresses or address ranges that are behind the address HTTP proxy. More...
#define	GRPC_ARG_SURFACE_USER_AGENT   "grpc.surface_user_agent"
	If set to non zero, surfaces the user agent string to the server. More...
#define	GRPC_ARG_INHIBIT_HEALTH_CHECKING   "grpc.inhibit_health_checking"
	If set, inhibits health checking (which may be enabled via the service config.). More...
#define	GRPC_ARG_DNS_ENABLE_SRV_QUERIES   "grpc.dns_enable_srv_queries"
	If enabled, the channel's DNS resolver queries for SRV records. More...
#define	GRPC_ARG_DNS_ARES_QUERY_TIMEOUT_MS   "grpc.dns_ares_query_timeout"
	If set, determines an upper bound on the number of milliseconds that the c-ares based DNS resolver will wait on queries before cancelling them. More...
#define	GRPC_ARG_USE_LOCAL_SUBCHANNEL_POOL   "grpc.use_local_subchannel_pool"
	If set, uses a local subchannel pool within the channel. More...
#define	GRPC_ARG_CHANNEL_POOL_DOMAIN   "grpc.channel_pooling_domain"
	gRPC Objective-C channel pooling domain string. More...
#define	GRPC_ARG_CHANNEL_ID   "grpc.channel_id"
	gRPC Objective-C channel pooling id. More...
#define	GRPC_ARG_AUTHORIZATION_POLICY_PROVIDER   "grpc.authorization_policy_provider"
	Channel argument for grpc_authorization_policy_provider. More...
#define	GRPC_ARG_SERVER_CONFIG_CHANGE_DRAIN_GRACE_TIME_MS   "grpc.experimental.server_config_change_drain_grace_time_ms"
	EXPERIMENTAL. More...
#define	GRPC_ARG_DSCP   "grpc.dscp"
	Configure the Differentiated Services Code Point used on outgoing packets. More...
#define	GRPC_ARG_HAPPY_EYEBALLS_CONNECTION_ATTEMPT_DELAY_MS   "grpc.happy_eyeballs_connection_attempt_delay_ms"
	Connection Attempt Delay for use in Happy Eyeballs, in milliseconds. More...
#define	GRPC_ARG_EVENT_ENGINE_USE_MEMORY_ALLOCATOR_FACTORY   "grpc.event_engine_use_memory_allocator_factory"
	It accepts a MemoryAllocatorFactory as input and If specified, it forces the default event engine to use memory allocators created using the provided factory. More...
#define	GRPC_ARG_MAX_ALLOWED_INCOMING_CONNECTIONS   "grpc.max_allowed_incoming_connections"
	Configure the max number of allowed incoming connections to the server. More...
#define	GRPC_ARG_EXPERIMENTAL_STATS_PLUGINS   "grpc.experimental.stats_plugins"
	Configure per-channel or per-server stats plugins. More...
#define	GRPC_ARG_SECURITY_FRAME_ALLOWED   "grpc.security_frame_allowed"
	If non-zero, allow security frames to be sent and received. More...