classgrpc_1_1_write_options.html 33 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645
  1. <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
  2. <html xmlns="http://www.w3.org/1999/xhtml">
  3. <head>
  4. <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
  5. <meta http-equiv="X-UA-Compatible" content="IE=9"/>
  6. <meta name="generator" content="Doxygen 1.8.6"/>
  7. <title>GRPC C++: grpc::WriteOptions Class Reference</title>
  8. <link href="tabs.css" rel="stylesheet" type="text/css"/>
  9. <script type="text/javascript" src="jquery.js"></script>
  10. <script type="text/javascript" src="dynsections.js"></script>
  11. <link href="search/search.css" rel="stylesheet" type="text/css"/>
  12. <script type="text/javascript" src="search/search.js"></script>
  13. <script type="text/javascript">
  14. $(document).ready(function() { searchBox.OnSelectItem(0); });
  15. </script>
  16. <link href="doxygen.css" rel="stylesheet" type="text/css" />
  17. </head>
  18. <body>
  19. <div id="top"><!-- do not remove this div, it is closed by doxygen! -->
  20. <div id="titlearea">
  21. <table cellspacing="0" cellpadding="0">
  22. <tbody>
  23. <tr style="height: 56px;">
  24. <td style="padding-left: 0.5em;">
  25. <div id="projectname">GRPC C++
  26. &#160;<span id="projectnumber">1.8.0</span>
  27. </div>
  28. </td>
  29. </tr>
  30. </tbody>
  31. </table>
  32. </div>
  33. <!-- end header part -->
  34. <!-- Generated by Doxygen 1.8.6 -->
  35. <script type="text/javascript">
  36. var searchBox = new SearchBox("searchBox", "search",false,'Search');
  37. </script>
  38. <div id="navrow1" class="tabs">
  39. <ul class="tablist">
  40. <li><a href="index.html"><span>Main&#160;Page</span></a></li>
  41. <li><a href="pages.html"><span>Related&#160;Pages</span></a></li>
  42. <li><a href="modules.html"><span>Modules</span></a></li>
  43. <li><a href="namespaces.html"><span>Namespaces</span></a></li>
  44. <li class="current"><a href="annotated.html"><span>Data&#160;Structures</span></a></li>
  45. <li><a href="files.html"><span>Files</span></a></li>
  46. <li>
  47. <div id="MSearchBox" class="MSearchBoxInactive">
  48. <span class="left">
  49. <img id="MSearchSelect" src="search/mag_sel.png"
  50. onmouseover="return searchBox.OnSearchSelectShow()"
  51. onmouseout="return searchBox.OnSearchSelectHide()"
  52. alt=""/>
  53. <input type="text" id="MSearchField" value="Search" accesskey="S"
  54. onfocus="searchBox.OnSearchFieldFocus(true)"
  55. onblur="searchBox.OnSearchFieldFocus(false)"
  56. onkeyup="searchBox.OnSearchFieldChange(event)"/>
  57. </span><span class="right">
  58. <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
  59. </span>
  60. </div>
  61. </li>
  62. </ul>
  63. </div>
  64. <div id="navrow2" class="tabs2">
  65. <ul class="tablist">
  66. <li><a href="annotated.html"><span>Data&#160;Structures</span></a></li>
  67. <li><a href="classes.html"><span>Data&#160;Structure&#160;Index</span></a></li>
  68. <li><a href="hierarchy.html"><span>Class&#160;Hierarchy</span></a></li>
  69. <li><a href="functions.html"><span>Data&#160;Fields</span></a></li>
  70. </ul>
  71. </div>
  72. <!-- window showing the filter options -->
  73. <div id="MSearchSelectWindow"
  74. onmouseover="return searchBox.OnSearchSelectShow()"
  75. onmouseout="return searchBox.OnSearchSelectHide()"
  76. onkeydown="return searchBox.OnSearchSelectKey(event)">
  77. <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><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(11)"><span class="SelectionMark">&#160;</span>Groups</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(12)"><span class="SelectionMark">&#160;</span>Pages</a></div>
  78. <!-- iframe showing the search results (closed by default) -->
  79. <div id="MSearchResultsWindow">
  80. <iframe src="javascript:void(0)" frameborder="0"
  81. name="MSearchResults" id="MSearchResults">
  82. </iframe>
  83. </div>
  84. <div id="nav-path" class="navpath">
  85. <ul>
  86. <li class="navelem"><a class="el" href="namespacegrpc.html">grpc</a></li><li class="navelem"><a class="el" href="classgrpc_1_1_write_options.html">WriteOptions</a></li> </ul>
  87. </div>
  88. </div><!-- top -->
  89. <div class="header">
  90. <div class="summary">
  91. <a href="#pub-methods">Public Member Functions</a> </div>
  92. <div class="headertitle">
  93. <div class="title">grpc::WriteOptions Class Reference</div> </div>
  94. </div><!--header-->
  95. <div class="contents">
  96. <p>Per-message write options.
  97. <a href="classgrpc_1_1_write_options.html#details">More...</a></p>
  98. <p><code>#include &lt;<a class="el" href="codegen_2call_8h_source.html">call.h</a>&gt;</code></p>
  99. <table class="memberdecls">
  100. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
  101. Public Member Functions</h2></td></tr>
  102. <tr class="memitem: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>
  103. <tr class="separator:a6a4e429313200ed6c017c5d306e26e93"><td class="memSeparator" colspan="2">&#160;</td></tr>
  104. <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>
  105. <tr class="separator:a4d7753bbd8d9d61e2c6d3e49e29be021"><td class="memSeparator" colspan="2">&#160;</td></tr>
  106. <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>
  107. <tr class="memdesc:a9fc0e51224292b15dcfefec342fa0e02"><td class="mdescLeft">&#160;</td><td class="mdescRight">Clear all flags. <a href="#a9fc0e51224292b15dcfefec342fa0e02">More...</a><br/></td></tr>
  108. <tr class="separator:a9fc0e51224292b15dcfefec342fa0e02"><td class="memSeparator" colspan="2">&#160;</td></tr>
  109. <tr class="memitem:aa4d45d531680bb9f2ed76a73bea1cb22"><td class="memItemLeft" align="right" valign="top">uint32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc_1_1_write_options.html#aa4d45d531680bb9f2ed76a73bea1cb22">flags</a> () const </td></tr>
  110. <tr class="memdesc:aa4d45d531680bb9f2ed76a73bea1cb22"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns raw flags bitset. <a href="#aa4d45d531680bb9f2ed76a73bea1cb22">More...</a><br/></td></tr>
  111. <tr class="separator:aa4d45d531680bb9f2ed76a73bea1cb22"><td class="memSeparator" colspan="2">&#160;</td></tr>
  112. <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>
  113. <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>
  114. <tr class="separator:afe5f12d1bf9ed01b7a833458dc889b66"><td class="memSeparator" colspan="2">&#160;</td></tr>
  115. <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>
  116. <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>
  117. <tr class="separator:a7bc26dd151ed56bc49329ca895fe15e7"><td class="memSeparator" colspan="2">&#160;</td></tr>
  118. <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>
  119. <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>
  120. <tr class="separator:accb16dd92f4001a6d024ffb01178d4bf"><td class="memSeparator" colspan="2">&#160;</td></tr>
  121. <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>
  122. <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>
  123. <tr class="separator:aecd282a8c7424e4b0c1a5f512c44b8a8"><td class="memSeparator" colspan="2">&#160;</td></tr>
  124. <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>
  125. <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>
  126. <tr class="separator:a897ba94e51b1f6ead41ade8f92efa89f"><td class="memSeparator" colspan="2">&#160;</td></tr>
  127. <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>
  128. <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>
  129. <tr class="separator:a58a983a81a17d0b8f3996164f55912ef"><td class="memSeparator" colspan="2">&#160;</td></tr>
  130. <tr class="memitem:abda047d0f7b1f18fbbfb5f9858c33f9d"><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#abda047d0f7b1f18fbbfb5f9858c33f9d">set_corked</a> ()</td></tr>
  131. <tr class="memdesc:abda047d0f7b1f18fbbfb5f9858c33f9d"><td class="mdescLeft">&#160;</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="#abda047d0f7b1f18fbbfb5f9858c33f9d">More...</a><br/></td></tr>
  132. <tr class="separator:abda047d0f7b1f18fbbfb5f9858c33f9d"><td class="memSeparator" colspan="2">&#160;</td></tr>
  133. <tr class="memitem:aae98f2a75fa805f2ba5f7fe5202d43c2"><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#aae98f2a75fa805f2ba5f7fe5202d43c2">clear_corked</a> ()</td></tr>
  134. <tr class="separator:aae98f2a75fa805f2ba5f7fe5202d43c2"><td class="memSeparator" colspan="2">&#160;</td></tr>
  135. <tr class="memitem:abd69a47aeaa341f6f94a540d648751c0"><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#abd69a47aeaa341f6f94a540d648751c0">is_corked</a> () const </td></tr>
  136. <tr class="separator:abd69a47aeaa341f6f94a540d648751c0"><td class="memSeparator" colspan="2">&#160;</td></tr>
  137. <tr class="memitem:ad930c28f5c32832e1d48ee30bf0858e3"><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#ad930c28f5c32832e1d48ee30bf0858e3">set_last_message</a> ()</td></tr>
  138. <tr class="memdesc:ad930c28f5c32832e1d48ee30bf0858e3"><td class="mdescLeft">&#160;</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="#ad930c28f5c32832e1d48ee30bf0858e3">More...</a><br/></td></tr>
  139. <tr class="separator:ad930c28f5c32832e1d48ee30bf0858e3"><td class="memSeparator" colspan="2">&#160;</td></tr>
  140. <tr class="memitem:aa96dfc3eceb841fb2b5416222561684c"><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#aa96dfc3eceb841fb2b5416222561684c">clear_last_message</a> ()</td></tr>
  141. <tr class="memdesc:aa96dfc3eceb841fb2b5416222561684c"><td class="mdescLeft">&#160;</td><td class="mdescRight">Clears flag indicating that this is the last message in a stream, disabling coalescing. <a href="#aa96dfc3eceb841fb2b5416222561684c">More...</a><br/></td></tr>
  142. <tr class="separator:aa96dfc3eceb841fb2b5416222561684c"><td class="memSeparator" colspan="2">&#160;</td></tr>
  143. <tr class="memitem:aaa5f7fcba7816c5d6b41b3e62b2b9b58"><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#aaa5f7fcba7816c5d6b41b3e62b2b9b58">set_write_through</a> ()</td></tr>
  144. <tr class="memdesc:aaa5f7fcba7816c5d6b41b3e62b2b9b58"><td class="mdescLeft">&#160;</td><td class="mdescRight">Guarantee that all bytes have been written to the wire before completing this write (usually writes are completed when they pass flow control) <a href="#aaa5f7fcba7816c5d6b41b3e62b2b9b58">More...</a><br/></td></tr>
  145. <tr class="separator:aaa5f7fcba7816c5d6b41b3e62b2b9b58"><td class="memSeparator" colspan="2">&#160;</td></tr>
  146. <tr class="memitem:a5aa00dfe73c2d20e15cd0be8a608c0db"><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#a5aa00dfe73c2d20e15cd0be8a608c0db">is_write_through</a> () const </td></tr>
  147. <tr class="separator:a5aa00dfe73c2d20e15cd0be8a608c0db"><td class="memSeparator" colspan="2">&#160;</td></tr>
  148. <tr class="memitem:a196c8fe4ed181e95efacf74be931bb79"><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#a196c8fe4ed181e95efacf74be931bb79">is_last_message</a> () const </td></tr>
  149. <tr class="memdesc:a196c8fe4ed181e95efacf74be931bb79"><td class="mdescLeft">&#160;</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="#a196c8fe4ed181e95efacf74be931bb79">More...</a><br/></td></tr>
  150. <tr class="separator:a196c8fe4ed181e95efacf74be931bb79"><td class="memSeparator" colspan="2">&#160;</td></tr>
  151. <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>
  152. <tr class="separator:abe3d32a3e5879022e7b8f1c6a7533841"><td class="memSeparator" colspan="2">&#160;</td></tr>
  153. </table>
  154. <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
  155. <div class="textblock"><p>Per-message write options. </p>
  156. </div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
  157. <a class="anchor" id="a6a4e429313200ed6c017c5d306e26e93"></a>
  158. <div class="memitem">
  159. <div class="memproto">
  160. <table class="mlabels">
  161. <tr>
  162. <td class="mlabels-left">
  163. <table class="memname">
  164. <tr>
  165. <td class="memname">grpc::WriteOptions::WriteOptions </td>
  166. <td>(</td>
  167. <td class="paramname"></td><td>)</td>
  168. <td></td>
  169. </tr>
  170. </table>
  171. </td>
  172. <td class="mlabels-right">
  173. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  174. </tr>
  175. </table>
  176. </div><div class="memdoc">
  177. </div>
  178. </div>
  179. <a class="anchor" id="a4d7753bbd8d9d61e2c6d3e49e29be021"></a>
  180. <div class="memitem">
  181. <div class="memproto">
  182. <table class="mlabels">
  183. <tr>
  184. <td class="mlabels-left">
  185. <table class="memname">
  186. <tr>
  187. <td class="memname">grpc::WriteOptions::WriteOptions </td>
  188. <td>(</td>
  189. <td class="paramtype">const <a class="el" href="classgrpc_1_1_write_options.html">WriteOptions</a> &amp;&#160;</td>
  190. <td class="paramname"><em>other</em></td><td>)</td>
  191. <td></td>
  192. </tr>
  193. </table>
  194. </td>
  195. <td class="mlabels-right">
  196. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  197. </tr>
  198. </table>
  199. </div><div class="memdoc">
  200. </div>
  201. </div>
  202. <h2 class="groupheader">Member Function Documentation</h2>
  203. <a class="anchor" id="a9fc0e51224292b15dcfefec342fa0e02"></a>
  204. <div class="memitem">
  205. <div class="memproto">
  206. <table class="mlabels">
  207. <tr>
  208. <td class="mlabels-left">
  209. <table class="memname">
  210. <tr>
  211. <td class="memname">void grpc::WriteOptions::Clear </td>
  212. <td>(</td>
  213. <td class="paramname"></td><td>)</td>
  214. <td></td>
  215. </tr>
  216. </table>
  217. </td>
  218. <td class="mlabels-right">
  219. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  220. </tr>
  221. </table>
  222. </div><div class="memdoc">
  223. <p>Clear all flags. </p>
  224. </div>
  225. </div>
  226. <a class="anchor" id="a897ba94e51b1f6ead41ade8f92efa89f"></a>
  227. <div class="memitem">
  228. <div class="memproto">
  229. <table class="mlabels">
  230. <tr>
  231. <td class="mlabels-left">
  232. <table class="memname">
  233. <tr>
  234. <td class="memname"><a class="el" href="classgrpc_1_1_write_options.html">WriteOptions</a>&amp; grpc::WriteOptions::clear_buffer_hint </td>
  235. <td>(</td>
  236. <td class="paramname"></td><td>)</td>
  237. <td></td>
  238. </tr>
  239. </table>
  240. </td>
  241. <td class="mlabels-right">
  242. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  243. </tr>
  244. </table>
  245. </div><div class="memdoc">
  246. <p>Clears flag indicating that the write may be buffered and need not go out on the wire immediately. </p>
  247. <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>
  248. </div>
  249. </div>
  250. <a class="anchor" id="aae98f2a75fa805f2ba5f7fe5202d43c2"></a>
  251. <div class="memitem">
  252. <div class="memproto">
  253. <table class="mlabels">
  254. <tr>
  255. <td class="mlabels-left">
  256. <table class="memname">
  257. <tr>
  258. <td class="memname"><a class="el" href="classgrpc_1_1_write_options.html">WriteOptions</a>&amp; grpc::WriteOptions::clear_corked </td>
  259. <td>(</td>
  260. <td class="paramname"></td><td>)</td>
  261. <td></td>
  262. </tr>
  263. </table>
  264. </td>
  265. <td class="mlabels-right">
  266. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  267. </tr>
  268. </table>
  269. </div><div class="memdoc">
  270. </div>
  271. </div>
  272. <a class="anchor" id="aa96dfc3eceb841fb2b5416222561684c"></a>
  273. <div class="memitem">
  274. <div class="memproto">
  275. <table class="mlabels">
  276. <tr>
  277. <td class="mlabels-left">
  278. <table class="memname">
  279. <tr>
  280. <td class="memname"><a class="el" href="classgrpc_1_1_write_options.html">WriteOptions</a>&amp; grpc::WriteOptions::clear_last_message </td>
  281. <td>(</td>
  282. <td class="paramname"></td><td>)</td>
  283. <td></td>
  284. </tr>
  285. </table>
  286. </td>
  287. <td class="mlabels-right">
  288. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  289. </tr>
  290. </table>
  291. </div><div class="memdoc">
  292. <p>Clears flag indicating that this is the last message in a stream, disabling coalescing. </p>
  293. </div>
  294. </div>
  295. <a class="anchor" id="a7bc26dd151ed56bc49329ca895fe15e7"></a>
  296. <div class="memitem">
  297. <div class="memproto">
  298. <table class="mlabels">
  299. <tr>
  300. <td class="mlabels-left">
  301. <table class="memname">
  302. <tr>
  303. <td class="memname"><a class="el" href="classgrpc_1_1_write_options.html">WriteOptions</a>&amp; grpc::WriteOptions::clear_no_compression </td>
  304. <td>(</td>
  305. <td class="paramname"></td><td>)</td>
  306. <td></td>
  307. </tr>
  308. </table>
  309. </td>
  310. <td class="mlabels-right">
  311. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  312. </tr>
  313. </table>
  314. </div><div class="memdoc">
  315. <p>Clears flag for the disabling of compression for the next message write. </p>
  316. <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>
  317. </div>
  318. </div>
  319. <a class="anchor" id="aa4d45d531680bb9f2ed76a73bea1cb22"></a>
  320. <div class="memitem">
  321. <div class="memproto">
  322. <table class="mlabels">
  323. <tr>
  324. <td class="mlabels-left">
  325. <table class="memname">
  326. <tr>
  327. <td class="memname">uint32_t grpc::WriteOptions::flags </td>
  328. <td>(</td>
  329. <td class="paramname"></td><td>)</td>
  330. <td> const</td>
  331. </tr>
  332. </table>
  333. </td>
  334. <td class="mlabels-right">
  335. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  336. </tr>
  337. </table>
  338. </div><div class="memdoc">
  339. <p>Returns raw flags bitset. </p>
  340. </div>
  341. </div>
  342. <a class="anchor" id="a58a983a81a17d0b8f3996164f55912ef"></a>
  343. <div class="memitem">
  344. <div class="memproto">
  345. <table class="mlabels">
  346. <tr>
  347. <td class="mlabels-left">
  348. <table class="memname">
  349. <tr>
  350. <td class="memname">bool grpc::WriteOptions::get_buffer_hint </td>
  351. <td>(</td>
  352. <td class="paramname"></td><td>)</td>
  353. <td> const</td>
  354. </tr>
  355. </table>
  356. </td>
  357. <td class="mlabels-right">
  358. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  359. </tr>
  360. </table>
  361. </div><div class="memdoc">
  362. <p>Get value for the flag indicating that the write may be buffered and need not go out on the wire immediately. </p>
  363. <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>
  364. </div>
  365. </div>
  366. <a class="anchor" id="accb16dd92f4001a6d024ffb01178d4bf"></a>
  367. <div class="memitem">
  368. <div class="memproto">
  369. <table class="mlabels">
  370. <tr>
  371. <td class="mlabels-left">
  372. <table class="memname">
  373. <tr>
  374. <td class="memname">bool grpc::WriteOptions::get_no_compression </td>
  375. <td>(</td>
  376. <td class="paramname"></td><td>)</td>
  377. <td> const</td>
  378. </tr>
  379. </table>
  380. </td>
  381. <td class="mlabels-right">
  382. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  383. </tr>
  384. </table>
  385. </div><div class="memdoc">
  386. <p>Get value for the flag indicating whether compression for the next message write is forcefully disabled. </p>
  387. <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>
  388. </div>
  389. </div>
  390. <a class="anchor" id="abd69a47aeaa341f6f94a540d648751c0"></a>
  391. <div class="memitem">
  392. <div class="memproto">
  393. <table class="mlabels">
  394. <tr>
  395. <td class="mlabels-left">
  396. <table class="memname">
  397. <tr>
  398. <td class="memname">bool grpc::WriteOptions::is_corked </td>
  399. <td>(</td>
  400. <td class="paramname"></td><td>)</td>
  401. <td> const</td>
  402. </tr>
  403. </table>
  404. </td>
  405. <td class="mlabels-right">
  406. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  407. </tr>
  408. </table>
  409. </div><div class="memdoc">
  410. </div>
  411. </div>
  412. <a class="anchor" id="a196c8fe4ed181e95efacf74be931bb79"></a>
  413. <div class="memitem">
  414. <div class="memproto">
  415. <table class="mlabels">
  416. <tr>
  417. <td class="mlabels-left">
  418. <table class="memname">
  419. <tr>
  420. <td class="memname">bool grpc::WriteOptions::is_last_message </td>
  421. <td>(</td>
  422. <td class="paramname"></td><td>)</td>
  423. <td> const</td>
  424. </tr>
  425. </table>
  426. </td>
  427. <td class="mlabels-right">
  428. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  429. </tr>
  430. </table>
  431. </div><div class="memdoc">
  432. <p>Get value for the flag indicating that this is the last message, and should be coalesced with trailing metadata. </p>
  433. <dl class="section see"><dt>See Also</dt><dd>GRPC_WRITE_LAST_MESSAGE </dd></dl>
  434. </div>
  435. </div>
  436. <a class="anchor" id="a5aa00dfe73c2d20e15cd0be8a608c0db"></a>
  437. <div class="memitem">
  438. <div class="memproto">
  439. <table class="mlabels">
  440. <tr>
  441. <td class="mlabels-left">
  442. <table class="memname">
  443. <tr>
  444. <td class="memname">bool grpc::WriteOptions::is_write_through </td>
  445. <td>(</td>
  446. <td class="paramname"></td><td>)</td>
  447. <td> const</td>
  448. </tr>
  449. </table>
  450. </td>
  451. <td class="mlabels-right">
  452. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  453. </tr>
  454. </table>
  455. </div><div class="memdoc">
  456. </div>
  457. </div>
  458. <a class="anchor" id="abe3d32a3e5879022e7b8f1c6a7533841"></a>
  459. <div class="memitem">
  460. <div class="memproto">
  461. <table class="mlabels">
  462. <tr>
  463. <td class="mlabels-left">
  464. <table class="memname">
  465. <tr>
  466. <td class="memname"><a class="el" href="classgrpc_1_1_write_options.html">WriteOptions</a>&amp; grpc::WriteOptions::operator= </td>
  467. <td>(</td>
  468. <td class="paramtype">const <a class="el" href="classgrpc_1_1_write_options.html">WriteOptions</a> &amp;&#160;</td>
  469. <td class="paramname"><em>rhs</em></td><td>)</td>
  470. <td></td>
  471. </tr>
  472. </table>
  473. </td>
  474. <td class="mlabels-right">
  475. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  476. </tr>
  477. </table>
  478. </div><div class="memdoc">
  479. </div>
  480. </div>
  481. <a class="anchor" id="aecd282a8c7424e4b0c1a5f512c44b8a8"></a>
  482. <div class="memitem">
  483. <div class="memproto">
  484. <table class="mlabels">
  485. <tr>
  486. <td class="mlabels-left">
  487. <table class="memname">
  488. <tr>
  489. <td class="memname"><a class="el" href="classgrpc_1_1_write_options.html">WriteOptions</a>&amp; grpc::WriteOptions::set_buffer_hint </td>
  490. <td>(</td>
  491. <td class="paramname"></td><td>)</td>
  492. <td></td>
  493. </tr>
  494. </table>
  495. </td>
  496. <td class="mlabels-right">
  497. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  498. </tr>
  499. </table>
  500. </div><div class="memdoc">
  501. <p>Sets flag indicating that the write may be buffered and need not go out on the wire immediately. </p>
  502. <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>
  503. </div>
  504. </div>
  505. <a class="anchor" id="abda047d0f7b1f18fbbfb5f9858c33f9d"></a>
  506. <div class="memitem">
  507. <div class="memproto">
  508. <table class="mlabels">
  509. <tr>
  510. <td class="mlabels-left">
  511. <table class="memname">
  512. <tr>
  513. <td class="memname"><a class="el" href="classgrpc_1_1_write_options.html">WriteOptions</a>&amp; grpc::WriteOptions::set_corked </td>
  514. <td>(</td>
  515. <td class="paramname"></td><td>)</td>
  516. <td></td>
  517. </tr>
  518. </table>
  519. </td>
  520. <td class="mlabels-right">
  521. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  522. </tr>
  523. </table>
  524. </div><div class="memdoc">
  525. <p>corked bit: aliases set_buffer_hint currently, with the intent that set_buffer_hint will be removed in the future </p>
  526. </div>
  527. </div>
  528. <a class="anchor" id="ad930c28f5c32832e1d48ee30bf0858e3"></a>
  529. <div class="memitem">
  530. <div class="memproto">
  531. <table class="mlabels">
  532. <tr>
  533. <td class="mlabels-left">
  534. <table class="memname">
  535. <tr>
  536. <td class="memname"><a class="el" href="classgrpc_1_1_write_options.html">WriteOptions</a>&amp; grpc::WriteOptions::set_last_message </td>
  537. <td>(</td>
  538. <td class="paramname"></td><td>)</td>
  539. <td></td>
  540. </tr>
  541. </table>
  542. </td>
  543. <td class="mlabels-right">
  544. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  545. </tr>
  546. </table>
  547. </div><div class="memdoc">
  548. <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>
  549. </div>
  550. </div>
  551. <a class="anchor" id="afe5f12d1bf9ed01b7a833458dc889b66"></a>
  552. <div class="memitem">
  553. <div class="memproto">
  554. <table class="mlabels">
  555. <tr>
  556. <td class="mlabels-left">
  557. <table class="memname">
  558. <tr>
  559. <td class="memname"><a class="el" href="classgrpc_1_1_write_options.html">WriteOptions</a>&amp; grpc::WriteOptions::set_no_compression </td>
  560. <td>(</td>
  561. <td class="paramname"></td><td>)</td>
  562. <td></td>
  563. </tr>
  564. </table>
  565. </td>
  566. <td class="mlabels-right">
  567. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  568. </tr>
  569. </table>
  570. </div><div class="memdoc">
  571. <p>Sets flag for the disabling of compression for the next message write. </p>
  572. <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>
  573. </div>
  574. </div>
  575. <a class="anchor" id="aaa5f7fcba7816c5d6b41b3e62b2b9b58"></a>
  576. <div class="memitem">
  577. <div class="memproto">
  578. <table class="mlabels">
  579. <tr>
  580. <td class="mlabels-left">
  581. <table class="memname">
  582. <tr>
  583. <td class="memname"><a class="el" href="classgrpc_1_1_write_options.html">WriteOptions</a>&amp; grpc::WriteOptions::set_write_through </td>
  584. <td>(</td>
  585. <td class="paramname"></td><td>)</td>
  586. <td></td>
  587. </tr>
  588. </table>
  589. </td>
  590. <td class="mlabels-right">
  591. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  592. </tr>
  593. </table>
  594. </div><div class="memdoc">
  595. <p>Guarantee that all bytes have been written to the wire before completing this write (usually writes are completed when they pass flow control) </p>
  596. </div>
  597. </div>
  598. <hr/>The documentation for this class was generated from the following file:<ul>
  599. <li>include/grpc++/impl/codegen/<a class="el" href="codegen_2call_8h_source.html">call.h</a></li>
  600. </ul>
  601. </div><!-- contents -->
  602. <!-- start footer part -->
  603. <hr class="footer"/><address class="footer"><small>
  604. Generated on Tue Dec 12 2017 18:36:13 for GRPC C++ by &#160;<a href="http://www.doxygen.org/index.html">
  605. <img class="footer" src="doxygen.png" alt="doxygen"/>
  606. </a> 1.8.6
  607. </small></address>
  608. </body>
  609. </html>