classgrpc_1_1_client_reader_interface.html 11 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169
  1. <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
  2. <html xmlns="http://www.w3.org/1999/xhtml">
  3. <head>
  4. <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
  5. <meta http-equiv="X-UA-Compatible" content="IE=9"/>
  6. <meta name="generator" content="Doxygen 1.8.11"/>
  7. <title>GRPC C++: grpc::ClientReaderInterface&lt; R &gt; Class Template Reference</title>
  8. <link href="tabs.css" rel="stylesheet" type="text/css"/>
  9. <script type="text/javascript" src="jquery.js"></script>
  10. <script type="text/javascript" src="dynsections.js"></script>
  11. <link href="search/search.css" rel="stylesheet" type="text/css"/>
  12. <script type="text/javascript" src="search/searchdata.js"></script>
  13. <script type="text/javascript" src="search/search.js"></script>
  14. <script type="text/javascript">
  15. $(document).ready(function() { init_search(); });
  16. </script>
  17. <link href="doxygen.css" rel="stylesheet" type="text/css" />
  18. </head>
  19. <body>
  20. <div id="top"><!-- do not remove this div, it is closed by doxygen! -->
  21. <div id="titlearea">
  22. <table cellspacing="0" cellpadding="0">
  23. <tbody>
  24. <tr style="height: 56px;">
  25. <td id="projectalign" style="padding-left: 0.5em;">
  26. <div id="projectname">GRPC C++
  27. &#160;<span id="projectnumber">1.0.0</span>
  28. </div>
  29. </td>
  30. </tr>
  31. </tbody>
  32. </table>
  33. </div>
  34. <!-- end header part -->
  35. <!-- Generated by Doxygen 1.8.11 -->
  36. <script type="text/javascript">
  37. var searchBox = new SearchBox("searchBox", "search",false,'Search');
  38. </script>
  39. <div id="navrow1" class="tabs">
  40. <ul class="tablist">
  41. <li><a href="index.html"><span>Main&#160;Page</span></a></li>
  42. <li><a href="modules.html"><span>Modules</span></a></li>
  43. <li><a href="namespaces.html"><span>Namespaces</span></a></li>
  44. <li class="current"><a href="annotated.html"><span>Data&#160;Structures</span></a></li>
  45. <li><a href="files.html"><span>Files</span></a></li>
  46. <li>
  47. <div id="MSearchBox" class="MSearchBoxInactive">
  48. <span class="left">
  49. <img id="MSearchSelect" src="search/mag_sel.png"
  50. onmouseover="return searchBox.OnSearchSelectShow()"
  51. onmouseout="return searchBox.OnSearchSelectHide()"
  52. alt=""/>
  53. <input type="text" id="MSearchField" value="Search" accesskey="S"
  54. onfocus="searchBox.OnSearchFieldFocus(true)"
  55. onblur="searchBox.OnSearchFieldFocus(false)"
  56. onkeyup="searchBox.OnSearchFieldChange(event)"/>
  57. </span><span class="right">
  58. <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
  59. </span>
  60. </div>
  61. </li>
  62. </ul>
  63. </div>
  64. <div id="navrow2" class="tabs2">
  65. <ul class="tablist">
  66. <li><a href="annotated.html"><span>Data&#160;Structures</span></a></li>
  67. <li><a href="classes.html"><span>Data&#160;Structure&#160;Index</span></a></li>
  68. <li><a href="hierarchy.html"><span>Class&#160;Hierarchy</span></a></li>
  69. <li><a href="functions.html"><span>Data&#160;Fields</span></a></li>
  70. </ul>
  71. </div>
  72. <!-- window showing the filter options -->
  73. <div id="MSearchSelectWindow"
  74. onmouseover="return searchBox.OnSearchSelectShow()"
  75. onmouseout="return searchBox.OnSearchSelectHide()"
  76. onkeydown="return searchBox.OnSearchSelectKey(event)">
  77. </div>
  78. <!-- iframe showing the search results (closed by default) -->
  79. <div id="MSearchResultsWindow">
  80. <iframe src="javascript:void(0)" frameborder="0"
  81. name="MSearchResults" id="MSearchResults">
  82. </iframe>
  83. </div>
  84. <div id="nav-path" class="navpath">
  85. <ul>
  86. <li class="navelem"><a class="el" href="namespacegrpc.html">grpc</a></li><li class="navelem"><a class="el" href="classgrpc_1_1_client_reader_interface.html">ClientReaderInterface</a></li> </ul>
  87. </div>
  88. </div><!-- top -->
  89. <div class="header">
  90. <div class="summary">
  91. <a href="#pub-methods">Public Member Functions</a> </div>
  92. <div class="headertitle">
  93. <div class="title">grpc::ClientReaderInterface&lt; R &gt; Class Template Reference<span class="mlabels"><span class="mlabel">abstract</span></span></div> </div>
  94. </div><!--header-->
  95. <div class="contents">
  96. <p>Client-side interface for streaming reads of message of type <em>R</em>.
  97. <a href="classgrpc_1_1_client_reader_interface.html#details">More...</a></p>
  98. <p><code>#include &lt;<a class="el" href="impl_2codegen_2sync__stream_8h_source.html">sync_stream.h</a>&gt;</code></p>
  99. <table class="memberdecls">
  100. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
  101. Public Member Functions</h2></td></tr>
  102. <tr class="memitem:aee87dd6e3e8a40853207ceb53b590b19"><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc_1_1_client_reader_interface.html#aee87dd6e3e8a40853207ceb53b590b19">WaitForInitialMetadata</a> ()=0</td></tr>
  103. <tr class="memdesc:aee87dd6e3e8a40853207ceb53b590b19"><td class="mdescLeft">&#160;</td><td class="mdescRight">Blocking wait for initial metadata from server. <a href="#aee87dd6e3e8a40853207ceb53b590b19">More...</a><br /></td></tr>
  104. <tr class="separator:aee87dd6e3e8a40853207ceb53b590b19"><td class="memSeparator" colspan="2">&#160;</td></tr>
  105. <tr class="inherit_header pub_methods_classgrpc_1_1_client_streaming_interface"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_classgrpc_1_1_client_streaming_interface')"><img src="closed.png" alt="-"/>&#160;Public Member Functions inherited from <a class="el" href="classgrpc_1_1_client_streaming_interface.html">grpc::ClientStreamingInterface</a></td></tr>
  106. <tr class="memitem:a312c9454c0f950e1c75b5c802bcbb00e inherit pub_methods_classgrpc_1_1_client_streaming_interface"><td class="memItemLeft" align="right" valign="top">virtual&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc_1_1_client_streaming_interface.html#a312c9454c0f950e1c75b5c802bcbb00e">~ClientStreamingInterface</a> ()</td></tr>
  107. <tr class="separator:a312c9454c0f950e1c75b5c802bcbb00e inherit pub_methods_classgrpc_1_1_client_streaming_interface"><td class="memSeparator" colspan="2">&#160;</td></tr>
  108. <tr class="memitem:a98e2927a42c793017ce7d8c6e88539c4 inherit pub_methods_classgrpc_1_1_client_streaming_interface"><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="classgrpc_1_1_status.html">Status</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc_1_1_client_streaming_interface.html#a98e2927a42c793017ce7d8c6e88539c4">Finish</a> ()=0</td></tr>
  109. <tr class="memdesc:a98e2927a42c793017ce7d8c6e88539c4 inherit pub_methods_classgrpc_1_1_client_streaming_interface"><td class="mdescLeft">&#160;</td><td class="mdescRight">Wait until the stream finishes, and return the final status. <a href="#a98e2927a42c793017ce7d8c6e88539c4">More...</a><br /></td></tr>
  110. <tr class="separator:a98e2927a42c793017ce7d8c6e88539c4 inherit pub_methods_classgrpc_1_1_client_streaming_interface"><td class="memSeparator" colspan="2">&#160;</td></tr>
  111. <tr class="inherit_header pub_methods_classgrpc_1_1_reader_interface"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_classgrpc_1_1_reader_interface')"><img src="closed.png" alt="-"/>&#160;Public Member Functions inherited from <a class="el" href="classgrpc_1_1_reader_interface.html">grpc::ReaderInterface&lt; R &gt;</a></td></tr>
  112. <tr class="memitem:a1fbd3d6e86e2f97e5444f29b0af0a9d5 inherit pub_methods_classgrpc_1_1_reader_interface"><td class="memItemLeft" align="right" valign="top">virtual&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc_1_1_reader_interface.html#a1fbd3d6e86e2f97e5444f29b0af0a9d5">~ReaderInterface</a> ()</td></tr>
  113. <tr class="separator:a1fbd3d6e86e2f97e5444f29b0af0a9d5 inherit pub_methods_classgrpc_1_1_reader_interface"><td class="memSeparator" colspan="2">&#160;</td></tr>
  114. <tr class="memitem:a04a1da8610d790ea86ecd5a14fe892b8 inherit pub_methods_classgrpc_1_1_reader_interface"><td class="memItemLeft" align="right" valign="top">virtual bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc_1_1_reader_interface.html#a04a1da8610d790ea86ecd5a14fe892b8">Read</a> (R *msg)=0</td></tr>
  115. <tr class="memdesc:a04a1da8610d790ea86ecd5a14fe892b8 inherit pub_methods_classgrpc_1_1_reader_interface"><td class="mdescLeft">&#160;</td><td class="mdescRight">Blocking read a message and parse to <em>msg</em>. <a href="#a04a1da8610d790ea86ecd5a14fe892b8">More...</a><br /></td></tr>
  116. <tr class="separator:a04a1da8610d790ea86ecd5a14fe892b8 inherit pub_methods_classgrpc_1_1_reader_interface"><td class="memSeparator" colspan="2">&#160;</td></tr>
  117. </table>
  118. <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
  119. <div class="textblock"><h3>template&lt;class R&gt;<br />
  120. class grpc::ClientReaderInterface&lt; R &gt;</h3>
  121. <p>Client-side interface for streaming reads of message of type <em>R</em>. </p>
  122. </div><h2 class="groupheader">Member Function Documentation</h2>
  123. <a class="anchor" id="aee87dd6e3e8a40853207ceb53b590b19"></a>
  124. <div class="memitem">
  125. <div class="memproto">
  126. <div class="memtemplate">
  127. template&lt;class R &gt; </div>
  128. <table class="mlabels">
  129. <tr>
  130. <td class="mlabels-left">
  131. <table class="memname">
  132. <tr>
  133. <td class="memname">virtual void <a class="el" href="classgrpc_1_1_client_reader_interface.html">grpc::ClientReaderInterface</a>&lt; R &gt;::WaitForInitialMetadata </td>
  134. <td>(</td>
  135. <td class="paramname"></td><td>)</td>
  136. <td></td>
  137. </tr>
  138. </table>
  139. </td>
  140. <td class="mlabels-right">
  141. <span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
  142. </tr>
  143. </table>
  144. </div><div class="memdoc">
  145. <p>Blocking wait for initial metadata from server. </p>
  146. <p>The received metadata can only be accessed after this call returns. Should only be called before the first read. Calling this method is optional, and if it is not called the metadata will be available in <a class="el" href="classgrpc_1_1_client_context.html">ClientContext</a> after the first read. </p>
  147. <p>Implemented in <a class="el" href="classgrpc_1_1_client_reader.html#aafa93fe8a65edb12a4742c067d90bec1">grpc::ClientReader&lt; R &gt;</a>.</p>
  148. </div>
  149. </div>
  150. <hr/>The documentation for this class was generated from the following file:<ul>
  151. <li>include/grpc++/impl/codegen/<a class="el" href="impl_2codegen_2sync__stream_8h_source.html">sync_stream.h</a></li>
  152. </ul>
  153. </div><!-- contents -->
  154. <!-- start footer part -->
  155. <hr class="footer"/><address class="footer"><small>
  156. Generated on Thu Aug 18 2016 21:34:58 for GRPC C++ by &#160;<a href="http://www.doxygen.org/index.html">
  157. <img class="footer" src="doxygen.png" alt="doxygen"/>
  158. </a> 1.8.11
  159. </small></address>
  160. </body>
  161. </html>