123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504 |
- <!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::ClientAsyncWriter< W > 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_async_writer.html">ClientAsyncWriter</a></li> </ul>
- </div>
- </div><!-- top -->
- <div class="header">
- <div class="summary">
- <a href="#pub-methods">Public Member Functions</a> |
- <a href="#pub-static-methods">Static Public Member Functions</a> |
- <a href="#friends">Friends</a> </div>
- <div class="headertitle">
- <div class="title">grpc::ClientAsyncWriter< W > Class Template Reference<span class="mlabels"><span class="mlabel">final</span></span></div> </div>
- </div><!--header-->
- <div class="contents">
- <p>Async API on the client side for doing client-streaming RPCs, where the outgoing message stream going to the server contains messages of type <em>W</em>.
- <a href="classgrpc_1_1_client_async_writer.html#details">More...</a></p>
- <p><code>#include <<a class="el" href="grpcpp_2impl_2codegen_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:a42b8329c9a8bf18528fee8a3776db3d6"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc_1_1_client_async_writer.html#a42b8329c9a8bf18528fee8a3776db3d6">StartCall</a> (void *tag) override</td></tr>
- <tr class="memdesc:a42b8329c9a8bf18528fee8a3776db3d6"><td class="mdescLeft"> </td><td class="mdescRight">Start the call that was set up by the constructor, but only if the constructor was invoked through the "Prepare" API which doesn't actually start the call. <a href="classgrpc_1_1_client_async_writer.html#a42b8329c9a8bf18528fee8a3776db3d6">More...</a><br /></td></tr>
- <tr class="separator:a42b8329c9a8bf18528fee8a3776db3d6"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a02f613eaaed4177f1682da3f5eebbdeb"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc_1_1_client_async_writer.html#a02f613eaaed4177f1682da3f5eebbdeb">ReadInitialMetadata</a> (void *tag) override</td></tr>
- <tr class="memdesc:a02f613eaaed4177f1682da3f5eebbdeb"><td class="mdescLeft"> </td><td class="mdescRight">See the <em>ClientAsyncStreamingInterface.ReadInitialMetadata</em> method for semantics. <a href="classgrpc_1_1_client_async_writer.html#a02f613eaaed4177f1682da3f5eebbdeb">More...</a><br /></td></tr>
- <tr class="separator:a02f613eaaed4177f1682da3f5eebbdeb"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a0e981b6dcce663e655edf305573f2f30"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc_1_1_client_async_writer.html#a0e981b6dcce663e655edf305573f2f30">Write</a> (const W &msg, void *tag) override</td></tr>
- <tr class="memdesc:a0e981b6dcce663e655edf305573f2f30"><td class="mdescLeft"> </td><td class="mdescRight">Request the writing of <em>msg</em> with identifying tag <em>tag</em>. <a href="classgrpc_1_1_client_async_writer.html#a0e981b6dcce663e655edf305573f2f30">More...</a><br /></td></tr>
- <tr class="separator:a0e981b6dcce663e655edf305573f2f30"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a1991aca74e32523932432c6486b91a09"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc_1_1_client_async_writer.html#a1991aca74e32523932432c6486b91a09">Write</a> (const W &msg, ::<a class="el" href="classgrpc_1_1_write_options.html">grpc::WriteOptions</a> options, void *tag) override</td></tr>
- <tr class="memdesc:a1991aca74e32523932432c6486b91a09"><td class="mdescLeft"> </td><td class="mdescRight">Request the writing of <em>msg</em> using <a class="el" href="classgrpc_1_1_write_options.html" title="Per-message write options.">WriteOptions</a> <em>options</em> with identifying tag <em>tag</em>. <a href="classgrpc_1_1_client_async_writer.html#a1991aca74e32523932432c6486b91a09">More...</a><br /></td></tr>
- <tr class="separator:a1991aca74e32523932432c6486b91a09"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:ab9fd5cd7dedd73d878a86de84c58e8ff"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc_1_1_client_async_writer.html#ab9fd5cd7dedd73d878a86de84c58e8ff">WritesDone</a> (void *tag) override</td></tr>
- <tr class="memdesc:ab9fd5cd7dedd73d878a86de84c58e8ff"><td class="mdescLeft"> </td><td class="mdescRight">Signal the client is done with the writes (half-close the client stream). <a href="classgrpc_1_1_client_async_writer.html#ab9fd5cd7dedd73d878a86de84c58e8ff">More...</a><br /></td></tr>
- <tr class="separator:ab9fd5cd7dedd73d878a86de84c58e8ff"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:aa94f32feaf8200695b65f1628d0ddf50"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc_1_1_client_async_writer.html#aa94f32feaf8200695b65f1628d0ddf50">Finish</a> (::<a class="el" href="classgrpc_1_1_status.html">grpc::Status</a> *status, void *tag) override</td></tr>
- <tr class="memdesc:aa94f32feaf8200695b65f1628d0ddf50"><td class="mdescLeft"> </td><td class="mdescRight">See the <em>ClientAsyncStreamingInterface.Finish</em> method for semantics. <a href="classgrpc_1_1_client_async_writer.html#aa94f32feaf8200695b65f1628d0ddf50">More...</a><br /></td></tr>
- <tr class="separator:aa94f32feaf8200695b65f1628d0ddf50"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="inherit_header pub_methods_classgrpc_1_1internal_1_1_client_async_streaming_interface"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_classgrpc_1_1internal_1_1_client_async_streaming_interface')"><img src="closed.png" alt="-"/> Public Member Functions inherited from <a class="el" href="classgrpc_1_1internal_1_1_client_async_streaming_interface.html">grpc::internal::ClientAsyncStreamingInterface</a></td></tr>
- <tr class="memitem:a5691ad84f8160a3eb10131f1f5de4708 inherit pub_methods_classgrpc_1_1internal_1_1_client_async_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_async_streaming_interface.html#a5691ad84f8160a3eb10131f1f5de4708">~ClientAsyncStreamingInterface</a> ()</td></tr>
- <tr class="separator:a5691ad84f8160a3eb10131f1f5de4708 inherit pub_methods_classgrpc_1_1internal_1_1_client_async_streaming_interface"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="inherit_header pub_methods_classgrpc_1_1internal_1_1_async_writer_interface"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_classgrpc_1_1internal_1_1_async_writer_interface')"><img src="closed.png" alt="-"/> Public Member Functions inherited from <a class="el" href="classgrpc_1_1internal_1_1_async_writer_interface.html">grpc::internal::AsyncWriterInterface< W ></a></td></tr>
- <tr class="memitem:a8ad846091252c112c4db0b41965e5a4c inherit pub_methods_classgrpc_1_1internal_1_1_async_writer_interface"><td class="memItemLeft" align="right" valign="top">virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc_1_1internal_1_1_async_writer_interface.html#a8ad846091252c112c4db0b41965e5a4c">~AsyncWriterInterface</a> ()</td></tr>
- <tr class="separator:a8ad846091252c112c4db0b41965e5a4c inherit pub_methods_classgrpc_1_1internal_1_1_async_writer_interface"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a8dbc8f388cb8e79f587b821fd7d64ce7 inherit pub_methods_classgrpc_1_1internal_1_1_async_writer_interface"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc_1_1internal_1_1_async_writer_interface.html#a8dbc8f388cb8e79f587b821fd7d64ce7">WriteLast</a> (const W &msg, ::<a class="el" href="classgrpc_1_1_write_options.html">grpc::WriteOptions</a> options, void *tag)</td></tr>
- <tr class="memdesc:a8dbc8f388cb8e79f587b821fd7d64ce7 inherit pub_methods_classgrpc_1_1internal_1_1_async_writer_interface"><td class="mdescLeft"> </td><td class="mdescRight">Request the writing of <em>msg</em> and coalesce it with the writing of trailing metadata, using <a class="el" href="classgrpc_1_1_write_options.html" title="Per-message write options.">WriteOptions</a> <em>options</em> with identifying tag <em>tag</em>. <a href="classgrpc_1_1internal_1_1_async_writer_interface.html#a8dbc8f388cb8e79f587b821fd7d64ce7">More...</a><br /></td></tr>
- <tr class="separator:a8dbc8f388cb8e79f587b821fd7d64ce7 inherit pub_methods_classgrpc_1_1internal_1_1_async_writer_interface"><td class="memSeparator" colspan="2"> </td></tr>
- </table><table class="memberdecls">
- <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-static-methods"></a>
- Static Public Member Functions</h2></td></tr>
- <tr class="memitem:a32b7fa49be4fec698a9672d4a69b011f"><td class="memItemLeft" align="right" valign="top">static void </td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc_1_1_client_async_writer.html#a32b7fa49be4fec698a9672d4a69b011f">operator delete</a> (void *, std::size_t size)</td></tr>
- <tr class="separator:a32b7fa49be4fec698a9672d4a69b011f"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a84a5a3dcfe4727183cd023aa1f7abe43"><td class="memItemLeft" align="right" valign="top">static void </td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc_1_1_client_async_writer.html#a84a5a3dcfe4727183cd023aa1f7abe43">operator delete</a> (void *, void *)</td></tr>
- <tr class="separator:a84a5a3dcfe4727183cd023aa1f7abe43"><td class="memSeparator" colspan="2"> </td></tr>
- </table><table class="memberdecls">
- <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="friends"></a>
- Friends</h2></td></tr>
- <tr class="memitem:a5e0a3f0980c67fa6bdb0affd2659b8d2"><td class="memItemLeft" align="right" valign="top">class </td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc_1_1_client_async_writer.html#a5e0a3f0980c67fa6bdb0affd2659b8d2">internal::ClientAsyncWriterFactory< W ></a></td></tr>
- <tr class="separator:a5e0a3f0980c67fa6bdb0affd2659b8d2"><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 W><br />
- class grpc::ClientAsyncWriter< W ></h3>
- <p>Async API on the client side for doing client-streaming RPCs, where the outgoing message stream going to the server contains messages of type <em>W</em>. </p>
- </div><h2 class="groupheader">Member Function Documentation</h2>
- <a id="aa94f32feaf8200695b65f1628d0ddf50"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#aa94f32feaf8200695b65f1628d0ddf50">◆ </a></span>Finish()</h2>
- <div class="memitem">
- <div class="memproto">
- <div class="memtemplate">
- template<class W > </div>
- <table class="mlabels">
- <tr>
- <td class="mlabels-left">
- <table class="memname">
- <tr>
- <td class="memname">void <a class="el" href="classgrpc_1_1_client_async_writer.html">grpc::ClientAsyncWriter</a>< W >::Finish </td>
- <td>(</td>
- <td class="paramtype">::<a class="el" href="classgrpc_1_1_status.html">grpc::Status</a> * </td>
- <td class="paramname"><em>status</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">inline</span><span class="mlabel">override</span><span class="mlabel">virtual</span></span> </td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>See the <em>ClientAsyncStreamingInterface.Finish</em> method for semantics. </p>
- <p>Side effect:</p><ul>
- <li>the <em><a class="el" href="classgrpc_1_1_client_context.html" title="A ClientContext allows the person implementing a service client to:">ClientContext</a></em> associated with this call is updated with possible initial and trailing metadata received from the server.</li>
- <li>attempts to fill in the <em>response</em> parameter passed to this class's constructor with the server's response message. </li>
- </ul>
- <p>Implements <a class="el" href="classgrpc_1_1internal_1_1_client_async_streaming_interface.html#a0c4fd4be2228fa196ae446502828e23a">grpc::internal::ClientAsyncStreamingInterface</a>.</p>
- </div>
- </div>
- <a id="a32b7fa49be4fec698a9672d4a69b011f"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#a32b7fa49be4fec698a9672d4a69b011f">◆ </a></span>operator delete() <span class="overload">[1/2]</span></h2>
- <div class="memitem">
- <div class="memproto">
- <div class="memtemplate">
- template<class W > </div>
- <table class="mlabels">
- <tr>
- <td class="mlabels-left">
- <table class="memname">
- <tr>
- <td class="memname">static void <a class="el" href="classgrpc_1_1_client_async_writer.html">grpc::ClientAsyncWriter</a>< W >::operator delete </td>
- <td>(</td>
- <td class="paramtype">void * </td>
- <td class="paramname">, </td>
- </tr>
- <tr>
- <td class="paramkey"></td>
- <td></td>
- <td class="paramtype">std::size_t </td>
- <td class="paramname"><em>size</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">inline</span><span class="mlabel">static</span></span> </td>
- </tr>
- </table>
- </div><div class="memdoc">
- </div>
- </div>
- <a id="a84a5a3dcfe4727183cd023aa1f7abe43"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#a84a5a3dcfe4727183cd023aa1f7abe43">◆ </a></span>operator delete() <span class="overload">[2/2]</span></h2>
- <div class="memitem">
- <div class="memproto">
- <div class="memtemplate">
- template<class W > </div>
- <table class="mlabels">
- <tr>
- <td class="mlabels-left">
- <table class="memname">
- <tr>
- <td class="memname">static void <a class="el" href="classgrpc_1_1_client_async_writer.html">grpc::ClientAsyncWriter</a>< W >::operator delete </td>
- <td>(</td>
- <td class="paramtype">void * </td>
- <td class="paramname">, </td>
- </tr>
- <tr>
- <td class="paramkey"></td>
- <td></td>
- <td class="paramtype">void * </td>
- <td class="paramname"> </td>
- </tr>
- <tr>
- <td></td>
- <td>)</td>
- <td></td><td></td>
- </tr>
- </table>
- </td>
- <td class="mlabels-right">
- <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">static</span></span> </td>
- </tr>
- </table>
- </div><div class="memdoc">
- </div>
- </div>
- <a id="a02f613eaaed4177f1682da3f5eebbdeb"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#a02f613eaaed4177f1682da3f5eebbdeb">◆ </a></span>ReadInitialMetadata()</h2>
- <div class="memitem">
- <div class="memproto">
- <div class="memtemplate">
- template<class W > </div>
- <table class="mlabels">
- <tr>
- <td class="mlabels-left">
- <table class="memname">
- <tr>
- <td class="memname">void <a class="el" href="classgrpc_1_1_client_async_writer.html">grpc::ClientAsyncWriter</a>< W >::ReadInitialMetadata </td>
- <td>(</td>
- <td class="paramtype">void * </td>
- <td class="paramname"><em>tag</em></td><td>)</td>
- <td></td>
- </tr>
- </table>
- </td>
- <td class="mlabels-right">
- <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">override</span><span class="mlabel">virtual</span></span> </td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>See the <em>ClientAsyncStreamingInterface.ReadInitialMetadata</em> method for semantics. </p>
- <p>Side effect:</p><ul>
- <li>upon receiving initial metadata from the server, the <em><a class="el" href="classgrpc_1_1_client_context.html" title="A ClientContext allows the person implementing a service client to:">ClientContext</a></em> associated with this call is updated, and the calling code can access the received metadata through the <em><a class="el" href="classgrpc_1_1_client_context.html" title="A ClientContext allows the person implementing a service client to:">ClientContext</a></em>. </li>
- </ul>
- <p>Implements <a class="el" href="classgrpc_1_1internal_1_1_client_async_streaming_interface.html#ab5a35e289028ac2aaf062572ba6d567d">grpc::internal::ClientAsyncStreamingInterface</a>.</p>
- </div>
- </div>
- <a id="a42b8329c9a8bf18528fee8a3776db3d6"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#a42b8329c9a8bf18528fee8a3776db3d6">◆ </a></span>StartCall()</h2>
- <div class="memitem">
- <div class="memproto">
- <div class="memtemplate">
- template<class W > </div>
- <table class="mlabels">
- <tr>
- <td class="mlabels-left">
- <table class="memname">
- <tr>
- <td class="memname">void <a class="el" href="classgrpc_1_1_client_async_writer.html">grpc::ClientAsyncWriter</a>< W >::StartCall </td>
- <td>(</td>
- <td class="paramtype">void * </td>
- <td class="paramname"><em>tag</em></td><td>)</td>
- <td></td>
- </tr>
- </table>
- </td>
- <td class="mlabels-right">
- <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">override</span><span class="mlabel">virtual</span></span> </td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>Start the call that was set up by the constructor, but only if the constructor was invoked through the "Prepare" API which doesn't actually start the call. </p>
- <p>Implements <a class="el" href="classgrpc_1_1internal_1_1_client_async_streaming_interface.html#a2bd65338b34000980fa048911c577637">grpc::internal::ClientAsyncStreamingInterface</a>.</p>
- </div>
- </div>
- <a id="a1991aca74e32523932432c6486b91a09"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#a1991aca74e32523932432c6486b91a09">◆ </a></span>Write() <span class="overload">[1/2]</span></h2>
- <div class="memitem">
- <div class="memproto">
- <div class="memtemplate">
- template<class W > </div>
- <table class="mlabels">
- <tr>
- <td class="mlabels-left">
- <table class="memname">
- <tr>
- <td class="memname">void <a class="el" href="classgrpc_1_1_client_async_writer.html">grpc::ClientAsyncWriter</a>< W >::Write </td>
- <td>(</td>
- <td class="paramtype">const W & </td>
- <td class="paramname"><em>msg</em>, </td>
- </tr>
- <tr>
- <td class="paramkey"></td>
- <td></td>
- <td class="paramtype">::<a class="el" href="classgrpc_1_1_write_options.html">grpc::WriteOptions</a> </td>
- <td class="paramname"><em>options</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">inline</span><span class="mlabel">override</span><span class="mlabel">virtual</span></span> </td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>Request the writing of <em>msg</em> using <a class="el" href="classgrpc_1_1_write_options.html" title="Per-message write options.">WriteOptions</a> <em>options</em> with identifying tag <em>tag</em>. </p>
- <p>Only one write may be outstanding at any given time. This means that after calling Write, one must wait to receive <em>tag</em> from the completion queue BEFORE calling Write again. <a class="el" href="classgrpc_1_1_write_options.html" title="Per-message write options.">WriteOptions</a> <em>options</em> is used to set the write options of this message. This is thread-safe with respect to <em>AsyncReaderInterface::Read</em> </p>
- <p>gRPC doesn't take ownership or a reference to <em>msg</em>, so it is safe to to deallocate once Write returns.</p>
- <dl class="params"><dt>Parameters</dt><dd>
- <table class="params">
- <tr><td class="paramdir">[in]</td><td class="paramname">msg</td><td>The message to be written. </td></tr>
- <tr><td class="paramdir">[in]</td><td class="paramname">options</td><td>The <a class="el" href="classgrpc_1_1_write_options.html" title="Per-message write options.">WriteOptions</a> to be used to write this 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>Implements <a class="el" href="classgrpc_1_1internal_1_1_async_writer_interface.html#a9fef3a3ceb6be3a140ef4a8ad33c6c75">grpc::internal::AsyncWriterInterface< W ></a>.</p>
- </div>
- </div>
- <a id="a0e981b6dcce663e655edf305573f2f30"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#a0e981b6dcce663e655edf305573f2f30">◆ </a></span>Write() <span class="overload">[2/2]</span></h2>
- <div class="memitem">
- <div class="memproto">
- <div class="memtemplate">
- template<class W > </div>
- <table class="mlabels">
- <tr>
- <td class="mlabels-left">
- <table class="memname">
- <tr>
- <td class="memname">void <a class="el" href="classgrpc_1_1_client_async_writer.html">grpc::ClientAsyncWriter</a>< W >::Write </td>
- <td>(</td>
- <td class="paramtype">const W & </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">inline</span><span class="mlabel">override</span><span class="mlabel">virtual</span></span> </td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>Request the writing of <em>msg</em> with identifying tag <em>tag</em>. </p>
- <p>Only one write may be outstanding at any given time. This means that after calling Write, one must wait to receive <em>tag</em> from the completion queue BEFORE calling Write again. This is thread-safe with respect to <em>AsyncReaderInterface::Read</em> </p>
- <p>gRPC doesn't take ownership or a reference to <em>msg</em>, so it is safe to to deallocate once Write returns.</p>
- <dl class="params"><dt>Parameters</dt><dd>
- <table class="params">
- <tr><td class="paramdir">[in]</td><td class="paramname">msg</td><td>The message to be written. </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>Implements <a class="el" href="classgrpc_1_1internal_1_1_async_writer_interface.html#aa61e21fdfef0a4fb34f595bef767e6a8">grpc::internal::AsyncWriterInterface< W ></a>.</p>
- </div>
- </div>
- <a id="ab9fd5cd7dedd73d878a86de84c58e8ff"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#ab9fd5cd7dedd73d878a86de84c58e8ff">◆ </a></span>WritesDone()</h2>
- <div class="memitem">
- <div class="memproto">
- <div class="memtemplate">
- template<class W > </div>
- <table class="mlabels">
- <tr>
- <td class="mlabels-left">
- <table class="memname">
- <tr>
- <td class="memname">void <a class="el" href="classgrpc_1_1_client_async_writer.html">grpc::ClientAsyncWriter</a>< W >::WritesDone </td>
- <td>(</td>
- <td class="paramtype">void * </td>
- <td class="paramname"><em>tag</em></td><td>)</td>
- <td></td>
- </tr>
- </table>
- </td>
- <td class="mlabels-right">
- <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">override</span><span class="mlabel">virtual</span></span> </td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>Signal the client is done with the writes (half-close the client stream). </p>
- <p>Thread-safe with respect to <em>AsyncReaderInterface::Read</em> </p>
- <dl class="params"><dt>Parameters</dt><dd>
- <table class="params">
- <tr><td class="paramdir">[in]</td><td class="paramname">tag</td><td>The tag identifying the operation. </td></tr>
- </table>
- </dd>
- </dl>
- <p>Implements <a class="el" href="classgrpc_1_1_client_async_writer_interface.html#a488d42d85f8e34902401e013572ff822">grpc::ClientAsyncWriterInterface< W ></a>.</p>
- </div>
- </div>
- <h2 class="groupheader">Friends And Related Function Documentation</h2>
- <a id="a5e0a3f0980c67fa6bdb0affd2659b8d2"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#a5e0a3f0980c67fa6bdb0affd2659b8d2">◆ </a></span>internal::ClientAsyncWriterFactory< W ></h2>
- <div class="memitem">
- <div class="memproto">
- <div class="memtemplate">
- template<class W > </div>
- <table class="mlabels">
- <tr>
- <td class="mlabels-left">
- <table class="memname">
- <tr>
- <td class="memname">friend class <a class="el" href="classgrpc_1_1internal_1_1_client_async_writer_factory.html">internal::ClientAsyncWriterFactory</a>< W ></td>
- </tr>
- </table>
- </td>
- <td class="mlabels-right">
- <span class="mlabels"><span class="mlabel">friend</span></span> </td>
- </tr>
- </table>
- </div><div class="memdoc">
- </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_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 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>
|