351 lines
16 KiB
HTML
351 lines
16 KiB
HTML
<!DOCTYPE html>
|
|
<!--[if IE]><![endif]-->
|
|
<html>
|
|
|
|
<head>
|
|
<meta charset="utf-8">
|
|
<meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1">
|
|
<title>Class GrpcChannelOptions
|
|
| gRPC for .NET </title>
|
|
<meta name="viewport" content="width=device-width">
|
|
<meta name="title" content="Class GrpcChannelOptions
|
|
| gRPC for .NET ">
|
|
<meta name="generator" content="docfx 2.36.0.0">
|
|
|
|
<link rel="shortcut icon" href="../favicon.ico">
|
|
<link rel="stylesheet" href="../styles/docfx.vendor.css">
|
|
<link rel="stylesheet" href="../styles/docfx.css">
|
|
<link rel="stylesheet" href="../styles/main.css">
|
|
<meta property="docfx:navrel" content="../toc.html">
|
|
<meta property="docfx:tocrel" content="toc.html">
|
|
|
|
<meta property="docfx:rel" content="../">
|
|
|
|
</head>
|
|
<body data-spy="scroll" data-target="#affix" data-offset="120">
|
|
<div id="wrapper">
|
|
<header>
|
|
|
|
<nav id="autocollapse" class="navbar navbar-inverse ng-scope" role="navigation">
|
|
<div class="container">
|
|
<div class="navbar-header">
|
|
<button type="button" class="navbar-toggle" data-toggle="collapse" data-target="#navbar">
|
|
<span class="sr-only">Toggle navigation</span>
|
|
<span class="icon-bar"></span>
|
|
<span class="icon-bar"></span>
|
|
<span class="icon-bar"></span>
|
|
</button>
|
|
|
|
<a class="navbar-brand" href="../index.html">
|
|
<img id="logo" class="svg" src="../logo.svg" alt="">
|
|
</a>
|
|
</div>
|
|
<div class="collapse navbar-collapse" id="navbar">
|
|
<form class="navbar-form navbar-right" role="search" id="search">
|
|
<div class="form-group">
|
|
<input type="text" class="form-control" id="search-query" placeholder="Search" autocomplete="off">
|
|
</div>
|
|
</form>
|
|
</div>
|
|
</div>
|
|
</nav>
|
|
|
|
<div class="subnav navbar navbar-default">
|
|
<div class="container hide-when-search" id="breadcrumb">
|
|
<ul class="breadcrumb">
|
|
<li></li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
</header>
|
|
<div class="container body-content">
|
|
|
|
<div id="search-results">
|
|
<div class="search-list"></div>
|
|
<div class="sr-items">
|
|
<p><i class="glyphicon glyphicon-refresh index-loading"></i></p>
|
|
</div>
|
|
<ul id="pagination"></ul>
|
|
</div>
|
|
</div>
|
|
<div role="main" class="container body-content hide-when-search">
|
|
|
|
<div class="sidenav hide-when-search">
|
|
<a class="btn toc-toggle collapse" data-toggle="collapse" href="#sidetoggle" aria-expanded="false" aria-controls="sidetoggle">Show / Hide Table of Contents</a>
|
|
<div class="sidetoggle collapse" id="sidetoggle">
|
|
<div id="sidetoc"></div>
|
|
</div>
|
|
</div>
|
|
<div class="article row grid-right">
|
|
<div class="col-md-10">
|
|
<article class="content wrap" id="_content" data-uid="Grpc.Net.Client.GrpcChannelOptions">
|
|
|
|
|
|
<h1 id="Grpc_Net_Client_GrpcChannelOptions" data-uid="Grpc.Net.Client.GrpcChannelOptions" class="text-break">Class GrpcChannelOptions
|
|
</h1>
|
|
<div class="markdown level0 summary"><p>An options class for configuring a <a class="xref" href="Grpc.Net.Client.GrpcChannel.html">GrpcChannel</a>.</p>
|
|
</div>
|
|
<div class="markdown level0 conceptual"></div>
|
|
<div class="inheritance">
|
|
<h5>Inheritance</h5>
|
|
<div class="level0"><span class="xref">System.Object</span></div>
|
|
<div class="level1"><span class="xref">GrpcChannelOptions</span></div>
|
|
</div>
|
|
<h6><strong>Namespace</strong>: <a class="xref" href="Grpc.Net.Client.html">Grpc.Net.Client</a></h6>
|
|
<h6><strong>Assembly</strong>: Grpc.Net.Client.dll</h6>
|
|
<h5 id="Grpc_Net_Client_GrpcChannelOptions_syntax">Syntax</h5>
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public sealed class GrpcChannelOptions : object</code></pre>
|
|
</div>
|
|
<h3 id="constructors">Constructors
|
|
</h3>
|
|
<a id="Grpc_Net_Client_GrpcChannelOptions__ctor_" data-uid="Grpc.Net.Client.GrpcChannelOptions.#ctor*"></a>
|
|
<h4 id="Grpc_Net_Client_GrpcChannelOptions__ctor" data-uid="Grpc.Net.Client.GrpcChannelOptions.#ctor">GrpcChannelOptions()</h4>
|
|
<div class="markdown level1 summary"><p>Initializes a new instance of the <a class="xref" href="Grpc.Net.Client.GrpcChannelOptions.html">GrpcChannelOptions</a> class.</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
<h5 class="decalaration">Declaration</h5>
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public GrpcChannelOptions()</code></pre>
|
|
</div>
|
|
<h3 id="properties">Properties
|
|
</h3>
|
|
<a id="Grpc_Net_Client_GrpcChannelOptions_CompressionProviders_" data-uid="Grpc.Net.Client.GrpcChannelOptions.CompressionProviders*"></a>
|
|
<h4 id="Grpc_Net_Client_GrpcChannelOptions_CompressionProviders" data-uid="Grpc.Net.Client.GrpcChannelOptions.CompressionProviders">CompressionProviders</h4>
|
|
<div class="markdown level1 summary"><p>Gets or sets a collection of compression providers.</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
<h5 class="decalaration">Declaration</h5>
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public IList<ICompressionProvider>? CompressionProviders { get; set; }</code></pre>
|
|
</div>
|
|
<h5 class="propertyValue">Property Value</h5>
|
|
<table class="table table-bordered table-striped table-condensed">
|
|
<thead>
|
|
<tr>
|
|
<th>Type</th>
|
|
<th>Description</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td><span class="xref">System.Nullable</span><<span class="xref">IList</span><<a class="xref" href="Grpc.Net.Compression.ICompressionProvider.html">ICompressionProvider</a>>></td>
|
|
<td></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<a id="Grpc_Net_Client_GrpcChannelOptions_Credentials_" data-uid="Grpc.Net.Client.GrpcChannelOptions.Credentials*"></a>
|
|
<h4 id="Grpc_Net_Client_GrpcChannelOptions_Credentials" data-uid="Grpc.Net.Client.GrpcChannelOptions.Credentials">Credentials</h4>
|
|
<div class="markdown level1 summary"><p>Gets or sets the credentials for the channel.</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
<h5 class="decalaration">Declaration</h5>
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public ChannelCredentials? Credentials { get; set; }</code></pre>
|
|
</div>
|
|
<h5 class="propertyValue">Property Value</h5>
|
|
<table class="table table-bordered table-striped table-condensed">
|
|
<thead>
|
|
<tr>
|
|
<th>Type</th>
|
|
<th>Description</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td><span class="xref">System.Nullable</span><<span class="xref">ChannelCredentials</span>></td>
|
|
<td></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<a id="Grpc_Net_Client_GrpcChannelOptions_DisposeHttpClient_" data-uid="Grpc.Net.Client.GrpcChannelOptions.DisposeHttpClient*"></a>
|
|
<h4 id="Grpc_Net_Client_GrpcChannelOptions_DisposeHttpClient" data-uid="Grpc.Net.Client.GrpcChannelOptions.DisposeHttpClient">DisposeHttpClient</h4>
|
|
<div class="markdown level1 summary"><p>Gets or sets a value indicating whether the underlying <see cref="!:System.Net.Http.HttpClient"></see> should be disposed
|
|
when the <a class="xref" href="Grpc.Net.Client.GrpcChannel.html">GrpcChannel</a> instance is disposed. The default value is <code>false</code>.</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
<h5 class="decalaration">Declaration</h5>
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public bool DisposeHttpClient { get; set; }</code></pre>
|
|
</div>
|
|
<h5 class="propertyValue">Property Value</h5>
|
|
<table class="table table-bordered table-striped table-condensed">
|
|
<thead>
|
|
<tr>
|
|
<th>Type</th>
|
|
<th>Description</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td><span class="xref">System.Boolean</span></td>
|
|
<td></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<h5 id="Grpc_Net_Client_GrpcChannelOptions_DisposeHttpClient_remarks">Remarks</h5>
|
|
<div class="markdown level1 remarks"><p>This setting is used when a <a class="xref" href="Grpc.Net.Client.GrpcChannelOptions.html#Grpc_Net_Client_GrpcChannelOptions_HttpClient">HttpClient</a> value is specified. If no <a class="xref" href="Grpc.Net.Client.GrpcChannelOptions.html#Grpc_Net_Client_GrpcChannelOptions_HttpClient">HttpClient</a> value is provided
|
|
then the channel will create an <see cref="!:System.Net.Http.HttpClient"></see> instance that is always disposed when
|
|
the channel is disposed.</p>
|
|
</div>
|
|
<a id="Grpc_Net_Client_GrpcChannelOptions_HttpClient_" data-uid="Grpc.Net.Client.GrpcChannelOptions.HttpClient*"></a>
|
|
<h4 id="Grpc_Net_Client_GrpcChannelOptions_HttpClient" data-uid="Grpc.Net.Client.GrpcChannelOptions.HttpClient">HttpClient</h4>
|
|
<div class="markdown level1 summary"><p>Gets or sets the <a class="xref" href="Grpc.Net.Client.GrpcChannelOptions.html#Grpc_Net_Client_GrpcChannelOptions_HttpClient">HttpClient</a> used by the channel.</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
<h5 class="decalaration">Declaration</h5>
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public HttpClient? HttpClient { get; set; }</code></pre>
|
|
</div>
|
|
<h5 class="propertyValue">Property Value</h5>
|
|
<table class="table table-bordered table-striped table-condensed">
|
|
<thead>
|
|
<tr>
|
|
<th>Type</th>
|
|
<th>Description</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td><span class="xref">System.Nullable</span><<span class="xref">HttpClient</span>></td>
|
|
<td></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<h5 id="Grpc_Net_Client_GrpcChannelOptions_HttpClient_remarks">Remarks</h5>
|
|
<div class="markdown level1 remarks"><p>By default a <see cref="!:System.Net.Http.HttpClient"></see> specified here will not be disposed with the channel.
|
|
To dispose the <see cref="!:System.Net.Http.HttpClient"></see> with the channel you must set <a class="xref" href="Grpc.Net.Client.GrpcChannelOptions.html#Grpc_Net_Client_GrpcChannelOptions_DisposeHttpClient">DisposeHttpClient</a>
|
|
to <code>true</code>.</p>
|
|
</div>
|
|
<a id="Grpc_Net_Client_GrpcChannelOptions_LoggerFactory_" data-uid="Grpc.Net.Client.GrpcChannelOptions.LoggerFactory*"></a>
|
|
<h4 id="Grpc_Net_Client_GrpcChannelOptions_LoggerFactory" data-uid="Grpc.Net.Client.GrpcChannelOptions.LoggerFactory">LoggerFactory</h4>
|
|
<div class="markdown level1 summary"><p>Gets or sets the logger factory used by the channel.</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
<h5 class="decalaration">Declaration</h5>
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public ILoggerFactory? LoggerFactory { get; set; }</code></pre>
|
|
</div>
|
|
<h5 class="propertyValue">Property Value</h5>
|
|
<table class="table table-bordered table-striped table-condensed">
|
|
<thead>
|
|
<tr>
|
|
<th>Type</th>
|
|
<th>Description</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td><span class="xref">System.Nullable</span><<span class="xref">ILoggerFactory</span>></td>
|
|
<td></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<a id="Grpc_Net_Client_GrpcChannelOptions_MaxReceiveMessageSize_" data-uid="Grpc.Net.Client.GrpcChannelOptions.MaxReceiveMessageSize*"></a>
|
|
<h4 id="Grpc_Net_Client_GrpcChannelOptions_MaxReceiveMessageSize" data-uid="Grpc.Net.Client.GrpcChannelOptions.MaxReceiveMessageSize">MaxReceiveMessageSize</h4>
|
|
<div class="markdown level1 summary"><p>Gets or sets the maximum message size in bytes that can be received by the client.</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
<h5 class="decalaration">Declaration</h5>
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public int? MaxReceiveMessageSize { get; set; }</code></pre>
|
|
</div>
|
|
<h5 class="propertyValue">Property Value</h5>
|
|
<table class="table table-bordered table-striped table-condensed">
|
|
<thead>
|
|
<tr>
|
|
<th>Type</th>
|
|
<th>Description</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td><span class="xref">System.Nullable</span><<span class="xref">System.Int32</span>></td>
|
|
<td></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<a id="Grpc_Net_Client_GrpcChannelOptions_MaxSendMessageSize_" data-uid="Grpc.Net.Client.GrpcChannelOptions.MaxSendMessageSize*"></a>
|
|
<h4 id="Grpc_Net_Client_GrpcChannelOptions_MaxSendMessageSize" data-uid="Grpc.Net.Client.GrpcChannelOptions.MaxSendMessageSize">MaxSendMessageSize</h4>
|
|
<div class="markdown level1 summary"><p>Gets or sets the maximum message size in bytes that can be sent from the client.</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
<h5 class="decalaration">Declaration</h5>
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public int? MaxSendMessageSize { get; set; }</code></pre>
|
|
</div>
|
|
<h5 class="propertyValue">Property Value</h5>
|
|
<table class="table table-bordered table-striped table-condensed">
|
|
<thead>
|
|
<tr>
|
|
<th>Type</th>
|
|
<th>Description</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td><span class="xref">System.Nullable</span><<span class="xref">System.Int32</span>></td>
|
|
<td></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<a id="Grpc_Net_Client_GrpcChannelOptions_ThrowOperationCanceledOnCancellation_" data-uid="Grpc.Net.Client.GrpcChannelOptions.ThrowOperationCanceledOnCancellation*"></a>
|
|
<h4 id="Grpc_Net_Client_GrpcChannelOptions_ThrowOperationCanceledOnCancellation" data-uid="Grpc.Net.Client.GrpcChannelOptions.ThrowOperationCanceledOnCancellation">ThrowOperationCanceledOnCancellation</h4>
|
|
<div class="markdown level1 summary"><p>Gets or sets a value indicating whether clients will throw <see cref="!:OperationCanceledException"></see> for a call when its
|
|
<see cref="!:CallOptions.CancellationToken"></see> is triggered or its <see cref="!:CallOptions.Deadline"></see> is exceeded.
|
|
The default value is <code>false</code>.
|
|
Note: experimental API that can change or be removed without any prior notice.</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
<h5 class="decalaration">Declaration</h5>
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public bool ThrowOperationCanceledOnCancellation { get; set; }</code></pre>
|
|
</div>
|
|
<h5 class="propertyValue">Property Value</h5>
|
|
<table class="table table-bordered table-striped table-condensed">
|
|
<thead>
|
|
<tr>
|
|
<th>Type</th>
|
|
<th>Description</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td><span class="xref">System.Boolean</span></td>
|
|
<td></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</article>
|
|
</div>
|
|
|
|
<div class="hidden-sm col-md-2" role="complementary">
|
|
<div class="sideaffix">
|
|
<nav class="bs-docs-sidebar hidden-print hidden-xs hidden-sm affix" id="affix">
|
|
<!-- <p><a class="back-to-top" href="#top">Back to top</a><p> -->
|
|
</nav>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
<footer>
|
|
<div class="grad-bottom"></div>
|
|
<div class="footer">
|
|
<div class="container">
|
|
<span class="pull-right">
|
|
<a href="#top">Back to top</a>
|
|
</span>
|
|
|
|
<span>Generated by <strong>DocFX</strong></span>
|
|
</div>
|
|
</div>
|
|
</footer>
|
|
</div>
|
|
|
|
<script type="text/javascript" src="../styles/docfx.vendor.js"></script>
|
|
<script type="text/javascript" src="../styles/docfx.js"></script>
|
|
<script type="text/javascript" src="../styles/main.js"></script>
|
|
</body>
|
|
</html>
|