Grpc.Core.ChannelOption.html 11 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319
  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.23.1.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">
  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"></div>
  58. <ul id="pagination"></ul>
  59. </div>
  60. </div>
  61. <div role="main" class="container body-content hide-when-search">
  62. <div class="sidenav hide-when-search">
  63. <a class="btn toc-toggle collapse" data-toggle="collapse" href="#sidetoggle" aria-expanded="false" aria-controls="sidetoggle">Show / Hide Table of Contents</a>
  64. <div class="sidetoggle collapse" id="sidetoggle">
  65. <div id="sidetoc"></div>
  66. </div>
  67. </div>
  68. <div class="article row grid-right">
  69. <div class="col-md-10">
  70. <article class="content wrap" id="_content" data-uid="Grpc.Core.ChannelOption">
  71. <h1 id="Grpc_Core_ChannelOption" data-uid="Grpc.Core.ChannelOption" class="text-break">Class ChannelOption
  72. </h1>
  73. <div class="markdown level0 summary"><p>Channel option specified when creating a channel.
  74. Corresponds to grpc_channel_args from grpc/grpc.h.</p>
  75. </div>
  76. <div class="markdown level0 conceptual"></div>
  77. <div class="inheritance">
  78. <h5>Inheritance</h5>
  79. <div class="level0"><span class="xref">System.Object</span></div>
  80. <div class="level1"><span class="xref">ChannelOption</span></div>
  81. </div>
  82. <div class="inheritedMembers">
  83. <h5>Inherited Members</h5>
  84. <div>
  85. <span class="xref">System.Object.ToString()</span>
  86. </div>
  87. <div>
  88. <span class="xref">System.Object.Equals(System.Object)</span>
  89. </div>
  90. <div>
  91. <span class="xref">System.Object.Equals(System.Object, System.Object)</span>
  92. </div>
  93. <div>
  94. <span class="xref">System.Object.ReferenceEquals(System.Object, System.Object)</span>
  95. </div>
  96. <div>
  97. <span class="xref">System.Object.GetHashCode()</span>
  98. </div>
  99. <div>
  100. <span class="xref">System.Object.GetType()</span>
  101. </div>
  102. <div>
  103. <span class="xref">System.Object.MemberwiseClone()</span>
  104. </div>
  105. </div>
  106. <h6><strong>Namespace</strong>: <a class="xref" href="Grpc.Core.html">Grpc.Core</a></h6>
  107. <h6><strong>Assembly</strong>: Grpc.Core.dll</h6>
  108. <h5 id="Grpc_Core_ChannelOption_syntax">Syntax</h5>
  109. <div class="codewrapper">
  110. <pre><code class="lang-csharp hljs">public sealed class ChannelOption</code></pre>
  111. </div>
  112. <h3 id="constructors">Constructors
  113. </h3>
  114. <a id="Grpc_Core_ChannelOption__ctor_" data-uid="Grpc.Core.ChannelOption.#ctor*"></a>
  115. <h4 id="Grpc_Core_ChannelOption__ctor_System_String_System_Int32_" data-uid="Grpc.Core.ChannelOption.#ctor(System.String,System.Int32)">ChannelOption(String, Int32)</h4>
  116. <div class="markdown level1 summary"><p>Creates a channel option with an integer value.</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 ChannelOption(string name, int intValue)</code></pre>
  122. </div>
  123. <h5 class="parameters">Parameters</h5>
  124. <table class="table table-bordered table-striped table-condensed">
  125. <thead>
  126. <tr>
  127. <th>Type</th>
  128. <th>Name</th>
  129. <th>Description</th>
  130. </tr>
  131. </thead>
  132. <tbody>
  133. <tr>
  134. <td><span class="xref">System.String</span></td>
  135. <td><span class="parametername">name</span></td>
  136. <td><p>Name.</p>
  137. </td>
  138. </tr>
  139. <tr>
  140. <td><span class="xref">System.Int32</span></td>
  141. <td><span class="parametername">intValue</span></td>
  142. <td><p>Integer value.</p>
  143. </td>
  144. </tr>
  145. </tbody>
  146. </table>
  147. <a id="Grpc_Core_ChannelOption__ctor_" data-uid="Grpc.Core.ChannelOption.#ctor*"></a>
  148. <h4 id="Grpc_Core_ChannelOption__ctor_System_String_System_String_" data-uid="Grpc.Core.ChannelOption.#ctor(System.String,System.String)">ChannelOption(String, String)</h4>
  149. <div class="markdown level1 summary"><p>Creates a channel option with a string value.</p>
  150. </div>
  151. <div class="markdown level1 conceptual"></div>
  152. <h5 class="decalaration">Declaration</h5>
  153. <div class="codewrapper">
  154. <pre><code class="lang-csharp hljs">public ChannelOption(string name, string stringValue)</code></pre>
  155. </div>
  156. <h5 class="parameters">Parameters</h5>
  157. <table class="table table-bordered table-striped table-condensed">
  158. <thead>
  159. <tr>
  160. <th>Type</th>
  161. <th>Name</th>
  162. <th>Description</th>
  163. </tr>
  164. </thead>
  165. <tbody>
  166. <tr>
  167. <td><span class="xref">System.String</span></td>
  168. <td><span class="parametername">name</span></td>
  169. <td><p>Name.</p>
  170. </td>
  171. </tr>
  172. <tr>
  173. <td><span class="xref">System.String</span></td>
  174. <td><span class="parametername">stringValue</span></td>
  175. <td><p>String value.</p>
  176. </td>
  177. </tr>
  178. </tbody>
  179. </table>
  180. <h3 id="properties">Properties
  181. </h3>
  182. <a id="Grpc_Core_ChannelOption_IntValue_" data-uid="Grpc.Core.ChannelOption.IntValue*"></a>
  183. <h4 id="Grpc_Core_ChannelOption_IntValue" data-uid="Grpc.Core.ChannelOption.IntValue">IntValue</h4>
  184. <div class="markdown level1 summary"><p>Gets the integer value the <code>ChannelOption</code>.</p>
  185. </div>
  186. <div class="markdown level1 conceptual"></div>
  187. <h5 class="decalaration">Declaration</h5>
  188. <div class="codewrapper">
  189. <pre><code class="lang-csharp hljs">public int IntValue { get; }</code></pre>
  190. </div>
  191. <h5 class="propertyValue">Property Value</h5>
  192. <table class="table table-bordered table-striped table-condensed">
  193. <thead>
  194. <tr>
  195. <th>Type</th>
  196. <th>Description</th>
  197. </tr>
  198. </thead>
  199. <tbody>
  200. <tr>
  201. <td><span class="xref">System.Int32</span></td>
  202. <td></td>
  203. </tr>
  204. </tbody>
  205. </table>
  206. <a id="Grpc_Core_ChannelOption_Name_" data-uid="Grpc.Core.ChannelOption.Name*"></a>
  207. <h4 id="Grpc_Core_ChannelOption_Name" data-uid="Grpc.Core.ChannelOption.Name">Name</h4>
  208. <div class="markdown level1 summary"><p>Gets the name of the <code>ChannelOption</code>.</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">public string Name { get; }</code></pre>
  214. </div>
  215. <h5 class="propertyValue">Property Value</h5>
  216. <table class="table table-bordered table-striped table-condensed">
  217. <thead>
  218. <tr>
  219. <th>Type</th>
  220. <th>Description</th>
  221. </tr>
  222. </thead>
  223. <tbody>
  224. <tr>
  225. <td><span class="xref">System.String</span></td>
  226. <td></td>
  227. </tr>
  228. </tbody>
  229. </table>
  230. <a id="Grpc_Core_ChannelOption_StringValue_" data-uid="Grpc.Core.ChannelOption.StringValue*"></a>
  231. <h4 id="Grpc_Core_ChannelOption_StringValue" data-uid="Grpc.Core.ChannelOption.StringValue">StringValue</h4>
  232. <div class="markdown level1 summary"><p>Gets the string value the <code>ChannelOption</code>.</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 string StringValue { get; }</code></pre>
  238. </div>
  239. <h5 class="propertyValue">Property 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. <a id="Grpc_Core_ChannelOption_Type_" data-uid="Grpc.Core.ChannelOption.Type*"></a>
  255. <h4 id="Grpc_Core_ChannelOption_Type" data-uid="Grpc.Core.ChannelOption.Type">Type</h4>
  256. <div class="markdown level1 summary"><p>Gets the type of the <code>ChannelOption</code>.</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 ChannelOption.OptionType Type { get; }</code></pre>
  262. </div>
  263. <h5 class="propertyValue">Property 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><a class="xref" href="Grpc.Core.ChannelOption.OptionType.html">ChannelOption.OptionType</a></td>
  274. <td></td>
  275. </tr>
  276. </tbody>
  277. </table>
  278. </article>
  279. </div>
  280. <div class="hidden-sm col-md-2" role="complementary">
  281. <div class="sideaffix">
  282. <nav class="bs-docs-sidebar hidden-print hidden-xs hidden-sm affix" id="affix">
  283. <!-- <p><a class="back-to-top" href="#top">Back to top</a><p> -->
  284. </nav>
  285. </div>
  286. </div>
  287. </div>
  288. </div>
  289. <footer>
  290. <div class="grad-bottom"></div>
  291. <div class="footer">
  292. <div class="container">
  293. <span class="pull-right">
  294. <a href="#top">Back to top</a>
  295. </span>
  296. <span>Copyright © 2015-2017 Microsoft<br>Generated by <strong>DocFX</strong></span>
  297. </div>
  298. </div>
  299. </footer>
  300. </div>
  301. <script type="text/javascript" src="../styles/docfx.vendor.js"></script>
  302. <script type="text/javascript" src="../styles/docfx.js"></script>
  303. <script type="text/javascript" src="../styles/main.js"></script>
  304. </body>
  305. </html>