380 lines
24 KiB
HTML
380 lines
24 KiB
HTML
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://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.13"/>
|
|
<meta name="viewport" content="width=device-width, initial-scale=1"/>
|
|
<title>GRPC C++: grpc::ClientReaderWriter< W, 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.22.0</span>
|
|
</div>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<!-- end header part -->
|
|
<!-- Generated by Doxygen 1.8.13 -->
|
|
<script type="text/javascript">
|
|
var searchBox = new SearchBox("searchBox", "search",false,'Search');
|
|
</script>
|
|
<script type="text/javascript" src="menudata.js"></script>
|
|
<script type="text/javascript" src="menu.js"></script>
|
|
<script type="text/javascript">
|
|
$(function() {
|
|
initMenu('',true,false,'search.php','Search');
|
|
$(document).ready(function() { init_search(); });
|
|
});
|
|
</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_writer.html">ClientReaderWriter</a></li> </ul>
|
|
</div>
|
|
</div><!-- top -->
|
|
<div class="header">
|
|
<div class="summary">
|
|
<a href="#pub-methods">Public Member Functions</a> |
|
|
<a href="#friends">Friends</a> </div>
|
|
<div class="headertitle">
|
|
<div class="title">grpc::ClientReaderWriter< W, R > Class Template Reference</div> </div>
|
|
</div><!--header-->
|
|
<div class="contents">
|
|
|
|
<p>Synchronous (blocking) client-side API for bi-directional streaming RPCs, where the outgoing message stream coming from the client has messages of type <em>W</em>, and the incoming messages stream coming from the server has messages of type <em>R</em>.
|
|
<a href="classgrpc_1_1_client_reader_writer.html#details">More...</a></p>
|
|
|
|
<p><code>#include <<a class="el" href="grpcpp_2impl_2codegen_2channel__interface_8h_source.html">channel_interface.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:ab6f436ca034fbc2e5e8035e637f7f5fc"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc_1_1_client_reader_writer.html#ab6f436ca034fbc2e5e8035e637f7f5fc">WaitForInitialMetadata</a> () override</td></tr>
|
|
<tr class="memdesc:ab6f436ca034fbc2e5e8035e637f7f5fc"><td class="mdescLeft"> </td><td class="mdescRight">Block waiting to read initial metadata from the server. <a href="#ab6f436ca034fbc2e5e8035e637f7f5fc">More...</a><br /></td></tr>
|
|
<tr class="separator:ab6f436ca034fbc2e5e8035e637f7f5fc"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a85c3018b87b4110c98b9f7f91adbfcef"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc_1_1_client_reader_writer.html#a85c3018b87b4110c98b9f7f91adbfcef">NextMessageSize</a> (uint32_t *sz) override</td></tr>
|
|
<tr class="memdesc:a85c3018b87b4110c98b9f7f91adbfcef"><td class="mdescLeft"> </td><td class="mdescRight">Get an upper bound on the next message size available for reading on this stream. <a href="#a85c3018b87b4110c98b9f7f91adbfcef">More...</a><br /></td></tr>
|
|
<tr class="separator:a85c3018b87b4110c98b9f7f91adbfcef"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:aa8887778273bea6ad32ffea3a6105699"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc_1_1_client_reader_writer.html#aa8887778273bea6ad32ffea3a6105699">Read</a> (R *msg) override</td></tr>
|
|
<tr class="memdesc:aa8887778273bea6ad32ffea3a6105699"><td class="mdescLeft"> </td><td class="mdescRight">See the <em>ReaderInterface.Read</em> method for semantics. <a href="#aa8887778273bea6ad32ffea3a6105699">More...</a><br /></td></tr>
|
|
<tr class="separator:aa8887778273bea6ad32ffea3a6105699"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ae30b0e18622f4132b1c7654e24605d53"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc_1_1_client_reader_writer.html#ae30b0e18622f4132b1c7654e24605d53">Write</a> (const W &msg, <a class="el" href="classgrpc_1_1_write_options.html">WriteOptions</a> options) override</td></tr>
|
|
<tr class="memdesc:ae30b0e18622f4132b1c7654e24605d53"><td class="mdescLeft"> </td><td class="mdescRight">Block to write <em>msg</em> to the stream with <a class="el" href="classgrpc_1_1_write_options.html" title="Per-message write options. ">WriteOptions</a> <em>options</em>. <a href="#ae30b0e18622f4132b1c7654e24605d53">More...</a><br /></td></tr>
|
|
<tr class="separator:ae30b0e18622f4132b1c7654e24605d53"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a183f35c478b847e939c76cb20c69a359"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc_1_1_client_reader_writer.html#a183f35c478b847e939c76cb20c69a359">WritesDone</a> () override</td></tr>
|
|
<tr class="memdesc:a183f35c478b847e939c76cb20c69a359"><td class="mdescLeft"> </td><td class="mdescRight">Half close writing from the client. <a href="#a183f35c478b847e939c76cb20c69a359">More...</a><br /></td></tr>
|
|
<tr class="separator:a183f35c478b847e939c76cb20c69a359"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a9fe0acda29ba46726d69cedfdb043c79"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classgrpc_1_1_status.html">Status</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc_1_1_client_reader_writer.html#a9fe0acda29ba46726d69cedfdb043c79">Finish</a> () override</td></tr>
|
|
<tr class="memdesc:a9fe0acda29ba46726d69cedfdb043c79"><td class="mdescLeft"> </td><td class="mdescRight">See the ClientStreamingInterface.Finish method for semantics. <a href="#a9fe0acda29ba46726d69cedfdb043c79">More...</a><br /></td></tr>
|
|
<tr class="separator:a9fe0acda29ba46726d69cedfdb043c79"><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="inherit_header pub_methods_classgrpc_1_1internal_1_1_writer_interface"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_classgrpc_1_1internal_1_1_writer_interface')"><img src="closed.png" alt="-"/> Public Member Functions inherited from <a class="el" href="classgrpc_1_1internal_1_1_writer_interface.html">grpc::internal::WriterInterface< W ></a></td></tr>
|
|
<tr class="memitem:a0f3bb9c5625b43d600d33d2bf8c17b60 inherit pub_methods_classgrpc_1_1internal_1_1_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_writer_interface.html#a0f3bb9c5625b43d600d33d2bf8c17b60">~WriterInterface</a> ()</td></tr>
|
|
<tr class="separator:a0f3bb9c5625b43d600d33d2bf8c17b60 inherit pub_methods_classgrpc_1_1internal_1_1_writer_interface"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a89d051f5c00ede4469cfb216bd05b594 inherit pub_methods_classgrpc_1_1internal_1_1_writer_interface"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc_1_1internal_1_1_writer_interface.html#a89d051f5c00ede4469cfb216bd05b594">Write</a> (const W &msg)</td></tr>
|
|
<tr class="memdesc:a89d051f5c00ede4469cfb216bd05b594 inherit pub_methods_classgrpc_1_1internal_1_1_writer_interface"><td class="mdescLeft"> </td><td class="mdescRight">Block to write <em>msg</em> to the stream with default write options. <a href="classgrpc_1_1internal_1_1_writer_interface.html#a89d051f5c00ede4469cfb216bd05b594">More...</a><br /></td></tr>
|
|
<tr class="separator:a89d051f5c00ede4469cfb216bd05b594 inherit pub_methods_classgrpc_1_1internal_1_1_writer_interface"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a3308bfe1558e317e5fa3530f74c63ce6 inherit pub_methods_classgrpc_1_1internal_1_1_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_writer_interface.html#a3308bfe1558e317e5fa3530f74c63ce6">WriteLast</a> (const W &msg, <a class="el" href="classgrpc_1_1_write_options.html">WriteOptions</a> options)</td></tr>
|
|
<tr class="memdesc:a3308bfe1558e317e5fa3530f74c63ce6 inherit pub_methods_classgrpc_1_1internal_1_1_writer_interface"><td class="mdescLeft"> </td><td class="mdescRight">Write <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>. <a href="classgrpc_1_1internal_1_1_writer_interface.html#a3308bfe1558e317e5fa3530f74c63ce6">More...</a><br /></td></tr>
|
|
<tr class="separator:a3308bfe1558e317e5fa3530f74c63ce6 inherit pub_methods_classgrpc_1_1internal_1_1_writer_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>
|
|
</table><table class="memberdecls">
|
|
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="friends"></a>
|
|
Friends</h2></td></tr>
|
|
<tr class="memitem:afecda317e553ccff29f57d43166b2d34"><td class="memItemLeft" align="right" valign="top">class </td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc_1_1_client_reader_writer.html#afecda317e553ccff29f57d43166b2d34">internal::ClientReaderWriterFactory< W, R ></a></td></tr>
|
|
<tr class="separator:afecda317e553ccff29f57d43166b2d34"><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, class R><br />
|
|
class grpc::ClientReaderWriter< W, R ></h3>
|
|
|
|
<p>Synchronous (blocking) client-side API for bi-directional streaming RPCs, where the outgoing message stream coming from the client has messages of type <em>W</em>, and the incoming messages stream coming from the server has messages of type <em>R</em>. </p>
|
|
</div><h2 class="groupheader">Member Function Documentation</h2>
|
|
<a id="a9fe0acda29ba46726d69cedfdb043c79"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a9fe0acda29ba46726d69cedfdb043c79">◆ </a></span>Finish()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<div class="memtemplate">
|
|
template<class W, class R> </div>
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="classgrpc_1_1_status.html">Status</a> <a class="el" href="classgrpc_1_1_client_reader_writer.html">grpc::ClientReaderWriter</a>< W, R >::Finish </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">override</span><span class="mlabel">virtual</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>See the ClientStreamingInterface.Finish method for semantics. </p>
|
|
<p>Side effect:</p><ul>
|
|
<li>the <em>ClientContext</em> associated with this call is updated with possible trailing metadata sent from the server. </li>
|
|
</ul>
|
|
|
|
<p>Implements <a class="el" href="classgrpc_1_1internal_1_1_client_streaming_interface.html#a47321b8c130947bcef5c793329a54619">grpc::internal::ClientStreamingInterface</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a85c3018b87b4110c98b9f7f91adbfcef"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a85c3018b87b4110c98b9f7f91adbfcef">◆ </a></span>NextMessageSize()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<div class="memtemplate">
|
|
template<class W, class R> </div>
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">bool <a class="el" href="classgrpc_1_1_client_reader_writer.html">grpc::ClientReaderWriter</a>< W, R >::NextMessageSize </td>
|
|
<td>(</td>
|
|
<td class="paramtype">uint32_t * </td>
|
|
<td class="paramname"><em>sz</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>Get an upper bound on the next message size available for reading on this stream. </p>
|
|
|
|
<p>Implements <a class="el" href="classgrpc_1_1internal_1_1_reader_interface.html#ad3216783fae57e614181e28df9435f33">grpc::internal::ReaderInterface< R ></a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="aa8887778273bea6ad32ffea3a6105699"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#aa8887778273bea6ad32ffea3a6105699">◆ </a></span>Read()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<div class="memtemplate">
|
|
template<class W, class R> </div>
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">bool <a class="el" href="classgrpc_1_1_client_reader_writer.html">grpc::ClientReaderWriter</a>< W, R >::Read </td>
|
|
<td>(</td>
|
|
<td class="paramtype">R * </td>
|
|
<td class="paramname"><em>msg</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>ReaderInterface.Read</em> method for semantics. </p>
|
|
<p>Side effect: Also receives initial metadata if not already received (updates the <em>ClientContext</em> associated with this call in that case). </p>
|
|
|
|
<p>Implements <a class="el" href="classgrpc_1_1internal_1_1_reader_interface.html#adfb50ace59b4b9666a46548d3f732ee8">grpc::internal::ReaderInterface< R ></a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ab6f436ca034fbc2e5e8035e637f7f5fc"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ab6f436ca034fbc2e5e8035e637f7f5fc">◆ </a></span>WaitForInitialMetadata()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<div class="memtemplate">
|
|
template<class W, class R> </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_reader_writer.html">grpc::ClientReaderWriter</a>< W, 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">inline</span><span class="mlabel">override</span><span class="mlabel">virtual</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Block waiting to read initial metadata from the server. </p>
|
|
<p>This call is optional, but if it is used, it cannot be used concurrently with or after the <em>Finish</em> method.</p>
|
|
<p>Once complete, the initial metadata read from the server will be accessible through the <em>ClientContext</em> used to construct this object. </p>
|
|
|
|
<p>Implements <a class="el" href="classgrpc_1_1_client_reader_writer_interface.html#a6ead554cc1b991f2289b26fb80fdde5e">grpc::ClientReaderWriterInterface< W, R ></a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ae30b0e18622f4132b1c7654e24605d53"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ae30b0e18622f4132b1c7654e24605d53">◆ </a></span>Write()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<div class="memtemplate">
|
|
template<class W, class R> </div>
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">bool <a class="el" href="classgrpc_1_1_client_reader_writer.html">grpc::ClientReaderWriter</a>< W, R >::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">WriteOptions</a> </td>
|
|
<td class="paramname"><em>options</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>Block to write <em>msg</em> to the stream with <a class="el" href="classgrpc_1_1_write_options.html" title="Per-message write options. ">WriteOptions</a> <em>options</em>. </p>
|
|
<p>This is thread-safe with respect to <em>ReaderInterface::Read</em> </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">msg</td><td>The message to be written to the stream. </td></tr>
|
|
<tr><td class="paramname">options</td><td>The <a class="el" href="classgrpc_1_1_write_options.html" title="Per-message write options. ">WriteOptions</a> affecting the write operation.</td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd><em>true</em> on success, <em>false</em> when the stream has been closed. </dd></dl>
|
|
|
|
<p>Implements <a class="el" href="classgrpc_1_1internal_1_1_writer_interface.html#add3e3940ba338ab08705ea69d017a80b">grpc::internal::WriterInterface< W ></a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a183f35c478b847e939c76cb20c69a359"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a183f35c478b847e939c76cb20c69a359">◆ </a></span>WritesDone()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<div class="memtemplate">
|
|
template<class W, class R> </div>
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">bool <a class="el" href="classgrpc_1_1_client_reader_writer.html">grpc::ClientReaderWriter</a>< W, R >::WritesDone </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">override</span><span class="mlabel">virtual</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Half close writing from the client. </p>
|
|
<p>(signal that the stream of messages coming from the clinet is complete). Blocks until currently-pending writes are completed. Thread-safe with respect to <em>ReaderInterface::Read</em> </p>
|
|
<dl class="section return"><dt>Returns</dt><dd>Whether the writes were successful. </dd></dl>
|
|
|
|
<p>Implements <a class="el" href="classgrpc_1_1_client_reader_writer_interface.html#a52f4e5d5ac7fe0e4995cb337aa0ecfc8">grpc::ClientReaderWriterInterface< W, R ></a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<h2 class="groupheader">Friends And Related Function Documentation</h2>
|
|
<a id="afecda317e553ccff29f57d43166b2d34"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#afecda317e553ccff29f57d43166b2d34">◆ </a></span>internal::ClientReaderWriterFactory< W, R ></h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<div class="memtemplate">
|
|
template<class W, class R> </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_reader_writer_factory.html">internal::ClientReaderWriterFactory</a>< W, R ></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 files:<ul>
|
|
<li>include/grpcpp/impl/codegen/<a class="el" href="grpcpp_2impl_2codegen_2channel__interface_8h_source.html">channel_interface.h</a></li>
|
|
<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 Jul 3 2019 14:51:27 for GRPC C++ by  <a href="http://www.doxygen.org/index.html">
|
|
<img class="footer" src="doxygen.png" alt="doxygen"/>
|
|
</a> 1.8.13
|
|
</small></address>
|
|
</body>
|
|
</html>
|