GRPC Core  1.0.0
Macros
Grpc_arg_keys

Channel argument keys. More...

Macros

#define GRPC_COMPRESSION_CHANNEL_DEFAULT_ALGORITHM   "grpc.default_compression_algorithm"
 Default compression algorithm for the channel. More...
 
#define GRPC_COMPRESSION_CHANNEL_DEFAULT_LEVEL   "grpc.default_compression_level"
 Default compression level for the channel. More...
 
#define GRPC_COMPRESSION_CHANNEL_ENABLED_ALGORITHMS_BITSET   "grpc.compression_enabled_algorithms_bitset"
 Compression algorithms supported by the channel. More...
 
#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_MAX_CONCURRENT_STREAMS   "grpc.max_concurrent_streams"
 Maximum number of concurrent incoming streams to allow on a http2 connection. More...
 
#define GRPC_ARG_MAX_MESSAGE_LENGTH   "grpc.max_message_length"
 Maximum message length that the channel can receive. More...
 
#define GRPC_ARG_HTTP2_INITIAL_SEQUENCE_NUMBER   "grpc.http2.initial_sequence_number"
 Initial sequence number 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_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_MAX_RECONNECT_BACKOFF_MS   "grpc.max_reconnect_backoff_ms"
 The maximum time between subsequent connection attempts, in ms. More...
 
#define GRPC_SSL_TARGET_NAME_OVERRIDE_ARG   "grpc.ssl_target_name_override"
 
#define GRPC_ARG_MAX_METADATA_SIZE   "grpc.max_metadata_size"
 
#define GRPC_ARG_ALLOW_REUSEPORT   "grpc.so_reuseport"
 If non-zero, allow the use of SO_REUSEPORT if it's available (default 1) More...
 

Detailed Description

Channel argument keys.

To be used in channel arguments.

Macro Definition Documentation

#define GRPC_ARG_ALLOW_REUSEPORT   "grpc.so_reuseport"

If non-zero, allow the use of SO_REUSEPORT if it's available (default 1)

#define GRPC_ARG_DEFAULT_AUTHORITY   "grpc.default_authority"

Default authority to pass if none specified on call construction.

A string.

#define GRPC_ARG_ENABLE_CENSUS   "grpc.census"

If non-zero, enable census for tracing and stats collection.

#define GRPC_ARG_ENABLE_LOAD_REPORTING   "grpc.loadreporting"

If non-zero, enable load reporting.

#define GRPC_ARG_HTTP2_HPACK_TABLE_SIZE_DECODER   "grpc.http2.hpack_table_size.decoder"

How much memory to use for hpack decoding.

Int valued, bytes.

#define GRPC_ARG_HTTP2_HPACK_TABLE_SIZE_ENCODER   "grpc.http2.hpack_table_size.encoder"

How much memory to use for hpack encoding.

Int valued, bytes.

#define GRPC_ARG_HTTP2_INITIAL_SEQUENCE_NUMBER   "grpc.http2.initial_sequence_number"

Initial sequence number for http2 transports.

Int valued.

#define GRPC_ARG_HTTP2_STREAM_LOOKAHEAD_BYTES   "grpc.http2.lookahead_bytes"

Amount to read ahead on individual streams.

Defaults to 64kb, larger values can help throughput on high-latency connections. NOTE: at some point we'd like to auto-tune this, and this parameter will become a no-op. Int valued, bytes.

#define GRPC_ARG_MAX_CONCURRENT_STREAMS   "grpc.max_concurrent_streams"

Maximum number of concurrent incoming streams to allow on a http2 connection.

Int valued.

#define GRPC_ARG_MAX_MESSAGE_LENGTH   "grpc.max_message_length"

Maximum message length that the channel can receive.

Int valued, bytes.

#define GRPC_ARG_MAX_METADATA_SIZE   "grpc.max_metadata_size"
#define GRPC_ARG_MAX_RECONNECT_BACKOFF_MS   "grpc.max_reconnect_backoff_ms"

The maximum time between subsequent connection attempts, in ms.

#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.

A string.

#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.

A string.

#define GRPC_COMPRESSION_CHANNEL_DEFAULT_ALGORITHM   "grpc.default_compression_algorithm"

Default compression algorithm for the channel.

Its value is an int from the grpc_compression_algorithm enum.

#define GRPC_COMPRESSION_CHANNEL_DEFAULT_LEVEL   "grpc.default_compression_level"

Default compression level for the channel.

Its value is an int from the grpc_compression_level enum.

#define GRPC_COMPRESSION_CHANNEL_ENABLED_ALGORITHMS_BITSET   "grpc.compression_enabled_algorithms_bitset"

Compression algorithms supported by the channel.

Its value is a bitset (an int). Bits correspond to algorithms in grpc_compression_algorithm. For example, its LSB corresponds to GRPC_COMPRESS_NONE, the next bit to GRPC_COMPRESS_DEFLATE, etc. Unset bits disable support for the algorithm. By default all algorithms are supported. It's not possible to disable GRPC_COMPRESS_NONE (the attempt will be ignored).

#define GRPC_SSL_TARGET_NAME_OVERRIDE_ARG   "grpc.ssl_target_name_override"