123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412 |
- <!DOCTYPE html>
- <!--[if IE]><![endif]-->
- <html>
-
- <head>
- <meta charset="utf-8">
- <meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1">
- <title>Class ChannelOptions
- | gRPC C# </title>
- <meta name="viewport" content="width=device-width">
- <meta name="title" content="Class ChannelOptions
- | gRPC C# ">
- <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.Core.ChannelOptions">
-
-
- <h1 id="Grpc_Core_ChannelOptions" data-uid="Grpc.Core.ChannelOptions" class="text-break">Class ChannelOptions
- </h1>
- <div class="markdown level0 summary"><p>Defines names of most commonly used channel options.
- Other supported options names can be found in grpc_types.h (GRPC_ARG_* definitions)</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">ChannelOptions</span></div>
- </div>
- <div class="inheritedMembers">
- <h5>Inherited Members</h5>
- <div>
- <span class="xref">System.Object.Equals(System.Object)</span>
- </div>
- <div>
- <span class="xref">System.Object.Equals(System.Object, System.Object)</span>
- </div>
- <div>
- <span class="xref">System.Object.GetHashCode()</span>
- </div>
- <div>
- <span class="xref">System.Object.GetType()</span>
- </div>
- <div>
- <span class="xref">System.Object.MemberwiseClone()</span>
- </div>
- <div>
- <span class="xref">System.Object.ReferenceEquals(System.Object, System.Object)</span>
- </div>
- <div>
- <span class="xref">System.Object.ToString()</span>
- </div>
- </div>
- <h6><strong>Namespace</strong>: <a class="xref" href="Grpc.Core.html">Grpc.Core</a></h6>
- <h6><strong>Assembly</strong>: Grpc.Core.dll</h6>
- <h5 id="Grpc_Core_ChannelOptions_syntax">Syntax</h5>
- <div class="codewrapper">
- <pre><code class="lang-csharp hljs">public static class ChannelOptions</code></pre>
- </div>
- <h3 id="fields">Fields
- </h3>
- <h4 id="Grpc_Core_ChannelOptions_Census" data-uid="Grpc.Core.ChannelOptions.Census">Census</h4>
- <div class="markdown level1 summary"><p>Enable census for tracing and stats collection</p>
- </div>
- <div class="markdown level1 conceptual"></div>
- <h5 class="decalaration">Declaration</h5>
- <div class="codewrapper">
- <pre><code class="lang-csharp hljs">public const string Census = "grpc.census"</code></pre>
- </div>
- <h5 class="fieldValue">Field 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.String</span></td>
- <td></td>
- </tr>
- </tbody>
- </table>
- <h4 id="Grpc_Core_ChannelOptions_DefaultAuthority" data-uid="Grpc.Core.ChannelOptions.DefaultAuthority">DefaultAuthority</h4>
- <div class="markdown level1 summary"><p>Default authority for calls.</p>
- </div>
- <div class="markdown level1 conceptual"></div>
- <h5 class="decalaration">Declaration</h5>
- <div class="codewrapper">
- <pre><code class="lang-csharp hljs">public const string DefaultAuthority = "grpc.default_authority"</code></pre>
- </div>
- <h5 class="fieldValue">Field 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.String</span></td>
- <td></td>
- </tr>
- </tbody>
- </table>
- <h4 id="Grpc_Core_ChannelOptions_Http2InitialSequenceNumber" data-uid="Grpc.Core.ChannelOptions.Http2InitialSequenceNumber">Http2InitialSequenceNumber</h4>
- <div class="markdown level1 summary"><p>Initial sequence number for http2 transports</p>
- </div>
- <div class="markdown level1 conceptual"></div>
- <h5 class="decalaration">Declaration</h5>
- <div class="codewrapper">
- <pre><code class="lang-csharp hljs">public const string Http2InitialSequenceNumber = "grpc.http2.initial_sequence_number"</code></pre>
- </div>
- <h5 class="fieldValue">Field 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.String</span></td>
- <td></td>
- </tr>
- </tbody>
- </table>
- <h4 id="Grpc_Core_ChannelOptions_MaxConcurrentStreams" data-uid="Grpc.Core.ChannelOptions.MaxConcurrentStreams">MaxConcurrentStreams</h4>
- <div class="markdown level1 summary"><p>Maximum number of concurrent incoming streams to allow on a http2 connection</p>
- </div>
- <div class="markdown level1 conceptual"></div>
- <h5 class="decalaration">Declaration</h5>
- <div class="codewrapper">
- <pre><code class="lang-csharp hljs">public const string MaxConcurrentStreams = "grpc.max_concurrent_streams"</code></pre>
- </div>
- <h5 class="fieldValue">Field 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.String</span></td>
- <td></td>
- </tr>
- </tbody>
- </table>
- <h4 id="Grpc_Core_ChannelOptions_MaxMessageLength" data-uid="Grpc.Core.ChannelOptions.MaxMessageLength">MaxMessageLength</h4>
- <div class="markdown level1 summary"><p>Obsolete, for backward compatibility only.</p>
- </div>
- <div class="markdown level1 conceptual"></div>
- <h5 class="decalaration">Declaration</h5>
- <div class="codewrapper">
- <pre><code class="lang-csharp hljs">[Obsolete("Use MaxReceiveMessageLength instead.")]
- public const string MaxMessageLength = "grpc.max_receive_message_length"</code></pre>
- </div>
- <h5 class="fieldValue">Field 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.String</span></td>
- <td></td>
- </tr>
- </tbody>
- </table>
- <h4 id="Grpc_Core_ChannelOptions_MaxReceiveMessageLength" data-uid="Grpc.Core.ChannelOptions.MaxReceiveMessageLength">MaxReceiveMessageLength</h4>
- <div class="markdown level1 summary"><p>Maximum message length that the channel can receive</p>
- </div>
- <div class="markdown level1 conceptual"></div>
- <h5 class="decalaration">Declaration</h5>
- <div class="codewrapper">
- <pre><code class="lang-csharp hljs">public const string MaxReceiveMessageLength = "grpc.max_receive_message_length"</code></pre>
- </div>
- <h5 class="fieldValue">Field 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.String</span></td>
- <td></td>
- </tr>
- </tbody>
- </table>
- <h4 id="Grpc_Core_ChannelOptions_MaxSendMessageLength" data-uid="Grpc.Core.ChannelOptions.MaxSendMessageLength">MaxSendMessageLength</h4>
- <div class="markdown level1 summary"><p>Maximum message length that the channel can send</p>
- </div>
- <div class="markdown level1 conceptual"></div>
- <h5 class="decalaration">Declaration</h5>
- <div class="codewrapper">
- <pre><code class="lang-csharp hljs">public const string MaxSendMessageLength = "grpc.max_send_message_length"</code></pre>
- </div>
- <h5 class="fieldValue">Field 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.String</span></td>
- <td></td>
- </tr>
- </tbody>
- </table>
- <h4 id="Grpc_Core_ChannelOptions_PrimaryUserAgentString" data-uid="Grpc.Core.ChannelOptions.PrimaryUserAgentString">PrimaryUserAgentString</h4>
- <div class="markdown level1 summary"><p>Primary user agent: goes at the start of the user-agent metadata</p>
- </div>
- <div class="markdown level1 conceptual"></div>
- <h5 class="decalaration">Declaration</h5>
- <div class="codewrapper">
- <pre><code class="lang-csharp hljs">public const string PrimaryUserAgentString = "grpc.primary_user_agent"</code></pre>
- </div>
- <h5 class="fieldValue">Field 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.String</span></td>
- <td></td>
- </tr>
- </tbody>
- </table>
- <h4 id="Grpc_Core_ChannelOptions_SecondaryUserAgentString" data-uid="Grpc.Core.ChannelOptions.SecondaryUserAgentString">SecondaryUserAgentString</h4>
- <div class="markdown level1 summary"><p>Secondary user agent: goes at the end of the user-agent metadata</p>
- </div>
- <div class="markdown level1 conceptual"></div>
- <h5 class="decalaration">Declaration</h5>
- <div class="codewrapper">
- <pre><code class="lang-csharp hljs">public const string SecondaryUserAgentString = "grpc.secondary_user_agent"</code></pre>
- </div>
- <h5 class="fieldValue">Field 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.String</span></td>
- <td></td>
- </tr>
- </tbody>
- </table>
- <h4 id="Grpc_Core_ChannelOptions_SoReuseport" data-uid="Grpc.Core.ChannelOptions.SoReuseport">SoReuseport</h4>
- <div class="markdown level1 summary"><p>If non-zero, allow the use of SO_REUSEPORT for server if it's available (default 1)</p>
- </div>
- <div class="markdown level1 conceptual"></div>
- <h5 class="decalaration">Declaration</h5>
- <div class="codewrapper">
- <pre><code class="lang-csharp hljs">public const string SoReuseport = "grpc.so_reuseport"</code></pre>
- </div>
- <h5 class="fieldValue">Field 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.String</span></td>
- <td></td>
- </tr>
- </tbody>
- </table>
- <h4 id="Grpc_Core_ChannelOptions_SslTargetNameOverride" data-uid="Grpc.Core.ChannelOptions.SslTargetNameOverride">SslTargetNameOverride</h4>
- <div class="markdown level1 summary"><p>Override SSL target check. Only to be used for testing.</p>
- </div>
- <div class="markdown level1 conceptual"></div>
- <h5 class="decalaration">Declaration</h5>
- <div class="codewrapper">
- <pre><code class="lang-csharp hljs">public const string SslTargetNameOverride = "grpc.ssl_target_name_override"</code></pre>
- </div>
- <h5 class="fieldValue">Field 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.String</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>
|