cpp/classgrpc_1_1internal_1_1_async_reader_interface.html - third_party/grpc - Git at Google

 <!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::internal::AsyncReaderInterface&lt; R &gt; 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++
    &#160;<span id="projectnumber">1.64.0</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&amp;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&amp;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="namespacegrpc_1_1internal.html">internal</a></li><li class="navelem"><a class="el" href="classgrpc_1_1internal_1_1_async_reader_interface.html">AsyncReaderInterface</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::internal::AsyncReaderInterface&lt; R &gt; Class Template Reference<span class="mlabels"><span class="mlabel">abstract</span></span></div>  </div>
 </div><!--header-->
 <div class="contents">

 <p>An interface that yields a sequence of messages of type <em>R</em>.
  <a href="classgrpc_1_1internal_1_1_async_reader_interface.html#details">More...</a></p>

 <p><code>#include &lt;<a class="el" href="grpcpp_2support_2async__stream_8h_source.html">async_stream.h</a>&gt;</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:a18fe4235232864c8770a562cc2aa1f3c"><td class="memItemLeft" align="right" valign="top">virtual&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc_1_1internal_1_1_async_reader_interface.html#a18fe4235232864c8770a562cc2aa1f3c">~AsyncReaderInterface</a> ()</td></tr>
 <tr class="separator:a18fe4235232864c8770a562cc2aa1f3c"><td class="memSeparator" colspan="2">&#160;</td></tr>
 <tr class="memitem:adf87c602036d69158950b7299d0aae70"><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc_1_1internal_1_1_async_reader_interface.html#adf87c602036d69158950b7299d0aae70">Read</a> (R *msg, void *tag)=0</td></tr>
 <tr class="memdesc:adf87c602036d69158950b7299d0aae70"><td class="mdescLeft">&#160;</td><td class="mdescRight">Read a message of type <em>R</em> into <em>msg</em>.  <a href="classgrpc_1_1internal_1_1_async_reader_interface.html#adf87c602036d69158950b7299d0aae70">More...</a><br /></td></tr>
 <tr class="separator:adf87c602036d69158950b7299d0aae70"><td class="memSeparator" colspan="2">&#160;</td></tr>
 </table>
 <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
 <div class="textblock"><h3>template&lt;class R&gt;<br />
 class grpc::internal::AsyncReaderInterface&lt; R &gt;</h3>

 <p>An interface that yields a sequence of messages of type <em>R</em>. </p>
 </div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
 <a id="a18fe4235232864c8770a562cc2aa1f3c"></a>
 <h2 class="memtitle"><span class="permalink"><a href="#a18fe4235232864c8770a562cc2aa1f3c">&#9670;&nbsp;</a></span>~AsyncReaderInterface()</h2>

 <div class="memitem">
 <div class="memproto">
 <div class="memtemplate">
 template&lt;class R &gt; </div>
 <table class="mlabels">
   <tr>
   <td class="mlabels-left">
       <table class="memname">
         <tr>
           <td class="memname">virtual <a class="el" href="classgrpc_1_1internal_1_1_async_reader_interface.html">grpc::internal::AsyncReaderInterface</a>&lt; R &gt;::~<a class="el" href="classgrpc_1_1internal_1_1_async_reader_interface.html">AsyncReaderInterface</a> </td>
           <td>(</td>
           <td class="paramname"></td><td>)</td>
           <td></td>
         </tr>
       </table>
   </td>
   <td class="mlabels-right">
 <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">virtual</span></span>  </td>
   </tr>
 </table>
 </div><div class="memdoc">

 </div>
 </div>
 <h2 class="groupheader">Member Function Documentation</h2>
 <a id="adf87c602036d69158950b7299d0aae70"></a>
 <h2 class="memtitle"><span class="permalink"><a href="#adf87c602036d69158950b7299d0aae70">&#9670;&nbsp;</a></span>Read()</h2>

 <div class="memitem">
 <div class="memproto">
 <div class="memtemplate">
 template&lt;class R &gt; </div>
 <table class="mlabels">
   <tr>
   <td class="mlabels-left">
       <table class="memname">
         <tr>
           <td class="memname">virtual void <a class="el" href="classgrpc_1_1internal_1_1_async_reader_interface.html">grpc::internal::AsyncReaderInterface</a>&lt; R &gt;::Read </td>
           <td>(</td>
           <td class="paramtype">R *&#160;</td>
           <td class="paramname"><em>msg</em>, </td>
         </tr>
         <tr>
           <td class="paramkey"></td>
           <td></td>
           <td class="paramtype">void *&#160;</td>
           <td class="paramname"><em>tag</em>&#160;</td>
         </tr>
         <tr>
           <td></td>
           <td>)</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>Read a message of type <em>R</em> into <em>msg</em>. </p>
 <p>Completion will be notified by <em>tag</em> on the associated completion queue. This is thread-safe with respect to <em>Write</em> or <em>WritesDone</em> methods. It should not be called concurrently with other streaming APIs on the same stream. It is not meaningful to call it concurrently with another <em><a class="el" href="classgrpc_1_1internal_1_1_async_reader_interface.html#adf87c602036d69158950b7299d0aae70" title="Read a message of type R into msg.">AsyncReaderInterface::Read</a></em> on the same stream since reads on the same stream are delivered in order.</p>
 <dl class="params"><dt>Parameters</dt><dd>
   <table class="params">
     <tr><td class="paramdir">[out]</td><td class="paramname">msg</td><td>Where to eventually store the read message. </td></tr>
     <tr><td class="paramdir">[in]</td><td class="paramname">tag</td><td>The tag identifying the operation.</td></tr>
   </table>
   </dd>
 </dl>
 <p>Side effect: note that this method attempt to receive initial metadata for a stream if it hasn't yet been received. </p>

 </div>
 </div>
 <hr/>The documentation for this class was generated from the following file:<ul>
 <li>include/grpcpp/support/<a class="el" href="grpcpp_2support_2async__stream_8h_source.html">async_stream.h</a></li>
 </ul>
 </div><!-- contents -->
 <!-- start footer part -->
 <hr class="footer"/><address class="footer"><small>
 Generated on Fri May 17 2024 01:17:16 for GRPC C++ by &#160;<a href="http://www.doxygen.org/index.html">
 <img class="footer" src="doxygen.png" alt="doxygen"/>
 </a> 1.8.17
 </small></address>
 </body>
 </html>
	<!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::internal::AsyncReaderInterface< 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.64.0</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="namespacegrpc_1_1internal.html">internal</a></li><li class="navelem"><a class="el" href="classgrpc_1_1internal_1_1_async_reader_interface.html">AsyncReaderInterface</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::internal::AsyncReaderInterface< R > Class Template Reference<span class="mlabels"><span class="mlabel">abstract</span></span></div> </div>
	</div><!--header-->
	<div class="contents">

	<p>An interface that yields a sequence of messages of type <em>R</em>.
	<a href="classgrpc_1_1internal_1_1_async_reader_interface.html#details">More...</a></p>

	<p><code>#include <<a class="el" href="grpcpp_2support_2async__stream_8h_source.html">async_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:a18fe4235232864c8770a562cc2aa1f3c"><td class="memItemLeft" align="right" valign="top">virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc_1_1internal_1_1_async_reader_interface.html#a18fe4235232864c8770a562cc2aa1f3c">~AsyncReaderInterface</a> ()</td></tr>
	<tr class="separator:a18fe4235232864c8770a562cc2aa1f3c"><td class="memSeparator" colspan="2"> </td></tr>
	<tr class="memitem:adf87c602036d69158950b7299d0aae70"><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc_1_1internal_1_1_async_reader_interface.html#adf87c602036d69158950b7299d0aae70">Read</a> (R msg, void tag)=0</td></tr>
	<tr class="memdesc:adf87c602036d69158950b7299d0aae70"><td class="mdescLeft"> </td><td class="mdescRight">Read a message of type <em>R</em> into <em>msg</em>. <a href="classgrpc_1_1internal_1_1_async_reader_interface.html#adf87c602036d69158950b7299d0aae70">More...</a><br /></td></tr>
	<tr class="separator:adf87c602036d69158950b7299d0aae70"><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::internal::AsyncReaderInterface< R ></h3>

	<p>An interface that yields a sequence of messages of type <em>R</em>. </p>
	</div><h2 class="groupheader">Constructor & Destructor Documentation</h2>
	<a id="a18fe4235232864c8770a562cc2aa1f3c"></a>
	<h2 class="memtitle"><span class="permalink"><a href="#a18fe4235232864c8770a562cc2aa1f3c">◆ </a></span>~AsyncReaderInterface()</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 <a class="el" href="classgrpc_1_1internal_1_1_async_reader_interface.html">grpc::internal::AsyncReaderInterface</a>< R >::~<a class="el" href="classgrpc_1_1internal_1_1_async_reader_interface.html">AsyncReaderInterface</a> </td>
	<td>(</td>
	<td class="paramname"></td><td>)</td>
	<td></td>
	</tr>
	</table>
	</td>
	<td class="mlabels-right">
	<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">virtual</span></span> </td>
	</tr>
	</table>
	</div><div class="memdoc">

	</div>
	</div>
	<h2 class="groupheader">Member Function Documentation</h2>
	<a id="adf87c602036d69158950b7299d0aae70"></a>
	<h2 class="memtitle"><span class="permalink"><a href="#adf87c602036d69158950b7299d0aae70">◆ </a></span>Read()</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_1internal_1_1_async_reader_interface.html">grpc::internal::AsyncReaderInterface</a>< R >::Read </td>
	<td>(</td>
	<td class="paramtype">R * </td>
	<td class="paramname"><em>msg</em>, </td>
	</tr>
	<tr>
	<td class="paramkey"></td>
	<td></td>
	<td class="paramtype">void * </td>
	<td class="paramname"><em>tag</em> </td>
	</tr>
	<tr>
	<td></td>
	<td>)</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>Read a message of type <em>R</em> into <em>msg</em>. </p>
	<p>Completion will be notified by <em>tag</em> on the associated completion queue. This is thread-safe with respect to <em>Write</em> or <em>WritesDone</em> methods. It should not be called concurrently with other streaming APIs on the same stream. It is not meaningful to call it concurrently with another <em><a class="el" href="classgrpc_1_1internal_1_1_async_reader_interface.html#adf87c602036d69158950b7299d0aae70" title="Read a message of type R into msg.">AsyncReaderInterface::Read</a></em> on the same stream since reads on the same stream are delivered in order.</p>
	<dl class="params"><dt>Parameters</dt><dd>
	<table class="params">
	<tr><td class="paramdir">[out]</td><td class="paramname">msg</td><td>Where to eventually store the read message. </td></tr>
	<tr><td class="paramdir">[in]</td><td class="paramname">tag</td><td>The tag identifying the operation.</td></tr>
	</table>
	</dd>
	</dl>
	<p>Side effect: note that this method attempt to receive initial metadata for a stream if it hasn't yet been received. </p>

	</div>
	</div>
	<hr/>The documentation for this class was generated from the following file:<ul>
	<li>include/grpcpp/support/<a class="el" href="grpcpp_2support_2async__stream_8h_source.html">async_stream.h</a></li>
	</ul>
	</div><!-- contents -->
	<!-- start footer part -->
	<hr class="footer"/><address class="footer"><small>
	Generated on Fri May 17 2024 01:17:16 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>