Chiebot-Mirror
/
grpc
mirror of https://github.com/grpc/grpc.git
8
0
Fork 0
Code Issues Projects Releases Wiki Activity

Merge pull request #9824 from markdroth/service_config_json_comment_fix

Browse Source 
Use '//' for JSON comments.
pull/9834/head
Mark D. Roth 8 years ago committed by GitHub
parent 81f81c26f6 8cf002a989
commit 674237e30e
1 changed files with 81 additions and 81 deletions
Whitespace
Show all changes Ignore whitespace when comparing lines Ignore changes in amount of whitespace Ignore changes in whitespace at EOL
Unified View
Diff Options
Show Stats Download Patch File Download Diff File
  1. 162
      doc/service_config.md

162
doc/service_config.md
Unescape View File

@ -12,105 +12,105 @@ The service config is a JSON string of the following form:
``` ```
{ {
# Load balancing policy name. // Load balancing policy name.
# Supported values are 'round_robin' and 'grpclb'. // Supported values are 'round_robin' and 'grpclb'.
# Optional; if unset, the default behavior is pick the first available // Optional; if unset, the default behavior is pick the first available
# backend. // backend.
# Note that if the resolver returns only balancer addresses and no // Note that if the resolver returns only balancer addresses and no
# backend addresses, gRPC will always use the 'grpclb' policy, // backend addresses, gRPC will always use the 'grpclb' policy,
# regardless of what this field is set to. // regardless of what this field is set to.
'loadBalancingPolicy': string, 'loadBalancingPolicy': string,
# Per-method configuration. Optional. // Per-method configuration. Optional.
'methodConfig': [ 'methodConfig': [
{ {
# The names of the methods to which this method config applies. There // The names of the methods to which this method config applies. There
# must be at least one name. Each name entry must be unique across the // must be at least one name. Each name entry must be unique across the
# entire service config. If the 'method' field is empty, then this // entire service config. If the 'method' field is empty, then this
# method config specifies the defaults for all methods for the specified // method config specifies the defaults for all methods for the specified
# service. // service.
# //
# For example, let's say that the service config contains the following // For example, let's say that the service config contains the following
# method config entries: // method config entries:
# //
# 'methodConfig': [ // 'methodConfig': [
# { 'name': [ { 'service': 'MyService' } ] ... }, // { 'name': [ { 'service': 'MyService' } ] ... },
# { 'name': [ { 'service': 'MyService', 'method': 'Foo' } ] ... } // { 'name': [ { 'service': 'MyService', 'method': 'Foo' } ] ... }
# ] // ]
# //
# For a request for MyService/Foo, we will use the second entry, because // For a request for MyService/Foo, we will use the second entry, because
# it exactly matches the service and method name. // it exactly matches the service and method name.
# For a request for MyService/Bar, we will use the first entry, because // For a request for MyService/Bar, we will use the first entry, because
# it provides the default for all methods of MyService. // it provides the default for all methods of MyService.
'name': [ 'name': [
{ {
# RPC service name. Required. // RPC service name. Required.
# If using gRPC with protobuf as the IDL, then this will be of // If using gRPC with protobuf as the IDL, then this will be of
# the form "pkg.service_name", where "pkg" is the package name // the form "pkg.service_name", where "pkg" is the package name
# defined in the proto file. // defined in the proto file.
'service': string, 'service': string,
# RPC method name. Optional (see above). // RPC method name. Optional (see above).
'method': string, 'method': string,
} }
], ],
# Whether RPCs sent to this method should wait until the connection is // Whether RPCs sent to this method should wait until the connection is
# ready by default. If false, the RPC will abort immediately if there // ready by default. If false, the RPC will abort immediately if there
# is a transient failure connecting to the server. Otherwise, gRPC will // is a transient failure connecting to the server. Otherwise, gRPC will
# attempt to connect until the deadline is exceeded. // attempt to connect until the deadline is exceeded.
# //
# The value specified via the gRPC client API will override the value // The value specified via the gRPC client API will override the value
# set here. However, note that setting the value in the client API will // set here. However, note that setting the value in the client API will
# also affect transient errors encountered during name resolution, // also affect transient errors encountered during name resolution,
# which cannot be caught by the value here, since the service config // which cannot be caught by the value here, since the service config
# is obtained by the gRPC client via name resolution. // is obtained by the gRPC client via name resolution.
'waitForReady': bool, 'waitForReady': bool,
# The default timeout in seconds for RPCs sent to this method. This can // The default timeout in seconds for RPCs sent to this method. This can
# be overridden in code. If no reply is received in the specified amount // be overridden in code. If no reply is received in the specified amount
# of time, the request is aborted and a deadline-exceeded error status // of time, the request is aborted and a deadline-exceeded error status
# is returned to the caller. // is returned to the caller.
# //
# The actual deadline used will be the minimum of the value specified // The actual deadline used will be the minimum of the value specified
# here and the value set by the application via the gRPC client API. // here and the value set by the application via the gRPC client API.
# If either one is not set, then the other will be used. // If either one is not set, then the other will be used.
# If neither is set, then the request has no deadline. // If neither is set, then the request has no deadline.
# //
# The format of the value is that of the 'Duration' type defined here: // The format of the value is that of the 'Duration' type defined here:
# https://developers.google.com/protocol-buffers/docs/proto3#json // https://developers.google.com/protocol-buffers/docs/proto3#json
'timeout': string, 'timeout': string,
# The maximum allowed payload size for an individual request or object // The maximum allowed payload size for an individual request or object
# in a stream (client->server) in bytes. The size which is measured is // in a stream (client->server) in bytes. The size which is measured is
# the serialized, uncompressed payload in bytes. This applies both // the serialized, uncompressed payload in bytes. This applies both
# to streaming and non-streaming requests. // to streaming and non-streaming requests.
# //
# The actual value used is the minimum of the value specified here and // The actual value used is the minimum of the value specified here and
# the value set by the application via the gRPC client API. // the value set by the application via the gRPC client API.
# If either one is not set, then the other will be used. // If either one is not set, then the other will be used.
# If neither is set, then the built-in default is used. // If neither is set, then the built-in default is used.
# //
# If a client attempts to send an object larger than this value, it // If a client attempts to send an object larger than this value, it
# will not be sent and the client will see an error. // will not be sent and the client will see an error.
# Note that 0 is a valid value, meaning that the request message must // Note that 0 is a valid value, meaning that the request message must
# be empty. // be empty.
'maxRequestMessageBytes': number, 'maxRequestMessageBytes': number,
# The maximum allowed payload size for an individual response or object // The maximum allowed payload size for an individual response or object
# in a stream (server->client) in bytes. The size which is measured is // in a stream (server->client) in bytes. The size which is measured is
# the serialized, uncompressed payload in bytes. This applies both // the serialized, uncompressed payload in bytes. This applies both
# to streaming and non-streaming requests. // to streaming and non-streaming requests.
# //
# The actual value used is the minimum of the value specified here and // The actual value used is the minimum of the value specified here and
# the value set by the application via the gRPC client API. // the value set by the application via the gRPC client API.
# If either one is not set, then the other will be used. // If either one is not set, then the other will be used.
# If neither is set, then the built-in default is used. // If neither is set, then the built-in default is used.
# //
# If a server attempts to send an object larger than this value, it // If a server attempts to send an object larger than this value, it
# will not be sent, and the client will see an error. // will not be sent, and the client will see an error.
# Note that 0 is a valid value, meaning that the response message must // Note that 0 is a valid value, meaning that the response message must
# be empty. // be empty.
'maxResponseMessageBytes': number 'maxResponseMessageBytes': number
} }
] ]

Write Preview
Loading…
Cancel
Save