cache nuget packages
This commit is contained in:
master
5
local-nuget/grpc.net.client/2.65.0/.nupkg.metadata
Normal file
5
local-nuget/grpc.net.client/2.65.0/.nupkg.metadata
Normal file
@@ -0,0 +1,5 @@
|
||||
{
|
||||
"version": 2,
|
||||
"contentHash": "ys1Rz7pxV0XR2pm4BVMkm/PrJ2BQu8OXFTvnXzzelTvQ+19OiHbUSb1kSZ2X4V7FziaxrtWY52ssXK3MFjQxbg==",
|
||||
"source": "https://api.nuget.org/v3/index.json"
|
||||
}
|
||||
BIN
local-nuget/grpc.net.client/2.65.0/.signature.p7s
Normal file
BIN
local-nuget/grpc.net.client/2.65.0/.signature.p7s
Normal file
Binary file not shown.
47
local-nuget/grpc.net.client/2.65.0/Grpc.Net.Client.nuspec
Normal file
47
local-nuget/grpc.net.client/2.65.0/Grpc.Net.Client.nuspec
Normal file
@@ -0,0 +1,47 @@
|
||||
<?xml version="1.0" encoding="utf-8"?>
|
||||
<package xmlns="http://schemas.microsoft.com/packaging/2013/05/nuspec.xsd">
|
||||
<metadata>
|
||||
<id>Grpc.Net.Client</id>
|
||||
<version>2.65.0</version>
|
||||
<authors>The gRPC Authors</authors>
|
||||
<license type="expression">Apache-2.0</license>
|
||||
<licenseUrl>https://licenses.nuget.org/Apache-2.0</licenseUrl>
|
||||
<icon>packageIcon.png</icon>
|
||||
<readme>README.md</readme>
|
||||
<projectUrl>https://github.com/grpc/grpc-dotnet</projectUrl>
|
||||
<description>.NET client for gRPC</description>
|
||||
<copyright>Copyright 2019 The gRPC Authors</copyright>
|
||||
<tags>gRPC RPC HTTP/2</tags>
|
||||
<repository type="git" url="https://github.com/grpc/grpc-dotnet.git" commit="60156334d62c5169792c5fca1a653aa490c1abd8" />
|
||||
<dependencies>
|
||||
<group targetFramework=".NETFramework4.6.2">
|
||||
<dependency id="Grpc.Net.Common" version="2.65.0" exclude="Build,Analyzers" />
|
||||
<dependency id="Microsoft.Extensions.Logging.Abstractions" version="6.0.0" exclude="Build,Analyzers" />
|
||||
<dependency id="System.Diagnostics.DiagnosticSource" version="6.0.1" exclude="Build,Analyzers" />
|
||||
<dependency id="System.Net.Http.WinHttpHandler" version="8.0.0" exclude="Build,Analyzers" />
|
||||
</group>
|
||||
<group targetFramework="net6.0">
|
||||
<dependency id="Grpc.Net.Common" version="2.65.0" exclude="Build,Analyzers" />
|
||||
<dependency id="Microsoft.Extensions.Logging.Abstractions" version="6.0.0" exclude="Build,Analyzers" />
|
||||
</group>
|
||||
<group targetFramework="net7.0">
|
||||
<dependency id="Grpc.Net.Common" version="2.65.0" exclude="Build,Analyzers" />
|
||||
<dependency id="Microsoft.Extensions.Logging.Abstractions" version="6.0.0" exclude="Build,Analyzers" />
|
||||
</group>
|
||||
<group targetFramework="net8.0">
|
||||
<dependency id="Grpc.Net.Common" version="2.65.0" exclude="Build,Analyzers" />
|
||||
<dependency id="Microsoft.Extensions.Logging.Abstractions" version="6.0.0" exclude="Build,Analyzers" />
|
||||
</group>
|
||||
<group targetFramework=".NETStandard2.0">
|
||||
<dependency id="Grpc.Net.Common" version="2.65.0" exclude="Build,Analyzers" />
|
||||
<dependency id="Microsoft.Extensions.Logging.Abstractions" version="6.0.0" exclude="Build,Analyzers" />
|
||||
<dependency id="System.Diagnostics.DiagnosticSource" version="6.0.1" exclude="Build,Analyzers" />
|
||||
</group>
|
||||
<group targetFramework=".NETStandard2.1">
|
||||
<dependency id="Grpc.Net.Common" version="2.65.0" exclude="Build,Analyzers" />
|
||||
<dependency id="Microsoft.Extensions.Logging.Abstractions" version="6.0.0" exclude="Build,Analyzers" />
|
||||
<dependency id="System.Diagnostics.DiagnosticSource" version="6.0.1" exclude="Build,Analyzers" />
|
||||
</group>
|
||||
</dependencies>
|
||||
</metadata>
|
||||
</package>
|
||||
151
local-nuget/grpc.net.client/2.65.0/README.md
Normal file
151
local-nuget/grpc.net.client/2.65.0/README.md
Normal file
@@ -0,0 +1,151 @@
|
||||
# Grpc.Net.Client
|
||||
|
||||
`Grpc.Net.Client` is a gRPC client library for .NET.
|
||||
|
||||
## Configure gRPC client
|
||||
|
||||
gRPC clients are concrete client types that are [generated from `.proto` files](https://docs.microsoft.com/aspnet/core/grpc/basics#generated-c-assets). The concrete gRPC client has methods that translate to the gRPC service in the `.proto` file. For example, a service called `Greeter` generates a `GreeterClient` type with methods to call the service.
|
||||
|
||||
A gRPC client is created from a channel. Start by using `GrpcChannel.ForAddress` to create a channel, and then use the channel to create a gRPC client:
|
||||
|
||||
```csharp
|
||||
var channel = GrpcChannel.ForAddress("https://localhost:5001");
|
||||
var client = new Greet.GreeterClient(channel);
|
||||
```
|
||||
|
||||
A channel represents a long-lived connection to a gRPC service. When a channel is created, it's configured with options related to calling a service. For example, the `HttpClient` used to make calls, the maximum send and receive message size, and logging can be specified on `GrpcChannelOptions` and used with `GrpcChannel.ForAddress`. For a complete list of options, see [client configuration options](https://docs.microsoft.com/aspnet/core/grpc/configuration#configure-client-options).
|
||||
|
||||
```csharp
|
||||
var channel = GrpcChannel.ForAddress("https://localhost:5001");
|
||||
|
||||
var greeterClient = new Greet.GreeterClient(channel);
|
||||
var counterClient = new Count.CounterClient(channel);
|
||||
|
||||
// Use clients to call gRPC services
|
||||
```
|
||||
|
||||
## Make gRPC calls
|
||||
|
||||
A gRPC call is initiated by calling a method on the client. The gRPC client will handle message serialization and addressing the gRPC call to the correct service.
|
||||
|
||||
gRPC has different types of methods. How the client is used to make a gRPC call depends on the type of method called. The gRPC method types are:
|
||||
|
||||
* Unary
|
||||
* Server streaming
|
||||
* Client streaming
|
||||
* Bi-directional streaming
|
||||
|
||||
### Unary call
|
||||
|
||||
A unary call starts with the client sending a request message. A response message is returned when the service finishes.
|
||||
|
||||
```csharp
|
||||
var client = new Greet.GreeterClient(channel);
|
||||
var response = await client.SayHelloAsync(new HelloRequest { Name = "World" });
|
||||
|
||||
Console.WriteLine("Greeting: " + response.Message);
|
||||
// Greeting: Hello World
|
||||
```
|
||||
|
||||
Each unary service method in the `.proto` file will result in two .NET methods on the concrete gRPC client type for calling the method: an asynchronous method and a blocking method. For example, on `GreeterClient` there are two ways of calling `SayHello`:
|
||||
|
||||
* `GreeterClient.SayHelloAsync` - calls `Greeter.SayHello` service asynchronously. Can be awaited.
|
||||
* `GreeterClient.SayHello` - calls `Greeter.SayHello` service and blocks until complete. Don't use in asynchronous code.
|
||||
|
||||
### Server streaming call
|
||||
|
||||
A server streaming call starts with the client sending a request message. `ResponseStream.MoveNext()` reads messages streamed from the service. The server streaming call is complete when `ResponseStream.MoveNext()` returns `false`.
|
||||
|
||||
```csharp
|
||||
var client = new Greet.GreeterClient(channel);
|
||||
using var call = client.SayHellos(new HelloRequest { Name = "World" });
|
||||
|
||||
while (await call.ResponseStream.MoveNext())
|
||||
{
|
||||
Console.WriteLine("Greeting: " + call.ResponseStream.Current.Message);
|
||||
// "Greeting: Hello World" is written multiple times
|
||||
}
|
||||
```
|
||||
|
||||
When using C# 8 or later, the `await foreach` syntax can be used to read messages. The `IAsyncStreamReader<T>.ReadAllAsync()` extension method reads all messages from the response stream:
|
||||
|
||||
```csharp
|
||||
var client = new Greet.GreeterClient(channel);
|
||||
using var call = client.SayHellos(new HelloRequest { Name = "World" });
|
||||
|
||||
await foreach (var response in call.ResponseStream.ReadAllAsync())
|
||||
{
|
||||
Console.WriteLine("Greeting: " + response.Message);
|
||||
// "Greeting: Hello World" is written multiple times
|
||||
}
|
||||
```
|
||||
|
||||
### Client streaming call
|
||||
|
||||
A client streaming call starts *without* the client sending a message. The client can choose to send messages with `RequestStream.WriteAsync`. When the client has finished sending messages, `RequestStream.CompleteAsync()` should be called to notify the service. The call is finished when the service returns a response message.
|
||||
|
||||
```csharp
|
||||
var client = new Counter.CounterClient(channel);
|
||||
using var call = client.AccumulateCount();
|
||||
|
||||
for (var i = 0; i < 3; i++)
|
||||
{
|
||||
await call.RequestStream.WriteAsync(new CounterRequest { Count = 1 });
|
||||
}
|
||||
await call.RequestStream.CompleteAsync();
|
||||
|
||||
var response = await call;
|
||||
Console.WriteLine($"Count: {response.Count}");
|
||||
// Count: 3
|
||||
```
|
||||
|
||||
### Bi-directional streaming call
|
||||
|
||||
A bi-directional streaming call starts *without* the client sending a message. The client can choose to send messages with `RequestStream.WriteAsync`. Messages streamed from the service are accessible with `ResponseStream.MoveNext()` or `ResponseStream.ReadAllAsync()`. The bi-directional streaming call is complete when the `ResponseStream` has no more messages.
|
||||
|
||||
```csharp
|
||||
var client = new Echo.EchoClient(channel);
|
||||
using var call = client.Echo();
|
||||
|
||||
Console.WriteLine("Starting background task to receive messages");
|
||||
var readTask = Task.Run(async () =>
|
||||
{
|
||||
await foreach (var response in call.ResponseStream.ReadAllAsync())
|
||||
{
|
||||
Console.WriteLine(response.Message);
|
||||
// Echo messages sent to the service
|
||||
}
|
||||
});
|
||||
|
||||
Console.WriteLine("Starting to send messages");
|
||||
Console.WriteLine("Type a message to echo then press enter.");
|
||||
while (true)
|
||||
{
|
||||
var result = Console.ReadLine();
|
||||
if (string.IsNullOrEmpty(result))
|
||||
{
|
||||
break;
|
||||
}
|
||||
|
||||
await call.RequestStream.WriteAsync(new EchoMessage { Message = result });
|
||||
}
|
||||
|
||||
Console.WriteLine("Disconnecting");
|
||||
await call.RequestStream.CompleteAsync();
|
||||
await readTask;
|
||||
```
|
||||
|
||||
For best performance, and to avoid unnecessary errors in the client and service, try to complete bi-directional streaming calls gracefully. A bi-directional call completes gracefully when the server has finished reading the request stream and the client has finished reading the response stream. The preceding sample call is one example of a bi-directional call that ends gracefully. In the call, the client:
|
||||
|
||||
1. Starts a new bi-directional streaming call by calling `EchoClient.Echo`.
|
||||
2. Creates a background task to read messages from the service using `ResponseStream.ReadAllAsync()`.
|
||||
3. Sends messages to the server with `RequestStream.WriteAsync`.
|
||||
4. Notifies the server it has finished sending messages with `RequestStream.CompleteAsync()`.
|
||||
5. Waits until the background task has read all incoming messages.
|
||||
|
||||
During a bi-directional streaming call, the client and service can send messages to each other at any time. The best client logic for interacting with a bi-directional call varies depending upon the service logic.
|
||||
|
||||
## Links
|
||||
|
||||
* [Documentation](https://docs.microsoft.com/aspnet/core/grpc/client)
|
||||
* [grpc-dotnet GitHub](https://github.com/grpc/grpc-dotnet)
|
||||
BIN
local-nuget/grpc.net.client/2.65.0/grpc.net.client.2.65.0.nupkg
Normal file
BIN
local-nuget/grpc.net.client/2.65.0/grpc.net.client.2.65.0.nupkg
Normal file
Binary file not shown.
@@ -0,0 +1 @@
|
||||
4D70mQNdbGbsHDS4ocHLvFz8qiCtNENtH79wADIWwGS/Nd40yjtNfLTXoYwNLmnbKRLtKzbc06E70JPkI40j/g==
|
||||
@@ -0,0 +1,933 @@
|
||||
<?xml version="1.0"?>
|
||||
<doc>
|
||||
<assembly>
|
||||
<name>Grpc.Net.Client</name>
|
||||
</assembly>
|
||||
<members>
|
||||
<member name="T:Grpc.Net.Client.Configuration.ConfigObject">
|
||||
<summary>
|
||||
Represents a configuration object. Implementations provide strongly typed wrappers over
|
||||
collections of untyped values.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Grpc.Net.Client.Configuration.ConfigObject.Inner">
|
||||
<summary>
|
||||
Gets the underlying configuration values.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="T:Grpc.Net.Client.Configuration.HedgingPolicy">
|
||||
<summary>
|
||||
The hedging policy for outgoing calls. Hedged calls may execute more than
|
||||
once on the server, so only idempotent methods should specify a hedging
|
||||
policy.
|
||||
</summary>
|
||||
<remarks>
|
||||
<para>
|
||||
Represents the <c>HedgingPolicy</c> message in <see href="https://github.com/grpc/grpc-proto/blob/master/grpc/service_config/service_config.proto"/>.
|
||||
</para>
|
||||
</remarks>
|
||||
</member>
|
||||
<member name="M:Grpc.Net.Client.Configuration.HedgingPolicy.#ctor">
|
||||
<summary>
|
||||
Initializes a new instance of the <see cref="T:Grpc.Net.Client.Configuration.HedgingPolicy"/> class.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Grpc.Net.Client.Configuration.HedgingPolicy.MaxAttempts">
|
||||
<summary>
|
||||
Gets or sets the maximum number of call attempts. This value includes the original attempt.
|
||||
The hedging policy will send up to this number of calls.
|
||||
|
||||
This property is required and must be 2 or greater.
|
||||
This value is limited by <see cref="P:Grpc.Net.Client.GrpcChannelOptions.MaxRetryAttempts"/>.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Grpc.Net.Client.Configuration.HedgingPolicy.HedgingDelay">
|
||||
<summary>
|
||||
Gets or sets the hedging delay.
|
||||
The first call will be sent immediately, but the subsequent
|
||||
hedged call will be sent at intervals of the specified delay.
|
||||
Set this to 0 or <c>null</c> to immediately send all hedged calls.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Grpc.Net.Client.Configuration.HedgingPolicy.NonFatalStatusCodes">
|
||||
<summary>
|
||||
Gets a collection of status codes which indicate other hedged calls may still
|
||||
succeed. If a non-fatal status code is returned by the server, hedged
|
||||
calls will continue. Otherwise, outstanding requests will be canceled and
|
||||
the error returned to the client application layer.
|
||||
|
||||
Specifying status codes is optional.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="T:Grpc.Net.Client.Configuration.LoadBalancingConfig">
|
||||
<summary>
|
||||
Base type for load balancer policy configuration.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:Grpc.Net.Client.Configuration.LoadBalancingConfig.PickFirstPolicyName">
|
||||
<summary>
|
||||
<c>pick_first</c> policy name.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:Grpc.Net.Client.Configuration.LoadBalancingConfig.RoundRobinPolicyName">
|
||||
<summary>
|
||||
<c>round_robin</c> policy name.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Grpc.Net.Client.Configuration.LoadBalancingConfig.#ctor(System.String)">
|
||||
<summary>
|
||||
Initializes a new instance of the <see cref="T:Grpc.Net.Client.Configuration.LoadBalancingConfig"/> class.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Grpc.Net.Client.Configuration.LoadBalancingConfig.PolicyName">
|
||||
<summary>
|
||||
Gets the load balancer policy name.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="T:Grpc.Net.Client.Configuration.MethodConfig">
|
||||
<summary>
|
||||
Configuration for a method.
|
||||
The <see cref="P:Grpc.Net.Client.Configuration.MethodConfig.Names"/> collection is used to determine which methods this configuration applies to.
|
||||
</summary>
|
||||
<remarks>
|
||||
<para>
|
||||
Represents the <c>MethodConfig</c> message in <see href="https://github.com/grpc/grpc-proto/blob/master/grpc/service_config/service_config.proto"/>.
|
||||
</para>
|
||||
</remarks>
|
||||
</member>
|
||||
<member name="M:Grpc.Net.Client.Configuration.MethodConfig.#ctor">
|
||||
<summary>
|
||||
Initializes a new instance of the <see cref="T:Grpc.Net.Client.Configuration.MethodConfig"/> class.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Grpc.Net.Client.Configuration.MethodConfig.RetryPolicy">
|
||||
<summary>
|
||||
Gets or sets the retry policy for outgoing calls.
|
||||
A retry policy can't be combined with <see cref="P:Grpc.Net.Client.Configuration.MethodConfig.HedgingPolicy"/>.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Grpc.Net.Client.Configuration.MethodConfig.HedgingPolicy">
|
||||
<summary>
|
||||
Gets or sets the hedging policy for outgoing calls. Hedged calls may execute
|
||||
more than once on the server, so only idempotent methods should specify a hedging
|
||||
policy. A hedging policy can't be combined with <see cref="P:Grpc.Net.Client.Configuration.MethodConfig.RetryPolicy"/>.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Grpc.Net.Client.Configuration.MethodConfig.Names">
|
||||
<summary>
|
||||
Gets a collection of names which determine the calls the method config will apply to.
|
||||
A <see cref="T:Grpc.Net.Client.Configuration.MethodConfig"/> without names won't be used. Each name must be unique
|
||||
across an entire <see cref="T:Grpc.Net.Client.Configuration.ServiceConfig"/>.
|
||||
</summary>
|
||||
<remarks>
|
||||
<para>
|
||||
If a name's <see cref="P:Grpc.Net.Client.Configuration.MethodName.Method"/> property isn't set then the method config is the default
|
||||
for all methods for the specified service.
|
||||
</para>
|
||||
<para>
|
||||
If a name's <see cref="P:Grpc.Net.Client.Configuration.MethodName.Service"/> property isn't set then <see cref="P:Grpc.Net.Client.Configuration.MethodName.Method"/> must also be unset,
|
||||
and the method config is the default for all methods on all services.
|
||||
<see cref="F:Grpc.Net.Client.Configuration.MethodName.Default"/> represents this global default name.
|
||||
</para>
|
||||
<para>
|
||||
When determining which method config to use for a given RPC, the most specific match wins. A method config
|
||||
with a configured <see cref="T:Grpc.Net.Client.Configuration.MethodName"/> that exactly matches a call's method and service will be used
|
||||
instead of a service or global default method config.
|
||||
</para>
|
||||
</remarks>
|
||||
</member>
|
||||
<member name="T:Grpc.Net.Client.Configuration.MethodName">
|
||||
<summary>
|
||||
The name of a method. Used to configure what calls a <see cref="T:Grpc.Net.Client.Configuration.MethodConfig"/> applies to using
|
||||
the <see cref="P:Grpc.Net.Client.Configuration.MethodConfig.Names"/> collection.
|
||||
</summary>
|
||||
<remarks>
|
||||
<para>
|
||||
Represents the <c>Name</c> message in <see href="https://github.com/grpc/grpc-proto/blob/master/grpc/service_config/service_config.proto"/>.
|
||||
</para>
|
||||
<para>
|
||||
If a name's <see cref="P:Grpc.Net.Client.Configuration.MethodName.Method"/> property isn't set then the method config is the default
|
||||
for all methods for the specified service.
|
||||
</para>
|
||||
<para>
|
||||
If a name's <see cref="P:Grpc.Net.Client.Configuration.MethodName.Service"/> property isn't set then <see cref="P:Grpc.Net.Client.Configuration.MethodName.Method"/> must also be unset,
|
||||
and the method config is the default for all methods on all services.
|
||||
<see cref="F:Grpc.Net.Client.Configuration.MethodName.Default"/> represents this global default name.
|
||||
</para>
|
||||
<para>
|
||||
When determining which method config to use for a given RPC, the most specific match wins. A method config
|
||||
with a configured <see cref="T:Grpc.Net.Client.Configuration.MethodName"/> that exactly matches a call's method and service will be used
|
||||
instead of a service or global default method config.
|
||||
</para>
|
||||
</remarks>
|
||||
</member>
|
||||
<member name="F:Grpc.Net.Client.Configuration.MethodName.Default">
|
||||
<summary>
|
||||
A global default name.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Grpc.Net.Client.Configuration.MethodName.#ctor">
|
||||
<summary>
|
||||
Initializes a new instance of the <see cref="T:Grpc.Net.Client.Configuration.MethodName"/> class.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Grpc.Net.Client.Configuration.MethodName.Service">
|
||||
<summary>
|
||||
Gets or sets the service name.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Grpc.Net.Client.Configuration.MethodName.Method">
|
||||
<summary>
|
||||
Gets or sets the method name.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="T:Grpc.Net.Client.Configuration.PickFirstConfig">
|
||||
<summary>
|
||||
Configuration for pick_first load balancer policy.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Grpc.Net.Client.Configuration.PickFirstConfig.#ctor">
|
||||
<summary>
|
||||
Initializes a new instance of the <see cref="T:Grpc.Net.Client.Configuration.PickFirstConfig"/> class.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="T:Grpc.Net.Client.Configuration.RetryPolicy">
|
||||
<summary>
|
||||
The retry policy for outgoing calls.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Grpc.Net.Client.Configuration.RetryPolicy.#ctor">
|
||||
<summary>
|
||||
Initializes a new instance of the <see cref="T:Grpc.Net.Client.Configuration.RetryPolicy"/> class.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Grpc.Net.Client.Configuration.RetryPolicy.MaxAttempts">
|
||||
<summary>
|
||||
Gets or sets the maximum number of call attempts. This value includes the original attempt.
|
||||
This property is required and must be greater than 1.
|
||||
This value is limited by <see cref="P:Grpc.Net.Client.GrpcChannelOptions.MaxRetryAttempts"/>.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Grpc.Net.Client.Configuration.RetryPolicy.InitialBackoff">
|
||||
<summary>
|
||||
Gets or sets the initial backoff.
|
||||
A randomized delay between 0 and the current backoff value will determine when the next
|
||||
retry attempt is made.
|
||||
This property is required and must be greater than zero.
|
||||
<para>
|
||||
The backoff will be multiplied by <see cref="P:Grpc.Net.Client.Configuration.RetryPolicy.BackoffMultiplier"/> after each retry
|
||||
attempt and will increase exponentially when the multiplier is greater than 1.
|
||||
</para>
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Grpc.Net.Client.Configuration.RetryPolicy.MaxBackoff">
|
||||
<summary>
|
||||
Gets or sets the maximum backoff.
|
||||
The maximum backoff places an upper limit on exponential backoff growth.
|
||||
This property is required and must be greater than zero.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Grpc.Net.Client.Configuration.RetryPolicy.BackoffMultiplier">
|
||||
<summary>
|
||||
Gets or sets the backoff multiplier.
|
||||
The backoff will be multiplied by <see cref="P:Grpc.Net.Client.Configuration.RetryPolicy.BackoffMultiplier"/> after each retry
|
||||
attempt and will increase exponentially when the multiplier is greater than 1.
|
||||
This property is required and must be greater than 0.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Grpc.Net.Client.Configuration.RetryPolicy.RetryableStatusCodes">
|
||||
<summary>
|
||||
Gets a collection of status codes which may be retried.
|
||||
At least one status code is required.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="T:Grpc.Net.Client.Configuration.RetryThrottlingPolicy">
|
||||
<summary>
|
||||
The retry throttling policy for a server.
|
||||
<para>
|
||||
For more information about configuring throttling, see <see href="https://github.com/grpc/proposal/blob/master/A6-client-retries.md#throttling-retry-attempts-and-hedged-rpcs"/>.
|
||||
</para>
|
||||
</summary>
|
||||
<remarks>
|
||||
<para>
|
||||
Represents the <c>RetryThrottlingPolicy</c> message in <see href="https://github.com/grpc/grpc-proto/blob/master/grpc/service_config/service_config.proto"/>.
|
||||
</para>
|
||||
</remarks>
|
||||
</member>
|
||||
<member name="M:Grpc.Net.Client.Configuration.RetryThrottlingPolicy.#ctor">
|
||||
<summary>
|
||||
Initializes a new instance of the <see cref="T:Grpc.Net.Client.Configuration.RetryThrottlingPolicy"/> class.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Grpc.Net.Client.Configuration.RetryThrottlingPolicy.MaxTokens">
|
||||
<summary>
|
||||
Gets or sets the maximum number of tokens.
|
||||
The number of tokens starts at <see cref="P:Grpc.Net.Client.Configuration.RetryThrottlingPolicy.MaxTokens"/> and the token count will
|
||||
always be between 0 and <see cref="P:Grpc.Net.Client.Configuration.RetryThrottlingPolicy.MaxTokens"/>.
|
||||
This property is required and must be greater than zero.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Grpc.Net.Client.Configuration.RetryThrottlingPolicy.TokenRatio">
|
||||
<summary>
|
||||
Gets or sets the amount of tokens to add on each successful call. Typically this will
|
||||
be some number between 0 and 1, e.g., 0.1.
|
||||
This property is required and must be greater than zero. Up to 3 decimal places are supported.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="T:Grpc.Net.Client.Configuration.RoundRobinConfig">
|
||||
<summary>
|
||||
Configuration for pick_first load balancer policy.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Grpc.Net.Client.Configuration.RoundRobinConfig.#ctor">
|
||||
<summary>
|
||||
Initializes a new instance of the <see cref="T:Grpc.Net.Client.Configuration.RoundRobinConfig"/> class.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="T:Grpc.Net.Client.Configuration.ServiceConfig">
|
||||
<summary>
|
||||
A <see cref="T:Grpc.Net.Client.Configuration.ServiceConfig"/> represents information about a service.
|
||||
</summary>
|
||||
<remarks>
|
||||
<para>
|
||||
Represents the <c>ServiceConfig</c> message in <see href="https://github.com/grpc/grpc-proto/blob/master/grpc/service_config/service_config.proto"/>.
|
||||
</para>
|
||||
</remarks>
|
||||
</member>
|
||||
<member name="M:Grpc.Net.Client.Configuration.ServiceConfig.#ctor">
|
||||
<summary>
|
||||
Initializes a new instance of the <see cref="T:Grpc.Net.Client.Configuration.ServiceConfig"/> class.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Grpc.Net.Client.Configuration.ServiceConfig.LoadBalancingConfigs">
|
||||
<summary>
|
||||
Gets a collection of <see cref="T:Grpc.Net.Client.Configuration.LoadBalancingConfig"/> instances. The client will iterate
|
||||
through the configured policies in order and use the first policy that is supported.
|
||||
If none are supported by the client then a configuration error is thrown.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Grpc.Net.Client.Configuration.ServiceConfig.MethodConfigs">
|
||||
<summary>
|
||||
Gets a collection of <see cref="T:Grpc.Net.Client.Configuration.MethodConfig"/> instances. This collection is used to specify
|
||||
configuration on a per-method basis. <see cref="P:Grpc.Net.Client.Configuration.MethodConfig.Names"/> determines which calls
|
||||
a method config applies to.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Grpc.Net.Client.Configuration.ServiceConfig.RetryThrottling">
|
||||
<summary>
|
||||
Gets or sets the retry throttling policy.
|
||||
If a <see cref="T:Grpc.Net.Client.Configuration.RetryThrottlingPolicy"/> is provided, gRPC will automatically throttle
|
||||
retry attempts and hedged RPCs when the client's ratio of failures to
|
||||
successes exceeds a threshold.
|
||||
<para>
|
||||
For more information about configuring throttling, see <see href="https://github.com/grpc/proposal/blob/master/A6-client-retries.md#throttling-retry-attempts-and-hedged-rpcs"/>.
|
||||
</para>
|
||||
</summary>
|
||||
</member>
|
||||
<member name="T:Grpc.Net.Client.GrpcChannel">
|
||||
<summary>
|
||||
Represents a gRPC channel. Channels are an abstraction of long-lived connections to remote servers.
|
||||
Client objects can reuse the same channel. Creating a channel is an expensive operation compared to invoking
|
||||
a remote call so in general you should reuse a single channel for as many calls as possible.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Grpc.Net.Client.GrpcChannel.CreateCallInvoker">
|
||||
<summary>
|
||||
Create a new <see cref="T:Grpc.Core.CallInvoker"/> for the channel.
|
||||
</summary>
|
||||
<returns>A new <see cref="T:Grpc.Core.CallInvoker"/>.</returns>
|
||||
</member>
|
||||
<member name="M:Grpc.Net.Client.GrpcChannel.ForAddress(System.String)">
|
||||
<summary>
|
||||
Creates a <see cref="T:Grpc.Net.Client.GrpcChannel"/> for the specified address.
|
||||
</summary>
|
||||
<param name="address">The address the channel will use.</param>
|
||||
<returns>A new instance of <see cref="T:Grpc.Net.Client.GrpcChannel"/>.</returns>
|
||||
</member>
|
||||
<member name="M:Grpc.Net.Client.GrpcChannel.ForAddress(System.String,Grpc.Net.Client.GrpcChannelOptions)">
|
||||
<summary>
|
||||
Creates a <see cref="T:Grpc.Net.Client.GrpcChannel"/> for the specified address and configuration options.
|
||||
</summary>
|
||||
<param name="address">The address the channel will use.</param>
|
||||
<param name="channelOptions">The channel configuration options.</param>
|
||||
<returns>A new instance of <see cref="T:Grpc.Net.Client.GrpcChannel"/>.</returns>
|
||||
</member>
|
||||
<member name="M:Grpc.Net.Client.GrpcChannel.ForAddress(System.Uri)">
|
||||
<summary>
|
||||
Creates a <see cref="T:Grpc.Net.Client.GrpcChannel"/> for the specified address.
|
||||
</summary>
|
||||
<param name="address">The address the channel will use.</param>
|
||||
<returns>A new instance of <see cref="T:Grpc.Net.Client.GrpcChannel"/>.</returns>
|
||||
</member>
|
||||
<member name="M:Grpc.Net.Client.GrpcChannel.ForAddress(System.Uri,Grpc.Net.Client.GrpcChannelOptions)">
|
||||
<summary>
|
||||
Creates a <see cref="T:Grpc.Net.Client.GrpcChannel"/> for the specified address and configuration options.
|
||||
</summary>
|
||||
<param name="address">The address the channel will use.</param>
|
||||
<param name="channelOptions">The channel configuration options.</param>
|
||||
<returns>A new instance of <see cref="T:Grpc.Net.Client.GrpcChannel"/>.</returns>
|
||||
</member>
|
||||
<member name="M:Grpc.Net.Client.GrpcChannel.Dispose">
|
||||
<summary>
|
||||
Releases the resources used by the <see cref="T:Grpc.Net.Client.GrpcChannel"/> class.
|
||||
Clients created with the channel can't be used after the channel is disposed.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="T:Grpc.Net.Client.GrpcChannelOptions">
|
||||
<summary>
|
||||
An options class for configuring a <see cref="T:Grpc.Net.Client.GrpcChannel"/>.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Grpc.Net.Client.GrpcChannelOptions.Credentials">
|
||||
<summary>
|
||||
Gets or sets the credentials for the channel. This setting is used to set <see cref="T:Grpc.Core.ChannelCredentials"/> for
|
||||
a channel. Connection transport layer security (TLS) is determined by the address used to create the channel.
|
||||
</summary>
|
||||
<remarks>
|
||||
<para>
|
||||
The channel credentials you use must match the address TLS setting. Use <see cref="P:Grpc.Core.ChannelCredentials.Insecure"/>
|
||||
for an "http" address and <see cref="P:Grpc.Core.ChannelCredentials.SecureSsl"/> for "https".
|
||||
</para>
|
||||
<para>
|
||||
The underlying <see cref="T:System.Net.Http.HttpClient"/> used by the channel automatically loads root certificates
|
||||
from the operating system certificate store.
|
||||
Client certificates should be configured on HttpClient. See <see href="https://aka.ms/aspnet/grpc/certauth"/> for details.
|
||||
</para>
|
||||
</remarks>
|
||||
</member>
|
||||
<member name="P:Grpc.Net.Client.GrpcChannelOptions.MaxSendMessageSize">
|
||||
<summary>
|
||||
Gets or sets the maximum message size in bytes that can be sent from the client. Attempting to send a message
|
||||
that exceeds the configured maximum message size results in an exception.
|
||||
<para>
|
||||
A <c>null</c> value removes the maximum message size limit. Defaults to <c>null</c>.
|
||||
</para>
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Grpc.Net.Client.GrpcChannelOptions.MaxReceiveMessageSize">
|
||||
<summary>
|
||||
Gets or sets the maximum message size in bytes that can be received by the client. If the client receives a
|
||||
message that exceeds this limit, it throws an exception.
|
||||
<para>
|
||||
A <c>null</c> value removes the maximum message size limit. Defaults to 4,194,304 (4 MB).
|
||||
</para>
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Grpc.Net.Client.GrpcChannelOptions.MaxRetryAttempts">
|
||||
<summary>
|
||||
Gets or sets the maximum retry attempts. This value limits any retry and hedging attempt values specified in
|
||||
the service config.
|
||||
<para>
|
||||
Setting this value alone doesn't enable retries. Retries are enabled in the service config, which can be done
|
||||
using <see cref="P:Grpc.Net.Client.GrpcChannelOptions.ServiceConfig"/>.
|
||||
</para>
|
||||
<para>
|
||||
A <c>null</c> value removes the maximum retry attempts limit. Defaults to 5.
|
||||
</para>
|
||||
<para>
|
||||
Note: Experimental API that can change or be removed without any prior notice.
|
||||
</para>
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Grpc.Net.Client.GrpcChannelOptions.MaxRetryBufferSize">
|
||||
<summary>
|
||||
Gets or sets the maximum buffer size in bytes that can be used to store sent messages when retrying
|
||||
or hedging calls. If the buffer limit is exceeded, then no more retry attempts are made and all
|
||||
hedging calls but one will be canceled. This limit is applied across all calls made using the channel.
|
||||
<para>
|
||||
Setting this value alone doesn't enable retries. Retries are enabled in the service config, which can be done
|
||||
using <see cref="P:Grpc.Net.Client.GrpcChannelOptions.ServiceConfig"/>.
|
||||
</para>
|
||||
<para>
|
||||
A <c>null</c> value removes the maximum retry buffer size limit. Defaults to 16,777,216 (16 MB).
|
||||
</para>
|
||||
<para>
|
||||
Note: Experimental API that can change or be removed without any prior notice.
|
||||
</para>
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Grpc.Net.Client.GrpcChannelOptions.MaxRetryBufferPerCallSize">
|
||||
<summary>
|
||||
Gets or sets the maximum buffer size in bytes that can be used to store sent messages when retrying
|
||||
or hedging calls. If the buffer limit is exceeded, then no more retry attempts are made and all
|
||||
hedging calls but one will be canceled. This limit is applied to one call.
|
||||
<para>
|
||||
Setting this value alone doesn't enable retries. Retries are enabled in the service config, which can be done
|
||||
using <see cref="P:Grpc.Net.Client.GrpcChannelOptions.ServiceConfig"/>.
|
||||
</para>
|
||||
<para>
|
||||
A <c>null</c> value removes the maximum retry buffer size limit per call. Defaults to 1,048,576 (1 MB).
|
||||
</para>
|
||||
<para>
|
||||
Note: Experimental API that can change or be removed without any prior notice.
|
||||
</para>
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Grpc.Net.Client.GrpcChannelOptions.CompressionProviders">
|
||||
<summary>
|
||||
Gets or sets a collection of compression providers.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Grpc.Net.Client.GrpcChannelOptions.LoggerFactory">
|
||||
<summary>
|
||||
Gets or sets the logger factory used by the channel. If no value is specified then the channel
|
||||
attempts to resolve an <see cref="T:Microsoft.Extensions.Logging.ILoggerFactory"/> from the <see cref="P:Grpc.Net.Client.GrpcChannelOptions.ServiceProvider"/>.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Grpc.Net.Client.GrpcChannelOptions.HttpClient">
|
||||
<summary>
|
||||
Gets or sets the <see cref="T:System.Net.Http.HttpClient"/> used by the channel to make HTTP calls.
|
||||
</summary>
|
||||
<remarks>
|
||||
<para>
|
||||
By default a <see cref="T:System.Net.Http.HttpClient"/> specified here will not be disposed with the channel.
|
||||
To dispose the <see cref="T:System.Net.Http.HttpClient"/> with the channel you must set <see cref="P:Grpc.Net.Client.GrpcChannelOptions.DisposeHttpClient"/>
|
||||
to <c>true</c>.
|
||||
</para>
|
||||
<para>
|
||||
Only one HTTP caller can be specified for a channel. An error will be thrown if this is configured
|
||||
together with <see cref="P:Grpc.Net.Client.GrpcChannelOptions.HttpHandler"/>.
|
||||
</para>
|
||||
</remarks>
|
||||
</member>
|
||||
<member name="P:Grpc.Net.Client.GrpcChannelOptions.HttpHandler">
|
||||
<summary>
|
||||
Gets or sets the <see cref="T:System.Net.Http.HttpMessageHandler"/> used by the channel to make HTTP calls.
|
||||
</summary>
|
||||
<remarks>
|
||||
<para>
|
||||
By default a <see cref="T:System.Net.Http.HttpMessageHandler"/> specified here will not be disposed with the channel.
|
||||
To dispose the <see cref="T:System.Net.Http.HttpMessageHandler"/> with the channel you must set <see cref="P:Grpc.Net.Client.GrpcChannelOptions.DisposeHttpClient"/>
|
||||
to <c>true</c>.
|
||||
</para>
|
||||
<para>
|
||||
Only one HTTP caller can be specified for a channel. An error will be thrown if this is configured
|
||||
together with <see cref="P:Grpc.Net.Client.GrpcChannelOptions.HttpClient"/>.
|
||||
</para>
|
||||
</remarks>
|
||||
</member>
|
||||
<member name="P:Grpc.Net.Client.GrpcChannelOptions.DisposeHttpClient">
|
||||
<summary>
|
||||
Gets or sets a value indicating whether the underlying <see cref="T:System.Net.Http.HttpClient"/> or
|
||||
<see cref="T:System.Net.Http.HttpMessageHandler"/> should be disposed when the <see cref="T:Grpc.Net.Client.GrpcChannel"/> instance is disposed.
|
||||
The default value is <c>false</c>.
|
||||
</summary>
|
||||
<remarks>
|
||||
This setting is used when a <see cref="P:Grpc.Net.Client.GrpcChannelOptions.HttpClient"/> or <see cref="P:Grpc.Net.Client.GrpcChannelOptions.HttpHandler"/> value is specified.
|
||||
If they are not specified then the channel will create an internal HTTP caller that is always disposed
|
||||
when the channel is disposed.
|
||||
</remarks>
|
||||
</member>
|
||||
<member name="P:Grpc.Net.Client.GrpcChannelOptions.ThrowOperationCanceledOnCancellation">
|
||||
<summary>
|
||||
Gets or sets a value indicating whether clients will throw <see cref="T:System.OperationCanceledException"/> for a call when its
|
||||
<see cref="P:Grpc.Core.CallOptions.CancellationToken"/> is triggered or its <see cref="P:Grpc.Core.CallOptions.Deadline"/> is exceeded.
|
||||
The default value is <c>false</c>.
|
||||
<para>
|
||||
Note: Experimental API that can change or be removed without any prior notice.
|
||||
</para>
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Grpc.Net.Client.GrpcChannelOptions.UnsafeUseInsecureChannelCallCredentials">
|
||||
<summary>
|
||||
Gets or sets a value indicating whether a gRPC call's <see cref="T:Grpc.Core.CallCredentials"/> are used by an insecure channel.
|
||||
The default value is <c>false</c>.
|
||||
<para>
|
||||
Note: Experimental API that can change or be removed without any prior notice.
|
||||
</para>
|
||||
</summary>
|
||||
<remarks>
|
||||
<para>
|
||||
The default value for this property is <c>false</c>, which causes an insecure channel to ignore a gRPC call's <see cref="T:Grpc.Core.CallCredentials"/>.
|
||||
Sending authentication headers over an insecure connection has security implications and shouldn't be done in production environments.
|
||||
</para>
|
||||
<para>
|
||||
If this property is set to <c>true</c>, call credentials are always used by a channel.
|
||||
</para>
|
||||
</remarks>
|
||||
</member>
|
||||
<member name="P:Grpc.Net.Client.GrpcChannelOptions.ServiceConfig">
|
||||
<summary>
|
||||
Gets or sets the service config for a gRPC channel. A service config allows service owners to publish parameters
|
||||
to be automatically used by all clients of their service. A service config can also be specified by a client
|
||||
using this property.
|
||||
<para>
|
||||
Note: Experimental API that can change or be removed without any prior notice.
|
||||
</para>
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Grpc.Net.Client.GrpcChannelOptions.ServiceProvider">
|
||||
<summary>
|
||||
Gets or sets the <see cref="T:System.IServiceProvider"/> the channel uses to resolve types.
|
||||
<para>
|
||||
Note: Experimental API that can change or be removed without any prior notice.
|
||||
</para>
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Grpc.Net.Client.GrpcChannelOptions.#ctor">
|
||||
<summary>
|
||||
Initializes a new instance of the <see cref="T:Grpc.Net.Client.GrpcChannelOptions"/> class.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Grpc.Net.Client.Internal.ClientStreamWriterBase`1.IsWriteInProgressUnsynchronized">
|
||||
<summary>
|
||||
A value indicating whether there is an async write already in progress.
|
||||
Should only check this property when holding the write lock.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Grpc.Net.Client.Internal.GrpcCall`2.Cleanup(Grpc.Core.Status)">
|
||||
<summary>
|
||||
Clean up can be called by:
|
||||
1. The user. AsyncUnaryCall.Dispose et al will call this on Dispose
|
||||
2. <see cref="M:Grpc.Net.Client.Internal.GrpcCall.ValidateHeaders(System.Net.Http.HttpResponseMessage,Grpc.Core.Metadata@)"/> will call dispose if errors fail validation
|
||||
3. <see cref="M:Grpc.Net.Client.Internal.GrpcCall`2.FinishResponseAndCleanUp(Grpc.Core.Status)"/> will call dispose
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Grpc.Net.Client.Internal.GrpcCall`2.ResponseStreamEnded(Grpc.Core.Status,System.Boolean)">
|
||||
<summary>
|
||||
Used by response stream reader to report it is finished.
|
||||
</summary>
|
||||
<param name="status">The completed response status code.</param>
|
||||
<param name="finishedGracefully">true when the end of the response stream was read, otherwise false.</param>
|
||||
</member>
|
||||
<member name="M:Grpc.Net.Client.Internal.GrpcCall`2.ResolveException(System.String,System.Exception,System.Nullable{Grpc.Core.Status}@,System.Exception@)">
|
||||
<summary>
|
||||
Resolve the specified exception to an end-user exception that will be thrown from the client.
|
||||
The resolved exception is normally a RpcException. Returns true when the resolved exception is changed.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Grpc.Net.Client.Internal.GrpcCallSerializationContext.GetWrittenPayload">
|
||||
<summary>
|
||||
Obtains the payload from this operation. Error is thrown if complete hasn't been called.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="T:Grpc.Net.Client.Internal.GrpcMethodInfo">
|
||||
<summary>
|
||||
Cached log scope and URI for a gRPC <see cref="T:Grpc.Core.IMethod"/>.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Grpc.Net.Client.Internal.GrpcProtocolConstants.GetDebugEnumerator(Grpc.Core.ChannelBase,Grpc.Core.IMethod,System.Object)">
|
||||
<summary>
|
||||
Gets key value pairs used by debugging. These are provided as an enumerator instead of a dictionary
|
||||
because it's one method to implement an enumerator on gRPC calls compared to a dozen members for a dictionary.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Grpc.Net.Client.Internal.GrpcProtocolHelpers.ResolveRpcExceptionStatusCode(System.Exception)">
|
||||
<summary>
|
||||
Resolve the exception from HttpClient to a gRPC status code.
|
||||
<param name="ex">The <see cref="T:System.Exception"/> to resolve a <see cref="T:Grpc.Core.StatusCode"/> from.</param>
|
||||
</summary>
|
||||
</member>
|
||||
<member name="T:Grpc.Net.Client.Internal.Http.WinHttpUnaryContent`2">
|
||||
<summary>
|
||||
WinHttp doesn't support streaming request data so a length needs to be specified.
|
||||
This HttpContent pre-serializes the payload so it has a length available.
|
||||
The payload is then written directly to the request using specialized context
|
||||
and serializer method.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="T:Grpc.Net.Client.Internal.HttpClientCallInvoker">
|
||||
<summary>
|
||||
A client-side RPC invocation using HttpClient.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Grpc.Net.Client.Internal.HttpClientCallInvoker.AsyncClientStreamingCall``2(Grpc.Core.Method{``0,``1},System.String,Grpc.Core.CallOptions)">
|
||||
<summary>
|
||||
Invokes a client streaming call asynchronously.
|
||||
In client streaming scenario, client sends a stream of requests and server responds with a single response.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Grpc.Net.Client.Internal.HttpClientCallInvoker.AsyncDuplexStreamingCall``2(Grpc.Core.Method{``0,``1},System.String,Grpc.Core.CallOptions)">
|
||||
<summary>
|
||||
Invokes a duplex streaming call asynchronously.
|
||||
In duplex streaming scenario, client sends a stream of requests and server responds with a stream of responses.
|
||||
The response stream is completely independent and both side can be sending messages at the same time.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Grpc.Net.Client.Internal.HttpClientCallInvoker.AsyncServerStreamingCall``2(Grpc.Core.Method{``0,``1},System.String,Grpc.Core.CallOptions,``0)">
|
||||
<summary>
|
||||
Invokes a server streaming call asynchronously.
|
||||
In server streaming scenario, client sends on request and server responds with a stream of responses.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Grpc.Net.Client.Internal.HttpClientCallInvoker.AsyncUnaryCall``2(Grpc.Core.Method{``0,``1},System.String,Grpc.Core.CallOptions,``0)">
|
||||
<summary>
|
||||
Invokes a simple remote call asynchronously.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Grpc.Net.Client.Internal.HttpClientCallInvoker.BlockingUnaryCall``2(Grpc.Core.Method{``0,``1},System.String,Grpc.Core.CallOptions,``0)">
|
||||
<summary>
|
||||
Invokes a simple remote call in a blocking fashion.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Grpc.Net.Client.Internal.HttpContentClientStreamReader`2.IsMoveNextInProgressUnsynchronized">
|
||||
<summary>
|
||||
A value indicating whether there is an async move next already in progress.
|
||||
Should only check this property when holding the move next lock.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="T:Grpc.Net.Client.Internal.Native">
|
||||
<summary>
|
||||
Types for calling RtlGetVersion. See https://www.pinvoke.net/default.aspx/ntdll/RtlGetVersion.html
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:Grpc.Net.Client.Internal.Native.NTSTATUS.STATUS_SUCCESS">
|
||||
<summary>
|
||||
The operation completed successfully.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Grpc.Net.Client.Internal.TaskExtensions.ObserveException(System.Threading.Tasks.Task)">
|
||||
<summary>
|
||||
Observes and ignores a potential exception on a given Task.
|
||||
If a Task fails and throws an exception which is never observed, it will be caught by the .NET finalizer thread.
|
||||
This function awaits the given task and if the exception is thrown, it observes this exception and simply ignores it.
|
||||
This will prevent the escalation of this exception to the .NET finalizer thread.
|
||||
</summary>
|
||||
<param name="task">The task to be ignored.</param>
|
||||
</member>
|
||||
<member name="M:Grpc.Net.Client.Internal.UserAgentGenerator.GetUserAgentString">
|
||||
<summary>
|
||||
Generates a user agent string to be transported in headers.
|
||||
<example>
|
||||
grpc-dotnet/2.41.0-dev (.NET 6.0.0-preview.7.21377.19; CLR 6.0.0; net6.0; osx; x64)
|
||||
grpc-dotnet/2.41.0-dev (Mono 6.12.0.140; CLR 4.0.30319; netstandard2.0; osx; x64)
|
||||
grpc-dotnet/2.41.0-dev (.NET 6.0.0-rc.1.21380.1; CLR 6.0.0; net6.0; linux; arm64)
|
||||
grpc-dotnet/2.41.0-dev (.NET 5.0.8; CLR 5.0.8; net5.0; linux; arm64)
|
||||
grpc-dotnet/2.41.0-dev (.NET Core; CLR 3.1.4; netstandard2.1; linux; arm64)
|
||||
grpc-dotnet/2.41.0-dev (.NET Framework; CLR 4.0.30319.42000; netstandard2.0; windows; x86)
|
||||
grpc-dotnet/2.41.0-dev (.NET 6.0.0-rc.1.21380.1; CLR 6.0.0; net6.0; windows; x64)
|
||||
</example>
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Grpc.Shared.ObjectDisposedThrowHelper.ThrowIf(System.Boolean,System.Object)">
|
||||
<summary>Throws an <see cref="T:System.ObjectDisposedException"/> if the specified <paramref name="condition"/> is <see langword="true"/>.</summary>
|
||||
<param name="condition">The condition to evaluate.</param>
|
||||
<param name="instance">The object whose type's full name should be included in any resulting <see cref="T:System.ObjectDisposedException"/>.</param>
|
||||
<exception cref="T:System.ObjectDisposedException">The <paramref name="condition"/> is <see langword="true"/>.</exception>
|
||||
</member>
|
||||
<member name="M:Grpc.Shared.ObjectDisposedThrowHelper.ThrowIf(System.Boolean,System.Type)">
|
||||
<summary>Throws an <see cref="T:System.ObjectDisposedException"/> if the specified <paramref name="condition"/> is <see langword="true"/>.</summary>
|
||||
<param name="condition">The condition to evaluate.</param>
|
||||
<param name="type">The type whose full name should be included in any resulting <see cref="T:System.ObjectDisposedException"/>.</param>
|
||||
<exception cref="T:System.ObjectDisposedException">The <paramref name="condition"/> is <see langword="true"/>.</exception>
|
||||
</member>
|
||||
<member name="M:Grpc.Shared.ArgumentNullThrowHelper.ThrowIfNull(System.Object,System.String)">
|
||||
<summary>Throws an <see cref="T:System.ArgumentNullException"/> if <paramref name="argument"/> is null.</summary>
|
||||
<param name="argument">The reference type argument to validate as non-null.</param>
|
||||
<param name="paramName">The name of the parameter with which <paramref name="argument"/> corresponds.</param>
|
||||
</member>
|
||||
<member name="T:System.Buffers.ArrayBufferWriter`1">
|
||||
<summary>
|
||||
Represents a heap-based, array-backed output sink into which <typeparam name="T"/> data can be written.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:System.Buffers.ArrayBufferWriter`1.#ctor">
|
||||
<summary>
|
||||
Creates an instance of an <see cref="T:System.Buffers.ArrayBufferWriter`1"/>, in which data can be written to,
|
||||
with the default initial capacity.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:System.Buffers.ArrayBufferWriter`1.#ctor(System.Int32)">
|
||||
<summary>
|
||||
Creates an instance of an <see cref="T:System.Buffers.ArrayBufferWriter`1"/>, in which data can be written to,
|
||||
with an initial capacity specified.
|
||||
</summary>
|
||||
<param name="initialCapacity">The minimum capacity with which to initialize the underlying buffer.</param>
|
||||
<exception cref="T:System.ArgumentException">
|
||||
Thrown when <paramref name="initialCapacity"/> is not positive (i.e. less than or equal to 0).
|
||||
</exception>
|
||||
</member>
|
||||
<member name="P:System.Buffers.ArrayBufferWriter`1.WrittenMemory">
|
||||
<summary>
|
||||
Returns the data written to the underlying buffer so far, as a <see cref="T:System.ReadOnlyMemory`1"/>.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:System.Buffers.ArrayBufferWriter`1.WrittenSpan">
|
||||
<summary>
|
||||
Returns the data written to the underlying buffer so far, as a <see cref="T:System.ReadOnlySpan`1"/>.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:System.Buffers.ArrayBufferWriter`1.WrittenCount">
|
||||
<summary>
|
||||
Returns the amount of data written to the underlying buffer so far.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:System.Buffers.ArrayBufferWriter`1.Capacity">
|
||||
<summary>
|
||||
Returns the total amount of space within the underlying buffer.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:System.Buffers.ArrayBufferWriter`1.FreeCapacity">
|
||||
<summary>
|
||||
Returns the amount of space available that can still be written into without forcing the underlying buffer to grow.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:System.Buffers.ArrayBufferWriter`1.Clear">
|
||||
<summary>
|
||||
Clears the data written to the underlying buffer.
|
||||
</summary>
|
||||
<remarks>
|
||||
You must clear the <see cref="T:System.Buffers.ArrayBufferWriter`1"/> before trying to re-use it.
|
||||
</remarks>
|
||||
</member>
|
||||
<member name="M:System.Buffers.ArrayBufferWriter`1.Advance(System.Int32)">
|
||||
<summary>
|
||||
Notifies <see cref="T:System.Buffers.IBufferWriter`1"/> that <paramref name="count"/> amount of data was written to the output <see cref="T:System.Span`1"/>/<see cref="T:System.Memory`1"/>
|
||||
</summary>
|
||||
<exception cref="T:System.ArgumentException">
|
||||
Thrown when <paramref name="count"/> is negative.
|
||||
</exception>
|
||||
<exception cref="T:System.InvalidOperationException">
|
||||
Thrown when attempting to advance past the end of the underlying buffer.
|
||||
</exception>
|
||||
<remarks>
|
||||
You must request a new buffer after calling Advance to continue writing more data and cannot write to a previously acquired buffer.
|
||||
</remarks>
|
||||
</member>
|
||||
<member name="M:System.Buffers.ArrayBufferWriter`1.GetMemory(System.Int32)">
|
||||
<summary>
|
||||
Returns a <see cref="T:System.Memory`1"/> to write to that is at least the requested length (specified by <paramref name="sizeHint"/>).
|
||||
If no <paramref name="sizeHint"/> is provided (or it's equal to <code>0</code>), some non-empty buffer is returned.
|
||||
</summary>
|
||||
<exception cref="T:System.ArgumentException">
|
||||
Thrown when <paramref name="sizeHint"/> is negative.
|
||||
</exception>
|
||||
<remarks>
|
||||
This will never return an empty <see cref="T:System.Memory`1"/>.
|
||||
</remarks>
|
||||
<remarks>
|
||||
There is no guarantee that successive calls will return the same buffer or the same-sized buffer.
|
||||
</remarks>
|
||||
<remarks>
|
||||
You must request a new buffer after calling Advance to continue writing more data and cannot write to a previously acquired buffer.
|
||||
</remarks>
|
||||
</member>
|
||||
<member name="M:System.Buffers.ArrayBufferWriter`1.GetSpan(System.Int32)">
|
||||
<summary>
|
||||
Returns a <see cref="T:System.Span`1"/> to write to that is at least the requested length (specified by <paramref name="sizeHint"/>).
|
||||
If no <paramref name="sizeHint"/> is provided (or it's equal to <code>0</code>), some non-empty buffer is returned.
|
||||
</summary>
|
||||
<exception cref="T:System.ArgumentException">
|
||||
Thrown when <paramref name="sizeHint"/> is negative.
|
||||
</exception>
|
||||
<remarks>
|
||||
This will never return an empty <see cref="T:System.Span`1"/>.
|
||||
</remarks>
|
||||
<remarks>
|
||||
There is no guarantee that successive calls will return the same buffer or the same-sized buffer.
|
||||
</remarks>
|
||||
<remarks>
|
||||
You must request a new buffer after calling Advance to continue writing more data and cannot write to a previously acquired buffer.
|
||||
</remarks>
|
||||
</member>
|
||||
<member name="T:System.Diagnostics.CodeAnalysis.AllowNullAttribute">
|
||||
<summary>Specifies that null is allowed as an input even if the corresponding type disallows it.</summary>
|
||||
</member>
|
||||
<member name="T:System.Diagnostics.CodeAnalysis.DisallowNullAttribute">
|
||||
<summary>Specifies that null is disallowed as an input even if the corresponding type allows it.</summary>
|
||||
</member>
|
||||
<member name="T:System.Diagnostics.CodeAnalysis.MaybeNullAttribute">
|
||||
<summary>Specifies that an output may be null even if the corresponding type disallows it.</summary>
|
||||
</member>
|
||||
<member name="T:System.Diagnostics.CodeAnalysis.NotNullAttribute">
|
||||
<summary>Specifies that an output will not be null even if the corresponding type allows it. Specifies that an input argument was not null when the call returns.</summary>
|
||||
</member>
|
||||
<member name="T:System.Diagnostics.CodeAnalysis.MaybeNullWhenAttribute">
|
||||
<summary>Specifies that when a method returns <see cref="P:System.Diagnostics.CodeAnalysis.MaybeNullWhenAttribute.ReturnValue"/>, the parameter may be null even if the corresponding type disallows it.</summary>
|
||||
</member>
|
||||
<member name="M:System.Diagnostics.CodeAnalysis.MaybeNullWhenAttribute.#ctor(System.Boolean)">
|
||||
<summary>Initializes the attribute with the specified return value condition.</summary>
|
||||
<param name="returnValue">
|
||||
The return value condition. If the method returns this value, the associated parameter may be null.
|
||||
</param>
|
||||
</member>
|
||||
<member name="P:System.Diagnostics.CodeAnalysis.MaybeNullWhenAttribute.ReturnValue">
|
||||
<summary>Gets the return value condition.</summary>
|
||||
</member>
|
||||
<member name="T:System.Diagnostics.CodeAnalysis.NotNullWhenAttribute">
|
||||
<summary>Specifies that when a method returns <see cref="P:System.Diagnostics.CodeAnalysis.NotNullWhenAttribute.ReturnValue"/>, the parameter will not be null even if the corresponding type allows it.</summary>
|
||||
</member>
|
||||
<member name="M:System.Diagnostics.CodeAnalysis.NotNullWhenAttribute.#ctor(System.Boolean)">
|
||||
<summary>Initializes the attribute with the specified return value condition.</summary>
|
||||
<param name="returnValue">
|
||||
The return value condition. If the method returns this value, the associated parameter will not be null.
|
||||
</param>
|
||||
</member>
|
||||
<member name="P:System.Diagnostics.CodeAnalysis.NotNullWhenAttribute.ReturnValue">
|
||||
<summary>Gets the return value condition.</summary>
|
||||
</member>
|
||||
<member name="T:System.Diagnostics.CodeAnalysis.NotNullIfNotNullAttribute">
|
||||
<summary>Specifies that the output will be non-null if the named parameter is non-null.</summary>
|
||||
</member>
|
||||
<member name="M:System.Diagnostics.CodeAnalysis.NotNullIfNotNullAttribute.#ctor(System.String)">
|
||||
<summary>Initializes the attribute with the associated parameter name.</summary>
|
||||
<param name="parameterName">
|
||||
The associated parameter name. The output will be non-null if the argument to the parameter specified is non-null.
|
||||
</param>
|
||||
</member>
|
||||
<member name="P:System.Diagnostics.CodeAnalysis.NotNullIfNotNullAttribute.ParameterName">
|
||||
<summary>Gets the associated parameter name.</summary>
|
||||
</member>
|
||||
<member name="T:System.Diagnostics.CodeAnalysis.DoesNotReturnAttribute">
|
||||
<summary>Applied to a method that will never return under any circumstance.</summary>
|
||||
</member>
|
||||
<member name="T:System.Diagnostics.CodeAnalysis.DoesNotReturnIfAttribute">
|
||||
<summary>Specifies that the method will not return if the associated Boolean parameter is passed the specified value.</summary>
|
||||
</member>
|
||||
<member name="M:System.Diagnostics.CodeAnalysis.DoesNotReturnIfAttribute.#ctor(System.Boolean)">
|
||||
<summary>Initializes the attribute with the specified parameter value.</summary>
|
||||
<param name="parameterValue">
|
||||
The condition parameter value. Code after the method will be considered unreachable by diagnostics if the argument to
|
||||
the associated parameter matches this value.
|
||||
</param>
|
||||
</member>
|
||||
<member name="P:System.Diagnostics.CodeAnalysis.DoesNotReturnIfAttribute.ParameterValue">
|
||||
<summary>Gets the condition parameter value.</summary>
|
||||
</member>
|
||||
<member name="T:System.Diagnostics.CodeAnalysis.MemberNotNullAttribute">
|
||||
<summary>Specifies that the method or property will ensure that the listed field and property members have not-null values.</summary>
|
||||
</member>
|
||||
<member name="M:System.Diagnostics.CodeAnalysis.MemberNotNullAttribute.#ctor(System.String)">
|
||||
<summary>Initializes the attribute with a field or property member.</summary>
|
||||
<param name="member">
|
||||
The field or property member that is promised to be not-null.
|
||||
</param>
|
||||
</member>
|
||||
<member name="M:System.Diagnostics.CodeAnalysis.MemberNotNullAttribute.#ctor(System.String[])">
|
||||
<summary>Initializes the attribute with the list of field and property members.</summary>
|
||||
<param name="members">
|
||||
The list of field and property members that are promised to be not-null.
|
||||
</param>
|
||||
</member>
|
||||
<member name="P:System.Diagnostics.CodeAnalysis.MemberNotNullAttribute.Members">
|
||||
<summary>Gets field or property member names.</summary>
|
||||
</member>
|
||||
<member name="T:System.Diagnostics.CodeAnalysis.MemberNotNullWhenAttribute">
|
||||
<summary>Specifies that the method or property will ensure that the listed field and property members have not-null values when returning with the specified return value condition.</summary>
|
||||
</member>
|
||||
<member name="M:System.Diagnostics.CodeAnalysis.MemberNotNullWhenAttribute.#ctor(System.Boolean,System.String)">
|
||||
<summary>Initializes the attribute with the specified return value condition and a field or property member.</summary>
|
||||
<param name="returnValue">
|
||||
The return value condition. If the method returns this value, the associated parameter will not be null.
|
||||
</param>
|
||||
<param name="member">
|
||||
The field or property member that is promised to be not-null.
|
||||
</param>
|
||||
</member>
|
||||
<member name="M:System.Diagnostics.CodeAnalysis.MemberNotNullWhenAttribute.#ctor(System.Boolean,System.String[])">
|
||||
<summary>Initializes the attribute with the specified return value condition and list of field and property members.</summary>
|
||||
<param name="returnValue">
|
||||
The return value condition. If the method returns this value, the associated parameter will not be null.
|
||||
</param>
|
||||
<param name="members">
|
||||
The list of field and property members that are promised to be not-null.
|
||||
</param>
|
||||
</member>
|
||||
<member name="P:System.Diagnostics.CodeAnalysis.MemberNotNullWhenAttribute.ReturnValue">
|
||||
<summary>Gets the return value condition.</summary>
|
||||
</member>
|
||||
<member name="P:System.Diagnostics.CodeAnalysis.MemberNotNullWhenAttribute.Members">
|
||||
<summary>Gets field or property member names.</summary>
|
||||
</member>
|
||||
</members>
|
||||
</doc>
|
||||
1906
local-nuget/grpc.net.client/2.65.0/lib/net6.0/Grpc.Net.Client.xml
Normal file
1906
local-nuget/grpc.net.client/2.65.0/lib/net6.0/Grpc.Net.Client.xml
Normal file
File diff suppressed because it is too large
Load Diff
1906
local-nuget/grpc.net.client/2.65.0/lib/net7.0/Grpc.Net.Client.xml
Normal file
1906
local-nuget/grpc.net.client/2.65.0/lib/net7.0/Grpc.Net.Client.xml
Normal file
File diff suppressed because it is too large
Load Diff
1906
local-nuget/grpc.net.client/2.65.0/lib/net8.0/Grpc.Net.Client.xml
Normal file
1906
local-nuget/grpc.net.client/2.65.0/lib/net8.0/Grpc.Net.Client.xml
Normal file
File diff suppressed because it is too large
Load Diff
@@ -0,0 +1,933 @@
|
||||
<?xml version="1.0"?>
|
||||
<doc>
|
||||
<assembly>
|
||||
<name>Grpc.Net.Client</name>
|
||||
</assembly>
|
||||
<members>
|
||||
<member name="T:Grpc.Net.Client.Configuration.ConfigObject">
|
||||
<summary>
|
||||
Represents a configuration object. Implementations provide strongly typed wrappers over
|
||||
collections of untyped values.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Grpc.Net.Client.Configuration.ConfigObject.Inner">
|
||||
<summary>
|
||||
Gets the underlying configuration values.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="T:Grpc.Net.Client.Configuration.HedgingPolicy">
|
||||
<summary>
|
||||
The hedging policy for outgoing calls. Hedged calls may execute more than
|
||||
once on the server, so only idempotent methods should specify a hedging
|
||||
policy.
|
||||
</summary>
|
||||
<remarks>
|
||||
<para>
|
||||
Represents the <c>HedgingPolicy</c> message in <see href="https://github.com/grpc/grpc-proto/blob/master/grpc/service_config/service_config.proto"/>.
|
||||
</para>
|
||||
</remarks>
|
||||
</member>
|
||||
<member name="M:Grpc.Net.Client.Configuration.HedgingPolicy.#ctor">
|
||||
<summary>
|
||||
Initializes a new instance of the <see cref="T:Grpc.Net.Client.Configuration.HedgingPolicy"/> class.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Grpc.Net.Client.Configuration.HedgingPolicy.MaxAttempts">
|
||||
<summary>
|
||||
Gets or sets the maximum number of call attempts. This value includes the original attempt.
|
||||
The hedging policy will send up to this number of calls.
|
||||
|
||||
This property is required and must be 2 or greater.
|
||||
This value is limited by <see cref="P:Grpc.Net.Client.GrpcChannelOptions.MaxRetryAttempts"/>.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Grpc.Net.Client.Configuration.HedgingPolicy.HedgingDelay">
|
||||
<summary>
|
||||
Gets or sets the hedging delay.
|
||||
The first call will be sent immediately, but the subsequent
|
||||
hedged call will be sent at intervals of the specified delay.
|
||||
Set this to 0 or <c>null</c> to immediately send all hedged calls.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Grpc.Net.Client.Configuration.HedgingPolicy.NonFatalStatusCodes">
|
||||
<summary>
|
||||
Gets a collection of status codes which indicate other hedged calls may still
|
||||
succeed. If a non-fatal status code is returned by the server, hedged
|
||||
calls will continue. Otherwise, outstanding requests will be canceled and
|
||||
the error returned to the client application layer.
|
||||
|
||||
Specifying status codes is optional.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="T:Grpc.Net.Client.Configuration.LoadBalancingConfig">
|
||||
<summary>
|
||||
Base type for load balancer policy configuration.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:Grpc.Net.Client.Configuration.LoadBalancingConfig.PickFirstPolicyName">
|
||||
<summary>
|
||||
<c>pick_first</c> policy name.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:Grpc.Net.Client.Configuration.LoadBalancingConfig.RoundRobinPolicyName">
|
||||
<summary>
|
||||
<c>round_robin</c> policy name.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Grpc.Net.Client.Configuration.LoadBalancingConfig.#ctor(System.String)">
|
||||
<summary>
|
||||
Initializes a new instance of the <see cref="T:Grpc.Net.Client.Configuration.LoadBalancingConfig"/> class.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Grpc.Net.Client.Configuration.LoadBalancingConfig.PolicyName">
|
||||
<summary>
|
||||
Gets the load balancer policy name.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="T:Grpc.Net.Client.Configuration.MethodConfig">
|
||||
<summary>
|
||||
Configuration for a method.
|
||||
The <see cref="P:Grpc.Net.Client.Configuration.MethodConfig.Names"/> collection is used to determine which methods this configuration applies to.
|
||||
</summary>
|
||||
<remarks>
|
||||
<para>
|
||||
Represents the <c>MethodConfig</c> message in <see href="https://github.com/grpc/grpc-proto/blob/master/grpc/service_config/service_config.proto"/>.
|
||||
</para>
|
||||
</remarks>
|
||||
</member>
|
||||
<member name="M:Grpc.Net.Client.Configuration.MethodConfig.#ctor">
|
||||
<summary>
|
||||
Initializes a new instance of the <see cref="T:Grpc.Net.Client.Configuration.MethodConfig"/> class.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Grpc.Net.Client.Configuration.MethodConfig.RetryPolicy">
|
||||
<summary>
|
||||
Gets or sets the retry policy for outgoing calls.
|
||||
A retry policy can't be combined with <see cref="P:Grpc.Net.Client.Configuration.MethodConfig.HedgingPolicy"/>.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Grpc.Net.Client.Configuration.MethodConfig.HedgingPolicy">
|
||||
<summary>
|
||||
Gets or sets the hedging policy for outgoing calls. Hedged calls may execute
|
||||
more than once on the server, so only idempotent methods should specify a hedging
|
||||
policy. A hedging policy can't be combined with <see cref="P:Grpc.Net.Client.Configuration.MethodConfig.RetryPolicy"/>.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Grpc.Net.Client.Configuration.MethodConfig.Names">
|
||||
<summary>
|
||||
Gets a collection of names which determine the calls the method config will apply to.
|
||||
A <see cref="T:Grpc.Net.Client.Configuration.MethodConfig"/> without names won't be used. Each name must be unique
|
||||
across an entire <see cref="T:Grpc.Net.Client.Configuration.ServiceConfig"/>.
|
||||
</summary>
|
||||
<remarks>
|
||||
<para>
|
||||
If a name's <see cref="P:Grpc.Net.Client.Configuration.MethodName.Method"/> property isn't set then the method config is the default
|
||||
for all methods for the specified service.
|
||||
</para>
|
||||
<para>
|
||||
If a name's <see cref="P:Grpc.Net.Client.Configuration.MethodName.Service"/> property isn't set then <see cref="P:Grpc.Net.Client.Configuration.MethodName.Method"/> must also be unset,
|
||||
and the method config is the default for all methods on all services.
|
||||
<see cref="F:Grpc.Net.Client.Configuration.MethodName.Default"/> represents this global default name.
|
||||
</para>
|
||||
<para>
|
||||
When determining which method config to use for a given RPC, the most specific match wins. A method config
|
||||
with a configured <see cref="T:Grpc.Net.Client.Configuration.MethodName"/> that exactly matches a call's method and service will be used
|
||||
instead of a service or global default method config.
|
||||
</para>
|
||||
</remarks>
|
||||
</member>
|
||||
<member name="T:Grpc.Net.Client.Configuration.MethodName">
|
||||
<summary>
|
||||
The name of a method. Used to configure what calls a <see cref="T:Grpc.Net.Client.Configuration.MethodConfig"/> applies to using
|
||||
the <see cref="P:Grpc.Net.Client.Configuration.MethodConfig.Names"/> collection.
|
||||
</summary>
|
||||
<remarks>
|
||||
<para>
|
||||
Represents the <c>Name</c> message in <see href="https://github.com/grpc/grpc-proto/blob/master/grpc/service_config/service_config.proto"/>.
|
||||
</para>
|
||||
<para>
|
||||
If a name's <see cref="P:Grpc.Net.Client.Configuration.MethodName.Method"/> property isn't set then the method config is the default
|
||||
for all methods for the specified service.
|
||||
</para>
|
||||
<para>
|
||||
If a name's <see cref="P:Grpc.Net.Client.Configuration.MethodName.Service"/> property isn't set then <see cref="P:Grpc.Net.Client.Configuration.MethodName.Method"/> must also be unset,
|
||||
and the method config is the default for all methods on all services.
|
||||
<see cref="F:Grpc.Net.Client.Configuration.MethodName.Default"/> represents this global default name.
|
||||
</para>
|
||||
<para>
|
||||
When determining which method config to use for a given RPC, the most specific match wins. A method config
|
||||
with a configured <see cref="T:Grpc.Net.Client.Configuration.MethodName"/> that exactly matches a call's method and service will be used
|
||||
instead of a service or global default method config.
|
||||
</para>
|
||||
</remarks>
|
||||
</member>
|
||||
<member name="F:Grpc.Net.Client.Configuration.MethodName.Default">
|
||||
<summary>
|
||||
A global default name.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Grpc.Net.Client.Configuration.MethodName.#ctor">
|
||||
<summary>
|
||||
Initializes a new instance of the <see cref="T:Grpc.Net.Client.Configuration.MethodName"/> class.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Grpc.Net.Client.Configuration.MethodName.Service">
|
||||
<summary>
|
||||
Gets or sets the service name.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Grpc.Net.Client.Configuration.MethodName.Method">
|
||||
<summary>
|
||||
Gets or sets the method name.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="T:Grpc.Net.Client.Configuration.PickFirstConfig">
|
||||
<summary>
|
||||
Configuration for pick_first load balancer policy.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Grpc.Net.Client.Configuration.PickFirstConfig.#ctor">
|
||||
<summary>
|
||||
Initializes a new instance of the <see cref="T:Grpc.Net.Client.Configuration.PickFirstConfig"/> class.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="T:Grpc.Net.Client.Configuration.RetryPolicy">
|
||||
<summary>
|
||||
The retry policy for outgoing calls.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Grpc.Net.Client.Configuration.RetryPolicy.#ctor">
|
||||
<summary>
|
||||
Initializes a new instance of the <see cref="T:Grpc.Net.Client.Configuration.RetryPolicy"/> class.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Grpc.Net.Client.Configuration.RetryPolicy.MaxAttempts">
|
||||
<summary>
|
||||
Gets or sets the maximum number of call attempts. This value includes the original attempt.
|
||||
This property is required and must be greater than 1.
|
||||
This value is limited by <see cref="P:Grpc.Net.Client.GrpcChannelOptions.MaxRetryAttempts"/>.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Grpc.Net.Client.Configuration.RetryPolicy.InitialBackoff">
|
||||
<summary>
|
||||
Gets or sets the initial backoff.
|
||||
A randomized delay between 0 and the current backoff value will determine when the next
|
||||
retry attempt is made.
|
||||
This property is required and must be greater than zero.
|
||||
<para>
|
||||
The backoff will be multiplied by <see cref="P:Grpc.Net.Client.Configuration.RetryPolicy.BackoffMultiplier"/> after each retry
|
||||
attempt and will increase exponentially when the multiplier is greater than 1.
|
||||
</para>
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Grpc.Net.Client.Configuration.RetryPolicy.MaxBackoff">
|
||||
<summary>
|
||||
Gets or sets the maximum backoff.
|
||||
The maximum backoff places an upper limit on exponential backoff growth.
|
||||
This property is required and must be greater than zero.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Grpc.Net.Client.Configuration.RetryPolicy.BackoffMultiplier">
|
||||
<summary>
|
||||
Gets or sets the backoff multiplier.
|
||||
The backoff will be multiplied by <see cref="P:Grpc.Net.Client.Configuration.RetryPolicy.BackoffMultiplier"/> after each retry
|
||||
attempt and will increase exponentially when the multiplier is greater than 1.
|
||||
This property is required and must be greater than 0.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Grpc.Net.Client.Configuration.RetryPolicy.RetryableStatusCodes">
|
||||
<summary>
|
||||
Gets a collection of status codes which may be retried.
|
||||
At least one status code is required.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="T:Grpc.Net.Client.Configuration.RetryThrottlingPolicy">
|
||||
<summary>
|
||||
The retry throttling policy for a server.
|
||||
<para>
|
||||
For more information about configuring throttling, see <see href="https://github.com/grpc/proposal/blob/master/A6-client-retries.md#throttling-retry-attempts-and-hedged-rpcs"/>.
|
||||
</para>
|
||||
</summary>
|
||||
<remarks>
|
||||
<para>
|
||||
Represents the <c>RetryThrottlingPolicy</c> message in <see href="https://github.com/grpc/grpc-proto/blob/master/grpc/service_config/service_config.proto"/>.
|
||||
</para>
|
||||
</remarks>
|
||||
</member>
|
||||
<member name="M:Grpc.Net.Client.Configuration.RetryThrottlingPolicy.#ctor">
|
||||
<summary>
|
||||
Initializes a new instance of the <see cref="T:Grpc.Net.Client.Configuration.RetryThrottlingPolicy"/> class.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Grpc.Net.Client.Configuration.RetryThrottlingPolicy.MaxTokens">
|
||||
<summary>
|
||||
Gets or sets the maximum number of tokens.
|
||||
The number of tokens starts at <see cref="P:Grpc.Net.Client.Configuration.RetryThrottlingPolicy.MaxTokens"/> and the token count will
|
||||
always be between 0 and <see cref="P:Grpc.Net.Client.Configuration.RetryThrottlingPolicy.MaxTokens"/>.
|
||||
This property is required and must be greater than zero.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Grpc.Net.Client.Configuration.RetryThrottlingPolicy.TokenRatio">
|
||||
<summary>
|
||||
Gets or sets the amount of tokens to add on each successful call. Typically this will
|
||||
be some number between 0 and 1, e.g., 0.1.
|
||||
This property is required and must be greater than zero. Up to 3 decimal places are supported.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="T:Grpc.Net.Client.Configuration.RoundRobinConfig">
|
||||
<summary>
|
||||
Configuration for pick_first load balancer policy.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Grpc.Net.Client.Configuration.RoundRobinConfig.#ctor">
|
||||
<summary>
|
||||
Initializes a new instance of the <see cref="T:Grpc.Net.Client.Configuration.RoundRobinConfig"/> class.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="T:Grpc.Net.Client.Configuration.ServiceConfig">
|
||||
<summary>
|
||||
A <see cref="T:Grpc.Net.Client.Configuration.ServiceConfig"/> represents information about a service.
|
||||
</summary>
|
||||
<remarks>
|
||||
<para>
|
||||
Represents the <c>ServiceConfig</c> message in <see href="https://github.com/grpc/grpc-proto/blob/master/grpc/service_config/service_config.proto"/>.
|
||||
</para>
|
||||
</remarks>
|
||||
</member>
|
||||
<member name="M:Grpc.Net.Client.Configuration.ServiceConfig.#ctor">
|
||||
<summary>
|
||||
Initializes a new instance of the <see cref="T:Grpc.Net.Client.Configuration.ServiceConfig"/> class.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Grpc.Net.Client.Configuration.ServiceConfig.LoadBalancingConfigs">
|
||||
<summary>
|
||||
Gets a collection of <see cref="T:Grpc.Net.Client.Configuration.LoadBalancingConfig"/> instances. The client will iterate
|
||||
through the configured policies in order and use the first policy that is supported.
|
||||
If none are supported by the client then a configuration error is thrown.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Grpc.Net.Client.Configuration.ServiceConfig.MethodConfigs">
|
||||
<summary>
|
||||
Gets a collection of <see cref="T:Grpc.Net.Client.Configuration.MethodConfig"/> instances. This collection is used to specify
|
||||
configuration on a per-method basis. <see cref="P:Grpc.Net.Client.Configuration.MethodConfig.Names"/> determines which calls
|
||||
a method config applies to.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Grpc.Net.Client.Configuration.ServiceConfig.RetryThrottling">
|
||||
<summary>
|
||||
Gets or sets the retry throttling policy.
|
||||
If a <see cref="T:Grpc.Net.Client.Configuration.RetryThrottlingPolicy"/> is provided, gRPC will automatically throttle
|
||||
retry attempts and hedged RPCs when the client's ratio of failures to
|
||||
successes exceeds a threshold.
|
||||
<para>
|
||||
For more information about configuring throttling, see <see href="https://github.com/grpc/proposal/blob/master/A6-client-retries.md#throttling-retry-attempts-and-hedged-rpcs"/>.
|
||||
</para>
|
||||
</summary>
|
||||
</member>
|
||||
<member name="T:Grpc.Net.Client.GrpcChannel">
|
||||
<summary>
|
||||
Represents a gRPC channel. Channels are an abstraction of long-lived connections to remote servers.
|
||||
Client objects can reuse the same channel. Creating a channel is an expensive operation compared to invoking
|
||||
a remote call so in general you should reuse a single channel for as many calls as possible.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Grpc.Net.Client.GrpcChannel.CreateCallInvoker">
|
||||
<summary>
|
||||
Create a new <see cref="T:Grpc.Core.CallInvoker"/> for the channel.
|
||||
</summary>
|
||||
<returns>A new <see cref="T:Grpc.Core.CallInvoker"/>.</returns>
|
||||
</member>
|
||||
<member name="M:Grpc.Net.Client.GrpcChannel.ForAddress(System.String)">
|
||||
<summary>
|
||||
Creates a <see cref="T:Grpc.Net.Client.GrpcChannel"/> for the specified address.
|
||||
</summary>
|
||||
<param name="address">The address the channel will use.</param>
|
||||
<returns>A new instance of <see cref="T:Grpc.Net.Client.GrpcChannel"/>.</returns>
|
||||
</member>
|
||||
<member name="M:Grpc.Net.Client.GrpcChannel.ForAddress(System.String,Grpc.Net.Client.GrpcChannelOptions)">
|
||||
<summary>
|
||||
Creates a <see cref="T:Grpc.Net.Client.GrpcChannel"/> for the specified address and configuration options.
|
||||
</summary>
|
||||
<param name="address">The address the channel will use.</param>
|
||||
<param name="channelOptions">The channel configuration options.</param>
|
||||
<returns>A new instance of <see cref="T:Grpc.Net.Client.GrpcChannel"/>.</returns>
|
||||
</member>
|
||||
<member name="M:Grpc.Net.Client.GrpcChannel.ForAddress(System.Uri)">
|
||||
<summary>
|
||||
Creates a <see cref="T:Grpc.Net.Client.GrpcChannel"/> for the specified address.
|
||||
</summary>
|
||||
<param name="address">The address the channel will use.</param>
|
||||
<returns>A new instance of <see cref="T:Grpc.Net.Client.GrpcChannel"/>.</returns>
|
||||
</member>
|
||||
<member name="M:Grpc.Net.Client.GrpcChannel.ForAddress(System.Uri,Grpc.Net.Client.GrpcChannelOptions)">
|
||||
<summary>
|
||||
Creates a <see cref="T:Grpc.Net.Client.GrpcChannel"/> for the specified address and configuration options.
|
||||
</summary>
|
||||
<param name="address">The address the channel will use.</param>
|
||||
<param name="channelOptions">The channel configuration options.</param>
|
||||
<returns>A new instance of <see cref="T:Grpc.Net.Client.GrpcChannel"/>.</returns>
|
||||
</member>
|
||||
<member name="M:Grpc.Net.Client.GrpcChannel.Dispose">
|
||||
<summary>
|
||||
Releases the resources used by the <see cref="T:Grpc.Net.Client.GrpcChannel"/> class.
|
||||
Clients created with the channel can't be used after the channel is disposed.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="T:Grpc.Net.Client.GrpcChannelOptions">
|
||||
<summary>
|
||||
An options class for configuring a <see cref="T:Grpc.Net.Client.GrpcChannel"/>.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Grpc.Net.Client.GrpcChannelOptions.Credentials">
|
||||
<summary>
|
||||
Gets or sets the credentials for the channel. This setting is used to set <see cref="T:Grpc.Core.ChannelCredentials"/> for
|
||||
a channel. Connection transport layer security (TLS) is determined by the address used to create the channel.
|
||||
</summary>
|
||||
<remarks>
|
||||
<para>
|
||||
The channel credentials you use must match the address TLS setting. Use <see cref="P:Grpc.Core.ChannelCredentials.Insecure"/>
|
||||
for an "http" address and <see cref="P:Grpc.Core.ChannelCredentials.SecureSsl"/> for "https".
|
||||
</para>
|
||||
<para>
|
||||
The underlying <see cref="T:System.Net.Http.HttpClient"/> used by the channel automatically loads root certificates
|
||||
from the operating system certificate store.
|
||||
Client certificates should be configured on HttpClient. See <see href="https://aka.ms/aspnet/grpc/certauth"/> for details.
|
||||
</para>
|
||||
</remarks>
|
||||
</member>
|
||||
<member name="P:Grpc.Net.Client.GrpcChannelOptions.MaxSendMessageSize">
|
||||
<summary>
|
||||
Gets or sets the maximum message size in bytes that can be sent from the client. Attempting to send a message
|
||||
that exceeds the configured maximum message size results in an exception.
|
||||
<para>
|
||||
A <c>null</c> value removes the maximum message size limit. Defaults to <c>null</c>.
|
||||
</para>
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Grpc.Net.Client.GrpcChannelOptions.MaxReceiveMessageSize">
|
||||
<summary>
|
||||
Gets or sets the maximum message size in bytes that can be received by the client. If the client receives a
|
||||
message that exceeds this limit, it throws an exception.
|
||||
<para>
|
||||
A <c>null</c> value removes the maximum message size limit. Defaults to 4,194,304 (4 MB).
|
||||
</para>
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Grpc.Net.Client.GrpcChannelOptions.MaxRetryAttempts">
|
||||
<summary>
|
||||
Gets or sets the maximum retry attempts. This value limits any retry and hedging attempt values specified in
|
||||
the service config.
|
||||
<para>
|
||||
Setting this value alone doesn't enable retries. Retries are enabled in the service config, which can be done
|
||||
using <see cref="P:Grpc.Net.Client.GrpcChannelOptions.ServiceConfig"/>.
|
||||
</para>
|
||||
<para>
|
||||
A <c>null</c> value removes the maximum retry attempts limit. Defaults to 5.
|
||||
</para>
|
||||
<para>
|
||||
Note: Experimental API that can change or be removed without any prior notice.
|
||||
</para>
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Grpc.Net.Client.GrpcChannelOptions.MaxRetryBufferSize">
|
||||
<summary>
|
||||
Gets or sets the maximum buffer size in bytes that can be used to store sent messages when retrying
|
||||
or hedging calls. If the buffer limit is exceeded, then no more retry attempts are made and all
|
||||
hedging calls but one will be canceled. This limit is applied across all calls made using the channel.
|
||||
<para>
|
||||
Setting this value alone doesn't enable retries. Retries are enabled in the service config, which can be done
|
||||
using <see cref="P:Grpc.Net.Client.GrpcChannelOptions.ServiceConfig"/>.
|
||||
</para>
|
||||
<para>
|
||||
A <c>null</c> value removes the maximum retry buffer size limit. Defaults to 16,777,216 (16 MB).
|
||||
</para>
|
||||
<para>
|
||||
Note: Experimental API that can change or be removed without any prior notice.
|
||||
</para>
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Grpc.Net.Client.GrpcChannelOptions.MaxRetryBufferPerCallSize">
|
||||
<summary>
|
||||
Gets or sets the maximum buffer size in bytes that can be used to store sent messages when retrying
|
||||
or hedging calls. If the buffer limit is exceeded, then no more retry attempts are made and all
|
||||
hedging calls but one will be canceled. This limit is applied to one call.
|
||||
<para>
|
||||
Setting this value alone doesn't enable retries. Retries are enabled in the service config, which can be done
|
||||
using <see cref="P:Grpc.Net.Client.GrpcChannelOptions.ServiceConfig"/>.
|
||||
</para>
|
||||
<para>
|
||||
A <c>null</c> value removes the maximum retry buffer size limit per call. Defaults to 1,048,576 (1 MB).
|
||||
</para>
|
||||
<para>
|
||||
Note: Experimental API that can change or be removed without any prior notice.
|
||||
</para>
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Grpc.Net.Client.GrpcChannelOptions.CompressionProviders">
|
||||
<summary>
|
||||
Gets or sets a collection of compression providers.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Grpc.Net.Client.GrpcChannelOptions.LoggerFactory">
|
||||
<summary>
|
||||
Gets or sets the logger factory used by the channel. If no value is specified then the channel
|
||||
attempts to resolve an <see cref="T:Microsoft.Extensions.Logging.ILoggerFactory"/> from the <see cref="P:Grpc.Net.Client.GrpcChannelOptions.ServiceProvider"/>.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Grpc.Net.Client.GrpcChannelOptions.HttpClient">
|
||||
<summary>
|
||||
Gets or sets the <see cref="T:System.Net.Http.HttpClient"/> used by the channel to make HTTP calls.
|
||||
</summary>
|
||||
<remarks>
|
||||
<para>
|
||||
By default a <see cref="T:System.Net.Http.HttpClient"/> specified here will not be disposed with the channel.
|
||||
To dispose the <see cref="T:System.Net.Http.HttpClient"/> with the channel you must set <see cref="P:Grpc.Net.Client.GrpcChannelOptions.DisposeHttpClient"/>
|
||||
to <c>true</c>.
|
||||
</para>
|
||||
<para>
|
||||
Only one HTTP caller can be specified for a channel. An error will be thrown if this is configured
|
||||
together with <see cref="P:Grpc.Net.Client.GrpcChannelOptions.HttpHandler"/>.
|
||||
</para>
|
||||
</remarks>
|
||||
</member>
|
||||
<member name="P:Grpc.Net.Client.GrpcChannelOptions.HttpHandler">
|
||||
<summary>
|
||||
Gets or sets the <see cref="T:System.Net.Http.HttpMessageHandler"/> used by the channel to make HTTP calls.
|
||||
</summary>
|
||||
<remarks>
|
||||
<para>
|
||||
By default a <see cref="T:System.Net.Http.HttpMessageHandler"/> specified here will not be disposed with the channel.
|
||||
To dispose the <see cref="T:System.Net.Http.HttpMessageHandler"/> with the channel you must set <see cref="P:Grpc.Net.Client.GrpcChannelOptions.DisposeHttpClient"/>
|
||||
to <c>true</c>.
|
||||
</para>
|
||||
<para>
|
||||
Only one HTTP caller can be specified for a channel. An error will be thrown if this is configured
|
||||
together with <see cref="P:Grpc.Net.Client.GrpcChannelOptions.HttpClient"/>.
|
||||
</para>
|
||||
</remarks>
|
||||
</member>
|
||||
<member name="P:Grpc.Net.Client.GrpcChannelOptions.DisposeHttpClient">
|
||||
<summary>
|
||||
Gets or sets a value indicating whether the underlying <see cref="T:System.Net.Http.HttpClient"/> or
|
||||
<see cref="T:System.Net.Http.HttpMessageHandler"/> should be disposed when the <see cref="T:Grpc.Net.Client.GrpcChannel"/> instance is disposed.
|
||||
The default value is <c>false</c>.
|
||||
</summary>
|
||||
<remarks>
|
||||
This setting is used when a <see cref="P:Grpc.Net.Client.GrpcChannelOptions.HttpClient"/> or <see cref="P:Grpc.Net.Client.GrpcChannelOptions.HttpHandler"/> value is specified.
|
||||
If they are not specified then the channel will create an internal HTTP caller that is always disposed
|
||||
when the channel is disposed.
|
||||
</remarks>
|
||||
</member>
|
||||
<member name="P:Grpc.Net.Client.GrpcChannelOptions.ThrowOperationCanceledOnCancellation">
|
||||
<summary>
|
||||
Gets or sets a value indicating whether clients will throw <see cref="T:System.OperationCanceledException"/> for a call when its
|
||||
<see cref="P:Grpc.Core.CallOptions.CancellationToken"/> is triggered or its <see cref="P:Grpc.Core.CallOptions.Deadline"/> is exceeded.
|
||||
The default value is <c>false</c>.
|
||||
<para>
|
||||
Note: Experimental API that can change or be removed without any prior notice.
|
||||
</para>
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Grpc.Net.Client.GrpcChannelOptions.UnsafeUseInsecureChannelCallCredentials">
|
||||
<summary>
|
||||
Gets or sets a value indicating whether a gRPC call's <see cref="T:Grpc.Core.CallCredentials"/> are used by an insecure channel.
|
||||
The default value is <c>false</c>.
|
||||
<para>
|
||||
Note: Experimental API that can change or be removed without any prior notice.
|
||||
</para>
|
||||
</summary>
|
||||
<remarks>
|
||||
<para>
|
||||
The default value for this property is <c>false</c>, which causes an insecure channel to ignore a gRPC call's <see cref="T:Grpc.Core.CallCredentials"/>.
|
||||
Sending authentication headers over an insecure connection has security implications and shouldn't be done in production environments.
|
||||
</para>
|
||||
<para>
|
||||
If this property is set to <c>true</c>, call credentials are always used by a channel.
|
||||
</para>
|
||||
</remarks>
|
||||
</member>
|
||||
<member name="P:Grpc.Net.Client.GrpcChannelOptions.ServiceConfig">
|
||||
<summary>
|
||||
Gets or sets the service config for a gRPC channel. A service config allows service owners to publish parameters
|
||||
to be automatically used by all clients of their service. A service config can also be specified by a client
|
||||
using this property.
|
||||
<para>
|
||||
Note: Experimental API that can change or be removed without any prior notice.
|
||||
</para>
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Grpc.Net.Client.GrpcChannelOptions.ServiceProvider">
|
||||
<summary>
|
||||
Gets or sets the <see cref="T:System.IServiceProvider"/> the channel uses to resolve types.
|
||||
<para>
|
||||
Note: Experimental API that can change or be removed without any prior notice.
|
||||
</para>
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Grpc.Net.Client.GrpcChannelOptions.#ctor">
|
||||
<summary>
|
||||
Initializes a new instance of the <see cref="T:Grpc.Net.Client.GrpcChannelOptions"/> class.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Grpc.Net.Client.Internal.ClientStreamWriterBase`1.IsWriteInProgressUnsynchronized">
|
||||
<summary>
|
||||
A value indicating whether there is an async write already in progress.
|
||||
Should only check this property when holding the write lock.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Grpc.Net.Client.Internal.GrpcCall`2.Cleanup(Grpc.Core.Status)">
|
||||
<summary>
|
||||
Clean up can be called by:
|
||||
1. The user. AsyncUnaryCall.Dispose et al will call this on Dispose
|
||||
2. <see cref="M:Grpc.Net.Client.Internal.GrpcCall.ValidateHeaders(System.Net.Http.HttpResponseMessage,Grpc.Core.Metadata@)"/> will call dispose if errors fail validation
|
||||
3. <see cref="M:Grpc.Net.Client.Internal.GrpcCall`2.FinishResponseAndCleanUp(Grpc.Core.Status)"/> will call dispose
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Grpc.Net.Client.Internal.GrpcCall`2.ResponseStreamEnded(Grpc.Core.Status,System.Boolean)">
|
||||
<summary>
|
||||
Used by response stream reader to report it is finished.
|
||||
</summary>
|
||||
<param name="status">The completed response status code.</param>
|
||||
<param name="finishedGracefully">true when the end of the response stream was read, otherwise false.</param>
|
||||
</member>
|
||||
<member name="M:Grpc.Net.Client.Internal.GrpcCall`2.ResolveException(System.String,System.Exception,System.Nullable{Grpc.Core.Status}@,System.Exception@)">
|
||||
<summary>
|
||||
Resolve the specified exception to an end-user exception that will be thrown from the client.
|
||||
The resolved exception is normally a RpcException. Returns true when the resolved exception is changed.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Grpc.Net.Client.Internal.GrpcCallSerializationContext.GetWrittenPayload">
|
||||
<summary>
|
||||
Obtains the payload from this operation. Error is thrown if complete hasn't been called.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="T:Grpc.Net.Client.Internal.GrpcMethodInfo">
|
||||
<summary>
|
||||
Cached log scope and URI for a gRPC <see cref="T:Grpc.Core.IMethod"/>.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Grpc.Net.Client.Internal.GrpcProtocolConstants.GetDebugEnumerator(Grpc.Core.ChannelBase,Grpc.Core.IMethod,System.Object)">
|
||||
<summary>
|
||||
Gets key value pairs used by debugging. These are provided as an enumerator instead of a dictionary
|
||||
because it's one method to implement an enumerator on gRPC calls compared to a dozen members for a dictionary.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Grpc.Net.Client.Internal.GrpcProtocolHelpers.ResolveRpcExceptionStatusCode(System.Exception)">
|
||||
<summary>
|
||||
Resolve the exception from HttpClient to a gRPC status code.
|
||||
<param name="ex">The <see cref="T:System.Exception"/> to resolve a <see cref="T:Grpc.Core.StatusCode"/> from.</param>
|
||||
</summary>
|
||||
</member>
|
||||
<member name="T:Grpc.Net.Client.Internal.Http.WinHttpUnaryContent`2">
|
||||
<summary>
|
||||
WinHttp doesn't support streaming request data so a length needs to be specified.
|
||||
This HttpContent pre-serializes the payload so it has a length available.
|
||||
The payload is then written directly to the request using specialized context
|
||||
and serializer method.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="T:Grpc.Net.Client.Internal.HttpClientCallInvoker">
|
||||
<summary>
|
||||
A client-side RPC invocation using HttpClient.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Grpc.Net.Client.Internal.HttpClientCallInvoker.AsyncClientStreamingCall``2(Grpc.Core.Method{``0,``1},System.String,Grpc.Core.CallOptions)">
|
||||
<summary>
|
||||
Invokes a client streaming call asynchronously.
|
||||
In client streaming scenario, client sends a stream of requests and server responds with a single response.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Grpc.Net.Client.Internal.HttpClientCallInvoker.AsyncDuplexStreamingCall``2(Grpc.Core.Method{``0,``1},System.String,Grpc.Core.CallOptions)">
|
||||
<summary>
|
||||
Invokes a duplex streaming call asynchronously.
|
||||
In duplex streaming scenario, client sends a stream of requests and server responds with a stream of responses.
|
||||
The response stream is completely independent and both side can be sending messages at the same time.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Grpc.Net.Client.Internal.HttpClientCallInvoker.AsyncServerStreamingCall``2(Grpc.Core.Method{``0,``1},System.String,Grpc.Core.CallOptions,``0)">
|
||||
<summary>
|
||||
Invokes a server streaming call asynchronously.
|
||||
In server streaming scenario, client sends on request and server responds with a stream of responses.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Grpc.Net.Client.Internal.HttpClientCallInvoker.AsyncUnaryCall``2(Grpc.Core.Method{``0,``1},System.String,Grpc.Core.CallOptions,``0)">
|
||||
<summary>
|
||||
Invokes a simple remote call asynchronously.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Grpc.Net.Client.Internal.HttpClientCallInvoker.BlockingUnaryCall``2(Grpc.Core.Method{``0,``1},System.String,Grpc.Core.CallOptions,``0)">
|
||||
<summary>
|
||||
Invokes a simple remote call in a blocking fashion.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Grpc.Net.Client.Internal.HttpContentClientStreamReader`2.IsMoveNextInProgressUnsynchronized">
|
||||
<summary>
|
||||
A value indicating whether there is an async move next already in progress.
|
||||
Should only check this property when holding the move next lock.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="T:Grpc.Net.Client.Internal.Native">
|
||||
<summary>
|
||||
Types for calling RtlGetVersion. See https://www.pinvoke.net/default.aspx/ntdll/RtlGetVersion.html
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:Grpc.Net.Client.Internal.Native.NTSTATUS.STATUS_SUCCESS">
|
||||
<summary>
|
||||
The operation completed successfully.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Grpc.Net.Client.Internal.TaskExtensions.ObserveException(System.Threading.Tasks.Task)">
|
||||
<summary>
|
||||
Observes and ignores a potential exception on a given Task.
|
||||
If a Task fails and throws an exception which is never observed, it will be caught by the .NET finalizer thread.
|
||||
This function awaits the given task and if the exception is thrown, it observes this exception and simply ignores it.
|
||||
This will prevent the escalation of this exception to the .NET finalizer thread.
|
||||
</summary>
|
||||
<param name="task">The task to be ignored.</param>
|
||||
</member>
|
||||
<member name="M:Grpc.Net.Client.Internal.UserAgentGenerator.GetUserAgentString">
|
||||
<summary>
|
||||
Generates a user agent string to be transported in headers.
|
||||
<example>
|
||||
grpc-dotnet/2.41.0-dev (.NET 6.0.0-preview.7.21377.19; CLR 6.0.0; net6.0; osx; x64)
|
||||
grpc-dotnet/2.41.0-dev (Mono 6.12.0.140; CLR 4.0.30319; netstandard2.0; osx; x64)
|
||||
grpc-dotnet/2.41.0-dev (.NET 6.0.0-rc.1.21380.1; CLR 6.0.0; net6.0; linux; arm64)
|
||||
grpc-dotnet/2.41.0-dev (.NET 5.0.8; CLR 5.0.8; net5.0; linux; arm64)
|
||||
grpc-dotnet/2.41.0-dev (.NET Core; CLR 3.1.4; netstandard2.1; linux; arm64)
|
||||
grpc-dotnet/2.41.0-dev (.NET Framework; CLR 4.0.30319.42000; netstandard2.0; windows; x86)
|
||||
grpc-dotnet/2.41.0-dev (.NET 6.0.0-rc.1.21380.1; CLR 6.0.0; net6.0; windows; x64)
|
||||
</example>
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Grpc.Shared.ObjectDisposedThrowHelper.ThrowIf(System.Boolean,System.Object)">
|
||||
<summary>Throws an <see cref="T:System.ObjectDisposedException"/> if the specified <paramref name="condition"/> is <see langword="true"/>.</summary>
|
||||
<param name="condition">The condition to evaluate.</param>
|
||||
<param name="instance">The object whose type's full name should be included in any resulting <see cref="T:System.ObjectDisposedException"/>.</param>
|
||||
<exception cref="T:System.ObjectDisposedException">The <paramref name="condition"/> is <see langword="true"/>.</exception>
|
||||
</member>
|
||||
<member name="M:Grpc.Shared.ObjectDisposedThrowHelper.ThrowIf(System.Boolean,System.Type)">
|
||||
<summary>Throws an <see cref="T:System.ObjectDisposedException"/> if the specified <paramref name="condition"/> is <see langword="true"/>.</summary>
|
||||
<param name="condition">The condition to evaluate.</param>
|
||||
<param name="type">The type whose full name should be included in any resulting <see cref="T:System.ObjectDisposedException"/>.</param>
|
||||
<exception cref="T:System.ObjectDisposedException">The <paramref name="condition"/> is <see langword="true"/>.</exception>
|
||||
</member>
|
||||
<member name="M:Grpc.Shared.ArgumentNullThrowHelper.ThrowIfNull(System.Object,System.String)">
|
||||
<summary>Throws an <see cref="T:System.ArgumentNullException"/> if <paramref name="argument"/> is null.</summary>
|
||||
<param name="argument">The reference type argument to validate as non-null.</param>
|
||||
<param name="paramName">The name of the parameter with which <paramref name="argument"/> corresponds.</param>
|
||||
</member>
|
||||
<member name="T:System.Buffers.ArrayBufferWriter`1">
|
||||
<summary>
|
||||
Represents a heap-based, array-backed output sink into which <typeparam name="T"/> data can be written.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:System.Buffers.ArrayBufferWriter`1.#ctor">
|
||||
<summary>
|
||||
Creates an instance of an <see cref="T:System.Buffers.ArrayBufferWriter`1"/>, in which data can be written to,
|
||||
with the default initial capacity.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:System.Buffers.ArrayBufferWriter`1.#ctor(System.Int32)">
|
||||
<summary>
|
||||
Creates an instance of an <see cref="T:System.Buffers.ArrayBufferWriter`1"/>, in which data can be written to,
|
||||
with an initial capacity specified.
|
||||
</summary>
|
||||
<param name="initialCapacity">The minimum capacity with which to initialize the underlying buffer.</param>
|
||||
<exception cref="T:System.ArgumentException">
|
||||
Thrown when <paramref name="initialCapacity"/> is not positive (i.e. less than or equal to 0).
|
||||
</exception>
|
||||
</member>
|
||||
<member name="P:System.Buffers.ArrayBufferWriter`1.WrittenMemory">
|
||||
<summary>
|
||||
Returns the data written to the underlying buffer so far, as a <see cref="T:System.ReadOnlyMemory`1"/>.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:System.Buffers.ArrayBufferWriter`1.WrittenSpan">
|
||||
<summary>
|
||||
Returns the data written to the underlying buffer so far, as a <see cref="T:System.ReadOnlySpan`1"/>.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:System.Buffers.ArrayBufferWriter`1.WrittenCount">
|
||||
<summary>
|
||||
Returns the amount of data written to the underlying buffer so far.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:System.Buffers.ArrayBufferWriter`1.Capacity">
|
||||
<summary>
|
||||
Returns the total amount of space within the underlying buffer.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:System.Buffers.ArrayBufferWriter`1.FreeCapacity">
|
||||
<summary>
|
||||
Returns the amount of space available that can still be written into without forcing the underlying buffer to grow.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:System.Buffers.ArrayBufferWriter`1.Clear">
|
||||
<summary>
|
||||
Clears the data written to the underlying buffer.
|
||||
</summary>
|
||||
<remarks>
|
||||
You must clear the <see cref="T:System.Buffers.ArrayBufferWriter`1"/> before trying to re-use it.
|
||||
</remarks>
|
||||
</member>
|
||||
<member name="M:System.Buffers.ArrayBufferWriter`1.Advance(System.Int32)">
|
||||
<summary>
|
||||
Notifies <see cref="T:System.Buffers.IBufferWriter`1"/> that <paramref name="count"/> amount of data was written to the output <see cref="T:System.Span`1"/>/<see cref="T:System.Memory`1"/>
|
||||
</summary>
|
||||
<exception cref="T:System.ArgumentException">
|
||||
Thrown when <paramref name="count"/> is negative.
|
||||
</exception>
|
||||
<exception cref="T:System.InvalidOperationException">
|
||||
Thrown when attempting to advance past the end of the underlying buffer.
|
||||
</exception>
|
||||
<remarks>
|
||||
You must request a new buffer after calling Advance to continue writing more data and cannot write to a previously acquired buffer.
|
||||
</remarks>
|
||||
</member>
|
||||
<member name="M:System.Buffers.ArrayBufferWriter`1.GetMemory(System.Int32)">
|
||||
<summary>
|
||||
Returns a <see cref="T:System.Memory`1"/> to write to that is at least the requested length (specified by <paramref name="sizeHint"/>).
|
||||
If no <paramref name="sizeHint"/> is provided (or it's equal to <code>0</code>), some non-empty buffer is returned.
|
||||
</summary>
|
||||
<exception cref="T:System.ArgumentException">
|
||||
Thrown when <paramref name="sizeHint"/> is negative.
|
||||
</exception>
|
||||
<remarks>
|
||||
This will never return an empty <see cref="T:System.Memory`1"/>.
|
||||
</remarks>
|
||||
<remarks>
|
||||
There is no guarantee that successive calls will return the same buffer or the same-sized buffer.
|
||||
</remarks>
|
||||
<remarks>
|
||||
You must request a new buffer after calling Advance to continue writing more data and cannot write to a previously acquired buffer.
|
||||
</remarks>
|
||||
</member>
|
||||
<member name="M:System.Buffers.ArrayBufferWriter`1.GetSpan(System.Int32)">
|
||||
<summary>
|
||||
Returns a <see cref="T:System.Span`1"/> to write to that is at least the requested length (specified by <paramref name="sizeHint"/>).
|
||||
If no <paramref name="sizeHint"/> is provided (or it's equal to <code>0</code>), some non-empty buffer is returned.
|
||||
</summary>
|
||||
<exception cref="T:System.ArgumentException">
|
||||
Thrown when <paramref name="sizeHint"/> is negative.
|
||||
</exception>
|
||||
<remarks>
|
||||
This will never return an empty <see cref="T:System.Span`1"/>.
|
||||
</remarks>
|
||||
<remarks>
|
||||
There is no guarantee that successive calls will return the same buffer or the same-sized buffer.
|
||||
</remarks>
|
||||
<remarks>
|
||||
You must request a new buffer after calling Advance to continue writing more data and cannot write to a previously acquired buffer.
|
||||
</remarks>
|
||||
</member>
|
||||
<member name="T:System.Diagnostics.CodeAnalysis.AllowNullAttribute">
|
||||
<summary>Specifies that null is allowed as an input even if the corresponding type disallows it.</summary>
|
||||
</member>
|
||||
<member name="T:System.Diagnostics.CodeAnalysis.DisallowNullAttribute">
|
||||
<summary>Specifies that null is disallowed as an input even if the corresponding type allows it.</summary>
|
||||
</member>
|
||||
<member name="T:System.Diagnostics.CodeAnalysis.MaybeNullAttribute">
|
||||
<summary>Specifies that an output may be null even if the corresponding type disallows it.</summary>
|
||||
</member>
|
||||
<member name="T:System.Diagnostics.CodeAnalysis.NotNullAttribute">
|
||||
<summary>Specifies that an output will not be null even if the corresponding type allows it. Specifies that an input argument was not null when the call returns.</summary>
|
||||
</member>
|
||||
<member name="T:System.Diagnostics.CodeAnalysis.MaybeNullWhenAttribute">
|
||||
<summary>Specifies that when a method returns <see cref="P:System.Diagnostics.CodeAnalysis.MaybeNullWhenAttribute.ReturnValue"/>, the parameter may be null even if the corresponding type disallows it.</summary>
|
||||
</member>
|
||||
<member name="M:System.Diagnostics.CodeAnalysis.MaybeNullWhenAttribute.#ctor(System.Boolean)">
|
||||
<summary>Initializes the attribute with the specified return value condition.</summary>
|
||||
<param name="returnValue">
|
||||
The return value condition. If the method returns this value, the associated parameter may be null.
|
||||
</param>
|
||||
</member>
|
||||
<member name="P:System.Diagnostics.CodeAnalysis.MaybeNullWhenAttribute.ReturnValue">
|
||||
<summary>Gets the return value condition.</summary>
|
||||
</member>
|
||||
<member name="T:System.Diagnostics.CodeAnalysis.NotNullWhenAttribute">
|
||||
<summary>Specifies that when a method returns <see cref="P:System.Diagnostics.CodeAnalysis.NotNullWhenAttribute.ReturnValue"/>, the parameter will not be null even if the corresponding type allows it.</summary>
|
||||
</member>
|
||||
<member name="M:System.Diagnostics.CodeAnalysis.NotNullWhenAttribute.#ctor(System.Boolean)">
|
||||
<summary>Initializes the attribute with the specified return value condition.</summary>
|
||||
<param name="returnValue">
|
||||
The return value condition. If the method returns this value, the associated parameter will not be null.
|
||||
</param>
|
||||
</member>
|
||||
<member name="P:System.Diagnostics.CodeAnalysis.NotNullWhenAttribute.ReturnValue">
|
||||
<summary>Gets the return value condition.</summary>
|
||||
</member>
|
||||
<member name="T:System.Diagnostics.CodeAnalysis.NotNullIfNotNullAttribute">
|
||||
<summary>Specifies that the output will be non-null if the named parameter is non-null.</summary>
|
||||
</member>
|
||||
<member name="M:System.Diagnostics.CodeAnalysis.NotNullIfNotNullAttribute.#ctor(System.String)">
|
||||
<summary>Initializes the attribute with the associated parameter name.</summary>
|
||||
<param name="parameterName">
|
||||
The associated parameter name. The output will be non-null if the argument to the parameter specified is non-null.
|
||||
</param>
|
||||
</member>
|
||||
<member name="P:System.Diagnostics.CodeAnalysis.NotNullIfNotNullAttribute.ParameterName">
|
||||
<summary>Gets the associated parameter name.</summary>
|
||||
</member>
|
||||
<member name="T:System.Diagnostics.CodeAnalysis.DoesNotReturnAttribute">
|
||||
<summary>Applied to a method that will never return under any circumstance.</summary>
|
||||
</member>
|
||||
<member name="T:System.Diagnostics.CodeAnalysis.DoesNotReturnIfAttribute">
|
||||
<summary>Specifies that the method will not return if the associated Boolean parameter is passed the specified value.</summary>
|
||||
</member>
|
||||
<member name="M:System.Diagnostics.CodeAnalysis.DoesNotReturnIfAttribute.#ctor(System.Boolean)">
|
||||
<summary>Initializes the attribute with the specified parameter value.</summary>
|
||||
<param name="parameterValue">
|
||||
The condition parameter value. Code after the method will be considered unreachable by diagnostics if the argument to
|
||||
the associated parameter matches this value.
|
||||
</param>
|
||||
</member>
|
||||
<member name="P:System.Diagnostics.CodeAnalysis.DoesNotReturnIfAttribute.ParameterValue">
|
||||
<summary>Gets the condition parameter value.</summary>
|
||||
</member>
|
||||
<member name="T:System.Diagnostics.CodeAnalysis.MemberNotNullAttribute">
|
||||
<summary>Specifies that the method or property will ensure that the listed field and property members have not-null values.</summary>
|
||||
</member>
|
||||
<member name="M:System.Diagnostics.CodeAnalysis.MemberNotNullAttribute.#ctor(System.String)">
|
||||
<summary>Initializes the attribute with a field or property member.</summary>
|
||||
<param name="member">
|
||||
The field or property member that is promised to be not-null.
|
||||
</param>
|
||||
</member>
|
||||
<member name="M:System.Diagnostics.CodeAnalysis.MemberNotNullAttribute.#ctor(System.String[])">
|
||||
<summary>Initializes the attribute with the list of field and property members.</summary>
|
||||
<param name="members">
|
||||
The list of field and property members that are promised to be not-null.
|
||||
</param>
|
||||
</member>
|
||||
<member name="P:System.Diagnostics.CodeAnalysis.MemberNotNullAttribute.Members">
|
||||
<summary>Gets field or property member names.</summary>
|
||||
</member>
|
||||
<member name="T:System.Diagnostics.CodeAnalysis.MemberNotNullWhenAttribute">
|
||||
<summary>Specifies that the method or property will ensure that the listed field and property members have not-null values when returning with the specified return value condition.</summary>
|
||||
</member>
|
||||
<member name="M:System.Diagnostics.CodeAnalysis.MemberNotNullWhenAttribute.#ctor(System.Boolean,System.String)">
|
||||
<summary>Initializes the attribute with the specified return value condition and a field or property member.</summary>
|
||||
<param name="returnValue">
|
||||
The return value condition. If the method returns this value, the associated parameter will not be null.
|
||||
</param>
|
||||
<param name="member">
|
||||
The field or property member that is promised to be not-null.
|
||||
</param>
|
||||
</member>
|
||||
<member name="M:System.Diagnostics.CodeAnalysis.MemberNotNullWhenAttribute.#ctor(System.Boolean,System.String[])">
|
||||
<summary>Initializes the attribute with the specified return value condition and list of field and property members.</summary>
|
||||
<param name="returnValue">
|
||||
The return value condition. If the method returns this value, the associated parameter will not be null.
|
||||
</param>
|
||||
<param name="members">
|
||||
The list of field and property members that are promised to be not-null.
|
||||
</param>
|
||||
</member>
|
||||
<member name="P:System.Diagnostics.CodeAnalysis.MemberNotNullWhenAttribute.ReturnValue">
|
||||
<summary>Gets the return value condition.</summary>
|
||||
</member>
|
||||
<member name="P:System.Diagnostics.CodeAnalysis.MemberNotNullWhenAttribute.Members">
|
||||
<summary>Gets field or property member names.</summary>
|
||||
</member>
|
||||
</members>
|
||||
</doc>
|
||||
@@ -0,0 +1,765 @@
|
||||
<?xml version="1.0"?>
|
||||
<doc>
|
||||
<assembly>
|
||||
<name>Grpc.Net.Client</name>
|
||||
</assembly>
|
||||
<members>
|
||||
<member name="T:Grpc.Net.Client.Configuration.ConfigObject">
|
||||
<summary>
|
||||
Represents a configuration object. Implementations provide strongly typed wrappers over
|
||||
collections of untyped values.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Grpc.Net.Client.Configuration.ConfigObject.Inner">
|
||||
<summary>
|
||||
Gets the underlying configuration values.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="T:Grpc.Net.Client.Configuration.HedgingPolicy">
|
||||
<summary>
|
||||
The hedging policy for outgoing calls. Hedged calls may execute more than
|
||||
once on the server, so only idempotent methods should specify a hedging
|
||||
policy.
|
||||
</summary>
|
||||
<remarks>
|
||||
<para>
|
||||
Represents the <c>HedgingPolicy</c> message in <see href="https://github.com/grpc/grpc-proto/blob/master/grpc/service_config/service_config.proto"/>.
|
||||
</para>
|
||||
</remarks>
|
||||
</member>
|
||||
<member name="M:Grpc.Net.Client.Configuration.HedgingPolicy.#ctor">
|
||||
<summary>
|
||||
Initializes a new instance of the <see cref="T:Grpc.Net.Client.Configuration.HedgingPolicy"/> class.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Grpc.Net.Client.Configuration.HedgingPolicy.MaxAttempts">
|
||||
<summary>
|
||||
Gets or sets the maximum number of call attempts. This value includes the original attempt.
|
||||
The hedging policy will send up to this number of calls.
|
||||
|
||||
This property is required and must be 2 or greater.
|
||||
This value is limited by <see cref="P:Grpc.Net.Client.GrpcChannelOptions.MaxRetryAttempts"/>.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Grpc.Net.Client.Configuration.HedgingPolicy.HedgingDelay">
|
||||
<summary>
|
||||
Gets or sets the hedging delay.
|
||||
The first call will be sent immediately, but the subsequent
|
||||
hedged call will be sent at intervals of the specified delay.
|
||||
Set this to 0 or <c>null</c> to immediately send all hedged calls.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Grpc.Net.Client.Configuration.HedgingPolicy.NonFatalStatusCodes">
|
||||
<summary>
|
||||
Gets a collection of status codes which indicate other hedged calls may still
|
||||
succeed. If a non-fatal status code is returned by the server, hedged
|
||||
calls will continue. Otherwise, outstanding requests will be canceled and
|
||||
the error returned to the client application layer.
|
||||
|
||||
Specifying status codes is optional.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="T:Grpc.Net.Client.Configuration.LoadBalancingConfig">
|
||||
<summary>
|
||||
Base type for load balancer policy configuration.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:Grpc.Net.Client.Configuration.LoadBalancingConfig.PickFirstPolicyName">
|
||||
<summary>
|
||||
<c>pick_first</c> policy name.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:Grpc.Net.Client.Configuration.LoadBalancingConfig.RoundRobinPolicyName">
|
||||
<summary>
|
||||
<c>round_robin</c> policy name.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Grpc.Net.Client.Configuration.LoadBalancingConfig.#ctor(System.String)">
|
||||
<summary>
|
||||
Initializes a new instance of the <see cref="T:Grpc.Net.Client.Configuration.LoadBalancingConfig"/> class.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Grpc.Net.Client.Configuration.LoadBalancingConfig.PolicyName">
|
||||
<summary>
|
||||
Gets the load balancer policy name.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="T:Grpc.Net.Client.Configuration.MethodConfig">
|
||||
<summary>
|
||||
Configuration for a method.
|
||||
The <see cref="P:Grpc.Net.Client.Configuration.MethodConfig.Names"/> collection is used to determine which methods this configuration applies to.
|
||||
</summary>
|
||||
<remarks>
|
||||
<para>
|
||||
Represents the <c>MethodConfig</c> message in <see href="https://github.com/grpc/grpc-proto/blob/master/grpc/service_config/service_config.proto"/>.
|
||||
</para>
|
||||
</remarks>
|
||||
</member>
|
||||
<member name="M:Grpc.Net.Client.Configuration.MethodConfig.#ctor">
|
||||
<summary>
|
||||
Initializes a new instance of the <see cref="T:Grpc.Net.Client.Configuration.MethodConfig"/> class.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Grpc.Net.Client.Configuration.MethodConfig.RetryPolicy">
|
||||
<summary>
|
||||
Gets or sets the retry policy for outgoing calls.
|
||||
A retry policy can't be combined with <see cref="P:Grpc.Net.Client.Configuration.MethodConfig.HedgingPolicy"/>.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Grpc.Net.Client.Configuration.MethodConfig.HedgingPolicy">
|
||||
<summary>
|
||||
Gets or sets the hedging policy for outgoing calls. Hedged calls may execute
|
||||
more than once on the server, so only idempotent methods should specify a hedging
|
||||
policy. A hedging policy can't be combined with <see cref="P:Grpc.Net.Client.Configuration.MethodConfig.RetryPolicy"/>.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Grpc.Net.Client.Configuration.MethodConfig.Names">
|
||||
<summary>
|
||||
Gets a collection of names which determine the calls the method config will apply to.
|
||||
A <see cref="T:Grpc.Net.Client.Configuration.MethodConfig"/> without names won't be used. Each name must be unique
|
||||
across an entire <see cref="T:Grpc.Net.Client.Configuration.ServiceConfig"/>.
|
||||
</summary>
|
||||
<remarks>
|
||||
<para>
|
||||
If a name's <see cref="P:Grpc.Net.Client.Configuration.MethodName.Method"/> property isn't set then the method config is the default
|
||||
for all methods for the specified service.
|
||||
</para>
|
||||
<para>
|
||||
If a name's <see cref="P:Grpc.Net.Client.Configuration.MethodName.Service"/> property isn't set then <see cref="P:Grpc.Net.Client.Configuration.MethodName.Method"/> must also be unset,
|
||||
and the method config is the default for all methods on all services.
|
||||
<see cref="F:Grpc.Net.Client.Configuration.MethodName.Default"/> represents this global default name.
|
||||
</para>
|
||||
<para>
|
||||
When determining which method config to use for a given RPC, the most specific match wins. A method config
|
||||
with a configured <see cref="T:Grpc.Net.Client.Configuration.MethodName"/> that exactly matches a call's method and service will be used
|
||||
instead of a service or global default method config.
|
||||
</para>
|
||||
</remarks>
|
||||
</member>
|
||||
<member name="T:Grpc.Net.Client.Configuration.MethodName">
|
||||
<summary>
|
||||
The name of a method. Used to configure what calls a <see cref="T:Grpc.Net.Client.Configuration.MethodConfig"/> applies to using
|
||||
the <see cref="P:Grpc.Net.Client.Configuration.MethodConfig.Names"/> collection.
|
||||
</summary>
|
||||
<remarks>
|
||||
<para>
|
||||
Represents the <c>Name</c> message in <see href="https://github.com/grpc/grpc-proto/blob/master/grpc/service_config/service_config.proto"/>.
|
||||
</para>
|
||||
<para>
|
||||
If a name's <see cref="P:Grpc.Net.Client.Configuration.MethodName.Method"/> property isn't set then the method config is the default
|
||||
for all methods for the specified service.
|
||||
</para>
|
||||
<para>
|
||||
If a name's <see cref="P:Grpc.Net.Client.Configuration.MethodName.Service"/> property isn't set then <see cref="P:Grpc.Net.Client.Configuration.MethodName.Method"/> must also be unset,
|
||||
and the method config is the default for all methods on all services.
|
||||
<see cref="F:Grpc.Net.Client.Configuration.MethodName.Default"/> represents this global default name.
|
||||
</para>
|
||||
<para>
|
||||
When determining which method config to use for a given RPC, the most specific match wins. A method config
|
||||
with a configured <see cref="T:Grpc.Net.Client.Configuration.MethodName"/> that exactly matches a call's method and service will be used
|
||||
instead of a service or global default method config.
|
||||
</para>
|
||||
</remarks>
|
||||
</member>
|
||||
<member name="F:Grpc.Net.Client.Configuration.MethodName.Default">
|
||||
<summary>
|
||||
A global default name.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Grpc.Net.Client.Configuration.MethodName.#ctor">
|
||||
<summary>
|
||||
Initializes a new instance of the <see cref="T:Grpc.Net.Client.Configuration.MethodName"/> class.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Grpc.Net.Client.Configuration.MethodName.Service">
|
||||
<summary>
|
||||
Gets or sets the service name.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Grpc.Net.Client.Configuration.MethodName.Method">
|
||||
<summary>
|
||||
Gets or sets the method name.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="T:Grpc.Net.Client.Configuration.PickFirstConfig">
|
||||
<summary>
|
||||
Configuration for pick_first load balancer policy.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Grpc.Net.Client.Configuration.PickFirstConfig.#ctor">
|
||||
<summary>
|
||||
Initializes a new instance of the <see cref="T:Grpc.Net.Client.Configuration.PickFirstConfig"/> class.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="T:Grpc.Net.Client.Configuration.RetryPolicy">
|
||||
<summary>
|
||||
The retry policy for outgoing calls.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Grpc.Net.Client.Configuration.RetryPolicy.#ctor">
|
||||
<summary>
|
||||
Initializes a new instance of the <see cref="T:Grpc.Net.Client.Configuration.RetryPolicy"/> class.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Grpc.Net.Client.Configuration.RetryPolicy.MaxAttempts">
|
||||
<summary>
|
||||
Gets or sets the maximum number of call attempts. This value includes the original attempt.
|
||||
This property is required and must be greater than 1.
|
||||
This value is limited by <see cref="P:Grpc.Net.Client.GrpcChannelOptions.MaxRetryAttempts"/>.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Grpc.Net.Client.Configuration.RetryPolicy.InitialBackoff">
|
||||
<summary>
|
||||
Gets or sets the initial backoff.
|
||||
A randomized delay between 0 and the current backoff value will determine when the next
|
||||
retry attempt is made.
|
||||
This property is required and must be greater than zero.
|
||||
<para>
|
||||
The backoff will be multiplied by <see cref="P:Grpc.Net.Client.Configuration.RetryPolicy.BackoffMultiplier"/> after each retry
|
||||
attempt and will increase exponentially when the multiplier is greater than 1.
|
||||
</para>
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Grpc.Net.Client.Configuration.RetryPolicy.MaxBackoff">
|
||||
<summary>
|
||||
Gets or sets the maximum backoff.
|
||||
The maximum backoff places an upper limit on exponential backoff growth.
|
||||
This property is required and must be greater than zero.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Grpc.Net.Client.Configuration.RetryPolicy.BackoffMultiplier">
|
||||
<summary>
|
||||
Gets or sets the backoff multiplier.
|
||||
The backoff will be multiplied by <see cref="P:Grpc.Net.Client.Configuration.RetryPolicy.BackoffMultiplier"/> after each retry
|
||||
attempt and will increase exponentially when the multiplier is greater than 1.
|
||||
This property is required and must be greater than 0.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Grpc.Net.Client.Configuration.RetryPolicy.RetryableStatusCodes">
|
||||
<summary>
|
||||
Gets a collection of status codes which may be retried.
|
||||
At least one status code is required.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="T:Grpc.Net.Client.Configuration.RetryThrottlingPolicy">
|
||||
<summary>
|
||||
The retry throttling policy for a server.
|
||||
<para>
|
||||
For more information about configuring throttling, see <see href="https://github.com/grpc/proposal/blob/master/A6-client-retries.md#throttling-retry-attempts-and-hedged-rpcs"/>.
|
||||
</para>
|
||||
</summary>
|
||||
<remarks>
|
||||
<para>
|
||||
Represents the <c>RetryThrottlingPolicy</c> message in <see href="https://github.com/grpc/grpc-proto/blob/master/grpc/service_config/service_config.proto"/>.
|
||||
</para>
|
||||
</remarks>
|
||||
</member>
|
||||
<member name="M:Grpc.Net.Client.Configuration.RetryThrottlingPolicy.#ctor">
|
||||
<summary>
|
||||
Initializes a new instance of the <see cref="T:Grpc.Net.Client.Configuration.RetryThrottlingPolicy"/> class.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Grpc.Net.Client.Configuration.RetryThrottlingPolicy.MaxTokens">
|
||||
<summary>
|
||||
Gets or sets the maximum number of tokens.
|
||||
The number of tokens starts at <see cref="P:Grpc.Net.Client.Configuration.RetryThrottlingPolicy.MaxTokens"/> and the token count will
|
||||
always be between 0 and <see cref="P:Grpc.Net.Client.Configuration.RetryThrottlingPolicy.MaxTokens"/>.
|
||||
This property is required and must be greater than zero.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Grpc.Net.Client.Configuration.RetryThrottlingPolicy.TokenRatio">
|
||||
<summary>
|
||||
Gets or sets the amount of tokens to add on each successful call. Typically this will
|
||||
be some number between 0 and 1, e.g., 0.1.
|
||||
This property is required and must be greater than zero. Up to 3 decimal places are supported.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="T:Grpc.Net.Client.Configuration.RoundRobinConfig">
|
||||
<summary>
|
||||
Configuration for pick_first load balancer policy.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Grpc.Net.Client.Configuration.RoundRobinConfig.#ctor">
|
||||
<summary>
|
||||
Initializes a new instance of the <see cref="T:Grpc.Net.Client.Configuration.RoundRobinConfig"/> class.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="T:Grpc.Net.Client.Configuration.ServiceConfig">
|
||||
<summary>
|
||||
A <see cref="T:Grpc.Net.Client.Configuration.ServiceConfig"/> represents information about a service.
|
||||
</summary>
|
||||
<remarks>
|
||||
<para>
|
||||
Represents the <c>ServiceConfig</c> message in <see href="https://github.com/grpc/grpc-proto/blob/master/grpc/service_config/service_config.proto"/>.
|
||||
</para>
|
||||
</remarks>
|
||||
</member>
|
||||
<member name="M:Grpc.Net.Client.Configuration.ServiceConfig.#ctor">
|
||||
<summary>
|
||||
Initializes a new instance of the <see cref="T:Grpc.Net.Client.Configuration.ServiceConfig"/> class.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Grpc.Net.Client.Configuration.ServiceConfig.LoadBalancingConfigs">
|
||||
<summary>
|
||||
Gets a collection of <see cref="T:Grpc.Net.Client.Configuration.LoadBalancingConfig"/> instances. The client will iterate
|
||||
through the configured policies in order and use the first policy that is supported.
|
||||
If none are supported by the client then a configuration error is thrown.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Grpc.Net.Client.Configuration.ServiceConfig.MethodConfigs">
|
||||
<summary>
|
||||
Gets a collection of <see cref="T:Grpc.Net.Client.Configuration.MethodConfig"/> instances. This collection is used to specify
|
||||
configuration on a per-method basis. <see cref="P:Grpc.Net.Client.Configuration.MethodConfig.Names"/> determines which calls
|
||||
a method config applies to.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Grpc.Net.Client.Configuration.ServiceConfig.RetryThrottling">
|
||||
<summary>
|
||||
Gets or sets the retry throttling policy.
|
||||
If a <see cref="T:Grpc.Net.Client.Configuration.RetryThrottlingPolicy"/> is provided, gRPC will automatically throttle
|
||||
retry attempts and hedged RPCs when the client's ratio of failures to
|
||||
successes exceeds a threshold.
|
||||
<para>
|
||||
For more information about configuring throttling, see <see href="https://github.com/grpc/proposal/blob/master/A6-client-retries.md#throttling-retry-attempts-and-hedged-rpcs"/>.
|
||||
</para>
|
||||
</summary>
|
||||
</member>
|
||||
<member name="T:Grpc.Net.Client.GrpcChannel">
|
||||
<summary>
|
||||
Represents a gRPC channel. Channels are an abstraction of long-lived connections to remote servers.
|
||||
Client objects can reuse the same channel. Creating a channel is an expensive operation compared to invoking
|
||||
a remote call so in general you should reuse a single channel for as many calls as possible.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Grpc.Net.Client.GrpcChannel.CreateCallInvoker">
|
||||
<summary>
|
||||
Create a new <see cref="T:Grpc.Core.CallInvoker"/> for the channel.
|
||||
</summary>
|
||||
<returns>A new <see cref="T:Grpc.Core.CallInvoker"/>.</returns>
|
||||
</member>
|
||||
<member name="M:Grpc.Net.Client.GrpcChannel.ForAddress(System.String)">
|
||||
<summary>
|
||||
Creates a <see cref="T:Grpc.Net.Client.GrpcChannel"/> for the specified address.
|
||||
</summary>
|
||||
<param name="address">The address the channel will use.</param>
|
||||
<returns>A new instance of <see cref="T:Grpc.Net.Client.GrpcChannel"/>.</returns>
|
||||
</member>
|
||||
<member name="M:Grpc.Net.Client.GrpcChannel.ForAddress(System.String,Grpc.Net.Client.GrpcChannelOptions)">
|
||||
<summary>
|
||||
Creates a <see cref="T:Grpc.Net.Client.GrpcChannel"/> for the specified address and configuration options.
|
||||
</summary>
|
||||
<param name="address">The address the channel will use.</param>
|
||||
<param name="channelOptions">The channel configuration options.</param>
|
||||
<returns>A new instance of <see cref="T:Grpc.Net.Client.GrpcChannel"/>.</returns>
|
||||
</member>
|
||||
<member name="M:Grpc.Net.Client.GrpcChannel.ForAddress(System.Uri)">
|
||||
<summary>
|
||||
Creates a <see cref="T:Grpc.Net.Client.GrpcChannel"/> for the specified address.
|
||||
</summary>
|
||||
<param name="address">The address the channel will use.</param>
|
||||
<returns>A new instance of <see cref="T:Grpc.Net.Client.GrpcChannel"/>.</returns>
|
||||
</member>
|
||||
<member name="M:Grpc.Net.Client.GrpcChannel.ForAddress(System.Uri,Grpc.Net.Client.GrpcChannelOptions)">
|
||||
<summary>
|
||||
Creates a <see cref="T:Grpc.Net.Client.GrpcChannel"/> for the specified address and configuration options.
|
||||
</summary>
|
||||
<param name="address">The address the channel will use.</param>
|
||||
<param name="channelOptions">The channel configuration options.</param>
|
||||
<returns>A new instance of <see cref="T:Grpc.Net.Client.GrpcChannel"/>.</returns>
|
||||
</member>
|
||||
<member name="M:Grpc.Net.Client.GrpcChannel.Dispose">
|
||||
<summary>
|
||||
Releases the resources used by the <see cref="T:Grpc.Net.Client.GrpcChannel"/> class.
|
||||
Clients created with the channel can't be used after the channel is disposed.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="T:Grpc.Net.Client.GrpcChannelOptions">
|
||||
<summary>
|
||||
An options class for configuring a <see cref="T:Grpc.Net.Client.GrpcChannel"/>.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Grpc.Net.Client.GrpcChannelOptions.Credentials">
|
||||
<summary>
|
||||
Gets or sets the credentials for the channel. This setting is used to set <see cref="T:Grpc.Core.ChannelCredentials"/> for
|
||||
a channel. Connection transport layer security (TLS) is determined by the address used to create the channel.
|
||||
</summary>
|
||||
<remarks>
|
||||
<para>
|
||||
The channel credentials you use must match the address TLS setting. Use <see cref="P:Grpc.Core.ChannelCredentials.Insecure"/>
|
||||
for an "http" address and <see cref="P:Grpc.Core.ChannelCredentials.SecureSsl"/> for "https".
|
||||
</para>
|
||||
<para>
|
||||
The underlying <see cref="T:System.Net.Http.HttpClient"/> used by the channel automatically loads root certificates
|
||||
from the operating system certificate store.
|
||||
Client certificates should be configured on HttpClient. See <see href="https://aka.ms/aspnet/grpc/certauth"/> for details.
|
||||
</para>
|
||||
</remarks>
|
||||
</member>
|
||||
<member name="P:Grpc.Net.Client.GrpcChannelOptions.MaxSendMessageSize">
|
||||
<summary>
|
||||
Gets or sets the maximum message size in bytes that can be sent from the client. Attempting to send a message
|
||||
that exceeds the configured maximum message size results in an exception.
|
||||
<para>
|
||||
A <c>null</c> value removes the maximum message size limit. Defaults to <c>null</c>.
|
||||
</para>
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Grpc.Net.Client.GrpcChannelOptions.MaxReceiveMessageSize">
|
||||
<summary>
|
||||
Gets or sets the maximum message size in bytes that can be received by the client. If the client receives a
|
||||
message that exceeds this limit, it throws an exception.
|
||||
<para>
|
||||
A <c>null</c> value removes the maximum message size limit. Defaults to 4,194,304 (4 MB).
|
||||
</para>
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Grpc.Net.Client.GrpcChannelOptions.MaxRetryAttempts">
|
||||
<summary>
|
||||
Gets or sets the maximum retry attempts. This value limits any retry and hedging attempt values specified in
|
||||
the service config.
|
||||
<para>
|
||||
Setting this value alone doesn't enable retries. Retries are enabled in the service config, which can be done
|
||||
using <see cref="P:Grpc.Net.Client.GrpcChannelOptions.ServiceConfig"/>.
|
||||
</para>
|
||||
<para>
|
||||
A <c>null</c> value removes the maximum retry attempts limit. Defaults to 5.
|
||||
</para>
|
||||
<para>
|
||||
Note: Experimental API that can change or be removed without any prior notice.
|
||||
</para>
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Grpc.Net.Client.GrpcChannelOptions.MaxRetryBufferSize">
|
||||
<summary>
|
||||
Gets or sets the maximum buffer size in bytes that can be used to store sent messages when retrying
|
||||
or hedging calls. If the buffer limit is exceeded, then no more retry attempts are made and all
|
||||
hedging calls but one will be canceled. This limit is applied across all calls made using the channel.
|
||||
<para>
|
||||
Setting this value alone doesn't enable retries. Retries are enabled in the service config, which can be done
|
||||
using <see cref="P:Grpc.Net.Client.GrpcChannelOptions.ServiceConfig"/>.
|
||||
</para>
|
||||
<para>
|
||||
A <c>null</c> value removes the maximum retry buffer size limit. Defaults to 16,777,216 (16 MB).
|
||||
</para>
|
||||
<para>
|
||||
Note: Experimental API that can change or be removed without any prior notice.
|
||||
</para>
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Grpc.Net.Client.GrpcChannelOptions.MaxRetryBufferPerCallSize">
|
||||
<summary>
|
||||
Gets or sets the maximum buffer size in bytes that can be used to store sent messages when retrying
|
||||
or hedging calls. If the buffer limit is exceeded, then no more retry attempts are made and all
|
||||
hedging calls but one will be canceled. This limit is applied to one call.
|
||||
<para>
|
||||
Setting this value alone doesn't enable retries. Retries are enabled in the service config, which can be done
|
||||
using <see cref="P:Grpc.Net.Client.GrpcChannelOptions.ServiceConfig"/>.
|
||||
</para>
|
||||
<para>
|
||||
A <c>null</c> value removes the maximum retry buffer size limit per call. Defaults to 1,048,576 (1 MB).
|
||||
</para>
|
||||
<para>
|
||||
Note: Experimental API that can change or be removed without any prior notice.
|
||||
</para>
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Grpc.Net.Client.GrpcChannelOptions.CompressionProviders">
|
||||
<summary>
|
||||
Gets or sets a collection of compression providers.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Grpc.Net.Client.GrpcChannelOptions.LoggerFactory">
|
||||
<summary>
|
||||
Gets or sets the logger factory used by the channel. If no value is specified then the channel
|
||||
attempts to resolve an <see cref="T:Microsoft.Extensions.Logging.ILoggerFactory"/> from the <see cref="P:Grpc.Net.Client.GrpcChannelOptions.ServiceProvider"/>.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Grpc.Net.Client.GrpcChannelOptions.HttpClient">
|
||||
<summary>
|
||||
Gets or sets the <see cref="T:System.Net.Http.HttpClient"/> used by the channel to make HTTP calls.
|
||||
</summary>
|
||||
<remarks>
|
||||
<para>
|
||||
By default a <see cref="T:System.Net.Http.HttpClient"/> specified here will not be disposed with the channel.
|
||||
To dispose the <see cref="T:System.Net.Http.HttpClient"/> with the channel you must set <see cref="P:Grpc.Net.Client.GrpcChannelOptions.DisposeHttpClient"/>
|
||||
to <c>true</c>.
|
||||
</para>
|
||||
<para>
|
||||
Only one HTTP caller can be specified for a channel. An error will be thrown if this is configured
|
||||
together with <see cref="P:Grpc.Net.Client.GrpcChannelOptions.HttpHandler"/>.
|
||||
</para>
|
||||
</remarks>
|
||||
</member>
|
||||
<member name="P:Grpc.Net.Client.GrpcChannelOptions.HttpHandler">
|
||||
<summary>
|
||||
Gets or sets the <see cref="T:System.Net.Http.HttpMessageHandler"/> used by the channel to make HTTP calls.
|
||||
</summary>
|
||||
<remarks>
|
||||
<para>
|
||||
By default a <see cref="T:System.Net.Http.HttpMessageHandler"/> specified here will not be disposed with the channel.
|
||||
To dispose the <see cref="T:System.Net.Http.HttpMessageHandler"/> with the channel you must set <see cref="P:Grpc.Net.Client.GrpcChannelOptions.DisposeHttpClient"/>
|
||||
to <c>true</c>.
|
||||
</para>
|
||||
<para>
|
||||
Only one HTTP caller can be specified for a channel. An error will be thrown if this is configured
|
||||
together with <see cref="P:Grpc.Net.Client.GrpcChannelOptions.HttpClient"/>.
|
||||
</para>
|
||||
</remarks>
|
||||
</member>
|
||||
<member name="P:Grpc.Net.Client.GrpcChannelOptions.DisposeHttpClient">
|
||||
<summary>
|
||||
Gets or sets a value indicating whether the underlying <see cref="T:System.Net.Http.HttpClient"/> or
|
||||
<see cref="T:System.Net.Http.HttpMessageHandler"/> should be disposed when the <see cref="T:Grpc.Net.Client.GrpcChannel"/> instance is disposed.
|
||||
The default value is <c>false</c>.
|
||||
</summary>
|
||||
<remarks>
|
||||
This setting is used when a <see cref="P:Grpc.Net.Client.GrpcChannelOptions.HttpClient"/> or <see cref="P:Grpc.Net.Client.GrpcChannelOptions.HttpHandler"/> value is specified.
|
||||
If they are not specified then the channel will create an internal HTTP caller that is always disposed
|
||||
when the channel is disposed.
|
||||
</remarks>
|
||||
</member>
|
||||
<member name="P:Grpc.Net.Client.GrpcChannelOptions.ThrowOperationCanceledOnCancellation">
|
||||
<summary>
|
||||
Gets or sets a value indicating whether clients will throw <see cref="T:System.OperationCanceledException"/> for a call when its
|
||||
<see cref="P:Grpc.Core.CallOptions.CancellationToken"/> is triggered or its <see cref="P:Grpc.Core.CallOptions.Deadline"/> is exceeded.
|
||||
The default value is <c>false</c>.
|
||||
<para>
|
||||
Note: Experimental API that can change or be removed without any prior notice.
|
||||
</para>
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Grpc.Net.Client.GrpcChannelOptions.UnsafeUseInsecureChannelCallCredentials">
|
||||
<summary>
|
||||
Gets or sets a value indicating whether a gRPC call's <see cref="T:Grpc.Core.CallCredentials"/> are used by an insecure channel.
|
||||
The default value is <c>false</c>.
|
||||
<para>
|
||||
Note: Experimental API that can change or be removed without any prior notice.
|
||||
</para>
|
||||
</summary>
|
||||
<remarks>
|
||||
<para>
|
||||
The default value for this property is <c>false</c>, which causes an insecure channel to ignore a gRPC call's <see cref="T:Grpc.Core.CallCredentials"/>.
|
||||
Sending authentication headers over an insecure connection has security implications and shouldn't be done in production environments.
|
||||
</para>
|
||||
<para>
|
||||
If this property is set to <c>true</c>, call credentials are always used by a channel.
|
||||
</para>
|
||||
</remarks>
|
||||
</member>
|
||||
<member name="P:Grpc.Net.Client.GrpcChannelOptions.ServiceConfig">
|
||||
<summary>
|
||||
Gets or sets the service config for a gRPC channel. A service config allows service owners to publish parameters
|
||||
to be automatically used by all clients of their service. A service config can also be specified by a client
|
||||
using this property.
|
||||
<para>
|
||||
Note: Experimental API that can change or be removed without any prior notice.
|
||||
</para>
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Grpc.Net.Client.GrpcChannelOptions.ServiceProvider">
|
||||
<summary>
|
||||
Gets or sets the <see cref="T:System.IServiceProvider"/> the channel uses to resolve types.
|
||||
<para>
|
||||
Note: Experimental API that can change or be removed without any prior notice.
|
||||
</para>
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Grpc.Net.Client.GrpcChannelOptions.#ctor">
|
||||
<summary>
|
||||
Initializes a new instance of the <see cref="T:Grpc.Net.Client.GrpcChannelOptions"/> class.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Grpc.Net.Client.Internal.ClientStreamWriterBase`1.IsWriteInProgressUnsynchronized">
|
||||
<summary>
|
||||
A value indicating whether there is an async write already in progress.
|
||||
Should only check this property when holding the write lock.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Grpc.Net.Client.Internal.GrpcCall`2.Cleanup(Grpc.Core.Status)">
|
||||
<summary>
|
||||
Clean up can be called by:
|
||||
1. The user. AsyncUnaryCall.Dispose et al will call this on Dispose
|
||||
2. <see cref="M:Grpc.Net.Client.Internal.GrpcCall.ValidateHeaders(System.Net.Http.HttpResponseMessage,Grpc.Core.Metadata@)"/> will call dispose if errors fail validation
|
||||
3. <see cref="M:Grpc.Net.Client.Internal.GrpcCall`2.FinishResponseAndCleanUp(Grpc.Core.Status)"/> will call dispose
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Grpc.Net.Client.Internal.GrpcCall`2.ResponseStreamEnded(Grpc.Core.Status,System.Boolean)">
|
||||
<summary>
|
||||
Used by response stream reader to report it is finished.
|
||||
</summary>
|
||||
<param name="status">The completed response status code.</param>
|
||||
<param name="finishedGracefully">true when the end of the response stream was read, otherwise false.</param>
|
||||
</member>
|
||||
<member name="M:Grpc.Net.Client.Internal.GrpcCall`2.ResolveException(System.String,System.Exception,System.Nullable{Grpc.Core.Status}@,System.Exception@)">
|
||||
<summary>
|
||||
Resolve the specified exception to an end-user exception that will be thrown from the client.
|
||||
The resolved exception is normally a RpcException. Returns true when the resolved exception is changed.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Grpc.Net.Client.Internal.GrpcCallSerializationContext.GetWrittenPayload">
|
||||
<summary>
|
||||
Obtains the payload from this operation. Error is thrown if complete hasn't been called.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="T:Grpc.Net.Client.Internal.GrpcMethodInfo">
|
||||
<summary>
|
||||
Cached log scope and URI for a gRPC <see cref="T:Grpc.Core.IMethod"/>.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Grpc.Net.Client.Internal.GrpcProtocolConstants.GetDebugEnumerator(Grpc.Core.ChannelBase,Grpc.Core.IMethod,System.Object)">
|
||||
<summary>
|
||||
Gets key value pairs used by debugging. These are provided as an enumerator instead of a dictionary
|
||||
because it's one method to implement an enumerator on gRPC calls compared to a dozen members for a dictionary.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Grpc.Net.Client.Internal.GrpcProtocolHelpers.ResolveRpcExceptionStatusCode(System.Exception)">
|
||||
<summary>
|
||||
Resolve the exception from HttpClient to a gRPC status code.
|
||||
<param name="ex">The <see cref="T:System.Exception"/> to resolve a <see cref="T:Grpc.Core.StatusCode"/> from.</param>
|
||||
</summary>
|
||||
</member>
|
||||
<member name="T:Grpc.Net.Client.Internal.Http.WinHttpUnaryContent`2">
|
||||
<summary>
|
||||
WinHttp doesn't support streaming request data so a length needs to be specified.
|
||||
This HttpContent pre-serializes the payload so it has a length available.
|
||||
The payload is then written directly to the request using specialized context
|
||||
and serializer method.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="T:Grpc.Net.Client.Internal.HttpClientCallInvoker">
|
||||
<summary>
|
||||
A client-side RPC invocation using HttpClient.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Grpc.Net.Client.Internal.HttpClientCallInvoker.AsyncClientStreamingCall``2(Grpc.Core.Method{``0,``1},System.String,Grpc.Core.CallOptions)">
|
||||
<summary>
|
||||
Invokes a client streaming call asynchronously.
|
||||
In client streaming scenario, client sends a stream of requests and server responds with a single response.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Grpc.Net.Client.Internal.HttpClientCallInvoker.AsyncDuplexStreamingCall``2(Grpc.Core.Method{``0,``1},System.String,Grpc.Core.CallOptions)">
|
||||
<summary>
|
||||
Invokes a duplex streaming call asynchronously.
|
||||
In duplex streaming scenario, client sends a stream of requests and server responds with a stream of responses.
|
||||
The response stream is completely independent and both side can be sending messages at the same time.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Grpc.Net.Client.Internal.HttpClientCallInvoker.AsyncServerStreamingCall``2(Grpc.Core.Method{``0,``1},System.String,Grpc.Core.CallOptions,``0)">
|
||||
<summary>
|
||||
Invokes a server streaming call asynchronously.
|
||||
In server streaming scenario, client sends on request and server responds with a stream of responses.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Grpc.Net.Client.Internal.HttpClientCallInvoker.AsyncUnaryCall``2(Grpc.Core.Method{``0,``1},System.String,Grpc.Core.CallOptions,``0)">
|
||||
<summary>
|
||||
Invokes a simple remote call asynchronously.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Grpc.Net.Client.Internal.HttpClientCallInvoker.BlockingUnaryCall``2(Grpc.Core.Method{``0,``1},System.String,Grpc.Core.CallOptions,``0)">
|
||||
<summary>
|
||||
Invokes a simple remote call in a blocking fashion.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Grpc.Net.Client.Internal.HttpContentClientStreamReader`2.IsMoveNextInProgressUnsynchronized">
|
||||
<summary>
|
||||
A value indicating whether there is an async move next already in progress.
|
||||
Should only check this property when holding the move next lock.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="T:Grpc.Net.Client.Internal.Native">
|
||||
<summary>
|
||||
Types for calling RtlGetVersion. See https://www.pinvoke.net/default.aspx/ntdll/RtlGetVersion.html
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:Grpc.Net.Client.Internal.Native.NTSTATUS.STATUS_SUCCESS">
|
||||
<summary>
|
||||
The operation completed successfully.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Grpc.Net.Client.Internal.TaskExtensions.ObserveException(System.Threading.Tasks.Task)">
|
||||
<summary>
|
||||
Observes and ignores a potential exception on a given Task.
|
||||
If a Task fails and throws an exception which is never observed, it will be caught by the .NET finalizer thread.
|
||||
This function awaits the given task and if the exception is thrown, it observes this exception and simply ignores it.
|
||||
This will prevent the escalation of this exception to the .NET finalizer thread.
|
||||
</summary>
|
||||
<param name="task">The task to be ignored.</param>
|
||||
</member>
|
||||
<member name="M:Grpc.Net.Client.Internal.UserAgentGenerator.GetUserAgentString">
|
||||
<summary>
|
||||
Generates a user agent string to be transported in headers.
|
||||
<example>
|
||||
grpc-dotnet/2.41.0-dev (.NET 6.0.0-preview.7.21377.19; CLR 6.0.0; net6.0; osx; x64)
|
||||
grpc-dotnet/2.41.0-dev (Mono 6.12.0.140; CLR 4.0.30319; netstandard2.0; osx; x64)
|
||||
grpc-dotnet/2.41.0-dev (.NET 6.0.0-rc.1.21380.1; CLR 6.0.0; net6.0; linux; arm64)
|
||||
grpc-dotnet/2.41.0-dev (.NET 5.0.8; CLR 5.0.8; net5.0; linux; arm64)
|
||||
grpc-dotnet/2.41.0-dev (.NET Core; CLR 3.1.4; netstandard2.1; linux; arm64)
|
||||
grpc-dotnet/2.41.0-dev (.NET Framework; CLR 4.0.30319.42000; netstandard2.0; windows; x86)
|
||||
grpc-dotnet/2.41.0-dev (.NET 6.0.0-rc.1.21380.1; CLR 6.0.0; net6.0; windows; x64)
|
||||
</example>
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Grpc.Shared.ObjectDisposedThrowHelper.ThrowIf(System.Boolean,System.Object)">
|
||||
<summary>Throws an <see cref="T:System.ObjectDisposedException"/> if the specified <paramref name="condition"/> is <see langword="true"/>.</summary>
|
||||
<param name="condition">The condition to evaluate.</param>
|
||||
<param name="instance">The object whose type's full name should be included in any resulting <see cref="T:System.ObjectDisposedException"/>.</param>
|
||||
<exception cref="T:System.ObjectDisposedException">The <paramref name="condition"/> is <see langword="true"/>.</exception>
|
||||
</member>
|
||||
<member name="M:Grpc.Shared.ObjectDisposedThrowHelper.ThrowIf(System.Boolean,System.Type)">
|
||||
<summary>Throws an <see cref="T:System.ObjectDisposedException"/> if the specified <paramref name="condition"/> is <see langword="true"/>.</summary>
|
||||
<param name="condition">The condition to evaluate.</param>
|
||||
<param name="type">The type whose full name should be included in any resulting <see cref="T:System.ObjectDisposedException"/>.</param>
|
||||
<exception cref="T:System.ObjectDisposedException">The <paramref name="condition"/> is <see langword="true"/>.</exception>
|
||||
</member>
|
||||
<member name="M:Grpc.Shared.ArgumentNullThrowHelper.ThrowIfNull(System.Object,System.String)">
|
||||
<summary>Throws an <see cref="T:System.ArgumentNullException"/> if <paramref name="argument"/> is null.</summary>
|
||||
<param name="argument">The reference type argument to validate as non-null.</param>
|
||||
<param name="paramName">The name of the parameter with which <paramref name="argument"/> corresponds.</param>
|
||||
</member>
|
||||
<member name="T:System.Diagnostics.CodeAnalysis.MemberNotNullAttribute">
|
||||
<summary>Specifies that the method or property will ensure that the listed field and property members have not-null values.</summary>
|
||||
</member>
|
||||
<member name="M:System.Diagnostics.CodeAnalysis.MemberNotNullAttribute.#ctor(System.String)">
|
||||
<summary>Initializes the attribute with a field or property member.</summary>
|
||||
<param name="member">
|
||||
The field or property member that is promised to be not-null.
|
||||
</param>
|
||||
</member>
|
||||
<member name="M:System.Diagnostics.CodeAnalysis.MemberNotNullAttribute.#ctor(System.String[])">
|
||||
<summary>Initializes the attribute with the list of field and property members.</summary>
|
||||
<param name="members">
|
||||
The list of field and property members that are promised to be not-null.
|
||||
</param>
|
||||
</member>
|
||||
<member name="P:System.Diagnostics.CodeAnalysis.MemberNotNullAttribute.Members">
|
||||
<summary>Gets field or property member names.</summary>
|
||||
</member>
|
||||
<member name="T:System.Diagnostics.CodeAnalysis.MemberNotNullWhenAttribute">
|
||||
<summary>Specifies that the method or property will ensure that the listed field and property members have not-null values when returning with the specified return value condition.</summary>
|
||||
</member>
|
||||
<member name="M:System.Diagnostics.CodeAnalysis.MemberNotNullWhenAttribute.#ctor(System.Boolean,System.String)">
|
||||
<summary>Initializes the attribute with the specified return value condition and a field or property member.</summary>
|
||||
<param name="returnValue">
|
||||
The return value condition. If the method returns this value, the associated parameter will not be null.
|
||||
</param>
|
||||
<param name="member">
|
||||
The field or property member that is promised to be not-null.
|
||||
</param>
|
||||
</member>
|
||||
<member name="M:System.Diagnostics.CodeAnalysis.MemberNotNullWhenAttribute.#ctor(System.Boolean,System.String[])">
|
||||
<summary>Initializes the attribute with the specified return value condition and list of field and property members.</summary>
|
||||
<param name="returnValue">
|
||||
The return value condition. If the method returns this value, the associated parameter will not be null.
|
||||
</param>
|
||||
<param name="members">
|
||||
The list of field and property members that are promised to be not-null.
|
||||
</param>
|
||||
</member>
|
||||
<member name="P:System.Diagnostics.CodeAnalysis.MemberNotNullWhenAttribute.ReturnValue">
|
||||
<summary>Gets the return value condition.</summary>
|
||||
</member>
|
||||
<member name="P:System.Diagnostics.CodeAnalysis.MemberNotNullWhenAttribute.Members">
|
||||
<summary>Gets field or property member names.</summary>
|
||||
</member>
|
||||
</members>
|
||||
</doc>
|
||||
BIN
local-nuget/grpc.net.client/2.65.0/packageIcon.png
Normal file
BIN
local-nuget/grpc.net.client/2.65.0/packageIcon.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 30 KiB |
Reference in New Issue
Block a user