Grpc.Core.ClientBase.html 10 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274
  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 C# </title>
  9. <meta name="viewport" content="width=device-width">
  10. <meta name="title" content="Class ClientBase
  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.ClientBase">
  71. <h1 id="Grpc_Core_ClientBase" data-uid="Grpc.Core.ClientBase" class="text-break">Class ClientBase
  72. </h1>
  73. <div class="markdown level0 summary"><p>Base class for client-side stubs.</p>
  74. </div>
  75. <div class="markdown level0 conceptual"></div>
  76. <div class="inheritance">
  77. <h5>Inheritance</h5>
  78. <div class="level0"><span class="xref">System.Object</span></div>
  79. <div class="level1"><span class="xref">ClientBase</span></div>
  80. </div>
  81. <div class="level2"><a class="xref" href="Grpc.Core.ClientBase-1.html">ClientBase&lt;T&gt;</a></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_ClientBase_syntax">Syntax</h5>
  109. <div class="codewrapper">
  110. <pre><code class="lang-csharp hljs">public abstract class ClientBase</code></pre>
  111. </div>
  112. <h3 id="constructors">Constructors
  113. </h3>
  114. <a id="Grpc_Core_ClientBase__ctor_" data-uid="Grpc.Core.ClientBase.#ctor*"></a>
  115. <h4 id="Grpc_Core_ClientBase__ctor" data-uid="Grpc.Core.ClientBase.#ctor">ClientBase()</h4>
  116. <div class="markdown level1 summary"><p>Initializes a new instance of <code>ClientBase</code> class that
  117. throws <code>NotImplementedException</code> upon invocation of any RPC.
  118. This constructor is only provided to allow creation of test doubles
  119. for client classes (e.g. mocking requires a parameterless constructor).</p>
  120. </div>
  121. <div class="markdown level1 conceptual"></div>
  122. <h5 class="decalaration">Declaration</h5>
  123. <div class="codewrapper">
  124. <pre><code class="lang-csharp hljs">protected ClientBase()</code></pre>
  125. </div>
  126. <a id="Grpc_Core_ClientBase__ctor_" data-uid="Grpc.Core.ClientBase.#ctor*"></a>
  127. <h4 id="Grpc_Core_ClientBase__ctor_Grpc_Core_CallInvoker_" data-uid="Grpc.Core.ClientBase.#ctor(Grpc.Core.CallInvoker)">ClientBase(CallInvoker)</h4>
  128. <div class="markdown level1 summary"><p>Initializes a new instance of <code>ClientBase</code> class.</p>
  129. </div>
  130. <div class="markdown level1 conceptual"></div>
  131. <h5 class="decalaration">Declaration</h5>
  132. <div class="codewrapper">
  133. <pre><code class="lang-csharp hljs">public ClientBase(CallInvoker callInvoker)</code></pre>
  134. </div>
  135. <h5 class="parameters">Parameters</h5>
  136. <table class="table table-bordered table-striped table-condensed">
  137. <thead>
  138. <tr>
  139. <th>Type</th>
  140. <th>Name</th>
  141. <th>Description</th>
  142. </tr>
  143. </thead>
  144. <tbody>
  145. <tr>
  146. <td><a class="xref" href="Grpc.Core.CallInvoker.html">CallInvoker</a></td>
  147. <td><span class="parametername">callInvoker</span></td>
  148. <td><p>The <code>CallInvoker</code> for remote call invocation.</p>
  149. </td>
  150. </tr>
  151. </tbody>
  152. </table>
  153. <a id="Grpc_Core_ClientBase__ctor_" data-uid="Grpc.Core.ClientBase.#ctor*"></a>
  154. <h4 id="Grpc_Core_ClientBase__ctor_Grpc_Core_Channel_" data-uid="Grpc.Core.ClientBase.#ctor(Grpc.Core.Channel)">ClientBase(Channel)</h4>
  155. <div class="markdown level1 summary"><p>Initializes a new instance of <code>ClientBase</code> class.</p>
  156. </div>
  157. <div class="markdown level1 conceptual"></div>
  158. <h5 class="decalaration">Declaration</h5>
  159. <div class="codewrapper">
  160. <pre><code class="lang-csharp hljs">public ClientBase(Channel channel)</code></pre>
  161. </div>
  162. <h5 class="parameters">Parameters</h5>
  163. <table class="table table-bordered table-striped table-condensed">
  164. <thead>
  165. <tr>
  166. <th>Type</th>
  167. <th>Name</th>
  168. <th>Description</th>
  169. </tr>
  170. </thead>
  171. <tbody>
  172. <tr>
  173. <td><a class="xref" href="Grpc.Core.Channel.html">Channel</a></td>
  174. <td><span class="parametername">channel</span></td>
  175. <td><p>The channel to use for remote call invocation.</p>
  176. </td>
  177. </tr>
  178. </tbody>
  179. </table>
  180. <a id="Grpc_Core_ClientBase__ctor_" data-uid="Grpc.Core.ClientBase.#ctor*"></a>
  181. <h4 id="Grpc_Core_ClientBase__ctor_Grpc_Core_ClientBase_ClientBaseConfiguration_" data-uid="Grpc.Core.ClientBase.#ctor(Grpc.Core.ClientBase.ClientBaseConfiguration)">ClientBase(ClientBase.ClientBaseConfiguration)</h4>
  182. <div class="markdown level1 summary"><p>Initializes a new instance of <code>ClientBase</code> class.</p>
  183. </div>
  184. <div class="markdown level1 conceptual"></div>
  185. <h5 class="decalaration">Declaration</h5>
  186. <div class="codewrapper">
  187. <pre><code class="lang-csharp hljs">protected ClientBase(ClientBase.ClientBaseConfiguration configuration)</code></pre>
  188. </div>
  189. <h5 class="parameters">Parameters</h5>
  190. <table class="table table-bordered table-striped table-condensed">
  191. <thead>
  192. <tr>
  193. <th>Type</th>
  194. <th>Name</th>
  195. <th>Description</th>
  196. </tr>
  197. </thead>
  198. <tbody>
  199. <tr>
  200. <td><a class="xref" href="Grpc.Core.ClientBase.ClientBaseConfiguration.html">ClientBase.ClientBaseConfiguration</a></td>
  201. <td><span class="parametername">configuration</span></td>
  202. <td><p>The configuration.</p>
  203. </td>
  204. </tr>
  205. </tbody>
  206. </table>
  207. <h3 id="properties">Properties
  208. </h3>
  209. <a id="Grpc_Core_ClientBase_CallInvoker_" data-uid="Grpc.Core.ClientBase.CallInvoker*"></a>
  210. <h4 id="Grpc_Core_ClientBase_CallInvoker" data-uid="Grpc.Core.ClientBase.CallInvoker">CallInvoker</h4>
  211. <div class="markdown level1 summary"><p>Gets the call invoker.</p>
  212. </div>
  213. <div class="markdown level1 conceptual"></div>
  214. <h5 class="decalaration">Declaration</h5>
  215. <div class="codewrapper">
  216. <pre><code class="lang-csharp hljs">protected CallInvoker CallInvoker { get; }</code></pre>
  217. </div>
  218. <h5 class="propertyValue">Property Value</h5>
  219. <table class="table table-bordered table-striped table-condensed">
  220. <thead>
  221. <tr>
  222. <th>Type</th>
  223. <th>Description</th>
  224. </tr>
  225. </thead>
  226. <tbody>
  227. <tr>
  228. <td><a class="xref" href="Grpc.Core.CallInvoker.html">CallInvoker</a></td>
  229. <td></td>
  230. </tr>
  231. </tbody>
  232. </table>
  233. </article>
  234. </div>
  235. <div class="hidden-sm col-md-2" role="complementary">
  236. <div class="sideaffix">
  237. <nav class="bs-docs-sidebar hidden-print hidden-xs hidden-sm affix" id="affix">
  238. <!-- <p><a class="back-to-top" href="#top">Back to top</a><p> -->
  239. </nav>
  240. </div>
  241. </div>
  242. </div>
  243. </div>
  244. <footer>
  245. <div class="grad-bottom"></div>
  246. <div class="footer">
  247. <div class="container">
  248. <span class="pull-right">
  249. <a href="#top">Back to top</a>
  250. </span>
  251. <span>Copyright © 2015-2017 Microsoft<br>Generated by <strong>DocFX</strong></span>
  252. </div>
  253. </div>
  254. </footer>
  255. </div>
  256. <script type="text/javascript" src="../styles/docfx.vendor.js"></script>
  257. <script type="text/javascript" src="../styles/docfx.js"></script>
  258. <script type="text/javascript" src="../styles/main.js"></script>
  259. </body>
  260. </html>