Grpc.Core.Method-2.html 14 KB

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