Grpc.Core.ClientBase.html 10 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253
  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 ClientBase
  8. | gRPC for .NET </title>
  9. <meta name="viewport" content="width=device-width">
  10. <meta name="title" content="Class ClientBase
  11. | gRPC for .NET ">
  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.ClientBase">
  73. <h1 id="Grpc_Core_ClientBase" data-uid="Grpc.Core.ClientBase" class="text-break">Class ClientBase
  74. </h1>
  75. <div class="markdown level0 summary"><p>Base class for client-side stubs.</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">ClientBase</span></div>
  82. <div class="level2"><a class="xref" href="Grpc.Core.ClientBase-1.html">ClientBase&lt;T&gt;</a></div>
  83. </div>
  84. <h6><strong>Namespace</strong>: <a class="xref" href="Grpc.Core.html">Grpc.Core</a></h6>
  85. <h6><strong>Assembly</strong>: Grpc.Core.Api.dll</h6>
  86. <h5 id="Grpc_Core_ClientBase_syntax">Syntax</h5>
  87. <div class="codewrapper">
  88. <pre><code class="lang-csharp hljs">public abstract class ClientBase : object</code></pre>
  89. </div>
  90. <h3 id="constructors">Constructors
  91. </h3>
  92. <a id="Grpc_Core_ClientBase__ctor_" data-uid="Grpc.Core.ClientBase.#ctor*"></a>
  93. <h4 id="Grpc_Core_ClientBase__ctor" data-uid="Grpc.Core.ClientBase.#ctor">ClientBase()</h4>
  94. <div class="markdown level1 summary"><p>Initializes a new instance of <code>ClientBase</code> class that
  95. throws <code>NotImplementedException</code> upon invocation of any RPC.
  96. This constructor is only provided to allow creation of test doubles
  97. for client classes (e.g. mocking requires a parameterless constructor).</p>
  98. </div>
  99. <div class="markdown level1 conceptual"></div>
  100. <h5 class="decalaration">Declaration</h5>
  101. <div class="codewrapper">
  102. <pre><code class="lang-csharp hljs">protected ClientBase()</code></pre>
  103. </div>
  104. <a id="Grpc_Core_ClientBase__ctor_" data-uid="Grpc.Core.ClientBase.#ctor*"></a>
  105. <h4 id="Grpc_Core_ClientBase__ctor_Grpc_Core_CallInvoker_" data-uid="Grpc.Core.ClientBase.#ctor(Grpc.Core.CallInvoker)">ClientBase(CallInvoker)</h4>
  106. <div class="markdown level1 summary"><p>Initializes a new instance of <code>ClientBase</code> class.</p>
  107. </div>
  108. <div class="markdown level1 conceptual"></div>
  109. <h5 class="decalaration">Declaration</h5>
  110. <div class="codewrapper">
  111. <pre><code class="lang-csharp hljs">public ClientBase(CallInvoker callInvoker)</code></pre>
  112. </div>
  113. <h5 class="parameters">Parameters</h5>
  114. <table class="table table-bordered table-striped table-condensed">
  115. <thead>
  116. <tr>
  117. <th>Type</th>
  118. <th>Name</th>
  119. <th>Description</th>
  120. </tr>
  121. </thead>
  122. <tbody>
  123. <tr>
  124. <td><a class="xref" href="Grpc.Core.CallInvoker.html">CallInvoker</a></td>
  125. <td><span class="parametername">callInvoker</span></td>
  126. <td><p>The <code>CallInvoker</code> for remote call invocation.</p>
  127. </td>
  128. </tr>
  129. </tbody>
  130. </table>
  131. <a id="Grpc_Core_ClientBase__ctor_" data-uid="Grpc.Core.ClientBase.#ctor*"></a>
  132. <h4 id="Grpc_Core_ClientBase__ctor_Grpc_Core_ChannelBase_" data-uid="Grpc.Core.ClientBase.#ctor(Grpc.Core.ChannelBase)">ClientBase(ChannelBase)</h4>
  133. <div class="markdown level1 summary"><p>Initializes a new instance of <code>ClientBase</code> class.</p>
  134. </div>
  135. <div class="markdown level1 conceptual"></div>
  136. <h5 class="decalaration">Declaration</h5>
  137. <div class="codewrapper">
  138. <pre><code class="lang-csharp hljs">public ClientBase(ChannelBase channel)</code></pre>
  139. </div>
  140. <h5 class="parameters">Parameters</h5>
  141. <table class="table table-bordered table-striped table-condensed">
  142. <thead>
  143. <tr>
  144. <th>Type</th>
  145. <th>Name</th>
  146. <th>Description</th>
  147. </tr>
  148. </thead>
  149. <tbody>
  150. <tr>
  151. <td><a class="xref" href="Grpc.Core.ChannelBase.html">ChannelBase</a></td>
  152. <td><span class="parametername">channel</span></td>
  153. <td><p>The channel to use for remote call invocation.</p>
  154. </td>
  155. </tr>
  156. </tbody>
  157. </table>
  158. <a id="Grpc_Core_ClientBase__ctor_" data-uid="Grpc.Core.ClientBase.#ctor*"></a>
  159. <h4 id="Grpc_Core_ClientBase__ctor_Grpc_Core_ClientBase_ClientBaseConfiguration_" data-uid="Grpc.Core.ClientBase.#ctor(Grpc.Core.ClientBase.ClientBaseConfiguration)">ClientBase(ClientBase.ClientBaseConfiguration)</h4>
  160. <div class="markdown level1 summary"><p>Initializes a new instance of <code>ClientBase</code> class.</p>
  161. </div>
  162. <div class="markdown level1 conceptual"></div>
  163. <h5 class="decalaration">Declaration</h5>
  164. <div class="codewrapper">
  165. <pre><code class="lang-csharp hljs">protected ClientBase(ClientBase.ClientBaseConfiguration configuration)</code></pre>
  166. </div>
  167. <h5 class="parameters">Parameters</h5>
  168. <table class="table table-bordered table-striped table-condensed">
  169. <thead>
  170. <tr>
  171. <th>Type</th>
  172. <th>Name</th>
  173. <th>Description</th>
  174. </tr>
  175. </thead>
  176. <tbody>
  177. <tr>
  178. <td><a class="xref" href="Grpc.Core.ClientBase.ClientBaseConfiguration.html">ClientBase.ClientBaseConfiguration</a></td>
  179. <td><span class="parametername">configuration</span></td>
  180. <td><p>The configuration.</p>
  181. </td>
  182. </tr>
  183. </tbody>
  184. </table>
  185. <h3 id="properties">Properties
  186. </h3>
  187. <a id="Grpc_Core_ClientBase_CallInvoker_" data-uid="Grpc.Core.ClientBase.CallInvoker*"></a>
  188. <h4 id="Grpc_Core_ClientBase_CallInvoker" data-uid="Grpc.Core.ClientBase.CallInvoker">CallInvoker</h4>
  189. <div class="markdown level1 summary"><p>Gets the call invoker.</p>
  190. </div>
  191. <div class="markdown level1 conceptual"></div>
  192. <h5 class="decalaration">Declaration</h5>
  193. <div class="codewrapper">
  194. <pre><code class="lang-csharp hljs">protected CallInvoker CallInvoker { get; }</code></pre>
  195. </div>
  196. <h5 class="propertyValue">Property Value</h5>
  197. <table class="table table-bordered table-striped table-condensed">
  198. <thead>
  199. <tr>
  200. <th>Type</th>
  201. <th>Description</th>
  202. </tr>
  203. </thead>
  204. <tbody>
  205. <tr>
  206. <td><a class="xref" href="Grpc.Core.CallInvoker.html">CallInvoker</a></td>
  207. <td></td>
  208. </tr>
  209. </tbody>
  210. </table>
  211. </article>
  212. </div>
  213. <div class="hidden-sm col-md-2" role="complementary">
  214. <div class="sideaffix">
  215. <nav class="bs-docs-sidebar hidden-print hidden-xs hidden-sm affix" id="affix">
  216. <!-- <p><a class="back-to-top" href="#top">Back to top</a><p> -->
  217. </nav>
  218. </div>
  219. </div>
  220. </div>
  221. </div>
  222. <footer>
  223. <div class="grad-bottom"></div>
  224. <div class="footer">
  225. <div class="container">
  226. <span class="pull-right">
  227. <a href="#top">Back to top</a>
  228. </span>
  229. <span>Generated by <strong>DocFX</strong></span>
  230. </div>
  231. </div>
  232. </footer>
  233. </div>
  234. <script type="text/javascript" src="../styles/docfx.vendor.js"></script>
  235. <script type="text/javascript" src="../styles/docfx.js"></script>
  236. <script type="text/javascript" src="../styles/main.js"></script>
  237. </body>
  238. </html>