Grpc.Core.Testing.TestCalls.html 20 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483
  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 TestCalls
  8. | gRPC C# </title>
  9. <meta name="viewport" content="width=device-width">
  10. <meta name="title" content="Class TestCalls
  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.Testing.TestCalls">
  73. <h1 id="Grpc_Core_Testing_TestCalls" data-uid="Grpc.Core.Testing.TestCalls" class="text-break">Class TestCalls
  74. </h1>
  75. <div class="markdown level0 summary"><p>Test doubles for client-side call objects.</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">TestCalls</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.Testing.html">Grpc.Core.Testing</a></h6>
  108. <h6><strong>Assembly</strong>: Grpc.Core.Testing.dll</h6>
  109. <h5 id="Grpc_Core_Testing_TestCalls_syntax">Syntax</h5>
  110. <div class="codewrapper">
  111. <pre><code class="lang-csharp hljs">public static class TestCalls</code></pre>
  112. </div>
  113. <h3 id="methods">Methods
  114. </h3>
  115. <a id="Grpc_Core_Testing_TestCalls_AsyncClientStreamingCall_" data-uid="Grpc.Core.Testing.TestCalls.AsyncClientStreamingCall*"></a>
  116. <h4 id="Grpc_Core_Testing_TestCalls_AsyncClientStreamingCall__2_IClientStreamWriter___0__System_Threading_Tasks_Task___1__System_Threading_Tasks_Task_Metadata__System_Func_Status__System_Func_Metadata__System_Action_" data-uid="Grpc.Core.Testing.TestCalls.AsyncClientStreamingCall``2(IClientStreamWriter{``0},System.Threading.Tasks.Task{``1},System.Threading.Tasks.Task{Metadata},System.Func{Status},System.Func{Metadata},System.Action)">AsyncClientStreamingCall&lt;TRequest, TResponse&gt;(IClientStreamWriter&lt;TRequest&gt;, Task&lt;TResponse&gt;, Task&lt;Metadata&gt;, Func&lt;Status&gt;, Func&lt;Metadata&gt;, Action)</h4>
  117. <div class="markdown level1 summary"><p>Creates a test double for <code>AsyncClientStreamingCall</code>. Only for testing.
  118. Note: experimental API that can change or be removed without any prior notice.</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 static AsyncClientStreamingCall&lt;TRequest, TResponse&gt; AsyncClientStreamingCall&lt;TRequest, TResponse&gt;(IClientStreamWriter&lt;TRequest&gt; requestStream, Task&lt;TResponse&gt; responseAsync, Task&lt;Metadata&gt; responseHeadersAsync, Func&lt;Status&gt; getStatusFunc, Func&lt;Metadata&gt; getTrailersFunc, Action disposeAction)</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><span class="xref">IClientStreamWriter</span>&lt;TRequest&gt;</td>
  137. <td><span class="parametername">requestStream</span></td>
  138. <td></td>
  139. </tr>
  140. <tr>
  141. <td><span class="xref">System.Threading.Tasks.Task</span>&lt;TResponse&gt;</td>
  142. <td><span class="parametername">responseAsync</span></td>
  143. <td></td>
  144. </tr>
  145. <tr>
  146. <td><span class="xref">System.Threading.Tasks.Task</span>&lt;<span class="xref">Metadata</span>&gt;</td>
  147. <td><span class="parametername">responseHeadersAsync</span></td>
  148. <td></td>
  149. </tr>
  150. <tr>
  151. <td><span class="xref">System.Func</span>&lt;<span class="xref">Status</span>&gt;</td>
  152. <td><span class="parametername">getStatusFunc</span></td>
  153. <td></td>
  154. </tr>
  155. <tr>
  156. <td><span class="xref">System.Func</span>&lt;<span class="xref">Metadata</span>&gt;</td>
  157. <td><span class="parametername">getTrailersFunc</span></td>
  158. <td></td>
  159. </tr>
  160. <tr>
  161. <td><span class="xref">System.Action</span></td>
  162. <td><span class="parametername">disposeAction</span></td>
  163. <td></td>
  164. </tr>
  165. </tbody>
  166. </table>
  167. <h5 class="returns">Returns</h5>
  168. <table class="table table-bordered table-striped table-condensed">
  169. <thead>
  170. <tr>
  171. <th>Type</th>
  172. <th>Description</th>
  173. </tr>
  174. </thead>
  175. <tbody>
  176. <tr>
  177. <td><span class="xref">AsyncClientStreamingCall</span>&lt;TRequest, TResponse&gt;</td>
  178. <td></td>
  179. </tr>
  180. </tbody>
  181. </table>
  182. <h5 class="typeParameters">Type Parameters</h5>
  183. <table class="table table-bordered table-striped table-condensed">
  184. <thead>
  185. <tr>
  186. <th>Name</th>
  187. <th>Description</th>
  188. </tr>
  189. </thead>
  190. <tbody>
  191. <tr>
  192. <td><span class="parametername">TRequest</span></td>
  193. <td></td>
  194. </tr>
  195. <tr>
  196. <td><span class="parametername">TResponse</span></td>
  197. <td></td>
  198. </tr>
  199. </tbody>
  200. </table>
  201. <a id="Grpc_Core_Testing_TestCalls_AsyncDuplexStreamingCall_" data-uid="Grpc.Core.Testing.TestCalls.AsyncDuplexStreamingCall*"></a>
  202. <h4 id="Grpc_Core_Testing_TestCalls_AsyncDuplexStreamingCall__2_IClientStreamWriter___0__IAsyncStreamReader___1__System_Threading_Tasks_Task_Metadata__System_Func_Status__System_Func_Metadata__System_Action_" data-uid="Grpc.Core.Testing.TestCalls.AsyncDuplexStreamingCall``2(IClientStreamWriter{``0},IAsyncStreamReader{``1},System.Threading.Tasks.Task{Metadata},System.Func{Status},System.Func{Metadata},System.Action)">AsyncDuplexStreamingCall&lt;TRequest, TResponse&gt;(IClientStreamWriter&lt;TRequest&gt;, IAsyncStreamReader&lt;TResponse&gt;, Task&lt;Metadata&gt;, Func&lt;Status&gt;, Func&lt;Metadata&gt;, Action)</h4>
  203. <div class="markdown level1 summary"><p>Creates a test double for <code>AsyncDuplexStreamingCall</code>. Only for testing.
  204. Note: experimental API that can change or be removed without any prior notice.</p>
  205. </div>
  206. <div class="markdown level1 conceptual"></div>
  207. <h5 class="decalaration">Declaration</h5>
  208. <div class="codewrapper">
  209. <pre><code class="lang-csharp hljs">public static AsyncDuplexStreamingCall&lt;TRequest, TResponse&gt; AsyncDuplexStreamingCall&lt;TRequest, TResponse&gt;(IClientStreamWriter&lt;TRequest&gt; requestStream, IAsyncStreamReader&lt;TResponse&gt; responseStream, Task&lt;Metadata&gt; responseHeadersAsync, Func&lt;Status&gt; getStatusFunc, Func&lt;Metadata&gt; getTrailersFunc, Action disposeAction)</code></pre>
  210. </div>
  211. <h5 class="parameters">Parameters</h5>
  212. <table class="table table-bordered table-striped table-condensed">
  213. <thead>
  214. <tr>
  215. <th>Type</th>
  216. <th>Name</th>
  217. <th>Description</th>
  218. </tr>
  219. </thead>
  220. <tbody>
  221. <tr>
  222. <td><span class="xref">IClientStreamWriter</span>&lt;TRequest&gt;</td>
  223. <td><span class="parametername">requestStream</span></td>
  224. <td></td>
  225. </tr>
  226. <tr>
  227. <td><span class="xref">IAsyncStreamReader</span>&lt;TResponse&gt;</td>
  228. <td><span class="parametername">responseStream</span></td>
  229. <td></td>
  230. </tr>
  231. <tr>
  232. <td><span class="xref">System.Threading.Tasks.Task</span>&lt;<span class="xref">Metadata</span>&gt;</td>
  233. <td><span class="parametername">responseHeadersAsync</span></td>
  234. <td></td>
  235. </tr>
  236. <tr>
  237. <td><span class="xref">System.Func</span>&lt;<span class="xref">Status</span>&gt;</td>
  238. <td><span class="parametername">getStatusFunc</span></td>
  239. <td></td>
  240. </tr>
  241. <tr>
  242. <td><span class="xref">System.Func</span>&lt;<span class="xref">Metadata</span>&gt;</td>
  243. <td><span class="parametername">getTrailersFunc</span></td>
  244. <td></td>
  245. </tr>
  246. <tr>
  247. <td><span class="xref">System.Action</span></td>
  248. <td><span class="parametername">disposeAction</span></td>
  249. <td></td>
  250. </tr>
  251. </tbody>
  252. </table>
  253. <h5 class="returns">Returns</h5>
  254. <table class="table table-bordered table-striped table-condensed">
  255. <thead>
  256. <tr>
  257. <th>Type</th>
  258. <th>Description</th>
  259. </tr>
  260. </thead>
  261. <tbody>
  262. <tr>
  263. <td><span class="xref">AsyncDuplexStreamingCall</span>&lt;TRequest, TResponse&gt;</td>
  264. <td></td>
  265. </tr>
  266. </tbody>
  267. </table>
  268. <h5 class="typeParameters">Type Parameters</h5>
  269. <table class="table table-bordered table-striped table-condensed">
  270. <thead>
  271. <tr>
  272. <th>Name</th>
  273. <th>Description</th>
  274. </tr>
  275. </thead>
  276. <tbody>
  277. <tr>
  278. <td><span class="parametername">TRequest</span></td>
  279. <td></td>
  280. </tr>
  281. <tr>
  282. <td><span class="parametername">TResponse</span></td>
  283. <td></td>
  284. </tr>
  285. </tbody>
  286. </table>
  287. <a id="Grpc_Core_Testing_TestCalls_AsyncServerStreamingCall_" data-uid="Grpc.Core.Testing.TestCalls.AsyncServerStreamingCall*"></a>
  288. <h4 id="Grpc_Core_Testing_TestCalls_AsyncServerStreamingCall__1_IAsyncStreamReader___0__System_Threading_Tasks_Task_Metadata__System_Func_Status__System_Func_Metadata__System_Action_" data-uid="Grpc.Core.Testing.TestCalls.AsyncServerStreamingCall``1(IAsyncStreamReader{``0},System.Threading.Tasks.Task{Metadata},System.Func{Status},System.Func{Metadata},System.Action)">AsyncServerStreamingCall&lt;TResponse&gt;(IAsyncStreamReader&lt;TResponse&gt;, Task&lt;Metadata&gt;, Func&lt;Status&gt;, Func&lt;Metadata&gt;, Action)</h4>
  289. <div class="markdown level1 summary"><p>Creates a test double for <code>AsyncServerStreamingCall</code>. Only for testing.
  290. Note: experimental API that can change or be removed without any prior notice.</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 static AsyncServerStreamingCall&lt;TResponse&gt; AsyncServerStreamingCall&lt;TResponse&gt;(IAsyncStreamReader&lt;TResponse&gt; responseStream, Task&lt;Metadata&gt; responseHeadersAsync, Func&lt;Status&gt; getStatusFunc, Func&lt;Metadata&gt; getTrailersFunc, Action disposeAction)</code></pre>
  296. </div>
  297. <h5 class="parameters">Parameters</h5>
  298. <table class="table table-bordered table-striped table-condensed">
  299. <thead>
  300. <tr>
  301. <th>Type</th>
  302. <th>Name</th>
  303. <th>Description</th>
  304. </tr>
  305. </thead>
  306. <tbody>
  307. <tr>
  308. <td><span class="xref">IAsyncStreamReader</span>&lt;TResponse&gt;</td>
  309. <td><span class="parametername">responseStream</span></td>
  310. <td></td>
  311. </tr>
  312. <tr>
  313. <td><span class="xref">System.Threading.Tasks.Task</span>&lt;<span class="xref">Metadata</span>&gt;</td>
  314. <td><span class="parametername">responseHeadersAsync</span></td>
  315. <td></td>
  316. </tr>
  317. <tr>
  318. <td><span class="xref">System.Func</span>&lt;<span class="xref">Status</span>&gt;</td>
  319. <td><span class="parametername">getStatusFunc</span></td>
  320. <td></td>
  321. </tr>
  322. <tr>
  323. <td><span class="xref">System.Func</span>&lt;<span class="xref">Metadata</span>&gt;</td>
  324. <td><span class="parametername">getTrailersFunc</span></td>
  325. <td></td>
  326. </tr>
  327. <tr>
  328. <td><span class="xref">System.Action</span></td>
  329. <td><span class="parametername">disposeAction</span></td>
  330. <td></td>
  331. </tr>
  332. </tbody>
  333. </table>
  334. <h5 class="returns">Returns</h5>
  335. <table class="table table-bordered table-striped table-condensed">
  336. <thead>
  337. <tr>
  338. <th>Type</th>
  339. <th>Description</th>
  340. </tr>
  341. </thead>
  342. <tbody>
  343. <tr>
  344. <td><span class="xref">AsyncServerStreamingCall</span>&lt;TResponse&gt;</td>
  345. <td></td>
  346. </tr>
  347. </tbody>
  348. </table>
  349. <h5 class="typeParameters">Type Parameters</h5>
  350. <table class="table table-bordered table-striped table-condensed">
  351. <thead>
  352. <tr>
  353. <th>Name</th>
  354. <th>Description</th>
  355. </tr>
  356. </thead>
  357. <tbody>
  358. <tr>
  359. <td><span class="parametername">TResponse</span></td>
  360. <td></td>
  361. </tr>
  362. </tbody>
  363. </table>
  364. <a id="Grpc_Core_Testing_TestCalls_AsyncUnaryCall_" data-uid="Grpc.Core.Testing.TestCalls.AsyncUnaryCall*"></a>
  365. <h4 id="Grpc_Core_Testing_TestCalls_AsyncUnaryCall__1_System_Threading_Tasks_Task___0__System_Threading_Tasks_Task_Metadata__System_Func_Status__System_Func_Metadata__System_Action_" data-uid="Grpc.Core.Testing.TestCalls.AsyncUnaryCall``1(System.Threading.Tasks.Task{``0},System.Threading.Tasks.Task{Metadata},System.Func{Status},System.Func{Metadata},System.Action)">AsyncUnaryCall&lt;TResponse&gt;(Task&lt;TResponse&gt;, Task&lt;Metadata&gt;, Func&lt;Status&gt;, Func&lt;Metadata&gt;, Action)</h4>
  366. <div class="markdown level1 summary"><p>Creates a test double for <code>AsyncUnaryCall</code>. Only for testing.
  367. Note: experimental API that can change or be removed without any prior notice.</p>
  368. </div>
  369. <div class="markdown level1 conceptual"></div>
  370. <h5 class="decalaration">Declaration</h5>
  371. <div class="codewrapper">
  372. <pre><code class="lang-csharp hljs">public static AsyncUnaryCall&lt;TResponse&gt; AsyncUnaryCall&lt;TResponse&gt;(Task&lt;TResponse&gt; responseAsync, Task&lt;Metadata&gt; responseHeadersAsync, Func&lt;Status&gt; getStatusFunc, Func&lt;Metadata&gt; getTrailersFunc, Action disposeAction)</code></pre>
  373. </div>
  374. <h5 class="parameters">Parameters</h5>
  375. <table class="table table-bordered table-striped table-condensed">
  376. <thead>
  377. <tr>
  378. <th>Type</th>
  379. <th>Name</th>
  380. <th>Description</th>
  381. </tr>
  382. </thead>
  383. <tbody>
  384. <tr>
  385. <td><span class="xref">System.Threading.Tasks.Task</span>&lt;TResponse&gt;</td>
  386. <td><span class="parametername">responseAsync</span></td>
  387. <td></td>
  388. </tr>
  389. <tr>
  390. <td><span class="xref">System.Threading.Tasks.Task</span>&lt;<span class="xref">Metadata</span>&gt;</td>
  391. <td><span class="parametername">responseHeadersAsync</span></td>
  392. <td></td>
  393. </tr>
  394. <tr>
  395. <td><span class="xref">System.Func</span>&lt;<span class="xref">Status</span>&gt;</td>
  396. <td><span class="parametername">getStatusFunc</span></td>
  397. <td></td>
  398. </tr>
  399. <tr>
  400. <td><span class="xref">System.Func</span>&lt;<span class="xref">Metadata</span>&gt;</td>
  401. <td><span class="parametername">getTrailersFunc</span></td>
  402. <td></td>
  403. </tr>
  404. <tr>
  405. <td><span class="xref">System.Action</span></td>
  406. <td><span class="parametername">disposeAction</span></td>
  407. <td></td>
  408. </tr>
  409. </tbody>
  410. </table>
  411. <h5 class="returns">Returns</h5>
  412. <table class="table table-bordered table-striped table-condensed">
  413. <thead>
  414. <tr>
  415. <th>Type</th>
  416. <th>Description</th>
  417. </tr>
  418. </thead>
  419. <tbody>
  420. <tr>
  421. <td><span class="xref">AsyncUnaryCall</span>&lt;TResponse&gt;</td>
  422. <td></td>
  423. </tr>
  424. </tbody>
  425. </table>
  426. <h5 class="typeParameters">Type Parameters</h5>
  427. <table class="table table-bordered table-striped table-condensed">
  428. <thead>
  429. <tr>
  430. <th>Name</th>
  431. <th>Description</th>
  432. </tr>
  433. </thead>
  434. <tbody>
  435. <tr>
  436. <td><span class="parametername">TResponse</span></td>
  437. <td></td>
  438. </tr>
  439. </tbody>
  440. </table>
  441. </article>
  442. </div>
  443. <div class="hidden-sm col-md-2" role="complementary">
  444. <div class="sideaffix">
  445. <nav class="bs-docs-sidebar hidden-print hidden-xs hidden-sm affix" id="affix">
  446. <!-- <p><a class="back-to-top" href="#top">Back to top</a><p> -->
  447. </nav>
  448. </div>
  449. </div>
  450. </div>
  451. </div>
  452. <footer>
  453. <div class="grad-bottom"></div>
  454. <div class="footer">
  455. <div class="container">
  456. <span class="pull-right">
  457. <a href="#top">Back to top</a>
  458. </span>
  459. <span>Generated by <strong>DocFX</strong></span>
  460. </div>
  461. </div>
  462. </footer>
  463. </div>
  464. <script type="text/javascript" src="../styles/docfx.vendor.js"></script>
  465. <script type="text/javascript" src="../styles/docfx.js"></script>
  466. <script type="text/javascript" src="../styles/main.js"></script>
  467. </body>
  468. </html>