Grpc.Core.ChannelOption.html 12 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322
  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 ChannelOption
  8. | gRPC C# </title>
  9. <meta name="viewport" content="width=device-width">
  10. <meta name="title" content="Class ChannelOption
  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.ChannelOption">
  73. <h1 id="Grpc_Core_ChannelOption" data-uid="Grpc.Core.ChannelOption" class="text-break">Class ChannelOption
  74. </h1>
  75. <div class="markdown level0 summary"><p>Channel option specified when creating a channel.
  76. Corresponds to grpc_channel_args from grpc/grpc.h.</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">ChannelOption</span></div>
  83. </div>
  84. <div class="inheritedMembers">
  85. <h5>Inherited Members</h5>
  86. <div>
  87. <span class="xref">System.Object.ToString()</span>
  88. </div>
  89. <div>
  90. <span class="xref">System.Object.Equals(System.Object)</span>
  91. </div>
  92. <div>
  93. <span class="xref">System.Object.Equals(System.Object, System.Object)</span>
  94. </div>
  95. <div>
  96. <span class="xref">System.Object.ReferenceEquals(System.Object, System.Object)</span>
  97. </div>
  98. <div>
  99. <span class="xref">System.Object.GetHashCode()</span>
  100. </div>
  101. <div>
  102. <span class="xref">System.Object.GetType()</span>
  103. </div>
  104. <div>
  105. <span class="xref">System.Object.MemberwiseClone()</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_ChannelOption_syntax">Syntax</h5>
  111. <div class="codewrapper">
  112. <pre><code class="lang-csharp hljs">public sealed class ChannelOption</code></pre>
  113. </div>
  114. <h3 id="constructors">Constructors
  115. </h3>
  116. <a id="Grpc_Core_ChannelOption__ctor_" data-uid="Grpc.Core.ChannelOption.#ctor*"></a>
  117. <h4 id="Grpc_Core_ChannelOption__ctor_System_String_System_Int32_" data-uid="Grpc.Core.ChannelOption.#ctor(System.String,System.Int32)">ChannelOption(String, Int32)</h4>
  118. <div class="markdown level1 summary"><p>Creates a channel option with an integer value.</p>
  119. </div>
  120. <div class="markdown level1 conceptual"></div>
  121. <h5 class="decalaration">Declaration</h5>
  122. <div class="codewrapper">
  123. <pre><code class="lang-csharp hljs">public ChannelOption(string name, int intValue)</code></pre>
  124. </div>
  125. <h5 class="parameters">Parameters</h5>
  126. <table class="table table-bordered table-striped table-condensed">
  127. <thead>
  128. <tr>
  129. <th>Type</th>
  130. <th>Name</th>
  131. <th>Description</th>
  132. </tr>
  133. </thead>
  134. <tbody>
  135. <tr>
  136. <td><span class="xref">System.String</span></td>
  137. <td><span class="parametername">name</span></td>
  138. <td><p>Name.</p>
  139. </td>
  140. </tr>
  141. <tr>
  142. <td><span class="xref">System.Int32</span></td>
  143. <td><span class="parametername">intValue</span></td>
  144. <td><p>Integer value.</p>
  145. </td>
  146. </tr>
  147. </tbody>
  148. </table>
  149. <a id="Grpc_Core_ChannelOption__ctor_" data-uid="Grpc.Core.ChannelOption.#ctor*"></a>
  150. <h4 id="Grpc_Core_ChannelOption__ctor_System_String_System_String_" data-uid="Grpc.Core.ChannelOption.#ctor(System.String,System.String)">ChannelOption(String, String)</h4>
  151. <div class="markdown level1 summary"><p>Creates a channel option with a string value.</p>
  152. </div>
  153. <div class="markdown level1 conceptual"></div>
  154. <h5 class="decalaration">Declaration</h5>
  155. <div class="codewrapper">
  156. <pre><code class="lang-csharp hljs">public ChannelOption(string name, string stringValue)</code></pre>
  157. </div>
  158. <h5 class="parameters">Parameters</h5>
  159. <table class="table table-bordered table-striped table-condensed">
  160. <thead>
  161. <tr>
  162. <th>Type</th>
  163. <th>Name</th>
  164. <th>Description</th>
  165. </tr>
  166. </thead>
  167. <tbody>
  168. <tr>
  169. <td><span class="xref">System.String</span></td>
  170. <td><span class="parametername">name</span></td>
  171. <td><p>Name.</p>
  172. </td>
  173. </tr>
  174. <tr>
  175. <td><span class="xref">System.String</span></td>
  176. <td><span class="parametername">stringValue</span></td>
  177. <td><p>String value.</p>
  178. </td>
  179. </tr>
  180. </tbody>
  181. </table>
  182. <h3 id="properties">Properties
  183. </h3>
  184. <a id="Grpc_Core_ChannelOption_IntValue_" data-uid="Grpc.Core.ChannelOption.IntValue*"></a>
  185. <h4 id="Grpc_Core_ChannelOption_IntValue" data-uid="Grpc.Core.ChannelOption.IntValue">IntValue</h4>
  186. <div class="markdown level1 summary"><p>Gets the integer value the <code>ChannelOption</code>.</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 int IntValue { get; }</code></pre>
  192. </div>
  193. <h5 class="propertyValue">Property 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.Int32</span></td>
  204. <td></td>
  205. </tr>
  206. </tbody>
  207. </table>
  208. <a id="Grpc_Core_ChannelOption_Name_" data-uid="Grpc.Core.ChannelOption.Name*"></a>
  209. <h4 id="Grpc_Core_ChannelOption_Name" data-uid="Grpc.Core.ChannelOption.Name">Name</h4>
  210. <div class="markdown level1 summary"><p>Gets the name of the <code>ChannelOption</code>.</p>
  211. </div>
  212. <div class="markdown level1 conceptual"></div>
  213. <h5 class="decalaration">Declaration</h5>
  214. <div class="codewrapper">
  215. <pre><code class="lang-csharp hljs">public string Name { get; }</code></pre>
  216. </div>
  217. <h5 class="propertyValue">Property 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. <a id="Grpc_Core_ChannelOption_StringValue_" data-uid="Grpc.Core.ChannelOption.StringValue*"></a>
  233. <h4 id="Grpc_Core_ChannelOption_StringValue" data-uid="Grpc.Core.ChannelOption.StringValue">StringValue</h4>
  234. <div class="markdown level1 summary"><p>Gets the string value the <code>ChannelOption</code>.</p>
  235. </div>
  236. <div class="markdown level1 conceptual"></div>
  237. <h5 class="decalaration">Declaration</h5>
  238. <div class="codewrapper">
  239. <pre><code class="lang-csharp hljs">public string StringValue { get; }</code></pre>
  240. </div>
  241. <h5 class="propertyValue">Property Value</h5>
  242. <table class="table table-bordered table-striped table-condensed">
  243. <thead>
  244. <tr>
  245. <th>Type</th>
  246. <th>Description</th>
  247. </tr>
  248. </thead>
  249. <tbody>
  250. <tr>
  251. <td><span class="xref">System.String</span></td>
  252. <td></td>
  253. </tr>
  254. </tbody>
  255. </table>
  256. <a id="Grpc_Core_ChannelOption_Type_" data-uid="Grpc.Core.ChannelOption.Type*"></a>
  257. <h4 id="Grpc_Core_ChannelOption_Type" data-uid="Grpc.Core.ChannelOption.Type">Type</h4>
  258. <div class="markdown level1 summary"><p>Gets the type of the <code>ChannelOption</code>.</p>
  259. </div>
  260. <div class="markdown level1 conceptual"></div>
  261. <h5 class="decalaration">Declaration</h5>
  262. <div class="codewrapper">
  263. <pre><code class="lang-csharp hljs">public ChannelOption.OptionType Type { get; }</code></pre>
  264. </div>
  265. <h5 class="propertyValue">Property Value</h5>
  266. <table class="table table-bordered table-striped table-condensed">
  267. <thead>
  268. <tr>
  269. <th>Type</th>
  270. <th>Description</th>
  271. </tr>
  272. </thead>
  273. <tbody>
  274. <tr>
  275. <td><a class="xref" href="Grpc.Core.ChannelOption.OptionType.html">ChannelOption.OptionType</a></td>
  276. <td></td>
  277. </tr>
  278. </tbody>
  279. </table>
  280. </article>
  281. </div>
  282. <div class="hidden-sm col-md-2" role="complementary">
  283. <div class="sideaffix">
  284. <nav class="bs-docs-sidebar hidden-print hidden-xs hidden-sm affix" id="affix">
  285. <!-- <p><a class="back-to-top" href="#top">Back to top</a><p> -->
  286. </nav>
  287. </div>
  288. </div>
  289. </div>
  290. </div>
  291. <footer>
  292. <div class="grad-bottom"></div>
  293. <div class="footer">
  294. <div class="container">
  295. <span class="pull-right">
  296. <a href="#top">Back to top</a>
  297. </span>
  298. <span>Generated by <strong>DocFX</strong></span>
  299. </div>
  300. </div>
  301. </footer>
  302. </div>
  303. <script type="text/javascript" src="../styles/docfx.vendor.js"></script>
  304. <script type="text/javascript" src="../styles/docfx.js"></script>
  305. <script type="text/javascript" src="../styles/main.js"></script>
  306. </body>
  307. </html>