123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149 |
- <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
- <html xmlns="http://www.w3.org/1999/xhtml">
- <head>
- <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
- <meta http-equiv="X-UA-Compatible" content="IE=9"/>
- <meta name="generator" content="Doxygen 1.8.17"/>
- <meta name="viewport" content="width=device-width, initial-scale=1"/>
- <title>GRPC C++: grpc::ClientReaderInterface< R > Class Template Reference</title>
- <link href="tabs.css" rel="stylesheet" type="text/css"/>
- <script type="text/javascript" src="jquery.js"></script>
- <script type="text/javascript" src="dynsections.js"></script>
- <link href="search/search.css" rel="stylesheet" type="text/css"/>
- <script type="text/javascript" src="search/searchdata.js"></script>
- <script type="text/javascript" src="search/search.js"></script>
- <link href="doxygen.css" rel="stylesheet" type="text/css" />
- </head>
- <body>
- <div id="top"><!-- do not remove this div, it is closed by doxygen! -->
- <div id="titlearea">
- <table cellspacing="0" cellpadding="0">
- <tbody>
- <tr style="height: 56px;">
- <td id="projectalign" style="padding-left: 0.5em;">
- <div id="projectname">GRPC C++
-  <span id="projectnumber">1.36.1</span>
- </div>
- </td>
- </tr>
- </tbody>
- </table>
- </div>
- <!-- end header part -->
- <!-- Generated by Doxygen 1.8.17 -->
- <script type="text/javascript">
- /* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */
- var searchBox = new SearchBox("searchBox", "search",false,'Search');
- /* @license-end */
- </script>
- <script type="text/javascript" src="menudata.js"></script>
- <script type="text/javascript" src="menu.js"></script>
- <script type="text/javascript">
- /* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */
- $(function() {
- initMenu('',true,false,'search.php','Search');
- $(document).ready(function() { init_search(); });
- });
- /* @license-end */</script>
- <div id="main-nav"></div>
- <!-- window showing the filter options -->
- <div id="MSearchSelectWindow"
- onmouseover="return searchBox.OnSearchSelectShow()"
- onmouseout="return searchBox.OnSearchSelectHide()"
- onkeydown="return searchBox.OnSearchSelectKey(event)">
- </div>
- <!-- iframe showing the search results (closed by default) -->
- <div id="MSearchResultsWindow">
- <iframe src="javascript:void(0)" frameborder="0"
- name="MSearchResults" id="MSearchResults">
- </iframe>
- </div>
- <div id="nav-path" class="navpath">
- <ul>
- <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>
- </div>
- </div><!-- top -->
- <div class="header">
- <div class="summary">
- <a href="#pub-methods">Public Member Functions</a> </div>
- <div class="headertitle">
- <div class="title">grpc::ClientReaderInterface< R > Class Template Reference<span class="mlabels"><span class="mlabel">abstract</span></span></div> </div>
- </div><!--header-->
- <div class="contents">
- <p>Client-side interface for streaming reads of message of type <em>R</em>.
- <a href="classgrpc_1_1_client_reader_interface.html#details">More...</a></p>
- <p><code>#include <<a class="el" href="grpcpp_2impl_2codegen_2sync__stream_8h_source.html">sync_stream.h</a>></code></p>
- <table class="memberdecls">
- <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
- Public Member Functions</h2></td></tr>
- <tr class="memitem:aee87dd6e3e8a40853207ceb53b590b19"><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc_1_1_client_reader_interface.html#aee87dd6e3e8a40853207ceb53b590b19">WaitForInitialMetadata</a> ()=0</td></tr>
- <tr class="memdesc:aee87dd6e3e8a40853207ceb53b590b19"><td class="mdescLeft"> </td><td class="mdescRight">Block to wait for initial metadata from server. <a href="classgrpc_1_1_client_reader_interface.html#aee87dd6e3e8a40853207ceb53b590b19">More...</a><br /></td></tr>
- <tr class="separator:aee87dd6e3e8a40853207ceb53b590b19"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="inherit_header pub_methods_classgrpc_1_1internal_1_1_client_streaming_interface"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_classgrpc_1_1internal_1_1_client_streaming_interface')"><img src="closed.png" alt="-"/> Public Member Functions inherited from <a class="el" href="classgrpc_1_1internal_1_1_client_streaming_interface.html">grpc::internal::ClientStreamingInterface</a></td></tr>
- <tr class="memitem:ab1a7a2664187d88d0354b69138db7eb1 inherit pub_methods_classgrpc_1_1internal_1_1_client_streaming_interface"><td class="memItemLeft" align="right" valign="top">virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc_1_1internal_1_1_client_streaming_interface.html#ab1a7a2664187d88d0354b69138db7eb1">~ClientStreamingInterface</a> ()</td></tr>
- <tr class="separator:ab1a7a2664187d88d0354b69138db7eb1 inherit pub_methods_classgrpc_1_1internal_1_1_client_streaming_interface"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:aee6647289bab889e8fee849221ab66ec inherit pub_methods_classgrpc_1_1internal_1_1_client_streaming_interface"><td class="memItemLeft" align="right" valign="top">virtual ::<a class="el" href="classgrpc_1_1_status.html">grpc::Status</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc_1_1internal_1_1_client_streaming_interface.html#aee6647289bab889e8fee849221ab66ec">Finish</a> ()=0</td></tr>
- <tr class="memdesc:aee6647289bab889e8fee849221ab66ec inherit pub_methods_classgrpc_1_1internal_1_1_client_streaming_interface"><td class="mdescLeft"> </td><td class="mdescRight">Block waiting until the stream finishes and a final status of the call is available. <a href="classgrpc_1_1internal_1_1_client_streaming_interface.html#aee6647289bab889e8fee849221ab66ec">More...</a><br /></td></tr>
- <tr class="separator:aee6647289bab889e8fee849221ab66ec inherit pub_methods_classgrpc_1_1internal_1_1_client_streaming_interface"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="inherit_header pub_methods_classgrpc_1_1internal_1_1_reader_interface"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_classgrpc_1_1internal_1_1_reader_interface')"><img src="closed.png" alt="-"/> Public Member Functions inherited from <a class="el" href="classgrpc_1_1internal_1_1_reader_interface.html">grpc::internal::ReaderInterface< R ></a></td></tr>
- <tr class="memitem:ad1d28c0720937a61b0f7952d3add7bba inherit pub_methods_classgrpc_1_1internal_1_1_reader_interface"><td class="memItemLeft" align="right" valign="top">virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc_1_1internal_1_1_reader_interface.html#ad1d28c0720937a61b0f7952d3add7bba">~ReaderInterface</a> ()</td></tr>
- <tr class="separator:ad1d28c0720937a61b0f7952d3add7bba inherit pub_methods_classgrpc_1_1internal_1_1_reader_interface"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:ad3216783fae57e614181e28df9435f33 inherit pub_methods_classgrpc_1_1internal_1_1_reader_interface"><td class="memItemLeft" align="right" valign="top">virtual bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc_1_1internal_1_1_reader_interface.html#ad3216783fae57e614181e28df9435f33">NextMessageSize</a> (uint32_t *sz)=0</td></tr>
- <tr class="memdesc:ad3216783fae57e614181e28df9435f33 inherit pub_methods_classgrpc_1_1internal_1_1_reader_interface"><td class="mdescLeft"> </td><td class="mdescRight">Get an upper bound on the next message size available for reading on this stream. <a href="classgrpc_1_1internal_1_1_reader_interface.html#ad3216783fae57e614181e28df9435f33">More...</a><br /></td></tr>
- <tr class="separator:ad3216783fae57e614181e28df9435f33 inherit pub_methods_classgrpc_1_1internal_1_1_reader_interface"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:adfb50ace59b4b9666a46548d3f732ee8 inherit pub_methods_classgrpc_1_1internal_1_1_reader_interface"><td class="memItemLeft" align="right" valign="top">virtual bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc_1_1internal_1_1_reader_interface.html#adfb50ace59b4b9666a46548d3f732ee8">Read</a> (R *msg)=0</td></tr>
- <tr class="memdesc:adfb50ace59b4b9666a46548d3f732ee8 inherit pub_methods_classgrpc_1_1internal_1_1_reader_interface"><td class="mdescLeft"> </td><td class="mdescRight">Block to read a message and parse to <em>msg</em>. <a href="classgrpc_1_1internal_1_1_reader_interface.html#adfb50ace59b4b9666a46548d3f732ee8">More...</a><br /></td></tr>
- <tr class="separator:adfb50ace59b4b9666a46548d3f732ee8 inherit pub_methods_classgrpc_1_1internal_1_1_reader_interface"><td class="memSeparator" colspan="2"> </td></tr>
- </table>
- <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
- <div class="textblock"><h3>template<class R><br />
- class grpc::ClientReaderInterface< R ></h3>
- <p>Client-side interface for streaming reads of message of type <em>R</em>. </p>
- </div><h2 class="groupheader">Member Function Documentation</h2>
- <a id="aee87dd6e3e8a40853207ceb53b590b19"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#aee87dd6e3e8a40853207ceb53b590b19">◆ </a></span>WaitForInitialMetadata()</h2>
- <div class="memitem">
- <div class="memproto">
- <div class="memtemplate">
- template<class R > </div>
- <table class="mlabels">
- <tr>
- <td class="mlabels-left">
- <table class="memname">
- <tr>
- <td class="memname">virtual void <a class="el" href="classgrpc_1_1_client_reader_interface.html">grpc::ClientReaderInterface</a>< R >::WaitForInitialMetadata </td>
- <td>(</td>
- <td class="paramname"></td><td>)</td>
- <td></td>
- </tr>
- </table>
- </td>
- <td class="mlabels-right">
- <span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>Block to wait for initial metadata from server. </p>
- <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" title="A ClientContext allows the person implementing a service client to:">ClientContext</a> after the first read. </p>
- </div>
- </div>
- <hr/>The documentation for this class was generated from the following file:<ul>
- <li>include/grpcpp/impl/codegen/<a class="el" href="grpcpp_2impl_2codegen_2sync__stream_8h_source.html">sync_stream.h</a></li>
- </ul>
- </div><!-- contents -->
- <!-- start footer part -->
- <hr class="footer"/><address class="footer"><small>
- Generated on Wed Mar 3 2021 19:17:24 for GRPC C++ by  <a href="http://www.doxygen.org/index.html">
- <img class="footer" src="doxygen.png" alt="doxygen"/>
- </a> 1.8.17
- </small></address>
- </body>
- </html>
|