Grpc.Core.IAsyncStreamReader-1.html 6.3 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166
  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>Interface IAsyncStreamReader&lt;T&gt;
  8. | gRPC C# </title>
  9. <meta name="viewport" content="width=device-width">
  10. <meta name="title" content="Interface IAsyncStreamReader&lt;T&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.IAsyncStreamReader`1">
  71. <h1 id="Grpc_Core_IAsyncStreamReader_1" data-uid="Grpc.Core.IAsyncStreamReader`1" class="text-break">Interface IAsyncStreamReader&lt;T&gt;
  72. </h1>
  73. <div class="markdown level0 summary"><p>A stream of messages to be read.
  74. Messages can be awaited <code>await reader.MoveNext()</code>, that returns <code>true</code>
  75. if there is a message available and <code>false</code> if there are no more messages
  76. (i.e. the stream has been closed).
  77. <p>
  78. On the client side, the last invocation of <code>MoveNext()</code> either returns <code>false</code>
  79. if the call has finished successfully or throws <code>RpcException</code> if call finished
  80. with an error. Once the call finishes, subsequent invocations of <code>MoveNext()</code> will
  81. continue yielding the same result (returning <code>false</code> or throwing an exception).
  82. </p>
  83. <p>
  84. On the server side, <code>MoveNext()</code> does not throw exceptions.
  85. In case of a failure, the request stream will appear to be finished
  86. (<code>MoveNext</code> will return <code>false</code>) and the <code>CancellationToken</code>
  87. associated with the call will be cancelled to signal the failure.
  88. </p></p>
  89. </div>
  90. <div class="markdown level0 conceptual"></div>
  91. <div class="inheritedMembers">
  92. <h5>Inherited Members</h5>
  93. <div>
  94. <span class="xref">System.Collections.Generic.IAsyncEnumerator&lt;T&gt;.MoveNext(System.Threading.CancellationToken)</span>
  95. </div>
  96. <div>
  97. <span class="xref">System.Collections.Generic.IAsyncEnumerator&lt;T&gt;.Current</span>
  98. </div>
  99. <div>
  100. <span class="xref">System.IDisposable.Dispose()</span>
  101. </div>
  102. </div>
  103. <h6><strong>Namespace</strong>: <a class="xref" href="Grpc.Core.html">Grpc.Core</a></h6>
  104. <h6><strong>Assembly</strong>: Grpc.Core.dll</h6>
  105. <h5 id="Grpc_Core_IAsyncStreamReader_1_syntax">Syntax</h5>
  106. <div class="codewrapper">
  107. <pre><code class="lang-csharp hljs">public interface IAsyncStreamReader&lt;T&gt; : IAsyncEnumerator&lt;T&gt;, IDisposable</code></pre>
  108. </div>
  109. <h5 class="typeParameters">Type Parameters</h5>
  110. <table class="table table-bordered table-striped table-condensed">
  111. <thead>
  112. <tr>
  113. <th>Name</th>
  114. <th>Description</th>
  115. </tr>
  116. </thead>
  117. <tbody>
  118. <tr>
  119. <td><span class="parametername">T</span></td>
  120. <td><p>The message type.</p>
  121. </td>
  122. </tr>
  123. </tbody>
  124. </table>
  125. </article>
  126. </div>
  127. <div class="hidden-sm col-md-2" role="complementary">
  128. <div class="sideaffix">
  129. <nav class="bs-docs-sidebar hidden-print hidden-xs hidden-sm affix" id="affix">
  130. <!-- <p><a class="back-to-top" href="#top">Back to top</a><p> -->
  131. </nav>
  132. </div>
  133. </div>
  134. </div>
  135. </div>
  136. <footer>
  137. <div class="grad-bottom"></div>
  138. <div class="footer">
  139. <div class="container">
  140. <span class="pull-right">
  141. <a href="#top">Back to top</a>
  142. </span>
  143. <span>Copyright © 2015-2017 Microsoft<br>Generated by <strong>DocFX</strong></span>
  144. </div>
  145. </div>
  146. </footer>
  147. </div>
  148. <script type="text/javascript" src="../styles/docfx.vendor.js"></script>
  149. <script type="text/javascript" src="../styles/docfx.js"></script>
  150. <script type="text/javascript" src="../styles/main.js"></script>
  151. </body>
  152. </html>