Grpc.Core.ServerServiceDefinition.Builder.html 19 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477
  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.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.ServerServiceDefinition.Builder">
  73. <h1 id="Grpc_Core_ServerServiceDefinition_Builder" data-uid="Grpc.Core.ServerServiceDefinition.Builder" class="text-break">Class ServerServiceDefinition.Builder
  74. </h1>
  75. <div class="markdown level0 summary"><p>Builder class for <a class="xref" href="Grpc.Core.ServerServiceDefinition.html">ServerServiceDefinition</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">ServerServiceDefinition.Builder</span></div>
  82. </div>
  83. <div class="inheritedMembers">
  84. <h5>Inherited Members</h5>
  85. <div>
  86. <span class="xref">System.Object.Equals(System.Object)</span>
  87. </div>
  88. <div>
  89. <span class="xref">System.Object.Equals(System.Object, System.Object)</span>
  90. </div>
  91. <div>
  92. <span class="xref">System.Object.GetHashCode()</span>
  93. </div>
  94. <div>
  95. <span class="xref">System.Object.GetType()</span>
  96. </div>
  97. <div>
  98. <span class="xref">System.Object.MemberwiseClone()</span>
  99. </div>
  100. <div>
  101. <span class="xref">System.Object.ReferenceEquals(System.Object, System.Object)</span>
  102. </div>
  103. <div>
  104. <span class="xref">System.Object.ToString()</span>
  105. </div>
  106. </div>
  107. <h6><strong>Namespace</strong>: <a class="xref" href="Grpc.Core.html">Grpc.Core</a></h6>
  108. <h6><strong>Assembly</strong>: Grpc.Core.Api.dll</h6>
  109. <h5 id="Grpc_Core_ServerServiceDefinition_Builder_syntax">Syntax</h5>
  110. <div class="codewrapper">
  111. <pre><code class="lang-csharp hljs">public class Builder</code></pre>
  112. </div>
  113. <h3 id="constructors">Constructors
  114. </h3>
  115. <a id="Grpc_Core_ServerServiceDefinition_Builder__ctor_" data-uid="Grpc.Core.ServerServiceDefinition.Builder.#ctor*"></a>
  116. <h4 id="Grpc_Core_ServerServiceDefinition_Builder__ctor" data-uid="Grpc.Core.ServerServiceDefinition.Builder.#ctor">Builder()</h4>
  117. <div class="markdown level1 summary"><p>Creates a new instance of builder.</p>
  118. </div>
  119. <div class="markdown level1 conceptual"></div>
  120. <h5 class="decalaration">Declaration</h5>
  121. <div class="codewrapper">
  122. <pre><code class="lang-csharp hljs">public Builder()</code></pre>
  123. </div>
  124. <h3 id="methods">Methods
  125. </h3>
  126. <a id="Grpc_Core_ServerServiceDefinition_Builder_AddMethod_" data-uid="Grpc.Core.ServerServiceDefinition.Builder.AddMethod*"></a>
  127. <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>
  128. <div class="markdown level1 summary"><p>Adds a definition for a client streaming method.</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 ServerServiceDefinition.Builder AddMethod&lt;TRequest, TResponse&gt;(Method&lt;TRequest, TResponse&gt; method, ClientStreamingServerMethod&lt;TRequest, TResponse&gt; handler)
  134. where TRequest : class where TResponse : class</code></pre>
  135. </div>
  136. <h5 class="parameters">Parameters</h5>
  137. <table class="table table-bordered table-striped table-condensed">
  138. <thead>
  139. <tr>
  140. <th>Type</th>
  141. <th>Name</th>
  142. <th>Description</th>
  143. </tr>
  144. </thead>
  145. <tbody>
  146. <tr>
  147. <td><a class="xref" href="Grpc.Core.Method-2.html">Method</a>&lt;TRequest, TResponse&gt;</td>
  148. <td><span class="parametername">method</span></td>
  149. <td><p>The method.</p>
  150. </td>
  151. </tr>
  152. <tr>
  153. <td><a class="xref" href="Grpc.Core.ClientStreamingServerMethod-2.html">ClientStreamingServerMethod</a>&lt;TRequest, TResponse&gt;</td>
  154. <td><span class="parametername">handler</span></td>
  155. <td><p>The method handler.</p>
  156. </td>
  157. </tr>
  158. </tbody>
  159. </table>
  160. <h5 class="returns">Returns</h5>
  161. <table class="table table-bordered table-striped table-condensed">
  162. <thead>
  163. <tr>
  164. <th>Type</th>
  165. <th>Description</th>
  166. </tr>
  167. </thead>
  168. <tbody>
  169. <tr>
  170. <td><a class="xref" href="Grpc.Core.ServerServiceDefinition.Builder.html">ServerServiceDefinition.Builder</a></td>
  171. <td><p>This builder instance.</p>
  172. </td>
  173. </tr>
  174. </tbody>
  175. </table>
  176. <h5 class="typeParameters">Type Parameters</h5>
  177. <table class="table table-bordered table-striped table-condensed">
  178. <thead>
  179. <tr>
  180. <th>Name</th>
  181. <th>Description</th>
  182. </tr>
  183. </thead>
  184. <tbody>
  185. <tr>
  186. <td><span class="parametername">TRequest</span></td>
  187. <td><p>The request message class.</p>
  188. </td>
  189. </tr>
  190. <tr>
  191. <td><span class="parametername">TResponse</span></td>
  192. <td><p>The response message class.</p>
  193. </td>
  194. </tr>
  195. </tbody>
  196. </table>
  197. <a id="Grpc_Core_ServerServiceDefinition_Builder_AddMethod_" data-uid="Grpc.Core.ServerServiceDefinition.Builder.AddMethod*"></a>
  198. <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>
  199. <div class="markdown level1 summary"><p>Adds a definition for a bidirectional streaming method.</p>
  200. </div>
  201. <div class="markdown level1 conceptual"></div>
  202. <h5 class="decalaration">Declaration</h5>
  203. <div class="codewrapper">
  204. <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)
  205. where TRequest : class where TResponse : class</code></pre>
  206. </div>
  207. <h5 class="parameters">Parameters</h5>
  208. <table class="table table-bordered table-striped table-condensed">
  209. <thead>
  210. <tr>
  211. <th>Type</th>
  212. <th>Name</th>
  213. <th>Description</th>
  214. </tr>
  215. </thead>
  216. <tbody>
  217. <tr>
  218. <td><a class="xref" href="Grpc.Core.Method-2.html">Method</a>&lt;TRequest, TResponse&gt;</td>
  219. <td><span class="parametername">method</span></td>
  220. <td><p>The method.</p>
  221. </td>
  222. </tr>
  223. <tr>
  224. <td><a class="xref" href="Grpc.Core.DuplexStreamingServerMethod-2.html">DuplexStreamingServerMethod</a>&lt;TRequest, TResponse&gt;</td>
  225. <td><span class="parametername">handler</span></td>
  226. <td><p>The method handler.</p>
  227. </td>
  228. </tr>
  229. </tbody>
  230. </table>
  231. <h5 class="returns">Returns</h5>
  232. <table class="table table-bordered table-striped table-condensed">
  233. <thead>
  234. <tr>
  235. <th>Type</th>
  236. <th>Description</th>
  237. </tr>
  238. </thead>
  239. <tbody>
  240. <tr>
  241. <td><a class="xref" href="Grpc.Core.ServerServiceDefinition.Builder.html">ServerServiceDefinition.Builder</a></td>
  242. <td><p>This builder instance.</p>
  243. </td>
  244. </tr>
  245. </tbody>
  246. </table>
  247. <h5 class="typeParameters">Type Parameters</h5>
  248. <table class="table table-bordered table-striped table-condensed">
  249. <thead>
  250. <tr>
  251. <th>Name</th>
  252. <th>Description</th>
  253. </tr>
  254. </thead>
  255. <tbody>
  256. <tr>
  257. <td><span class="parametername">TRequest</span></td>
  258. <td><p>The request message class.</p>
  259. </td>
  260. </tr>
  261. <tr>
  262. <td><span class="parametername">TResponse</span></td>
  263. <td><p>The response message class.</p>
  264. </td>
  265. </tr>
  266. </tbody>
  267. </table>
  268. <a id="Grpc_Core_ServerServiceDefinition_Builder_AddMethod_" data-uid="Grpc.Core.ServerServiceDefinition.Builder.AddMethod*"></a>
  269. <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>
  270. <div class="markdown level1 summary"><p>Adds a definition for a server streaming method.</p>
  271. </div>
  272. <div class="markdown level1 conceptual"></div>
  273. <h5 class="decalaration">Declaration</h5>
  274. <div class="codewrapper">
  275. <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)
  276. where TRequest : class where TResponse : class</code></pre>
  277. </div>
  278. <h5 class="parameters">Parameters</h5>
  279. <table class="table table-bordered table-striped table-condensed">
  280. <thead>
  281. <tr>
  282. <th>Type</th>
  283. <th>Name</th>
  284. <th>Description</th>
  285. </tr>
  286. </thead>
  287. <tbody>
  288. <tr>
  289. <td><a class="xref" href="Grpc.Core.Method-2.html">Method</a>&lt;TRequest, TResponse&gt;</td>
  290. <td><span class="parametername">method</span></td>
  291. <td><p>The method.</p>
  292. </td>
  293. </tr>
  294. <tr>
  295. <td><a class="xref" href="Grpc.Core.ServerStreamingServerMethod-2.html">ServerStreamingServerMethod</a>&lt;TRequest, TResponse&gt;</td>
  296. <td><span class="parametername">handler</span></td>
  297. <td><p>The method handler.</p>
  298. </td>
  299. </tr>
  300. </tbody>
  301. </table>
  302. <h5 class="returns">Returns</h5>
  303. <table class="table table-bordered table-striped table-condensed">
  304. <thead>
  305. <tr>
  306. <th>Type</th>
  307. <th>Description</th>
  308. </tr>
  309. </thead>
  310. <tbody>
  311. <tr>
  312. <td><a class="xref" href="Grpc.Core.ServerServiceDefinition.Builder.html">ServerServiceDefinition.Builder</a></td>
  313. <td><p>This builder instance.</p>
  314. </td>
  315. </tr>
  316. </tbody>
  317. </table>
  318. <h5 class="typeParameters">Type Parameters</h5>
  319. <table class="table table-bordered table-striped table-condensed">
  320. <thead>
  321. <tr>
  322. <th>Name</th>
  323. <th>Description</th>
  324. </tr>
  325. </thead>
  326. <tbody>
  327. <tr>
  328. <td><span class="parametername">TRequest</span></td>
  329. <td><p>The request message class.</p>
  330. </td>
  331. </tr>
  332. <tr>
  333. <td><span class="parametername">TResponse</span></td>
  334. <td><p>The response message class.</p>
  335. </td>
  336. </tr>
  337. </tbody>
  338. </table>
  339. <a id="Grpc_Core_ServerServiceDefinition_Builder_AddMethod_" data-uid="Grpc.Core.ServerServiceDefinition.Builder.AddMethod*"></a>
  340. <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>
  341. <div class="markdown level1 summary"><p>Adds a definition for a single request - single response method.</p>
  342. </div>
  343. <div class="markdown level1 conceptual"></div>
  344. <h5 class="decalaration">Declaration</h5>
  345. <div class="codewrapper">
  346. <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)
  347. where TRequest : class where TResponse : class</code></pre>
  348. </div>
  349. <h5 class="parameters">Parameters</h5>
  350. <table class="table table-bordered table-striped table-condensed">
  351. <thead>
  352. <tr>
  353. <th>Type</th>
  354. <th>Name</th>
  355. <th>Description</th>
  356. </tr>
  357. </thead>
  358. <tbody>
  359. <tr>
  360. <td><a class="xref" href="Grpc.Core.Method-2.html">Method</a>&lt;TRequest, TResponse&gt;</td>
  361. <td><span class="parametername">method</span></td>
  362. <td><p>The method.</p>
  363. </td>
  364. </tr>
  365. <tr>
  366. <td><a class="xref" href="Grpc.Core.UnaryServerMethod-2.html">UnaryServerMethod</a>&lt;TRequest, TResponse&gt;</td>
  367. <td><span class="parametername">handler</span></td>
  368. <td><p>The method handler.</p>
  369. </td>
  370. </tr>
  371. </tbody>
  372. </table>
  373. <h5 class="returns">Returns</h5>
  374. <table class="table table-bordered table-striped table-condensed">
  375. <thead>
  376. <tr>
  377. <th>Type</th>
  378. <th>Description</th>
  379. </tr>
  380. </thead>
  381. <tbody>
  382. <tr>
  383. <td><a class="xref" href="Grpc.Core.ServerServiceDefinition.Builder.html">ServerServiceDefinition.Builder</a></td>
  384. <td><p>This builder instance.</p>
  385. </td>
  386. </tr>
  387. </tbody>
  388. </table>
  389. <h5 class="typeParameters">Type Parameters</h5>
  390. <table class="table table-bordered table-striped table-condensed">
  391. <thead>
  392. <tr>
  393. <th>Name</th>
  394. <th>Description</th>
  395. </tr>
  396. </thead>
  397. <tbody>
  398. <tr>
  399. <td><span class="parametername">TRequest</span></td>
  400. <td><p>The request message class.</p>
  401. </td>
  402. </tr>
  403. <tr>
  404. <td><span class="parametername">TResponse</span></td>
  405. <td><p>The response message class.</p>
  406. </td>
  407. </tr>
  408. </tbody>
  409. </table>
  410. <a id="Grpc_Core_ServerServiceDefinition_Builder_Build_" data-uid="Grpc.Core.ServerServiceDefinition.Builder.Build*"></a>
  411. <h4 id="Grpc_Core_ServerServiceDefinition_Builder_Build" data-uid="Grpc.Core.ServerServiceDefinition.Builder.Build">Build()</h4>
  412. <div class="markdown level1 summary"><p>Creates an immutable <code>ServerServiceDefinition</code> from this builder.</p>
  413. </div>
  414. <div class="markdown level1 conceptual"></div>
  415. <h5 class="decalaration">Declaration</h5>
  416. <div class="codewrapper">
  417. <pre><code class="lang-csharp hljs">public ServerServiceDefinition Build()</code></pre>
  418. </div>
  419. <h5 class="returns">Returns</h5>
  420. <table class="table table-bordered table-striped table-condensed">
  421. <thead>
  422. <tr>
  423. <th>Type</th>
  424. <th>Description</th>
  425. </tr>
  426. </thead>
  427. <tbody>
  428. <tr>
  429. <td><a class="xref" href="Grpc.Core.ServerServiceDefinition.html">ServerServiceDefinition</a></td>
  430. <td><p>The <code>ServerServiceDefinition</code> object.</p>
  431. </td>
  432. </tr>
  433. </tbody>
  434. </table>
  435. </article>
  436. </div>
  437. <div class="hidden-sm col-md-2" role="complementary">
  438. <div class="sideaffix">
  439. <nav class="bs-docs-sidebar hidden-print hidden-xs hidden-sm affix" id="affix">
  440. <!-- <p><a class="back-to-top" href="#top">Back to top</a><p> -->
  441. </nav>
  442. </div>
  443. </div>
  444. </div>
  445. </div>
  446. <footer>
  447. <div class="grad-bottom"></div>
  448. <div class="footer">
  449. <div class="container">
  450. <span class="pull-right">
  451. <a href="#top">Back to top</a>
  452. </span>
  453. <span>Generated by <strong>DocFX</strong></span>
  454. </div>
  455. </div>
  456. </footer>
  457. </div>
  458. <script type="text/javascript" src="../styles/docfx.vendor.js"></script>
  459. <script type="text/javascript" src="../styles/docfx.js"></script>
  460. <script type="text/javascript" src="../styles/main.js"></script>
  461. </body>
  462. </html>