blob: 06ca54cc65018679cdb55c257296d471998271d6 [file] [log] [blame]
<!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.6"/>
<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/search.js"></script>
<script type="text/javascript">
$(document).ready(function() { searchBox.OnSelectItem(0); });
</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 style="padding-left: 0.5em;">
<div id="projectname">GRPC C++
&#160;<span id="projectnumber">0.10.0.0</span>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.6 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
<div id="navrow1" class="tabs">
<ul class="tablist">
<li><a href="index.html"><span>Main&#160;Page</span></a></li>
<li><a href="namespaces.html"><span>Namespaces</span></a></li>
<li class="current"><a href="annotated.html"><span>Data&#160;Structures</span></a></li>
<li><a href="files.html"><span>Files</span></a></li>
<li>
<div id="MSearchBox" class="MSearchBoxInactive">
<span class="left">
<img id="MSearchSelect" src="search/mag_sel.png"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
alt=""/>
<input type="text" id="MSearchField" value="Search" accesskey="S"
onfocus="searchBox.OnSearchFieldFocus(true)"
onblur="searchBox.OnSearchFieldFocus(false)"
onkeyup="searchBox.OnSearchFieldChange(event)"/>
</span><span class="right">
<a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
</span>
</div>
</li>
</ul>
</div>
<div id="navrow2" class="tabs2">
<ul class="tablist">
<li><a href="annotated.html"><span>Data&#160;Structures</span></a></li>
<li><a href="classes.html"><span>Data&#160;Structure&#160;Index</span></a></li>
<li><a href="hierarchy.html"><span>Class&#160;Hierarchy</span></a></li>
<li><a href="functions.html"><span>Data&#160;Fields</span></a></li>
</ul>
</div>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
<a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark">&#160;</span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark">&#160;</span>Data Structures</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark">&#160;</span>Namespaces</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark">&#160;</span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark">&#160;</span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark">&#160;</span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark">&#160;</span>Typedefs</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(7)"><span class="SelectionMark">&#160;</span>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(8)"><span class="SelectionMark">&#160;</span>Enumerator</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(9)"><span class="SelectionMark">&#160;</span>Friends</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(10)"><span class="SelectionMark">&#160;</span>Macros</a></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 &lt;<a class="el" href="call_8h_source.html">call.h</a>&gt;</code></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:a6a4e429313200ed6c017c5d306e26e93"><td class="memItemLeft" align="right" valign="top">&#160;</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">&#160;</td></tr>
<tr class="memitem:a4d7753bbd8d9d61e2c6d3e49e29be021"><td class="memItemLeft" align="right" valign="top">&#160;</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> &amp;other)</td></tr>
<tr class="separator:a4d7753bbd8d9d61e2c6d3e49e29be021"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a9fc0e51224292b15dcfefec342fa0e02"><td class="memItemLeft" align="right" valign="top">void&#160;</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">&#160;</td><td class="mdescRight">Clear all flags. <a href="#a9fc0e51224292b15dcfefec342fa0e02">More...</a><br/></td></tr>
<tr class="separator:a9fc0e51224292b15dcfefec342fa0e02"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a0e047a4f3d159749153bff276880e153"><td class="memItemLeft" align="right" valign="top">gpr_uint32&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc_1_1_write_options.html#a0e047a4f3d159749153bff276880e153">flags</a> () const </td></tr>
<tr class="memdesc:a0e047a4f3d159749153bff276880e153"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns raw flags bitset. <a href="#a0e047a4f3d159749153bff276880e153">More...</a><br/></td></tr>
<tr class="separator:a0e047a4f3d159749153bff276880e153"><td class="memSeparator" colspan="2">&#160;</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> &amp;&#160;</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">&#160;</td><td class="mdescRight">Sets flag for the disabling of compression for the next message write. <a href="#afe5f12d1bf9ed01b7a833458dc889b66">More...</a><br/></td></tr>
<tr class="separator:afe5f12d1bf9ed01b7a833458dc889b66"><td class="memSeparator" colspan="2">&#160;</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> &amp;&#160;</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">&#160;</td><td class="mdescRight">Clears flag for the disabling of compression for the next message write. <a href="#a7bc26dd151ed56bc49329ca895fe15e7">More...</a><br/></td></tr>
<tr class="separator:a7bc26dd151ed56bc49329ca895fe15e7"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:accb16dd92f4001a6d024ffb01178d4bf"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc_1_1_write_options.html#accb16dd92f4001a6d024ffb01178d4bf">get_no_compression</a> () const </td></tr>
<tr class="memdesc:accb16dd92f4001a6d024ffb01178d4bf"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get value for the flag indicating whether compression for the next message write is forcefully disabled. <a href="#accb16dd92f4001a6d024ffb01178d4bf">More...</a><br/></td></tr>
<tr class="separator:accb16dd92f4001a6d024ffb01178d4bf"><td class="memSeparator" colspan="2">&#160;</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> &amp;&#160;</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">&#160;</td><td class="mdescRight">Sets flag indicating that the write may be buffered and need not go out on the wire immediately. <a href="#aecd282a8c7424e4b0c1a5f512c44b8a8">More...</a><br/></td></tr>
<tr class="separator:aecd282a8c7424e4b0c1a5f512c44b8a8"><td class="memSeparator" colspan="2">&#160;</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> &amp;&#160;</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">&#160;</td><td class="mdescRight">Clears flag indicating that the write may be buffered and need not go out on the wire immediately. <a href="#a897ba94e51b1f6ead41ade8f92efa89f">More...</a><br/></td></tr>
<tr class="separator:a897ba94e51b1f6ead41ade8f92efa89f"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a58a983a81a17d0b8f3996164f55912ef"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc_1_1_write_options.html#a58a983a81a17d0b8f3996164f55912ef">get_buffer_hint</a> () const </td></tr>
<tr class="memdesc:a58a983a81a17d0b8f3996164f55912ef"><td class="mdescLeft">&#160;</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="#a58a983a81a17d0b8f3996164f55912ef">More...</a><br/></td></tr>
<tr class="separator:a58a983a81a17d0b8f3996164f55912ef"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:abe3d32a3e5879022e7b8f1c6a7533841"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classgrpc_1_1_write_options.html">WriteOptions</a> &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc_1_1_write_options.html#abe3d32a3e5879022e7b8f1c6a7533841">operator=</a> (const <a class="el" href="classgrpc_1_1_write_options.html">WriteOptions</a> &amp;rhs)</td></tr>
<tr class="separator:abe3d32a3e5879022e7b8f1c6a7533841"><td class="memSeparator" colspan="2">&#160;</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 &amp; Destructor Documentation</h2>
<a class="anchor" id="a6a4e429313200ed6c017c5d306e26e93"></a>
<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 class="anchor" id="a4d7753bbd8d9d61e2c6d3e49e29be021"></a>
<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> &amp;&#160;</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 class="anchor" id="a9fc0e51224292b15dcfefec342fa0e02"></a>
<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 class="anchor" id="a897ba94e51b1f6ead41ade8f92efa89f"></a>
<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>&amp; 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>GRPC_WRITE_BUFFER_HINT </dd></dl>
</div>
</div>
<a class="anchor" id="a7bc26dd151ed56bc49329ca895fe15e7"></a>
<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>&amp; 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>GRPC_WRITE_NO_COMPRESS </dd></dl>
</div>
</div>
<a class="anchor" id="a0e047a4f3d159749153bff276880e153"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">gpr_uint32 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 class="anchor" id="a58a983a81a17d0b8f3996164f55912ef"></a>
<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>GRPC_WRITE_BUFFER_HINT </dd></dl>
</div>
</div>
<a class="anchor" id="accb16dd92f4001a6d024ffb01178d4bf"></a>
<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>GRPC_WRITE_NO_COMPRESS </dd></dl>
</div>
</div>
<a class="anchor" id="abe3d32a3e5879022e7b8f1c6a7533841"></a>
<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>&amp; grpc::WriteOptions::operator= </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classgrpc_1_1_write_options.html">WriteOptions</a> &amp;&#160;</td>
<td class="paramname"><em>rhs</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>
<a class="anchor" id="aecd282a8c7424e4b0c1a5f512c44b8a8"></a>
<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>&amp; 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>GRPC_WRITE_BUFFER_HINT </dd></dl>
</div>
</div>
<a class="anchor" id="afe5f12d1bf9ed01b7a833458dc889b66"></a>
<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>&amp; 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>GRPC_WRITE_NO_COMPRESS </dd></dl>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li>include/grpc++/impl/<a class="el" href="call_8h_source.html">call.h</a></li>
</ul>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Wed Aug 5 2015 08:17:06 for GRPC C++ by &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.6
</small></address>
</body>
</html>