Grpc.Core.ServerServiceDefinition.Builder.html 18 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470
  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 ServerServiceDefinition.Builder
  8. | gRPC C# </title>
  9. <meta name="viewport" content="width=device-width">
  10. <meta name="title" content="Class ServerServiceDefinition.Builder
  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.ServerServiceDefinition.Builder">
  71. <h1 id="Grpc_Core_ServerServiceDefinition_Builder" data-uid="Grpc.Core.ServerServiceDefinition.Builder" class="text-break">Class ServerServiceDefinition.Builder
  72. </h1>
  73. <div class="markdown level0 summary"><p>Builder class for <a class="xref" href="Grpc.Core.ServerServiceDefinition.html">ServerServiceDefinition</a>.</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">ServerServiceDefinition.Builder</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_ServerServiceDefinition_Builder_syntax">Syntax</h5>
  108. <div class="codewrapper">
  109. <pre><code class="lang-csharp hljs">public class Builder</code></pre>
  110. </div>
  111. <h3 id="constructors">Constructors
  112. </h3>
  113. <a id="Grpc_Core_ServerServiceDefinition_Builder__ctor_" data-uid="Grpc.Core.ServerServiceDefinition.Builder.#ctor*"></a>
  114. <h4 id="Grpc_Core_ServerServiceDefinition_Builder__ctor" data-uid="Grpc.Core.ServerServiceDefinition.Builder.#ctor">Builder()</h4>
  115. <div class="markdown level1 summary"><p>Creates a new instance of builder.</p>
  116. </div>
  117. <div class="markdown level1 conceptual"></div>
  118. <h5 class="decalaration">Declaration</h5>
  119. <div class="codewrapper">
  120. <pre><code class="lang-csharp hljs">public Builder()</code></pre>
  121. </div>
  122. <h3 id="methods">Methods
  123. </h3>
  124. <a id="Grpc_Core_ServerServiceDefinition_Builder_AddMethod_" data-uid="Grpc.Core.ServerServiceDefinition.Builder.AddMethod*"></a>
  125. <h4 id="Grpc_Core_ServerServiceDefinition_Builder_AddMethod__2_Grpc_Core_Method___0___1__Grpc_Core_ClientStreamingServerMethod___0___1__" data-uid="Grpc.Core.ServerServiceDefinition.Builder.AddMethod``2(Grpc.Core.Method{``0,``1},Grpc.Core.ClientStreamingServerMethod{``0,``1})">AddMethod&lt;TRequest, TResponse&gt;(Method&lt;TRequest, TResponse&gt;, ClientStreamingServerMethod&lt;TRequest, TResponse&gt;)</h4>
  126. <div class="markdown level1 summary"><p>Adds a definitions for a client streaming method.</p>
  127. </div>
  128. <div class="markdown level1 conceptual"></div>
  129. <h5 class="decalaration">Declaration</h5>
  130. <div class="codewrapper">
  131. <pre><code class="lang-csharp hljs">public ServerServiceDefinition.Builder AddMethod&lt;TRequest, TResponse&gt;(Method&lt;TRequest, TResponse&gt; method, ClientStreamingServerMethod&lt;TRequest, TResponse&gt; handler)where TRequest : class where TResponse : class</code></pre>
  132. </div>
  133. <h5 class="parameters">Parameters</h5>
  134. <table class="table table-bordered table-striped table-condensed">
  135. <thead>
  136. <tr>
  137. <th>Type</th>
  138. <th>Name</th>
  139. <th>Description</th>
  140. </tr>
  141. </thead>
  142. <tbody>
  143. <tr>
  144. <td><a class="xref" href="Grpc.Core.Method-2.html">Method</a>&lt;TRequest, TResponse&gt;</td>
  145. <td><span class="parametername">method</span></td>
  146. <td><p>The method.</p>
  147. </td>
  148. </tr>
  149. <tr>
  150. <td><a class="xref" href="Grpc.Core.ClientStreamingServerMethod-2.html">ClientStreamingServerMethod</a>&lt;TRequest, TResponse&gt;</td>
  151. <td><span class="parametername">handler</span></td>
  152. <td><p>The method handler.</p>
  153. </td>
  154. </tr>
  155. </tbody>
  156. </table>
  157. <h5 class="returns">Returns</h5>
  158. <table class="table table-bordered table-striped table-condensed">
  159. <thead>
  160. <tr>
  161. <th>Type</th>
  162. <th>Description</th>
  163. </tr>
  164. </thead>
  165. <tbody>
  166. <tr>
  167. <td><a class="xref" href="Grpc.Core.ServerServiceDefinition.Builder.html">ServerServiceDefinition.Builder</a></td>
  168. <td><p>This builder instance.</p>
  169. </td>
  170. </tr>
  171. </tbody>
  172. </table>
  173. <h5 class="typeParameters">Type Parameters</h5>
  174. <table class="table table-bordered table-striped table-condensed">
  175. <thead>
  176. <tr>
  177. <th>Name</th>
  178. <th>Description</th>
  179. </tr>
  180. </thead>
  181. <tbody>
  182. <tr>
  183. <td><span class="parametername">TRequest</span></td>
  184. <td><p>The request message class.</p>
  185. </td>
  186. </tr>
  187. <tr>
  188. <td><span class="parametername">TResponse</span></td>
  189. <td><p>The response message class.</p>
  190. </td>
  191. </tr>
  192. </tbody>
  193. </table>
  194. <a id="Grpc_Core_ServerServiceDefinition_Builder_AddMethod_" data-uid="Grpc.Core.ServerServiceDefinition.Builder.AddMethod*"></a>
  195. <h4 id="Grpc_Core_ServerServiceDefinition_Builder_AddMethod__2_Grpc_Core_Method___0___1__Grpc_Core_DuplexStreamingServerMethod___0___1__" data-uid="Grpc.Core.ServerServiceDefinition.Builder.AddMethod``2(Grpc.Core.Method{``0,``1},Grpc.Core.DuplexStreamingServerMethod{``0,``1})">AddMethod&lt;TRequest, TResponse&gt;(Method&lt;TRequest, TResponse&gt;, DuplexStreamingServerMethod&lt;TRequest, TResponse&gt;)</h4>
  196. <div class="markdown level1 summary"><p>Adds a definitions for a bidirectional streaming 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 ServerServiceDefinition.Builder AddMethod&lt;TRequest, TResponse&gt;(Method&lt;TRequest, TResponse&gt; method, DuplexStreamingServerMethod&lt;TRequest, TResponse&gt; handler)where TRequest : class where TResponse : class</code></pre>
  202. </div>
  203. <h5 class="parameters">Parameters</h5>
  204. <table class="table table-bordered table-striped table-condensed">
  205. <thead>
  206. <tr>
  207. <th>Type</th>
  208. <th>Name</th>
  209. <th>Description</th>
  210. </tr>
  211. </thead>
  212. <tbody>
  213. <tr>
  214. <td><a class="xref" href="Grpc.Core.Method-2.html">Method</a>&lt;TRequest, TResponse&gt;</td>
  215. <td><span class="parametername">method</span></td>
  216. <td><p>The method.</p>
  217. </td>
  218. </tr>
  219. <tr>
  220. <td><a class="xref" href="Grpc.Core.DuplexStreamingServerMethod-2.html">DuplexStreamingServerMethod</a>&lt;TRequest, TResponse&gt;</td>
  221. <td><span class="parametername">handler</span></td>
  222. <td><p>The method handler.</p>
  223. </td>
  224. </tr>
  225. </tbody>
  226. </table>
  227. <h5 class="returns">Returns</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.ServerServiceDefinition.Builder.html">ServerServiceDefinition.Builder</a></td>
  238. <td><p>This builder instance.</p>
  239. </td>
  240. </tr>
  241. </tbody>
  242. </table>
  243. <h5 class="typeParameters">Type Parameters</h5>
  244. <table class="table table-bordered table-striped table-condensed">
  245. <thead>
  246. <tr>
  247. <th>Name</th>
  248. <th>Description</th>
  249. </tr>
  250. </thead>
  251. <tbody>
  252. <tr>
  253. <td><span class="parametername">TRequest</span></td>
  254. <td><p>The request message class.</p>
  255. </td>
  256. </tr>
  257. <tr>
  258. <td><span class="parametername">TResponse</span></td>
  259. <td><p>The response message class.</p>
  260. </td>
  261. </tr>
  262. </tbody>
  263. </table>
  264. <a id="Grpc_Core_ServerServiceDefinition_Builder_AddMethod_" data-uid="Grpc.Core.ServerServiceDefinition.Builder.AddMethod*"></a>
  265. <h4 id="Grpc_Core_ServerServiceDefinition_Builder_AddMethod__2_Grpc_Core_Method___0___1__Grpc_Core_ServerStreamingServerMethod___0___1__" data-uid="Grpc.Core.ServerServiceDefinition.Builder.AddMethod``2(Grpc.Core.Method{``0,``1},Grpc.Core.ServerStreamingServerMethod{``0,``1})">AddMethod&lt;TRequest, TResponse&gt;(Method&lt;TRequest, TResponse&gt;, ServerStreamingServerMethod&lt;TRequest, TResponse&gt;)</h4>
  266. <div class="markdown level1 summary"><p>Adds a definitions for a server streaming method.</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 ServerServiceDefinition.Builder AddMethod&lt;TRequest, TResponse&gt;(Method&lt;TRequest, TResponse&gt; method, ServerStreamingServerMethod&lt;TRequest, TResponse&gt; handler)where TRequest : class where TResponse : class</code></pre>
  272. </div>
  273. <h5 class="parameters">Parameters</h5>
  274. <table class="table table-bordered table-striped table-condensed">
  275. <thead>
  276. <tr>
  277. <th>Type</th>
  278. <th>Name</th>
  279. <th>Description</th>
  280. </tr>
  281. </thead>
  282. <tbody>
  283. <tr>
  284. <td><a class="xref" href="Grpc.Core.Method-2.html">Method</a>&lt;TRequest, TResponse&gt;</td>
  285. <td><span class="parametername">method</span></td>
  286. <td><p>The method.</p>
  287. </td>
  288. </tr>
  289. <tr>
  290. <td><a class="xref" href="Grpc.Core.ServerStreamingServerMethod-2.html">ServerStreamingServerMethod</a>&lt;TRequest, TResponse&gt;</td>
  291. <td><span class="parametername">handler</span></td>
  292. <td><p>The method handler.</p>
  293. </td>
  294. </tr>
  295. </tbody>
  296. </table>
  297. <h5 class="returns">Returns</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><a class="xref" href="Grpc.Core.ServerServiceDefinition.Builder.html">ServerServiceDefinition.Builder</a></td>
  308. <td><p>This builder instance.</p>
  309. </td>
  310. </tr>
  311. </tbody>
  312. </table>
  313. <h5 class="typeParameters">Type Parameters</h5>
  314. <table class="table table-bordered table-striped table-condensed">
  315. <thead>
  316. <tr>
  317. <th>Name</th>
  318. <th>Description</th>
  319. </tr>
  320. </thead>
  321. <tbody>
  322. <tr>
  323. <td><span class="parametername">TRequest</span></td>
  324. <td><p>The request message class.</p>
  325. </td>
  326. </tr>
  327. <tr>
  328. <td><span class="parametername">TResponse</span></td>
  329. <td><p>The response message class.</p>
  330. </td>
  331. </tr>
  332. </tbody>
  333. </table>
  334. <a id="Grpc_Core_ServerServiceDefinition_Builder_AddMethod_" data-uid="Grpc.Core.ServerServiceDefinition.Builder.AddMethod*"></a>
  335. <h4 id="Grpc_Core_ServerServiceDefinition_Builder_AddMethod__2_Grpc_Core_Method___0___1__Grpc_Core_UnaryServerMethod___0___1__" data-uid="Grpc.Core.ServerServiceDefinition.Builder.AddMethod``2(Grpc.Core.Method{``0,``1},Grpc.Core.UnaryServerMethod{``0,``1})">AddMethod&lt;TRequest, TResponse&gt;(Method&lt;TRequest, TResponse&gt;, UnaryServerMethod&lt;TRequest, TResponse&gt;)</h4>
  336. <div class="markdown level1 summary"><p>Adds a definitions for a single request - single response method.</p>
  337. </div>
  338. <div class="markdown level1 conceptual"></div>
  339. <h5 class="decalaration">Declaration</h5>
  340. <div class="codewrapper">
  341. <pre><code class="lang-csharp hljs">public ServerServiceDefinition.Builder AddMethod&lt;TRequest, TResponse&gt;(Method&lt;TRequest, TResponse&gt; method, UnaryServerMethod&lt;TRequest, TResponse&gt; handler)where TRequest : class where TResponse : class</code></pre>
  342. </div>
  343. <h5 class="parameters">Parameters</h5>
  344. <table class="table table-bordered table-striped table-condensed">
  345. <thead>
  346. <tr>
  347. <th>Type</th>
  348. <th>Name</th>
  349. <th>Description</th>
  350. </tr>
  351. </thead>
  352. <tbody>
  353. <tr>
  354. <td><a class="xref" href="Grpc.Core.Method-2.html">Method</a>&lt;TRequest, TResponse&gt;</td>
  355. <td><span class="parametername">method</span></td>
  356. <td><p>The method.</p>
  357. </td>
  358. </tr>
  359. <tr>
  360. <td><a class="xref" href="Grpc.Core.UnaryServerMethod-2.html">UnaryServerMethod</a>&lt;TRequest, TResponse&gt;</td>
  361. <td><span class="parametername">handler</span></td>
  362. <td><p>The method handler.</p>
  363. </td>
  364. </tr>
  365. </tbody>
  366. </table>
  367. <h5 class="returns">Returns</h5>
  368. <table class="table table-bordered table-striped table-condensed">
  369. <thead>
  370. <tr>
  371. <th>Type</th>
  372. <th>Description</th>
  373. </tr>
  374. </thead>
  375. <tbody>
  376. <tr>
  377. <td><a class="xref" href="Grpc.Core.ServerServiceDefinition.Builder.html">ServerServiceDefinition.Builder</a></td>
  378. <td><p>This builder instance.</p>
  379. </td>
  380. </tr>
  381. </tbody>
  382. </table>
  383. <h5 class="typeParameters">Type Parameters</h5>
  384. <table class="table table-bordered table-striped table-condensed">
  385. <thead>
  386. <tr>
  387. <th>Name</th>
  388. <th>Description</th>
  389. </tr>
  390. </thead>
  391. <tbody>
  392. <tr>
  393. <td><span class="parametername">TRequest</span></td>
  394. <td><p>The request message class.</p>
  395. </td>
  396. </tr>
  397. <tr>
  398. <td><span class="parametername">TResponse</span></td>
  399. <td><p>The response message class.</p>
  400. </td>
  401. </tr>
  402. </tbody>
  403. </table>
  404. <a id="Grpc_Core_ServerServiceDefinition_Builder_Build_" data-uid="Grpc.Core.ServerServiceDefinition.Builder.Build*"></a>
  405. <h4 id="Grpc_Core_ServerServiceDefinition_Builder_Build" data-uid="Grpc.Core.ServerServiceDefinition.Builder.Build">Build()</h4>
  406. <div class="markdown level1 summary"><p>Creates an immutable <code>ServerServiceDefinition</code> from this builder.</p>
  407. </div>
  408. <div class="markdown level1 conceptual"></div>
  409. <h5 class="decalaration">Declaration</h5>
  410. <div class="codewrapper">
  411. <pre><code class="lang-csharp hljs">public ServerServiceDefinition Build()</code></pre>
  412. </div>
  413. <h5 class="returns">Returns</h5>
  414. <table class="table table-bordered table-striped table-condensed">
  415. <thead>
  416. <tr>
  417. <th>Type</th>
  418. <th>Description</th>
  419. </tr>
  420. </thead>
  421. <tbody>
  422. <tr>
  423. <td><a class="xref" href="Grpc.Core.ServerServiceDefinition.html">ServerServiceDefinition</a></td>
  424. <td><p>The <code>ServerServiceDefinition</code> object.</p>
  425. </td>
  426. </tr>
  427. </tbody>
  428. </table>
  429. </article>
  430. </div>
  431. <div class="hidden-sm col-md-2" role="complementary">
  432. <div class="sideaffix">
  433. <nav class="bs-docs-sidebar hidden-print hidden-xs hidden-sm affix" id="affix">
  434. <!-- <p><a class="back-to-top" href="#top">Back to top</a><p> -->
  435. </nav>
  436. </div>
  437. </div>
  438. </div>
  439. </div>
  440. <footer>
  441. <div class="grad-bottom"></div>
  442. <div class="footer">
  443. <div class="container">
  444. <span class="pull-right">
  445. <a href="#top">Back to top</a>
  446. </span>
  447. <span>Copyright © 2015-2017 Microsoft<br>Generated by <strong>DocFX</strong></span>
  448. </div>
  449. </div>
  450. </footer>
  451. </div>
  452. <script type="text/javascript" src="../styles/docfx.vendor.js"></script>
  453. <script type="text/javascript" src="../styles/docfx.js"></script>
  454. <script type="text/javascript" src="../styles/main.js"></script>
  455. </body>
  456. </html>