classgrpc_1_1_client_async_writer_interface.html 12 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179
  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::ClientAsyncWriterInterface&lt; W &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_async_writer_interface.html">ClientAsyncWriterInterface</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::ClientAsyncWriterInterface&lt; W &gt; Class Template Reference<span class="mlabels"><span class="mlabel">abstract</span></span></div> </div>
  94. </div><!--header-->
  95. <div class="contents">
  96. <p>Common interface for client side asynchronous writing.
  97. <a href="classgrpc_1_1_client_async_writer_interface.html#details">More...</a></p>
  98. <p><code>#include &lt;<a class="el" href="impl_2codegen_2async__stream_8h_source.html">async_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:a488d42d85f8e34902401e013572ff822"><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc_1_1_client_async_writer_interface.html#a488d42d85f8e34902401e013572ff822">WritesDone</a> (void *tag)=0</td></tr>
  103. <tr class="memdesc:a488d42d85f8e34902401e013572ff822"><td class="mdescLeft">&#160;</td><td class="mdescRight">Signal the client is done with the writes. <a href="#a488d42d85f8e34902401e013572ff822">More...</a><br /></td></tr>
  104. <tr class="separator:a488d42d85f8e34902401e013572ff822"><td class="memSeparator" colspan="2">&#160;</td></tr>
  105. <tr class="inherit_header pub_methods_classgrpc_1_1_client_async_streaming_interface"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_classgrpc_1_1_client_async_streaming_interface')"><img src="closed.png" alt="-"/>&#160;Public Member Functions inherited from <a class="el" href="classgrpc_1_1_client_async_streaming_interface.html">grpc::ClientAsyncStreamingInterface</a></td></tr>
  106. <tr class="memitem:a103c33e82dbf1715749886c4249f3f28 inherit pub_methods_classgrpc_1_1_client_async_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_async_streaming_interface.html#a103c33e82dbf1715749886c4249f3f28">~ClientAsyncStreamingInterface</a> ()</td></tr>
  107. <tr class="separator:a103c33e82dbf1715749886c4249f3f28 inherit pub_methods_classgrpc_1_1_client_async_streaming_interface"><td class="memSeparator" colspan="2">&#160;</td></tr>
  108. <tr class="memitem:ad83bfe2febf4a6296b7d2646799b8174 inherit pub_methods_classgrpc_1_1_client_async_streaming_interface"><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc_1_1_client_async_streaming_interface.html#ad83bfe2febf4a6296b7d2646799b8174">ReadInitialMetadata</a> (void *tag)=0</td></tr>
  109. <tr class="memdesc:ad83bfe2febf4a6296b7d2646799b8174 inherit pub_methods_classgrpc_1_1_client_async_streaming_interface"><td class="mdescLeft">&#160;</td><td class="mdescRight">Request notification of the reading of the initial metadata. <a href="#ad83bfe2febf4a6296b7d2646799b8174">More...</a><br /></td></tr>
  110. <tr class="separator:ad83bfe2febf4a6296b7d2646799b8174 inherit pub_methods_classgrpc_1_1_client_async_streaming_interface"><td class="memSeparator" colspan="2">&#160;</td></tr>
  111. <tr class="memitem:afc1cfbd1514fea47088bc837bb578a24 inherit pub_methods_classgrpc_1_1_client_async_streaming_interface"><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc_1_1_client_async_streaming_interface.html#afc1cfbd1514fea47088bc837bb578a24">Finish</a> (<a class="el" href="classgrpc_1_1_status.html">Status</a> *status, void *tag)=0</td></tr>
  112. <tr class="memdesc:afc1cfbd1514fea47088bc837bb578a24 inherit pub_methods_classgrpc_1_1_client_async_streaming_interface"><td class="mdescLeft">&#160;</td><td class="mdescRight">Indicate that the stream is to be finished and request notification Should not be used concurrently with other operations. <a href="#afc1cfbd1514fea47088bc837bb578a24">More...</a><br /></td></tr>
  113. <tr class="separator:afc1cfbd1514fea47088bc837bb578a24 inherit pub_methods_classgrpc_1_1_client_async_streaming_interface"><td class="memSeparator" colspan="2">&#160;</td></tr>
  114. <tr class="inherit_header pub_methods_classgrpc_1_1_async_writer_interface"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_classgrpc_1_1_async_writer_interface')"><img src="closed.png" alt="-"/>&#160;Public Member Functions inherited from <a class="el" href="classgrpc_1_1_async_writer_interface.html">grpc::AsyncWriterInterface&lt; W &gt;</a></td></tr>
  115. <tr class="memitem:a94cc9e4ed13c8fe4a1d883d465477ddd inherit pub_methods_classgrpc_1_1_async_writer_interface"><td class="memItemLeft" align="right" valign="top">virtual&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc_1_1_async_writer_interface.html#a94cc9e4ed13c8fe4a1d883d465477ddd">~AsyncWriterInterface</a> ()</td></tr>
  116. <tr class="separator:a94cc9e4ed13c8fe4a1d883d465477ddd inherit pub_methods_classgrpc_1_1_async_writer_interface"><td class="memSeparator" colspan="2">&#160;</td></tr>
  117. <tr class="memitem:a40c1091ac5cb5243c874da725ae291b4 inherit pub_methods_classgrpc_1_1_async_writer_interface"><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc_1_1_async_writer_interface.html#a40c1091ac5cb5243c874da725ae291b4">Write</a> (const W &amp;msg, void *tag)=0</td></tr>
  118. <tr class="memdesc:a40c1091ac5cb5243c874da725ae291b4 inherit pub_methods_classgrpc_1_1_async_writer_interface"><td class="mdescLeft">&#160;</td><td class="mdescRight">Request the writing of <em>msg</em> with identifying tag <em>tag</em>. <a href="#a40c1091ac5cb5243c874da725ae291b4">More...</a><br /></td></tr>
  119. <tr class="separator:a40c1091ac5cb5243c874da725ae291b4 inherit pub_methods_classgrpc_1_1_async_writer_interface"><td class="memSeparator" colspan="2">&#160;</td></tr>
  120. </table>
  121. <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
  122. <div class="textblock"><h3>template&lt;class W&gt;<br />
  123. class grpc::ClientAsyncWriterInterface&lt; W &gt;</h3>
  124. <p>Common interface for client side asynchronous writing. </p>
  125. </div><h2 class="groupheader">Member Function Documentation</h2>
  126. <a class="anchor" id="a488d42d85f8e34902401e013572ff822"></a>
  127. <div class="memitem">
  128. <div class="memproto">
  129. <div class="memtemplate">
  130. template&lt;class W &gt; </div>
  131. <table class="mlabels">
  132. <tr>
  133. <td class="mlabels-left">
  134. <table class="memname">
  135. <tr>
  136. <td class="memname">virtual void <a class="el" href="classgrpc_1_1_client_async_writer_interface.html">grpc::ClientAsyncWriterInterface</a>&lt; W &gt;::WritesDone </td>
  137. <td>(</td>
  138. <td class="paramtype">void *&#160;</td>
  139. <td class="paramname"><em>tag</em></td><td>)</td>
  140. <td></td>
  141. </tr>
  142. </table>
  143. </td>
  144. <td class="mlabels-right">
  145. <span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
  146. </tr>
  147. </table>
  148. </div><div class="memdoc">
  149. <p>Signal the client is done with the writes. </p>
  150. <p>Thread-safe with respect to <em>Read</em> </p>
  151. <dl class="params"><dt>Parameters</dt><dd>
  152. <table class="params">
  153. <tr><td class="paramdir">[in]</td><td class="paramname">tag</td><td>The tag identifying the operation. </td></tr>
  154. </table>
  155. </dd>
  156. </dl>
  157. <p>Implemented in <a class="el" href="classgrpc_1_1_client_async_writer.html#af9fbf77049c3e5402913c0edeccf3d47">grpc::ClientAsyncWriter&lt; W &gt;</a>.</p>
  158. </div>
  159. </div>
  160. <hr/>The documentation for this class was generated from the following file:<ul>
  161. <li>include/grpc++/impl/codegen/<a class="el" href="impl_2codegen_2async__stream_8h_source.html">async_stream.h</a></li>
  162. </ul>
  163. </div><!-- contents -->
  164. <!-- start footer part -->
  165. <hr class="footer"/><address class="footer"><small>
  166. Generated on Thu Aug 18 2016 21:34:58 for GRPC C++ by &#160;<a href="http://www.doxygen.org/index.html">
  167. <img class="footer" src="doxygen.png" alt="doxygen"/>
  168. </a> 1.8.11
  169. </small></address>
  170. </body>
  171. </html>