664 lines
33 KiB
HTML
664 lines
33 KiB
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::WriteOptions Class 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.31.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_write_options.html">WriteOptions</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::WriteOptions Class Reference</div> </div>
|
|
</div><!--header-->
|
|
<div class="contents">
|
|
|
|
<p>Per-message write options.
|
|
<a href="classgrpc_1_1_write_options.html#details">More...</a></p>
|
|
|
|
<p><code>#include <<a class="el" href="call__op__set_8h_source.html">call_op_set.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:a6a4e429313200ed6c017c5d306e26e93"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc_1_1_write_options.html#a6a4e429313200ed6c017c5d306e26e93">WriteOptions</a> ()</td></tr>
|
|
<tr class="separator:a6a4e429313200ed6c017c5d306e26e93"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a4d7753bbd8d9d61e2c6d3e49e29be021"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc_1_1_write_options.html#a4d7753bbd8d9d61e2c6d3e49e29be021">WriteOptions</a> (const <a class="el" href="classgrpc_1_1_write_options.html">WriteOptions</a> &other)</td></tr>
|
|
<tr class="separator:a4d7753bbd8d9d61e2c6d3e49e29be021"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a4a9471bfddcd66722bb14121e2faf25f"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classgrpc_1_1_write_options.html">WriteOptions</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc_1_1_write_options.html#a4a9471bfddcd66722bb14121e2faf25f">operator=</a> (const <a class="el" href="classgrpc_1_1_write_options.html">WriteOptions</a> &other)=default</td></tr>
|
|
<tr class="memdesc:a4a9471bfddcd66722bb14121e2faf25f"><td class="mdescLeft"> </td><td class="mdescRight">Default assignment operator. <a href="classgrpc_1_1_write_options.html#a4a9471bfddcd66722bb14121e2faf25f">More...</a><br /></td></tr>
|
|
<tr class="separator:a4a9471bfddcd66722bb14121e2faf25f"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a9fc0e51224292b15dcfefec342fa0e02"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc_1_1_write_options.html#a9fc0e51224292b15dcfefec342fa0e02">Clear</a> ()</td></tr>
|
|
<tr class="memdesc:a9fc0e51224292b15dcfefec342fa0e02"><td class="mdescLeft"> </td><td class="mdescRight">Clear all flags. <a href="classgrpc_1_1_write_options.html#a9fc0e51224292b15dcfefec342fa0e02">More...</a><br /></td></tr>
|
|
<tr class="separator:a9fc0e51224292b15dcfefec342fa0e02"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ab5d1533a5c6d5d787435729f214474bc"><td class="memItemLeft" align="right" valign="top">uint32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc_1_1_write_options.html#ab5d1533a5c6d5d787435729f214474bc">flags</a> () const</td></tr>
|
|
<tr class="memdesc:ab5d1533a5c6d5d787435729f214474bc"><td class="mdescLeft"> </td><td class="mdescRight">Returns raw flags bitset. <a href="classgrpc_1_1_write_options.html#ab5d1533a5c6d5d787435729f214474bc">More...</a><br /></td></tr>
|
|
<tr class="separator:ab5d1533a5c6d5d787435729f214474bc"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:afe5f12d1bf9ed01b7a833458dc889b66"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classgrpc_1_1_write_options.html">WriteOptions</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc_1_1_write_options.html#afe5f12d1bf9ed01b7a833458dc889b66">set_no_compression</a> ()</td></tr>
|
|
<tr class="memdesc:afe5f12d1bf9ed01b7a833458dc889b66"><td class="mdescLeft"> </td><td class="mdescRight">Sets flag for the disabling of compression for the next message write. <a href="classgrpc_1_1_write_options.html#afe5f12d1bf9ed01b7a833458dc889b66">More...</a><br /></td></tr>
|
|
<tr class="separator:afe5f12d1bf9ed01b7a833458dc889b66"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a7bc26dd151ed56bc49329ca895fe15e7"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classgrpc_1_1_write_options.html">WriteOptions</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc_1_1_write_options.html#a7bc26dd151ed56bc49329ca895fe15e7">clear_no_compression</a> ()</td></tr>
|
|
<tr class="memdesc:a7bc26dd151ed56bc49329ca895fe15e7"><td class="mdescLeft"> </td><td class="mdescRight">Clears flag for the disabling of compression for the next message write. <a href="classgrpc_1_1_write_options.html#a7bc26dd151ed56bc49329ca895fe15e7">More...</a><br /></td></tr>
|
|
<tr class="separator:a7bc26dd151ed56bc49329ca895fe15e7"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a0c02bd1632cc1a239c55f06c073fe642"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc_1_1_write_options.html#a0c02bd1632cc1a239c55f06c073fe642">get_no_compression</a> () const</td></tr>
|
|
<tr class="memdesc:a0c02bd1632cc1a239c55f06c073fe642"><td class="mdescLeft"> </td><td class="mdescRight">Get value for the flag indicating whether compression for the next message write is forcefully disabled. <a href="classgrpc_1_1_write_options.html#a0c02bd1632cc1a239c55f06c073fe642">More...</a><br /></td></tr>
|
|
<tr class="separator:a0c02bd1632cc1a239c55f06c073fe642"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:aecd282a8c7424e4b0c1a5f512c44b8a8"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classgrpc_1_1_write_options.html">WriteOptions</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc_1_1_write_options.html#aecd282a8c7424e4b0c1a5f512c44b8a8">set_buffer_hint</a> ()</td></tr>
|
|
<tr class="memdesc:aecd282a8c7424e4b0c1a5f512c44b8a8"><td class="mdescLeft"> </td><td class="mdescRight">Sets flag indicating that the write may be buffered and need not go out on the wire immediately. <a href="classgrpc_1_1_write_options.html#aecd282a8c7424e4b0c1a5f512c44b8a8">More...</a><br /></td></tr>
|
|
<tr class="separator:aecd282a8c7424e4b0c1a5f512c44b8a8"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a897ba94e51b1f6ead41ade8f92efa89f"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classgrpc_1_1_write_options.html">WriteOptions</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc_1_1_write_options.html#a897ba94e51b1f6ead41ade8f92efa89f">clear_buffer_hint</a> ()</td></tr>
|
|
<tr class="memdesc:a897ba94e51b1f6ead41ade8f92efa89f"><td class="mdescLeft"> </td><td class="mdescRight">Clears flag indicating that the write may be buffered and need not go out on the wire immediately. <a href="classgrpc_1_1_write_options.html#a897ba94e51b1f6ead41ade8f92efa89f">More...</a><br /></td></tr>
|
|
<tr class="separator:a897ba94e51b1f6ead41ade8f92efa89f"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a432f0759e437909f8cc30c6262b97faf"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc_1_1_write_options.html#a432f0759e437909f8cc30c6262b97faf">get_buffer_hint</a> () const</td></tr>
|
|
<tr class="memdesc:a432f0759e437909f8cc30c6262b97faf"><td class="mdescLeft"> </td><td class="mdescRight">Get value for the flag indicating that the write may be buffered and need not go out on the wire immediately. <a href="classgrpc_1_1_write_options.html#a432f0759e437909f8cc30c6262b97faf">More...</a><br /></td></tr>
|
|
<tr class="separator:a432f0759e437909f8cc30c6262b97faf"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:abda047d0f7b1f18fbbfb5f9858c33f9d"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classgrpc_1_1_write_options.html">WriteOptions</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc_1_1_write_options.html#abda047d0f7b1f18fbbfb5f9858c33f9d">set_corked</a> ()</td></tr>
|
|
<tr class="memdesc:abda047d0f7b1f18fbbfb5f9858c33f9d"><td class="mdescLeft"> </td><td class="mdescRight">corked bit: aliases set_buffer_hint currently, with the intent that set_buffer_hint will be removed in the future <a href="classgrpc_1_1_write_options.html#abda047d0f7b1f18fbbfb5f9858c33f9d">More...</a><br /></td></tr>
|
|
<tr class="separator:abda047d0f7b1f18fbbfb5f9858c33f9d"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:aae98f2a75fa805f2ba5f7fe5202d43c2"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classgrpc_1_1_write_options.html">WriteOptions</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc_1_1_write_options.html#aae98f2a75fa805f2ba5f7fe5202d43c2">clear_corked</a> ()</td></tr>
|
|
<tr class="separator:aae98f2a75fa805f2ba5f7fe5202d43c2"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a28b60c6668d42680d8928e1cffc90db8"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc_1_1_write_options.html#a28b60c6668d42680d8928e1cffc90db8">is_corked</a> () const</td></tr>
|
|
<tr class="separator:a28b60c6668d42680d8928e1cffc90db8"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ad930c28f5c32832e1d48ee30bf0858e3"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classgrpc_1_1_write_options.html">WriteOptions</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc_1_1_write_options.html#ad930c28f5c32832e1d48ee30bf0858e3">set_last_message</a> ()</td></tr>
|
|
<tr class="memdesc:ad930c28f5c32832e1d48ee30bf0858e3"><td class="mdescLeft"> </td><td class="mdescRight">last-message bit: indicates this is the last message in a stream client-side: makes Write the equivalent of performing Write, WritesDone in a single step server-side: hold the Write until the service handler returns (sync api) or until Finish is called (async api) <a href="classgrpc_1_1_write_options.html#ad930c28f5c32832e1d48ee30bf0858e3">More...</a><br /></td></tr>
|
|
<tr class="separator:ad930c28f5c32832e1d48ee30bf0858e3"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:aa96dfc3eceb841fb2b5416222561684c"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classgrpc_1_1_write_options.html">WriteOptions</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc_1_1_write_options.html#aa96dfc3eceb841fb2b5416222561684c">clear_last_message</a> ()</td></tr>
|
|
<tr class="memdesc:aa96dfc3eceb841fb2b5416222561684c"><td class="mdescLeft"> </td><td class="mdescRight">Clears flag indicating that this is the last message in a stream, disabling coalescing. <a href="classgrpc_1_1_write_options.html#aa96dfc3eceb841fb2b5416222561684c">More...</a><br /></td></tr>
|
|
<tr class="separator:aa96dfc3eceb841fb2b5416222561684c"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:aaa5f7fcba7816c5d6b41b3e62b2b9b58"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classgrpc_1_1_write_options.html">WriteOptions</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc_1_1_write_options.html#aaa5f7fcba7816c5d6b41b3e62b2b9b58">set_write_through</a> ()</td></tr>
|
|
<tr class="memdesc:aaa5f7fcba7816c5d6b41b3e62b2b9b58"><td class="mdescLeft"> </td><td class="mdescRight">Guarantee that all bytes have been written to the socket before completing this write (usually writes are completed when they pass flow control). <a href="classgrpc_1_1_write_options.html#aaa5f7fcba7816c5d6b41b3e62b2b9b58">More...</a><br /></td></tr>
|
|
<tr class="separator:aaa5f7fcba7816c5d6b41b3e62b2b9b58"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a1031b0d61c166df4f2699f56fbba3d0f"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc_1_1_write_options.html#a1031b0d61c166df4f2699f56fbba3d0f">is_write_through</a> () const</td></tr>
|
|
<tr class="separator:a1031b0d61c166df4f2699f56fbba3d0f"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a7d08d7bc3a62cc4cfe8499d4bd70e0d7"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc_1_1_write_options.html#a7d08d7bc3a62cc4cfe8499d4bd70e0d7">is_last_message</a> () const</td></tr>
|
|
<tr class="memdesc:a7d08d7bc3a62cc4cfe8499d4bd70e0d7"><td class="mdescLeft"> </td><td class="mdescRight">Get value for the flag indicating that this is the last message, and should be coalesced with trailing metadata. <a href="classgrpc_1_1_write_options.html#a7d08d7bc3a62cc4cfe8499d4bd70e0d7">More...</a><br /></td></tr>
|
|
<tr class="separator:a7d08d7bc3a62cc4cfe8499d4bd70e0d7"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table>
|
|
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
|
|
<div class="textblock"><p>Per-message write options. </p>
|
|
</div><h2 class="groupheader">Constructor & Destructor Documentation</h2>
|
|
<a id="a6a4e429313200ed6c017c5d306e26e93"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a6a4e429313200ed6c017c5d306e26e93">◆ </a></span>WriteOptions() <span class="overload">[1/2]</span></h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">grpc::WriteOptions::WriteOptions </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> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a4d7753bbd8d9d61e2c6d3e49e29be021"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a4d7753bbd8d9d61e2c6d3e49e29be021">◆ </a></span>WriteOptions() <span class="overload">[2/2]</span></h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">grpc::WriteOptions::WriteOptions </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const <a class="el" href="classgrpc_1_1_write_options.html">WriteOptions</a> & </td>
|
|
<td class="paramname"><em>other</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
</div>
|
|
</div>
|
|
<h2 class="groupheader">Member Function Documentation</h2>
|
|
<a id="a9fc0e51224292b15dcfefec342fa0e02"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a9fc0e51224292b15dcfefec342fa0e02">◆ </a></span>Clear()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void grpc::WriteOptions::Clear </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> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Clear all flags. </p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a897ba94e51b1f6ead41ade8f92efa89f"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a897ba94e51b1f6ead41ade8f92efa89f">◆ </a></span>clear_buffer_hint()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="classgrpc_1_1_write_options.html">WriteOptions</a>& grpc::WriteOptions::clear_buffer_hint </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> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Clears flag indicating that the write may be buffered and need not go out on the wire immediately. </p>
|
|
<dl class="section see"><dt>See also</dt><dd><a class="el" href="grpc__types_8h.html#adf29fd8b7df2ecc47d14a7f5a3a079c0" title="Write Flags:">GRPC_WRITE_BUFFER_HINT</a> </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="aae98f2a75fa805f2ba5f7fe5202d43c2"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#aae98f2a75fa805f2ba5f7fe5202d43c2">◆ </a></span>clear_corked()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="classgrpc_1_1_write_options.html">WriteOptions</a>& grpc::WriteOptions::clear_corked </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> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
</div>
|
|
</div>
|
|
<a id="aa96dfc3eceb841fb2b5416222561684c"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#aa96dfc3eceb841fb2b5416222561684c">◆ </a></span>clear_last_message()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="classgrpc_1_1_write_options.html">WriteOptions</a>& grpc::WriteOptions::clear_last_message </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> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Clears flag indicating that this is the last message in a stream, disabling coalescing. </p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a7bc26dd151ed56bc49329ca895fe15e7"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a7bc26dd151ed56bc49329ca895fe15e7">◆ </a></span>clear_no_compression()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="classgrpc_1_1_write_options.html">WriteOptions</a>& grpc::WriteOptions::clear_no_compression </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> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Clears flag for the disabling of compression for the next message write. </p>
|
|
<dl class="section see"><dt>See also</dt><dd><a class="el" href="grpc__types_8h.html#ae09000181671f031ed0e319ed557da4e" title="Force compression to be disabled for a particular write (start_write/add_metadata).">GRPC_WRITE_NO_COMPRESS</a> </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ab5d1533a5c6d5d787435729f214474bc"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ab5d1533a5c6d5d787435729f214474bc">◆ </a></span>flags()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">uint32_t grpc::WriteOptions::flags </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td> const</td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Returns raw flags bitset. </p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a432f0759e437909f8cc30c6262b97faf"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a432f0759e437909f8cc30c6262b97faf">◆ </a></span>get_buffer_hint()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">bool grpc::WriteOptions::get_buffer_hint </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td> const</td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Get value for the flag indicating that the write may be buffered and need not go out on the wire immediately. </p>
|
|
<dl class="section see"><dt>See also</dt><dd><a class="el" href="grpc__types_8h.html#adf29fd8b7df2ecc47d14a7f5a3a079c0" title="Write Flags:">GRPC_WRITE_BUFFER_HINT</a> </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a0c02bd1632cc1a239c55f06c073fe642"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a0c02bd1632cc1a239c55f06c073fe642">◆ </a></span>get_no_compression()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">bool grpc::WriteOptions::get_no_compression </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td> const</td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Get value for the flag indicating whether compression for the next message write is forcefully disabled. </p>
|
|
<dl class="section see"><dt>See also</dt><dd><a class="el" href="grpc__types_8h.html#ae09000181671f031ed0e319ed557da4e" title="Force compression to be disabled for a particular write (start_write/add_metadata).">GRPC_WRITE_NO_COMPRESS</a> </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a28b60c6668d42680d8928e1cffc90db8"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a28b60c6668d42680d8928e1cffc90db8">◆ </a></span>is_corked()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">bool grpc::WriteOptions::is_corked </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td> const</td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a7d08d7bc3a62cc4cfe8499d4bd70e0d7"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a7d08d7bc3a62cc4cfe8499d4bd70e0d7">◆ </a></span>is_last_message()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">bool grpc::WriteOptions::is_last_message </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td> const</td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Get value for the flag indicating that this is the last message, and should be coalesced with trailing metadata. </p>
|
|
<dl class="section see"><dt>See also</dt><dd>GRPC_WRITE_LAST_MESSAGE </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a1031b0d61c166df4f2699f56fbba3d0f"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a1031b0d61c166df4f2699f56fbba3d0f">◆ </a></span>is_write_through()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">bool grpc::WriteOptions::is_write_through </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td> const</td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a4a9471bfddcd66722bb14121e2faf25f"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a4a9471bfddcd66722bb14121e2faf25f">◆ </a></span>operator=()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="classgrpc_1_1_write_options.html">WriteOptions</a>& grpc::WriteOptions::operator= </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const <a class="el" href="classgrpc_1_1_write_options.html">WriteOptions</a> & </td>
|
|
<td class="paramname"><em>other</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">default</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Default assignment operator. </p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="aecd282a8c7424e4b0c1a5f512c44b8a8"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#aecd282a8c7424e4b0c1a5f512c44b8a8">◆ </a></span>set_buffer_hint()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="classgrpc_1_1_write_options.html">WriteOptions</a>& grpc::WriteOptions::set_buffer_hint </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> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Sets flag indicating that the write may be buffered and need not go out on the wire immediately. </p>
|
|
<dl class="section see"><dt>See also</dt><dd><a class="el" href="grpc__types_8h.html#adf29fd8b7df2ecc47d14a7f5a3a079c0" title="Write Flags:">GRPC_WRITE_BUFFER_HINT</a> </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="abda047d0f7b1f18fbbfb5f9858c33f9d"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#abda047d0f7b1f18fbbfb5f9858c33f9d">◆ </a></span>set_corked()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="classgrpc_1_1_write_options.html">WriteOptions</a>& grpc::WriteOptions::set_corked </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> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>corked bit: aliases set_buffer_hint currently, with the intent that set_buffer_hint will be removed in the future </p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ad930c28f5c32832e1d48ee30bf0858e3"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ad930c28f5c32832e1d48ee30bf0858e3">◆ </a></span>set_last_message()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="classgrpc_1_1_write_options.html">WriteOptions</a>& grpc::WriteOptions::set_last_message </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> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>last-message bit: indicates this is the last message in a stream client-side: makes Write the equivalent of performing Write, WritesDone in a single step server-side: hold the Write until the service handler returns (sync api) or until Finish is called (async api) </p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="afe5f12d1bf9ed01b7a833458dc889b66"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#afe5f12d1bf9ed01b7a833458dc889b66">◆ </a></span>set_no_compression()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="classgrpc_1_1_write_options.html">WriteOptions</a>& grpc::WriteOptions::set_no_compression </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> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Sets flag for the disabling of compression for the next message write. </p>
|
|
<dl class="section see"><dt>See also</dt><dd><a class="el" href="grpc__types_8h.html#ae09000181671f031ed0e319ed557da4e" title="Force compression to be disabled for a particular write (start_write/add_metadata).">GRPC_WRITE_NO_COMPRESS</a> </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="aaa5f7fcba7816c5d6b41b3e62b2b9b58"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#aaa5f7fcba7816c5d6b41b3e62b2b9b58">◆ </a></span>set_write_through()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="classgrpc_1_1_write_options.html">WriteOptions</a>& grpc::WriteOptions::set_write_through </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> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Guarantee that all bytes have been written to the socket before completing this write (usually writes are completed when they pass flow control). </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="call__op__set_8h_source.html">call_op_set.h</a></li>
|
|
</ul>
|
|
</div><!-- contents -->
|
|
<!-- start footer part -->
|
|
<hr class="footer"/><address class="footer"><small>
|
|
Generated on Tue Aug 18 2020 16:24:48 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>
|