Built motion from commit 6a09e18b.|2.6.11

[motion2.git] / legacy-libs / grpc-cloned / deps / grpc / src / core / ext / filters / client_channel / README.md

diff --git a/legacy-libs/grpc-cloned/deps/grpc/src/core/ext/filters/client_channel/README.md b/legacy-libs/grpc-cloned/deps/grpc/src/core/ext/filters/client_channel/README.md
new file mode 100644 (file)
index 0000000..ffb09fd
--- /dev/null
+++ b/legacy-libs/grpc-cloned/deps/grpc/src/core/ext/filters/client_channel/README.md
@@ -0,0 +1,49 @@
+Client Configuration Support for GRPC
+=====================================
+
+This library provides high level configuration machinery to construct client
+channels and load balance between them.
+
+Each `grpc_channel` is created with a `Resolver`. It is the resolver's duty
+to resolve a name into a set of arguments for the channel. Such arguments
+might include:
+
+- a list of (ip, port) addresses to connect to
+- a load balancing policy to decide which server to send a request to
+- a set of filters to mutate outgoing requests (say, by adding metadata)
+
+The resolver provides this data as a stream of `grpc_channel_args` objects to
+the channel. We represent arguments as a stream so that they can be changed
+by the resolver during execution, by reacting to external events (such as
+new service configuration data being pushed to some store).
+
+
+Load Balancing
+--------------
+
+Load balancing configuration is provided by a `LoadBalancingPolicy` object.
+
+The primary job of the load balancing policies is to pick a target server
+given only the initial metadata for a request. It does this by providing
+a `ConnectedSubchannel` object to the owning channel.
+
+
+Sub-Channels
+------------
+
+A sub-channel provides a connection to a server for a client channel. It has a
+connectivity state like a regular channel, and so can be connected or
+disconnected. This connectivity state can be used to inform load balancing
+decisions (for example, by avoiding disconnected backends).
+
+Configured sub-channels are fully setup to participate in the grpc data plane.
+Their behavior is specified by a set of grpc channel filters defined at their
+construction. To customize this behavior, transports build
+`ClientChannelFactory` objects, which customize construction arguments for
+concrete subchannel instances.
+
+
+Naming for GRPC
+===============
+
+See [/doc/naming.md](gRPC name resolution).