Grpc.Core.ChannelOptions.html 16 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411
  1. <!DOCTYPE html>
  2. <!--[if IE]><![endif]-->
  3. <html>
  4. <head>
  5. <meta charset="utf-8">
  6. <meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1">
  7. <title>Class ChannelOptions
  8. | gRPC C# </title>
  9. <meta name="viewport" content="width=device-width">
  10. <meta name="title" content="Class ChannelOptions
  11. | gRPC C# ">
  12. <meta name="generator" content="docfx 2.36.0.0">
  13. <link rel="shortcut icon" href="../favicon.ico">
  14. <link rel="stylesheet" href="../styles/docfx.vendor.css">
  15. <link rel="stylesheet" href="../styles/docfx.css">
  16. <link rel="stylesheet" href="../styles/main.css">
  17. <meta property="docfx:navrel" content="../toc.html">
  18. <meta property="docfx:tocrel" content="toc.html">
  19. <meta property="docfx:rel" content="../">
  20. <script type="text/javascript"> (function(i,s,o,g,r,a,m){i['GoogleAnalyticsObject']=r;i[r]=i[r]||function(){ (i[r].q=i[r].q||[]).push(arguments)},i[r].l=1*new Date();a=s.createElement(o), m=s.getElementsByTagName(o)[0];a.async=1;a.src=g;m.parentNode.insertBefore(a,m) })(window,document,'script','//www.google-analytics.com/analytics.js','ga'); ga('create', 'UA-60127042-1', 'auto'); ga('send', 'pageview'); </script> </head>
  21. <body data-spy="scroll" data-target="#affix" data-offset="120">
  22. <div id="wrapper">
  23. <header>
  24. <nav id="autocollapse" class="navbar navbar-inverse ng-scope" role="navigation">
  25. <div class="container">
  26. <div class="navbar-header">
  27. <button type="button" class="navbar-toggle" data-toggle="collapse" data-target="#navbar">
  28. <span class="sr-only">Toggle navigation</span>
  29. <span class="icon-bar"></span>
  30. <span class="icon-bar"></span>
  31. <span class="icon-bar"></span>
  32. </button>
  33. <a class="navbar-brand" href="../index.html">
  34. <img id="logo" class="svg" src="../logo.svg" alt="">
  35. </a>
  36. </div>
  37. <div class="collapse navbar-collapse" id="navbar">
  38. <form class="navbar-form navbar-right" role="search" id="search">
  39. <div class="form-group">
  40. <input type="text" class="form-control" id="search-query" placeholder="Search" autocomplete="off">
  41. </div>
  42. </form>
  43. </div>
  44. </div>
  45. </nav>
  46. <div class="subnav navbar navbar-default">
  47. <div class="container hide-when-search" id="breadcrumb">
  48. <ul class="breadcrumb">
  49. <li></li>
  50. </ul>
  51. </div>
  52. </div>
  53. </header>
  54. <div class="container body-content">
  55. <div id="search-results">
  56. <div class="search-list"></div>
  57. <div class="sr-items">
  58. <p><i class="glyphicon glyphicon-refresh index-loading"></i></p>
  59. </div>
  60. <ul id="pagination"></ul>
  61. </div>
  62. </div>
  63. <div role="main" class="container body-content hide-when-search">
  64. <div class="sidenav hide-when-search">
  65. <a class="btn toc-toggle collapse" data-toggle="collapse" href="#sidetoggle" aria-expanded="false" aria-controls="sidetoggle">Show / Hide Table of Contents</a>
  66. <div class="sidetoggle collapse" id="sidetoggle">
  67. <div id="sidetoc"></div>
  68. </div>
  69. </div>
  70. <div class="article row grid-right">
  71. <div class="col-md-10">
  72. <article class="content wrap" id="_content" data-uid="Grpc.Core.ChannelOptions">
  73. <h1 id="Grpc_Core_ChannelOptions" data-uid="Grpc.Core.ChannelOptions" class="text-break">Class ChannelOptions
  74. </h1>
  75. <div class="markdown level0 summary"><p>Defines names of supported channel options.</p>
  76. </div>
  77. <div class="markdown level0 conceptual"></div>
  78. <div class="inheritance">
  79. <h5>Inheritance</h5>
  80. <div class="level0"><span class="xref">System.Object</span></div>
  81. <div class="level1"><span class="xref">ChannelOptions</span></div>
  82. </div>
  83. <div class="inheritedMembers">
  84. <h5>Inherited Members</h5>
  85. <div>
  86. <span class="xref">System.Object.ToString()</span>
  87. </div>
  88. <div>
  89. <span class="xref">System.Object.Equals(System.Object)</span>
  90. </div>
  91. <div>
  92. <span class="xref">System.Object.Equals(System.Object, System.Object)</span>
  93. </div>
  94. <div>
  95. <span class="xref">System.Object.ReferenceEquals(System.Object, System.Object)</span>
  96. </div>
  97. <div>
  98. <span class="xref">System.Object.GetHashCode()</span>
  99. </div>
  100. <div>
  101. <span class="xref">System.Object.GetType()</span>
  102. </div>
  103. <div>
  104. <span class="xref">System.Object.MemberwiseClone()</span>
  105. </div>
  106. </div>
  107. <h6><strong>Namespace</strong>: <a class="xref" href="Grpc.Core.html">Grpc.Core</a></h6>
  108. <h6><strong>Assembly</strong>: Grpc.Core.dll</h6>
  109. <h5 id="Grpc_Core_ChannelOptions_syntax">Syntax</h5>
  110. <div class="codewrapper">
  111. <pre><code class="lang-csharp hljs">public static class ChannelOptions</code></pre>
  112. </div>
  113. <h3 id="fields">Fields
  114. </h3>
  115. <h4 id="Grpc_Core_ChannelOptions_Census" data-uid="Grpc.Core.ChannelOptions.Census">Census</h4>
  116. <div class="markdown level1 summary"><p>Enable census for tracing and stats collection</p>
  117. </div>
  118. <div class="markdown level1 conceptual"></div>
  119. <h5 class="decalaration">Declaration</h5>
  120. <div class="codewrapper">
  121. <pre><code class="lang-csharp hljs">public const string Census = &quot;grpc.census&quot;</code></pre>
  122. </div>
  123. <h5 class="fieldValue">Field Value</h5>
  124. <table class="table table-bordered table-striped table-condensed">
  125. <thead>
  126. <tr>
  127. <th>Type</th>
  128. <th>Description</th>
  129. </tr>
  130. </thead>
  131. <tbody>
  132. <tr>
  133. <td><span class="xref">System.String</span></td>
  134. <td></td>
  135. </tr>
  136. </tbody>
  137. </table>
  138. <h4 id="Grpc_Core_ChannelOptions_DefaultAuthority" data-uid="Grpc.Core.ChannelOptions.DefaultAuthority">DefaultAuthority</h4>
  139. <div class="markdown level1 summary"><p>Default authority for calls.</p>
  140. </div>
  141. <div class="markdown level1 conceptual"></div>
  142. <h5 class="decalaration">Declaration</h5>
  143. <div class="codewrapper">
  144. <pre><code class="lang-csharp hljs">public const string DefaultAuthority = &quot;grpc.default_authority&quot;</code></pre>
  145. </div>
  146. <h5 class="fieldValue">Field Value</h5>
  147. <table class="table table-bordered table-striped table-condensed">
  148. <thead>
  149. <tr>
  150. <th>Type</th>
  151. <th>Description</th>
  152. </tr>
  153. </thead>
  154. <tbody>
  155. <tr>
  156. <td><span class="xref">System.String</span></td>
  157. <td></td>
  158. </tr>
  159. </tbody>
  160. </table>
  161. <h4 id="Grpc_Core_ChannelOptions_Http2InitialSequenceNumber" data-uid="Grpc.Core.ChannelOptions.Http2InitialSequenceNumber">Http2InitialSequenceNumber</h4>
  162. <div class="markdown level1 summary"><p>Initial sequence number for http2 transports</p>
  163. </div>
  164. <div class="markdown level1 conceptual"></div>
  165. <h5 class="decalaration">Declaration</h5>
  166. <div class="codewrapper">
  167. <pre><code class="lang-csharp hljs">public const string Http2InitialSequenceNumber = &quot;grpc.http2.initial_sequence_number&quot;</code></pre>
  168. </div>
  169. <h5 class="fieldValue">Field Value</h5>
  170. <table class="table table-bordered table-striped table-condensed">
  171. <thead>
  172. <tr>
  173. <th>Type</th>
  174. <th>Description</th>
  175. </tr>
  176. </thead>
  177. <tbody>
  178. <tr>
  179. <td><span class="xref">System.String</span></td>
  180. <td></td>
  181. </tr>
  182. </tbody>
  183. </table>
  184. <h4 id="Grpc_Core_ChannelOptions_MaxConcurrentStreams" data-uid="Grpc.Core.ChannelOptions.MaxConcurrentStreams">MaxConcurrentStreams</h4>
  185. <div class="markdown level1 summary"><p>Maximum number of concurrent incoming streams to allow on a http2 connection</p>
  186. </div>
  187. <div class="markdown level1 conceptual"></div>
  188. <h5 class="decalaration">Declaration</h5>
  189. <div class="codewrapper">
  190. <pre><code class="lang-csharp hljs">public const string MaxConcurrentStreams = &quot;grpc.max_concurrent_streams&quot;</code></pre>
  191. </div>
  192. <h5 class="fieldValue">Field Value</h5>
  193. <table class="table table-bordered table-striped table-condensed">
  194. <thead>
  195. <tr>
  196. <th>Type</th>
  197. <th>Description</th>
  198. </tr>
  199. </thead>
  200. <tbody>
  201. <tr>
  202. <td><span class="xref">System.String</span></td>
  203. <td></td>
  204. </tr>
  205. </tbody>
  206. </table>
  207. <h4 id="Grpc_Core_ChannelOptions_MaxMessageLength" data-uid="Grpc.Core.ChannelOptions.MaxMessageLength">MaxMessageLength</h4>
  208. <div class="markdown level1 summary"><p>Obsolete, for backward compatibility only.</p>
  209. </div>
  210. <div class="markdown level1 conceptual"></div>
  211. <h5 class="decalaration">Declaration</h5>
  212. <div class="codewrapper">
  213. <pre><code class="lang-csharp hljs">[Obsolete(&quot;Use MaxReceiveMessageLength instead.&quot;)]
  214. public const string MaxMessageLength = &quot;grpc.max_receive_message_length&quot;</code></pre>
  215. </div>
  216. <h5 class="fieldValue">Field Value</h5>
  217. <table class="table table-bordered table-striped table-condensed">
  218. <thead>
  219. <tr>
  220. <th>Type</th>
  221. <th>Description</th>
  222. </tr>
  223. </thead>
  224. <tbody>
  225. <tr>
  226. <td><span class="xref">System.String</span></td>
  227. <td></td>
  228. </tr>
  229. </tbody>
  230. </table>
  231. <h4 id="Grpc_Core_ChannelOptions_MaxReceiveMessageLength" data-uid="Grpc.Core.ChannelOptions.MaxReceiveMessageLength">MaxReceiveMessageLength</h4>
  232. <div class="markdown level1 summary"><p>Maximum message length that the channel can receive</p>
  233. </div>
  234. <div class="markdown level1 conceptual"></div>
  235. <h5 class="decalaration">Declaration</h5>
  236. <div class="codewrapper">
  237. <pre><code class="lang-csharp hljs">public const string MaxReceiveMessageLength = &quot;grpc.max_receive_message_length&quot;</code></pre>
  238. </div>
  239. <h5 class="fieldValue">Field Value</h5>
  240. <table class="table table-bordered table-striped table-condensed">
  241. <thead>
  242. <tr>
  243. <th>Type</th>
  244. <th>Description</th>
  245. </tr>
  246. </thead>
  247. <tbody>
  248. <tr>
  249. <td><span class="xref">System.String</span></td>
  250. <td></td>
  251. </tr>
  252. </tbody>
  253. </table>
  254. <h4 id="Grpc_Core_ChannelOptions_MaxSendMessageLength" data-uid="Grpc.Core.ChannelOptions.MaxSendMessageLength">MaxSendMessageLength</h4>
  255. <div class="markdown level1 summary"><p>Maximum message length that the channel can send</p>
  256. </div>
  257. <div class="markdown level1 conceptual"></div>
  258. <h5 class="decalaration">Declaration</h5>
  259. <div class="codewrapper">
  260. <pre><code class="lang-csharp hljs">public const string MaxSendMessageLength = &quot;grpc.max_send_message_length&quot;</code></pre>
  261. </div>
  262. <h5 class="fieldValue">Field Value</h5>
  263. <table class="table table-bordered table-striped table-condensed">
  264. <thead>
  265. <tr>
  266. <th>Type</th>
  267. <th>Description</th>
  268. </tr>
  269. </thead>
  270. <tbody>
  271. <tr>
  272. <td><span class="xref">System.String</span></td>
  273. <td></td>
  274. </tr>
  275. </tbody>
  276. </table>
  277. <h4 id="Grpc_Core_ChannelOptions_PrimaryUserAgentString" data-uid="Grpc.Core.ChannelOptions.PrimaryUserAgentString">PrimaryUserAgentString</h4>
  278. <div class="markdown level1 summary"><p>Primary user agent: goes at the start of the user-agent metadata</p>
  279. </div>
  280. <div class="markdown level1 conceptual"></div>
  281. <h5 class="decalaration">Declaration</h5>
  282. <div class="codewrapper">
  283. <pre><code class="lang-csharp hljs">public const string PrimaryUserAgentString = &quot;grpc.primary_user_agent&quot;</code></pre>
  284. </div>
  285. <h5 class="fieldValue">Field Value</h5>
  286. <table class="table table-bordered table-striped table-condensed">
  287. <thead>
  288. <tr>
  289. <th>Type</th>
  290. <th>Description</th>
  291. </tr>
  292. </thead>
  293. <tbody>
  294. <tr>
  295. <td><span class="xref">System.String</span></td>
  296. <td></td>
  297. </tr>
  298. </tbody>
  299. </table>
  300. <h4 id="Grpc_Core_ChannelOptions_SecondaryUserAgentString" data-uid="Grpc.Core.ChannelOptions.SecondaryUserAgentString">SecondaryUserAgentString</h4>
  301. <div class="markdown level1 summary"><p>Secondary user agent: goes at the end of the user-agent metadata</p>
  302. </div>
  303. <div class="markdown level1 conceptual"></div>
  304. <h5 class="decalaration">Declaration</h5>
  305. <div class="codewrapper">
  306. <pre><code class="lang-csharp hljs">public const string SecondaryUserAgentString = &quot;grpc.secondary_user_agent&quot;</code></pre>
  307. </div>
  308. <h5 class="fieldValue">Field Value</h5>
  309. <table class="table table-bordered table-striped table-condensed">
  310. <thead>
  311. <tr>
  312. <th>Type</th>
  313. <th>Description</th>
  314. </tr>
  315. </thead>
  316. <tbody>
  317. <tr>
  318. <td><span class="xref">System.String</span></td>
  319. <td></td>
  320. </tr>
  321. </tbody>
  322. </table>
  323. <h4 id="Grpc_Core_ChannelOptions_SoReuseport" data-uid="Grpc.Core.ChannelOptions.SoReuseport">SoReuseport</h4>
  324. <div class="markdown level1 summary"><p>If non-zero, allow the use of SO_REUSEPORT for server if it&apos;s available (default 1)</p>
  325. </div>
  326. <div class="markdown level1 conceptual"></div>
  327. <h5 class="decalaration">Declaration</h5>
  328. <div class="codewrapper">
  329. <pre><code class="lang-csharp hljs">public const string SoReuseport = &quot;grpc.so_reuseport&quot;</code></pre>
  330. </div>
  331. <h5 class="fieldValue">Field Value</h5>
  332. <table class="table table-bordered table-striped table-condensed">
  333. <thead>
  334. <tr>
  335. <th>Type</th>
  336. <th>Description</th>
  337. </tr>
  338. </thead>
  339. <tbody>
  340. <tr>
  341. <td><span class="xref">System.String</span></td>
  342. <td></td>
  343. </tr>
  344. </tbody>
  345. </table>
  346. <h4 id="Grpc_Core_ChannelOptions_SslTargetNameOverride" data-uid="Grpc.Core.ChannelOptions.SslTargetNameOverride">SslTargetNameOverride</h4>
  347. <div class="markdown level1 summary"><p>Override SSL target check. Only to be used for testing.</p>
  348. </div>
  349. <div class="markdown level1 conceptual"></div>
  350. <h5 class="decalaration">Declaration</h5>
  351. <div class="codewrapper">
  352. <pre><code class="lang-csharp hljs">public const string SslTargetNameOverride = &quot;grpc.ssl_target_name_override&quot;</code></pre>
  353. </div>
  354. <h5 class="fieldValue">Field Value</h5>
  355. <table class="table table-bordered table-striped table-condensed">
  356. <thead>
  357. <tr>
  358. <th>Type</th>
  359. <th>Description</th>
  360. </tr>
  361. </thead>
  362. <tbody>
  363. <tr>
  364. <td><span class="xref">System.String</span></td>
  365. <td></td>
  366. </tr>
  367. </tbody>
  368. </table>
  369. </article>
  370. </div>
  371. <div class="hidden-sm col-md-2" role="complementary">
  372. <div class="sideaffix">
  373. <nav class="bs-docs-sidebar hidden-print hidden-xs hidden-sm affix" id="affix">
  374. <!-- <p><a class="back-to-top" href="#top">Back to top</a><p> -->
  375. </nav>
  376. </div>
  377. </div>
  378. </div>
  379. </div>
  380. <footer>
  381. <div class="grad-bottom"></div>
  382. <div class="footer">
  383. <div class="container">
  384. <span class="pull-right">
  385. <a href="#top">Back to top</a>
  386. </span>
  387. <span>Generated by <strong>DocFX</strong></span>
  388. </div>
  389. </div>
  390. </footer>
  391. </div>
  392. <script type="text/javascript" src="../styles/docfx.vendor.js"></script>
  393. <script type="text/javascript" src="../styles/docfx.js"></script>
  394. <script type="text/javascript" src="../styles/main.js"></script>
  395. </body>
  396. </html>