Grpc.AspNetCore.Server.Model.ServiceMethodProviderContext-1.html 18 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393
  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 ServiceMethodProviderContext&lt;TService&gt;
  8. | gRPC for .NET </title>
  9. <meta name="viewport" content="width=device-width">
  10. <meta name="title" content="Class ServiceMethodProviderContext&lt;TService&gt;
  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.AspNetCore.Server.Model.ServiceMethodProviderContext`1">
  73. <h1 id="Grpc_AspNetCore_Server_Model_ServiceMethodProviderContext_1" data-uid="Grpc.AspNetCore.Server.Model.ServiceMethodProviderContext`1" class="text-break">Class ServiceMethodProviderContext&lt;TService&gt;
  74. </h1>
  75. <div class="markdown level0 summary"><p>A context for <a class="xref" href="Grpc.AspNetCore.Server.Model.IServiceMethodProvider-1.html">IServiceMethodProvider&lt;TService&gt;</a>.</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">ServiceMethodProviderContext&lt;TService&gt;</span></div>
  82. </div>
  83. <h6><strong>Namespace</strong>: <a class="xref" href="Grpc.AspNetCore.Server.Model.html">Grpc.AspNetCore.Server.Model</a></h6>
  84. <h6><strong>Assembly</strong>: Grpc.AspNetCore.Server.dll</h6>
  85. <h5 id="Grpc_AspNetCore_Server_Model_ServiceMethodProviderContext_1_syntax">Syntax</h5>
  86. <div class="codewrapper">
  87. <pre><code class="lang-csharp hljs">public class ServiceMethodProviderContext&lt;TService&gt; : object where TService : class</code></pre>
  88. </div>
  89. <h5 class="typeParameters">Type Parameters</h5>
  90. <table class="table table-bordered table-striped table-condensed">
  91. <thead>
  92. <tr>
  93. <th>Name</th>
  94. <th>Description</th>
  95. </tr>
  96. </thead>
  97. <tbody>
  98. <tr>
  99. <td><span class="parametername">TService</span></td>
  100. <td><p>Service type for the context.</p>
  101. </td>
  102. </tr>
  103. </tbody>
  104. </table>
  105. <h3 id="methods">Methods
  106. </h3>
  107. <a id="Grpc_AspNetCore_Server_Model_ServiceMethodProviderContext_1_AddClientStreamingMethod_" data-uid="Grpc.AspNetCore.Server.Model.ServiceMethodProviderContext`1.AddClientStreamingMethod*"></a>
  108. <h4 id="Grpc_AspNetCore_Server_Model_ServiceMethodProviderContext_1_AddClientStreamingMethod__2_Method___0___1__IList_System_Object__Grpc_AspNetCore_Server_Model_ClientStreamingServerMethod__0___0___1__" data-uid="Grpc.AspNetCore.Server.Model.ServiceMethodProviderContext`1.AddClientStreamingMethod``2(Method{``0,``1},IList{System.Object},Grpc.AspNetCore.Server.Model.ClientStreamingServerMethod{`0,``0,``1})">AddClientStreamingMethod&lt;TRequest, TResponse&gt;(Method&lt;TRequest, TResponse&gt;, IList&lt;Object&gt;, ClientStreamingServerMethod&lt;TService, TRequest, TResponse&gt;)</h4>
  109. <div class="markdown level1 summary"><p>Adds a client streaming method to a service.</p>
  110. </div>
  111. <div class="markdown level1 conceptual"></div>
  112. <h5 class="decalaration">Declaration</h5>
  113. <div class="codewrapper">
  114. <pre><code class="lang-csharp hljs">public void AddClientStreamingMethod&lt;TRequest, TResponse&gt;(Method&lt;TRequest, TResponse&gt; method, IList&lt;object&gt; metadata, ClientStreamingServerMethod&lt;TService, TRequest, TResponse&gt; invoker)
  115. where TRequest : class where TResponse : class</code></pre>
  116. </div>
  117. <h5 class="parameters">Parameters</h5>
  118. <table class="table table-bordered table-striped table-condensed">
  119. <thead>
  120. <tr>
  121. <th>Type</th>
  122. <th>Name</th>
  123. <th>Description</th>
  124. </tr>
  125. </thead>
  126. <tbody>
  127. <tr>
  128. <td><span class="xref">Method</span>&lt;TRequest, TResponse&gt;</td>
  129. <td><span class="parametername">method</span></td>
  130. <td><p>The method description.</p>
  131. </td>
  132. </tr>
  133. <tr>
  134. <td><span class="xref">IList</span>&lt;<span class="xref">System.Object</span>&gt;</td>
  135. <td><span class="parametername">metadata</span></td>
  136. <td><p>The method metadata. This metadata can be used by routing and middleware when invoking a gRPC method.</p>
  137. </td>
  138. </tr>
  139. <tr>
  140. <td><a class="xref" href="Grpc.AspNetCore.Server.Model.ClientStreamingServerMethod-3.html">ClientStreamingServerMethod</a>&lt;TService, TRequest, TResponse&gt;</td>
  141. <td><span class="parametername">invoker</span></td>
  142. <td><p>The method invoker that is executed when the method is called.</p>
  143. </td>
  144. </tr>
  145. </tbody>
  146. </table>
  147. <h5 class="typeParameters">Type Parameters</h5>
  148. <table class="table table-bordered table-striped table-condensed">
  149. <thead>
  150. <tr>
  151. <th>Name</th>
  152. <th>Description</th>
  153. </tr>
  154. </thead>
  155. <tbody>
  156. <tr>
  157. <td><span class="parametername">TRequest</span></td>
  158. <td><p>Request message type for this method.</p>
  159. </td>
  160. </tr>
  161. <tr>
  162. <td><span class="parametername">TResponse</span></td>
  163. <td><p>Response message type for this method.</p>
  164. </td>
  165. </tr>
  166. </tbody>
  167. </table>
  168. <a id="Grpc_AspNetCore_Server_Model_ServiceMethodProviderContext_1_AddDuplexStreamingMethod_" data-uid="Grpc.AspNetCore.Server.Model.ServiceMethodProviderContext`1.AddDuplexStreamingMethod*"></a>
  169. <h4 id="Grpc_AspNetCore_Server_Model_ServiceMethodProviderContext_1_AddDuplexStreamingMethod__2_Method___0___1__IList_System_Object__Grpc_AspNetCore_Server_Model_DuplexStreamingServerMethod__0___0___1__" data-uid="Grpc.AspNetCore.Server.Model.ServiceMethodProviderContext`1.AddDuplexStreamingMethod``2(Method{``0,``1},IList{System.Object},Grpc.AspNetCore.Server.Model.DuplexStreamingServerMethod{`0,``0,``1})">AddDuplexStreamingMethod&lt;TRequest, TResponse&gt;(Method&lt;TRequest, TResponse&gt;, IList&lt;Object&gt;, DuplexStreamingServerMethod&lt;TService, TRequest, TResponse&gt;)</h4>
  170. <div class="markdown level1 summary"><p>Adds a duplex streaming method to a service.</p>
  171. </div>
  172. <div class="markdown level1 conceptual"></div>
  173. <h5 class="decalaration">Declaration</h5>
  174. <div class="codewrapper">
  175. <pre><code class="lang-csharp hljs">public void AddDuplexStreamingMethod&lt;TRequest, TResponse&gt;(Method&lt;TRequest, TResponse&gt; method, IList&lt;object&gt; metadata, DuplexStreamingServerMethod&lt;TService, TRequest, TResponse&gt; invoker)
  176. where TRequest : class where TResponse : class</code></pre>
  177. </div>
  178. <h5 class="parameters">Parameters</h5>
  179. <table class="table table-bordered table-striped table-condensed">
  180. <thead>
  181. <tr>
  182. <th>Type</th>
  183. <th>Name</th>
  184. <th>Description</th>
  185. </tr>
  186. </thead>
  187. <tbody>
  188. <tr>
  189. <td><span class="xref">Method</span>&lt;TRequest, TResponse&gt;</td>
  190. <td><span class="parametername">method</span></td>
  191. <td><p>The method description.</p>
  192. </td>
  193. </tr>
  194. <tr>
  195. <td><span class="xref">IList</span>&lt;<span class="xref">System.Object</span>&gt;</td>
  196. <td><span class="parametername">metadata</span></td>
  197. <td><p>The method metadata. This metadata can be used by routing and middleware when invoking a gRPC method.</p>
  198. </td>
  199. </tr>
  200. <tr>
  201. <td><a class="xref" href="Grpc.AspNetCore.Server.Model.DuplexStreamingServerMethod-3.html">DuplexStreamingServerMethod</a>&lt;TService, TRequest, TResponse&gt;</td>
  202. <td><span class="parametername">invoker</span></td>
  203. <td><p>The method invoker that is executed when the method is called.</p>
  204. </td>
  205. </tr>
  206. </tbody>
  207. </table>
  208. <h5 class="typeParameters">Type Parameters</h5>
  209. <table class="table table-bordered table-striped table-condensed">
  210. <thead>
  211. <tr>
  212. <th>Name</th>
  213. <th>Description</th>
  214. </tr>
  215. </thead>
  216. <tbody>
  217. <tr>
  218. <td><span class="parametername">TRequest</span></td>
  219. <td><p>Request message type for this method.</p>
  220. </td>
  221. </tr>
  222. <tr>
  223. <td><span class="parametername">TResponse</span></td>
  224. <td><p>Response message type for this method.</p>
  225. </td>
  226. </tr>
  227. </tbody>
  228. </table>
  229. <a id="Grpc_AspNetCore_Server_Model_ServiceMethodProviderContext_1_AddServerStreamingMethod_" data-uid="Grpc.AspNetCore.Server.Model.ServiceMethodProviderContext`1.AddServerStreamingMethod*"></a>
  230. <h4 id="Grpc_AspNetCore_Server_Model_ServiceMethodProviderContext_1_AddServerStreamingMethod__2_Method___0___1__IList_System_Object__Grpc_AspNetCore_Server_Model_ServerStreamingServerMethod__0___0___1__" data-uid="Grpc.AspNetCore.Server.Model.ServiceMethodProviderContext`1.AddServerStreamingMethod``2(Method{``0,``1},IList{System.Object},Grpc.AspNetCore.Server.Model.ServerStreamingServerMethod{`0,``0,``1})">AddServerStreamingMethod&lt;TRequest, TResponse&gt;(Method&lt;TRequest, TResponse&gt;, IList&lt;Object&gt;, ServerStreamingServerMethod&lt;TService, TRequest, TResponse&gt;)</h4>
  231. <div class="markdown level1 summary"><p>Adds a server streaming method to a service.</p>
  232. </div>
  233. <div class="markdown level1 conceptual"></div>
  234. <h5 class="decalaration">Declaration</h5>
  235. <div class="codewrapper">
  236. <pre><code class="lang-csharp hljs">public void AddServerStreamingMethod&lt;TRequest, TResponse&gt;(Method&lt;TRequest, TResponse&gt; method, IList&lt;object&gt; metadata, ServerStreamingServerMethod&lt;TService, TRequest, TResponse&gt; invoker)
  237. where TRequest : class where TResponse : class</code></pre>
  238. </div>
  239. <h5 class="parameters">Parameters</h5>
  240. <table class="table table-bordered table-striped table-condensed">
  241. <thead>
  242. <tr>
  243. <th>Type</th>
  244. <th>Name</th>
  245. <th>Description</th>
  246. </tr>
  247. </thead>
  248. <tbody>
  249. <tr>
  250. <td><span class="xref">Method</span>&lt;TRequest, TResponse&gt;</td>
  251. <td><span class="parametername">method</span></td>
  252. <td><p>The method description.</p>
  253. </td>
  254. </tr>
  255. <tr>
  256. <td><span class="xref">IList</span>&lt;<span class="xref">System.Object</span>&gt;</td>
  257. <td><span class="parametername">metadata</span></td>
  258. <td><p>The method metadata. This metadata can be used by routing and middleware when invoking a gRPC method.</p>
  259. </td>
  260. </tr>
  261. <tr>
  262. <td><a class="xref" href="Grpc.AspNetCore.Server.Model.ServerStreamingServerMethod-3.html">ServerStreamingServerMethod</a>&lt;TService, TRequest, TResponse&gt;</td>
  263. <td><span class="parametername">invoker</span></td>
  264. <td><p>The method invoker that is executed when the method is called.</p>
  265. </td>
  266. </tr>
  267. </tbody>
  268. </table>
  269. <h5 class="typeParameters">Type Parameters</h5>
  270. <table class="table table-bordered table-striped table-condensed">
  271. <thead>
  272. <tr>
  273. <th>Name</th>
  274. <th>Description</th>
  275. </tr>
  276. </thead>
  277. <tbody>
  278. <tr>
  279. <td><span class="parametername">TRequest</span></td>
  280. <td><p>Request message type for this method.</p>
  281. </td>
  282. </tr>
  283. <tr>
  284. <td><span class="parametername">TResponse</span></td>
  285. <td><p>Response message type for this method.</p>
  286. </td>
  287. </tr>
  288. </tbody>
  289. </table>
  290. <a id="Grpc_AspNetCore_Server_Model_ServiceMethodProviderContext_1_AddUnaryMethod_" data-uid="Grpc.AspNetCore.Server.Model.ServiceMethodProviderContext`1.AddUnaryMethod*"></a>
  291. <h4 id="Grpc_AspNetCore_Server_Model_ServiceMethodProviderContext_1_AddUnaryMethod__2_Method___0___1__IList_System_Object__Grpc_AspNetCore_Server_Model_UnaryServerMethod__0___0___1__" data-uid="Grpc.AspNetCore.Server.Model.ServiceMethodProviderContext`1.AddUnaryMethod``2(Method{``0,``1},IList{System.Object},Grpc.AspNetCore.Server.Model.UnaryServerMethod{`0,``0,``1})">AddUnaryMethod&lt;TRequest, TResponse&gt;(Method&lt;TRequest, TResponse&gt;, IList&lt;Object&gt;, UnaryServerMethod&lt;TService, TRequest, TResponse&gt;)</h4>
  292. <div class="markdown level1 summary"><p>Adds a unary method to a service.</p>
  293. </div>
  294. <div class="markdown level1 conceptual"></div>
  295. <h5 class="decalaration">Declaration</h5>
  296. <div class="codewrapper">
  297. <pre><code class="lang-csharp hljs">public void AddUnaryMethod&lt;TRequest, TResponse&gt;(Method&lt;TRequest, TResponse&gt; method, IList&lt;object&gt; metadata, UnaryServerMethod&lt;TService, TRequest, TResponse&gt; invoker)
  298. where TRequest : class where TResponse : class</code></pre>
  299. </div>
  300. <h5 class="parameters">Parameters</h5>
  301. <table class="table table-bordered table-striped table-condensed">
  302. <thead>
  303. <tr>
  304. <th>Type</th>
  305. <th>Name</th>
  306. <th>Description</th>
  307. </tr>
  308. </thead>
  309. <tbody>
  310. <tr>
  311. <td><span class="xref">Method</span>&lt;TRequest, TResponse&gt;</td>
  312. <td><span class="parametername">method</span></td>
  313. <td><p>The method description.</p>
  314. </td>
  315. </tr>
  316. <tr>
  317. <td><span class="xref">IList</span>&lt;<span class="xref">System.Object</span>&gt;</td>
  318. <td><span class="parametername">metadata</span></td>
  319. <td><p>The method metadata. This metadata can be used by routing and middleware when invoking a gRPC method.</p>
  320. </td>
  321. </tr>
  322. <tr>
  323. <td><a class="xref" href="Grpc.AspNetCore.Server.Model.UnaryServerMethod-3.html">UnaryServerMethod</a>&lt;TService, TRequest, TResponse&gt;</td>
  324. <td><span class="parametername">invoker</span></td>
  325. <td><p>The method invoker that is executed when the method is called.</p>
  326. </td>
  327. </tr>
  328. </tbody>
  329. </table>
  330. <h5 class="typeParameters">Type Parameters</h5>
  331. <table class="table table-bordered table-striped table-condensed">
  332. <thead>
  333. <tr>
  334. <th>Name</th>
  335. <th>Description</th>
  336. </tr>
  337. </thead>
  338. <tbody>
  339. <tr>
  340. <td><span class="parametername">TRequest</span></td>
  341. <td><p>Request message type for this method.</p>
  342. </td>
  343. </tr>
  344. <tr>
  345. <td><span class="parametername">TResponse</span></td>
  346. <td><p>Response message type for this method.</p>
  347. </td>
  348. </tr>
  349. </tbody>
  350. </table>
  351. </article>
  352. </div>
  353. <div class="hidden-sm col-md-2" role="complementary">
  354. <div class="sideaffix">
  355. <nav class="bs-docs-sidebar hidden-print hidden-xs hidden-sm affix" id="affix">
  356. <!-- <p><a class="back-to-top" href="#top">Back to top</a><p> -->
  357. </nav>
  358. </div>
  359. </div>
  360. </div>
  361. </div>
  362. <footer>
  363. <div class="grad-bottom"></div>
  364. <div class="footer">
  365. <div class="container">
  366. <span class="pull-right">
  367. <a href="#top">Back to top</a>
  368. </span>
  369. <span>Generated by <strong>DocFX</strong></span>
  370. </div>
  371. </div>
  372. </footer>
  373. </div>
  374. <script type="text/javascript" src="../styles/docfx.vendor.js"></script>
  375. <script type="text/javascript" src="../styles/docfx.js"></script>
  376. <script type="text/javascript" src="../styles/main.js"></script>
  377. </body>
  378. </html>