Grpc.Core.ChannelOptions.html 15 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412
  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. </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 most commonly used channel options.
  76. Other supported options names can be found in grpc_types.h (GRPC_ARG_* definitions)</p>
  77. </div>
  78. <div class="markdown level0 conceptual"></div>
  79. <div class="inheritance">
  80. <h5>Inheritance</h5>
  81. <div class="level0"><span class="xref">System.Object</span></div>
  82. <div class="level1"><span class="xref">ChannelOptions</span></div>
  83. </div>
  84. <div class="inheritedMembers">
  85. <h5>Inherited Members</h5>
  86. <div>
  87. <span class="xref">System.Object.Equals(System.Object)</span>
  88. </div>
  89. <div>
  90. <span class="xref">System.Object.Equals(System.Object, System.Object)</span>
  91. </div>
  92. <div>
  93. <span class="xref">System.Object.GetHashCode()</span>
  94. </div>
  95. <div>
  96. <span class="xref">System.Object.GetType()</span>
  97. </div>
  98. <div>
  99. <span class="xref">System.Object.MemberwiseClone()</span>
  100. </div>
  101. <div>
  102. <span class="xref">System.Object.ReferenceEquals(System.Object, System.Object)</span>
  103. </div>
  104. <div>
  105. <span class="xref">System.Object.ToString()</span>
  106. </div>
  107. </div>
  108. <h6><strong>Namespace</strong>: <a class="xref" href="Grpc.Core.html">Grpc.Core</a></h6>
  109. <h6><strong>Assembly</strong>: Grpc.Core.dll</h6>
  110. <h5 id="Grpc_Core_ChannelOptions_syntax">Syntax</h5>
  111. <div class="codewrapper">
  112. <pre><code class="lang-csharp hljs">public static class ChannelOptions</code></pre>
  113. </div>
  114. <h3 id="fields">Fields
  115. </h3>
  116. <h4 id="Grpc_Core_ChannelOptions_Census" data-uid="Grpc.Core.ChannelOptions.Census">Census</h4>
  117. <div class="markdown level1 summary"><p>Enable census for tracing and stats collection</p>
  118. </div>
  119. <div class="markdown level1 conceptual"></div>
  120. <h5 class="decalaration">Declaration</h5>
  121. <div class="codewrapper">
  122. <pre><code class="lang-csharp hljs">public const string Census = &quot;grpc.census&quot;</code></pre>
  123. </div>
  124. <h5 class="fieldValue">Field Value</h5>
  125. <table class="table table-bordered table-striped table-condensed">
  126. <thead>
  127. <tr>
  128. <th>Type</th>
  129. <th>Description</th>
  130. </tr>
  131. </thead>
  132. <tbody>
  133. <tr>
  134. <td><span class="xref">System.String</span></td>
  135. <td></td>
  136. </tr>
  137. </tbody>
  138. </table>
  139. <h4 id="Grpc_Core_ChannelOptions_DefaultAuthority" data-uid="Grpc.Core.ChannelOptions.DefaultAuthority">DefaultAuthority</h4>
  140. <div class="markdown level1 summary"><p>Default authority for calls.</p>
  141. </div>
  142. <div class="markdown level1 conceptual"></div>
  143. <h5 class="decalaration">Declaration</h5>
  144. <div class="codewrapper">
  145. <pre><code class="lang-csharp hljs">public const string DefaultAuthority = &quot;grpc.default_authority&quot;</code></pre>
  146. </div>
  147. <h5 class="fieldValue">Field Value</h5>
  148. <table class="table table-bordered table-striped table-condensed">
  149. <thead>
  150. <tr>
  151. <th>Type</th>
  152. <th>Description</th>
  153. </tr>
  154. </thead>
  155. <tbody>
  156. <tr>
  157. <td><span class="xref">System.String</span></td>
  158. <td></td>
  159. </tr>
  160. </tbody>
  161. </table>
  162. <h4 id="Grpc_Core_ChannelOptions_Http2InitialSequenceNumber" data-uid="Grpc.Core.ChannelOptions.Http2InitialSequenceNumber">Http2InitialSequenceNumber</h4>
  163. <div class="markdown level1 summary"><p>Initial sequence number for http2 transports</p>
  164. </div>
  165. <div class="markdown level1 conceptual"></div>
  166. <h5 class="decalaration">Declaration</h5>
  167. <div class="codewrapper">
  168. <pre><code class="lang-csharp hljs">public const string Http2InitialSequenceNumber = &quot;grpc.http2.initial_sequence_number&quot;</code></pre>
  169. </div>
  170. <h5 class="fieldValue">Field Value</h5>
  171. <table class="table table-bordered table-striped table-condensed">
  172. <thead>
  173. <tr>
  174. <th>Type</th>
  175. <th>Description</th>
  176. </tr>
  177. </thead>
  178. <tbody>
  179. <tr>
  180. <td><span class="xref">System.String</span></td>
  181. <td></td>
  182. </tr>
  183. </tbody>
  184. </table>
  185. <h4 id="Grpc_Core_ChannelOptions_MaxConcurrentStreams" data-uid="Grpc.Core.ChannelOptions.MaxConcurrentStreams">MaxConcurrentStreams</h4>
  186. <div class="markdown level1 summary"><p>Maximum number of concurrent incoming streams to allow on a http2 connection</p>
  187. </div>
  188. <div class="markdown level1 conceptual"></div>
  189. <h5 class="decalaration">Declaration</h5>
  190. <div class="codewrapper">
  191. <pre><code class="lang-csharp hljs">public const string MaxConcurrentStreams = &quot;grpc.max_concurrent_streams&quot;</code></pre>
  192. </div>
  193. <h5 class="fieldValue">Field Value</h5>
  194. <table class="table table-bordered table-striped table-condensed">
  195. <thead>
  196. <tr>
  197. <th>Type</th>
  198. <th>Description</th>
  199. </tr>
  200. </thead>
  201. <tbody>
  202. <tr>
  203. <td><span class="xref">System.String</span></td>
  204. <td></td>
  205. </tr>
  206. </tbody>
  207. </table>
  208. <h4 id="Grpc_Core_ChannelOptions_MaxMessageLength" data-uid="Grpc.Core.ChannelOptions.MaxMessageLength">MaxMessageLength</h4>
  209. <div class="markdown level1 summary"><p>Obsolete, for backward compatibility only.</p>
  210. </div>
  211. <div class="markdown level1 conceptual"></div>
  212. <h5 class="decalaration">Declaration</h5>
  213. <div class="codewrapper">
  214. <pre><code class="lang-csharp hljs">[Obsolete(&quot;Use MaxReceiveMessageLength instead.&quot;)]
  215. public const string MaxMessageLength = &quot;grpc.max_receive_message_length&quot;</code></pre>
  216. </div>
  217. <h5 class="fieldValue">Field Value</h5>
  218. <table class="table table-bordered table-striped table-condensed">
  219. <thead>
  220. <tr>
  221. <th>Type</th>
  222. <th>Description</th>
  223. </tr>
  224. </thead>
  225. <tbody>
  226. <tr>
  227. <td><span class="xref">System.String</span></td>
  228. <td></td>
  229. </tr>
  230. </tbody>
  231. </table>
  232. <h4 id="Grpc_Core_ChannelOptions_MaxReceiveMessageLength" data-uid="Grpc.Core.ChannelOptions.MaxReceiveMessageLength">MaxReceiveMessageLength</h4>
  233. <div class="markdown level1 summary"><p>Maximum message length that the channel can receive</p>
  234. </div>
  235. <div class="markdown level1 conceptual"></div>
  236. <h5 class="decalaration">Declaration</h5>
  237. <div class="codewrapper">
  238. <pre><code class="lang-csharp hljs">public const string MaxReceiveMessageLength = &quot;grpc.max_receive_message_length&quot;</code></pre>
  239. </div>
  240. <h5 class="fieldValue">Field Value</h5>
  241. <table class="table table-bordered table-striped table-condensed">
  242. <thead>
  243. <tr>
  244. <th>Type</th>
  245. <th>Description</th>
  246. </tr>
  247. </thead>
  248. <tbody>
  249. <tr>
  250. <td><span class="xref">System.String</span></td>
  251. <td></td>
  252. </tr>
  253. </tbody>
  254. </table>
  255. <h4 id="Grpc_Core_ChannelOptions_MaxSendMessageLength" data-uid="Grpc.Core.ChannelOptions.MaxSendMessageLength">MaxSendMessageLength</h4>
  256. <div class="markdown level1 summary"><p>Maximum message length that the channel can send</p>
  257. </div>
  258. <div class="markdown level1 conceptual"></div>
  259. <h5 class="decalaration">Declaration</h5>
  260. <div class="codewrapper">
  261. <pre><code class="lang-csharp hljs">public const string MaxSendMessageLength = &quot;grpc.max_send_message_length&quot;</code></pre>
  262. </div>
  263. <h5 class="fieldValue">Field Value</h5>
  264. <table class="table table-bordered table-striped table-condensed">
  265. <thead>
  266. <tr>
  267. <th>Type</th>
  268. <th>Description</th>
  269. </tr>
  270. </thead>
  271. <tbody>
  272. <tr>
  273. <td><span class="xref">System.String</span></td>
  274. <td></td>
  275. </tr>
  276. </tbody>
  277. </table>
  278. <h4 id="Grpc_Core_ChannelOptions_PrimaryUserAgentString" data-uid="Grpc.Core.ChannelOptions.PrimaryUserAgentString">PrimaryUserAgentString</h4>
  279. <div class="markdown level1 summary"><p>Primary user agent: goes at the start of the user-agent metadata</p>
  280. </div>
  281. <div class="markdown level1 conceptual"></div>
  282. <h5 class="decalaration">Declaration</h5>
  283. <div class="codewrapper">
  284. <pre><code class="lang-csharp hljs">public const string PrimaryUserAgentString = &quot;grpc.primary_user_agent&quot;</code></pre>
  285. </div>
  286. <h5 class="fieldValue">Field Value</h5>
  287. <table class="table table-bordered table-striped table-condensed">
  288. <thead>
  289. <tr>
  290. <th>Type</th>
  291. <th>Description</th>
  292. </tr>
  293. </thead>
  294. <tbody>
  295. <tr>
  296. <td><span class="xref">System.String</span></td>
  297. <td></td>
  298. </tr>
  299. </tbody>
  300. </table>
  301. <h4 id="Grpc_Core_ChannelOptions_SecondaryUserAgentString" data-uid="Grpc.Core.ChannelOptions.SecondaryUserAgentString">SecondaryUserAgentString</h4>
  302. <div class="markdown level1 summary"><p>Secondary user agent: goes at the end of the user-agent metadata</p>
  303. </div>
  304. <div class="markdown level1 conceptual"></div>
  305. <h5 class="decalaration">Declaration</h5>
  306. <div class="codewrapper">
  307. <pre><code class="lang-csharp hljs">public const string SecondaryUserAgentString = &quot;grpc.secondary_user_agent&quot;</code></pre>
  308. </div>
  309. <h5 class="fieldValue">Field Value</h5>
  310. <table class="table table-bordered table-striped table-condensed">
  311. <thead>
  312. <tr>
  313. <th>Type</th>
  314. <th>Description</th>
  315. </tr>
  316. </thead>
  317. <tbody>
  318. <tr>
  319. <td><span class="xref">System.String</span></td>
  320. <td></td>
  321. </tr>
  322. </tbody>
  323. </table>
  324. <h4 id="Grpc_Core_ChannelOptions_SoReuseport" data-uid="Grpc.Core.ChannelOptions.SoReuseport">SoReuseport</h4>
  325. <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>
  326. </div>
  327. <div class="markdown level1 conceptual"></div>
  328. <h5 class="decalaration">Declaration</h5>
  329. <div class="codewrapper">
  330. <pre><code class="lang-csharp hljs">public const string SoReuseport = &quot;grpc.so_reuseport&quot;</code></pre>
  331. </div>
  332. <h5 class="fieldValue">Field Value</h5>
  333. <table class="table table-bordered table-striped table-condensed">
  334. <thead>
  335. <tr>
  336. <th>Type</th>
  337. <th>Description</th>
  338. </tr>
  339. </thead>
  340. <tbody>
  341. <tr>
  342. <td><span class="xref">System.String</span></td>
  343. <td></td>
  344. </tr>
  345. </tbody>
  346. </table>
  347. <h4 id="Grpc_Core_ChannelOptions_SslTargetNameOverride" data-uid="Grpc.Core.ChannelOptions.SslTargetNameOverride">SslTargetNameOverride</h4>
  348. <div class="markdown level1 summary"><p>Override SSL target check. Only to be used for testing.</p>
  349. </div>
  350. <div class="markdown level1 conceptual"></div>
  351. <h5 class="decalaration">Declaration</h5>
  352. <div class="codewrapper">
  353. <pre><code class="lang-csharp hljs">public const string SslTargetNameOverride = &quot;grpc.ssl_target_name_override&quot;</code></pre>
  354. </div>
  355. <h5 class="fieldValue">Field Value</h5>
  356. <table class="table table-bordered table-striped table-condensed">
  357. <thead>
  358. <tr>
  359. <th>Type</th>
  360. <th>Description</th>
  361. </tr>
  362. </thead>
  363. <tbody>
  364. <tr>
  365. <td><span class="xref">System.String</span></td>
  366. <td></td>
  367. </tr>
  368. </tbody>
  369. </table>
  370. </article>
  371. </div>
  372. <div class="hidden-sm col-md-2" role="complementary">
  373. <div class="sideaffix">
  374. <nav class="bs-docs-sidebar hidden-print hidden-xs hidden-sm affix" id="affix">
  375. <!-- <p><a class="back-to-top" href="#top">Back to top</a><p> -->
  376. </nav>
  377. </div>
  378. </div>
  379. </div>
  380. </div>
  381. <footer>
  382. <div class="grad-bottom"></div>
  383. <div class="footer">
  384. <div class="container">
  385. <span class="pull-right">
  386. <a href="#top">Back to top</a>
  387. </span>
  388. <span>Generated by <strong>DocFX</strong></span>
  389. </div>
  390. </div>
  391. </footer>
  392. </div>
  393. <script type="text/javascript" src="../styles/docfx.vendor.js"></script>
  394. <script type="text/javascript" src="../styles/docfx.js"></script>
  395. <script type="text/javascript" src="../styles/main.js"></script>
  396. </body>
  397. </html>