Grpc.Core.Method-2.html 14 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360
  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 Method&lt;TRequest, TResponse&gt;
  8. | gRPC for .NET </title>
  9. <meta name="viewport" content="width=device-width">
  10. <meta name="title" content="Class Method&lt;TRequest, TResponse&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.Core.Method`2">
  73. <h1 id="Grpc_Core_Method_2" data-uid="Grpc.Core.Method`2" class="text-break">Class Method&lt;TRequest, TResponse&gt;
  74. </h1>
  75. <div class="markdown level0 summary"><p>A description of a remote method.</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">Method&lt;TRequest, TResponse&gt;</span></div>
  82. </div>
  83. <div classs="implements">
  84. <h5>Implements</h5>
  85. <div><a class="xref" href="Grpc.Core.IMethod.html">IMethod</a></div>
  86. </div>
  87. <h6><strong>Namespace</strong>: <a class="xref" href="Grpc.Core.html">Grpc.Core</a></h6>
  88. <h6><strong>Assembly</strong>: Grpc.Core.Api.dll</h6>
  89. <h5 id="Grpc_Core_Method_2_syntax">Syntax</h5>
  90. <div class="codewrapper">
  91. <pre><code class="lang-csharp hljs">public class Method&lt;TRequest, TResponse&gt; : object, IMethod</code></pre>
  92. </div>
  93. <h5 class="typeParameters">Type Parameters</h5>
  94. <table class="table table-bordered table-striped table-condensed">
  95. <thead>
  96. <tr>
  97. <th>Name</th>
  98. <th>Description</th>
  99. </tr>
  100. </thead>
  101. <tbody>
  102. <tr>
  103. <td><span class="parametername">TRequest</span></td>
  104. <td><p>Request message type for this method.</p>
  105. </td>
  106. </tr>
  107. <tr>
  108. <td><span class="parametername">TResponse</span></td>
  109. <td><p>Response message type for this method.</p>
  110. </td>
  111. </tr>
  112. </tbody>
  113. </table>
  114. <h3 id="constructors">Constructors
  115. </h3>
  116. <a id="Grpc_Core_Method_2__ctor_" data-uid="Grpc.Core.Method`2.#ctor*"></a>
  117. <h4 id="Grpc_Core_Method_2__ctor_Grpc_Core_MethodType_System_String_System_String_Grpc_Core_Marshaller__0__Grpc_Core_Marshaller__1__" data-uid="Grpc.Core.Method`2.#ctor(Grpc.Core.MethodType,System.String,System.String,Grpc.Core.Marshaller{`0},Grpc.Core.Marshaller{`1})">Method(MethodType, String, String, Marshaller&lt;TRequest&gt;, Marshaller&lt;TResponse&gt;)</h4>
  118. <div class="markdown level1 summary"><p>Initializes a new instance of the <code>Method</code> class.</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 Method(MethodType type, string serviceName, string name, Marshaller&lt;TRequest&gt; requestMarshaller, Marshaller&lt;TResponse&gt; responseMarshaller)</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><a class="xref" href="Grpc.Core.MethodType.html">MethodType</a></td>
  137. <td><span class="parametername">type</span></td>
  138. <td><p>Type of method.</p>
  139. </td>
  140. </tr>
  141. <tr>
  142. <td><span class="xref">System.String</span></td>
  143. <td><span class="parametername">serviceName</span></td>
  144. <td><p>Name of service this method belongs to.</p>
  145. </td>
  146. </tr>
  147. <tr>
  148. <td><span class="xref">System.String</span></td>
  149. <td><span class="parametername">name</span></td>
  150. <td><p>Unqualified name of the method.</p>
  151. </td>
  152. </tr>
  153. <tr>
  154. <td><a class="xref" href="Grpc.Core.Marshaller-1.html">Marshaller</a>&lt;TRequest&gt;</td>
  155. <td><span class="parametername">requestMarshaller</span></td>
  156. <td><p>Marshaller used for request messages.</p>
  157. </td>
  158. </tr>
  159. <tr>
  160. <td><a class="xref" href="Grpc.Core.Marshaller-1.html">Marshaller</a>&lt;TResponse&gt;</td>
  161. <td><span class="parametername">responseMarshaller</span></td>
  162. <td><p>Marshaller used for response messages.</p>
  163. </td>
  164. </tr>
  165. </tbody>
  166. </table>
  167. <h3 id="properties">Properties
  168. </h3>
  169. <a id="Grpc_Core_Method_2_FullName_" data-uid="Grpc.Core.Method`2.FullName*"></a>
  170. <h4 id="Grpc_Core_Method_2_FullName" data-uid="Grpc.Core.Method`2.FullName">FullName</h4>
  171. <div class="markdown level1 summary"><p>Gets the fully qualified name of the method. On the server side, methods are dispatched
  172. based on this name.</p>
  173. </div>
  174. <div class="markdown level1 conceptual"></div>
  175. <h5 class="decalaration">Declaration</h5>
  176. <div class="codewrapper">
  177. <pre><code class="lang-csharp hljs">public string FullName { get; }</code></pre>
  178. </div>
  179. <h5 class="propertyValue">Property Value</h5>
  180. <table class="table table-bordered table-striped table-condensed">
  181. <thead>
  182. <tr>
  183. <th>Type</th>
  184. <th>Description</th>
  185. </tr>
  186. </thead>
  187. <tbody>
  188. <tr>
  189. <td><span class="xref">System.String</span></td>
  190. <td></td>
  191. </tr>
  192. </tbody>
  193. </table>
  194. <a id="Grpc_Core_Method_2_Name_" data-uid="Grpc.Core.Method`2.Name*"></a>
  195. <h4 id="Grpc_Core_Method_2_Name" data-uid="Grpc.Core.Method`2.Name">Name</h4>
  196. <div class="markdown level1 summary"><p>Gets the unqualified name of the method.</p>
  197. </div>
  198. <div class="markdown level1 conceptual"></div>
  199. <h5 class="decalaration">Declaration</h5>
  200. <div class="codewrapper">
  201. <pre><code class="lang-csharp hljs">public string Name { get; }</code></pre>
  202. </div>
  203. <h5 class="propertyValue">Property Value</h5>
  204. <table class="table table-bordered table-striped table-condensed">
  205. <thead>
  206. <tr>
  207. <th>Type</th>
  208. <th>Description</th>
  209. </tr>
  210. </thead>
  211. <tbody>
  212. <tr>
  213. <td><span class="xref">System.String</span></td>
  214. <td></td>
  215. </tr>
  216. </tbody>
  217. </table>
  218. <a id="Grpc_Core_Method_2_RequestMarshaller_" data-uid="Grpc.Core.Method`2.RequestMarshaller*"></a>
  219. <h4 id="Grpc_Core_Method_2_RequestMarshaller" data-uid="Grpc.Core.Method`2.RequestMarshaller">RequestMarshaller</h4>
  220. <div class="markdown level1 summary"><p>Gets the marshaller used for request messages.</p>
  221. </div>
  222. <div class="markdown level1 conceptual"></div>
  223. <h5 class="decalaration">Declaration</h5>
  224. <div class="codewrapper">
  225. <pre><code class="lang-csharp hljs">public Marshaller&lt;TRequest&gt; RequestMarshaller { get; }</code></pre>
  226. </div>
  227. <h5 class="propertyValue">Property Value</h5>
  228. <table class="table table-bordered table-striped table-condensed">
  229. <thead>
  230. <tr>
  231. <th>Type</th>
  232. <th>Description</th>
  233. </tr>
  234. </thead>
  235. <tbody>
  236. <tr>
  237. <td><a class="xref" href="Grpc.Core.Marshaller-1.html">Marshaller</a>&lt;TRequest&gt;</td>
  238. <td></td>
  239. </tr>
  240. </tbody>
  241. </table>
  242. <a id="Grpc_Core_Method_2_ResponseMarshaller_" data-uid="Grpc.Core.Method`2.ResponseMarshaller*"></a>
  243. <h4 id="Grpc_Core_Method_2_ResponseMarshaller" data-uid="Grpc.Core.Method`2.ResponseMarshaller">ResponseMarshaller</h4>
  244. <div class="markdown level1 summary"><p>Gets the marshaller used for response messages.</p>
  245. </div>
  246. <div class="markdown level1 conceptual"></div>
  247. <h5 class="decalaration">Declaration</h5>
  248. <div class="codewrapper">
  249. <pre><code class="lang-csharp hljs">public Marshaller&lt;TResponse&gt; ResponseMarshaller { get; }</code></pre>
  250. </div>
  251. <h5 class="propertyValue">Property Value</h5>
  252. <table class="table table-bordered table-striped table-condensed">
  253. <thead>
  254. <tr>
  255. <th>Type</th>
  256. <th>Description</th>
  257. </tr>
  258. </thead>
  259. <tbody>
  260. <tr>
  261. <td><a class="xref" href="Grpc.Core.Marshaller-1.html">Marshaller</a>&lt;TResponse&gt;</td>
  262. <td></td>
  263. </tr>
  264. </tbody>
  265. </table>
  266. <a id="Grpc_Core_Method_2_ServiceName_" data-uid="Grpc.Core.Method`2.ServiceName*"></a>
  267. <h4 id="Grpc_Core_Method_2_ServiceName" data-uid="Grpc.Core.Method`2.ServiceName">ServiceName</h4>
  268. <div class="markdown level1 summary"><p>Gets the name of the service to which this method belongs.</p>
  269. </div>
  270. <div class="markdown level1 conceptual"></div>
  271. <h5 class="decalaration">Declaration</h5>
  272. <div class="codewrapper">
  273. <pre><code class="lang-csharp hljs">public string ServiceName { get; }</code></pre>
  274. </div>
  275. <h5 class="propertyValue">Property Value</h5>
  276. <table class="table table-bordered table-striped table-condensed">
  277. <thead>
  278. <tr>
  279. <th>Type</th>
  280. <th>Description</th>
  281. </tr>
  282. </thead>
  283. <tbody>
  284. <tr>
  285. <td><span class="xref">System.String</span></td>
  286. <td></td>
  287. </tr>
  288. </tbody>
  289. </table>
  290. <a id="Grpc_Core_Method_2_Type_" data-uid="Grpc.Core.Method`2.Type*"></a>
  291. <h4 id="Grpc_Core_Method_2_Type" data-uid="Grpc.Core.Method`2.Type">Type</h4>
  292. <div class="markdown level1 summary"><p>Gets the type of the method.</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 MethodType Type { get; }</code></pre>
  298. </div>
  299. <h5 class="propertyValue">Property Value</h5>
  300. <table class="table table-bordered table-striped table-condensed">
  301. <thead>
  302. <tr>
  303. <th>Type</th>
  304. <th>Description</th>
  305. </tr>
  306. </thead>
  307. <tbody>
  308. <tr>
  309. <td><a class="xref" href="Grpc.Core.MethodType.html">MethodType</a></td>
  310. <td></td>
  311. </tr>
  312. </tbody>
  313. </table>
  314. <h3 id="implements">Implements</h3>
  315. <div>
  316. <a class="xref" href="Grpc.Core.IMethod.html">IMethod</a>
  317. </div>
  318. </article>
  319. </div>
  320. <div class="hidden-sm col-md-2" role="complementary">
  321. <div class="sideaffix">
  322. <nav class="bs-docs-sidebar hidden-print hidden-xs hidden-sm affix" id="affix">
  323. <!-- <p><a class="back-to-top" href="#top">Back to top</a><p> -->
  324. </nav>
  325. </div>
  326. </div>
  327. </div>
  328. </div>
  329. <footer>
  330. <div class="grad-bottom"></div>
  331. <div class="footer">
  332. <div class="container">
  333. <span class="pull-right">
  334. <a href="#top">Back to top</a>
  335. </span>
  336. <span>Generated by <strong>DocFX</strong></span>
  337. </div>
  338. </div>
  339. </footer>
  340. </div>
  341. <script type="text/javascript" src="../styles/docfx.vendor.js"></script>
  342. <script type="text/javascript" src="../styles/docfx.js"></script>
  343. <script type="text/javascript" src="../styles/main.js"></script>
  344. </body>
  345. </html>