classgrpc_1_1_write_options.html 30 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604
  1. <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://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.17"/>
  7. <meta name="viewport" content="width=device-width, initial-scale=1"/>
  8. <title>GRPC C++: grpc::WriteOptions Class Reference</title>
  9. <link href="tabs.css" rel="stylesheet" type="text/css"/>
  10. <script type="text/javascript" src="jquery.js"></script>
  11. <script type="text/javascript" src="dynsections.js"></script>
  12. <link href="search/search.css" rel="stylesheet" type="text/css"/>
  13. <script type="text/javascript" src="search/searchdata.js"></script>
  14. <script type="text/javascript" src="search/search.js"></script>
  15. <link href="doxygen.css" rel="stylesheet" type="text/css" />
  16. </head>
  17. <body>
  18. <div id="top"><!-- do not remove this div, it is closed by doxygen! -->
  19. <div id="titlearea">
  20. <table cellspacing="0" cellpadding="0">
  21. <tbody>
  22. <tr style="height: 56px;">
  23. <td id="projectalign" style="padding-left: 0.5em;">
  24. <div id="projectname">GRPC C++
  25. &#160;<span id="projectnumber">1.36.1</span>
  26. </div>
  27. </td>
  28. </tr>
  29. </tbody>
  30. </table>
  31. </div>
  32. <!-- end header part -->
  33. <!-- Generated by Doxygen 1.8.17 -->
  34. <script type="text/javascript">
  35. /* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
  36. var searchBox = new SearchBox("searchBox", "search",false,'Search');
  37. /* @license-end */
  38. </script>
  39. <script type="text/javascript" src="menudata.js"></script>
  40. <script type="text/javascript" src="menu.js"></script>
  41. <script type="text/javascript">
  42. /* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
  43. $(function() {
  44. initMenu('',true,false,'search.php','Search');
  45. $(document).ready(function() { init_search(); });
  46. });
  47. /* @license-end */</script>
  48. <div id="main-nav"></div>
  49. <!-- window showing the filter options -->
  50. <div id="MSearchSelectWindow"
  51. onmouseover="return searchBox.OnSearchSelectShow()"
  52. onmouseout="return searchBox.OnSearchSelectHide()"
  53. onkeydown="return searchBox.OnSearchSelectKey(event)">
  54. </div>
  55. <!-- iframe showing the search results (closed by default) -->
  56. <div id="MSearchResultsWindow">
  57. <iframe src="javascript:void(0)" frameborder="0"
  58. name="MSearchResults" id="MSearchResults">
  59. </iframe>
  60. </div>
  61. <div id="nav-path" class="navpath">
  62. <ul>
  63. <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>
  64. </div>
  65. </div><!-- top -->
  66. <div class="header">
  67. <div class="summary">
  68. <a href="#pub-methods">Public Member Functions</a> </div>
  69. <div class="headertitle">
  70. <div class="title">grpc::WriteOptions Class Reference</div> </div>
  71. </div><!--header-->
  72. <div class="contents">
  73. <p>Per-message write options.
  74. <a href="classgrpc_1_1_write_options.html#details">More...</a></p>
  75. <p><code>#include &lt;<a class="el" href="call__op__set_8h_source.html">call_op_set.h</a>&gt;</code></p>
  76. <table class="memberdecls">
  77. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
  78. Public Member Functions</h2></td></tr>
  79. <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>
  80. <tr class="separator:a6a4e429313200ed6c017c5d306e26e93"><td class="memSeparator" colspan="2">&#160;</td></tr>
  81. <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>
  82. <tr class="memdesc:a9fc0e51224292b15dcfefec342fa0e02"><td class="mdescLeft">&#160;</td><td class="mdescRight">Clear all flags. <a href="classgrpc_1_1_write_options.html#a9fc0e51224292b15dcfefec342fa0e02">More...</a><br /></td></tr>
  83. <tr class="separator:a9fc0e51224292b15dcfefec342fa0e02"><td class="memSeparator" colspan="2">&#160;</td></tr>
  84. <tr class="memitem:ab5d1533a5c6d5d787435729f214474bc"><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#ab5d1533a5c6d5d787435729f214474bc">flags</a> () const</td></tr>
  85. <tr class="memdesc:ab5d1533a5c6d5d787435729f214474bc"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns raw flags bitset. <a href="classgrpc_1_1_write_options.html#ab5d1533a5c6d5d787435729f214474bc">More...</a><br /></td></tr>
  86. <tr class="separator:ab5d1533a5c6d5d787435729f214474bc"><td class="memSeparator" colspan="2">&#160;</td></tr>
  87. <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>
  88. <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="classgrpc_1_1_write_options.html#afe5f12d1bf9ed01b7a833458dc889b66">More...</a><br /></td></tr>
  89. <tr class="separator:afe5f12d1bf9ed01b7a833458dc889b66"><td class="memSeparator" colspan="2">&#160;</td></tr>
  90. <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>
  91. <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="classgrpc_1_1_write_options.html#a7bc26dd151ed56bc49329ca895fe15e7">More...</a><br /></td></tr>
  92. <tr class="separator:a7bc26dd151ed56bc49329ca895fe15e7"><td class="memSeparator" colspan="2">&#160;</td></tr>
  93. <tr class="memitem:a0c02bd1632cc1a239c55f06c073fe642"><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#a0c02bd1632cc1a239c55f06c073fe642">get_no_compression</a> () const</td></tr>
  94. <tr class="memdesc:a0c02bd1632cc1a239c55f06c073fe642"><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="classgrpc_1_1_write_options.html#a0c02bd1632cc1a239c55f06c073fe642">More...</a><br /></td></tr>
  95. <tr class="separator:a0c02bd1632cc1a239c55f06c073fe642"><td class="memSeparator" colspan="2">&#160;</td></tr>
  96. <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>
  97. <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="classgrpc_1_1_write_options.html#aecd282a8c7424e4b0c1a5f512c44b8a8">More...</a><br /></td></tr>
  98. <tr class="separator:aecd282a8c7424e4b0c1a5f512c44b8a8"><td class="memSeparator" colspan="2">&#160;</td></tr>
  99. <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>
  100. <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="classgrpc_1_1_write_options.html#a897ba94e51b1f6ead41ade8f92efa89f">More...</a><br /></td></tr>
  101. <tr class="separator:a897ba94e51b1f6ead41ade8f92efa89f"><td class="memSeparator" colspan="2">&#160;</td></tr>
  102. <tr class="memitem:a432f0759e437909f8cc30c6262b97faf"><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#a432f0759e437909f8cc30c6262b97faf">get_buffer_hint</a> () const</td></tr>
  103. <tr class="memdesc:a432f0759e437909f8cc30c6262b97faf"><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="classgrpc_1_1_write_options.html#a432f0759e437909f8cc30c6262b97faf">More...</a><br /></td></tr>
  104. <tr class="separator:a432f0759e437909f8cc30c6262b97faf"><td class="memSeparator" colspan="2">&#160;</td></tr>
  105. <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>
  106. <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="classgrpc_1_1_write_options.html#abda047d0f7b1f18fbbfb5f9858c33f9d">More...</a><br /></td></tr>
  107. <tr class="separator:abda047d0f7b1f18fbbfb5f9858c33f9d"><td class="memSeparator" colspan="2">&#160;</td></tr>
  108. <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>
  109. <tr class="separator:aae98f2a75fa805f2ba5f7fe5202d43c2"><td class="memSeparator" colspan="2">&#160;</td></tr>
  110. <tr class="memitem:a28b60c6668d42680d8928e1cffc90db8"><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#a28b60c6668d42680d8928e1cffc90db8">is_corked</a> () const</td></tr>
  111. <tr class="separator:a28b60c6668d42680d8928e1cffc90db8"><td class="memSeparator" colspan="2">&#160;</td></tr>
  112. <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>
  113. <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="classgrpc_1_1_write_options.html#ad930c28f5c32832e1d48ee30bf0858e3">More...</a><br /></td></tr>
  114. <tr class="separator:ad930c28f5c32832e1d48ee30bf0858e3"><td class="memSeparator" colspan="2">&#160;</td></tr>
  115. <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>
  116. <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="classgrpc_1_1_write_options.html#aa96dfc3eceb841fb2b5416222561684c">More...</a><br /></td></tr>
  117. <tr class="separator:aa96dfc3eceb841fb2b5416222561684c"><td class="memSeparator" colspan="2">&#160;</td></tr>
  118. <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>
  119. <tr class="memdesc:aaa5f7fcba7816c5d6b41b3e62b2b9b58"><td class="mdescLeft">&#160;</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>
  120. <tr class="separator:aaa5f7fcba7816c5d6b41b3e62b2b9b58"><td class="memSeparator" colspan="2">&#160;</td></tr>
  121. <tr class="memitem:a1031b0d61c166df4f2699f56fbba3d0f"><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#a1031b0d61c166df4f2699f56fbba3d0f">is_write_through</a> () const</td></tr>
  122. <tr class="separator:a1031b0d61c166df4f2699f56fbba3d0f"><td class="memSeparator" colspan="2">&#160;</td></tr>
  123. <tr class="memitem:a7d08d7bc3a62cc4cfe8499d4bd70e0d7"><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#a7d08d7bc3a62cc4cfe8499d4bd70e0d7">is_last_message</a> () const</td></tr>
  124. <tr class="memdesc:a7d08d7bc3a62cc4cfe8499d4bd70e0d7"><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="classgrpc_1_1_write_options.html#a7d08d7bc3a62cc4cfe8499d4bd70e0d7">More...</a><br /></td></tr>
  125. <tr class="separator:a7d08d7bc3a62cc4cfe8499d4bd70e0d7"><td class="memSeparator" colspan="2">&#160;</td></tr>
  126. </table>
  127. <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
  128. <div class="textblock"><p>Per-message write options. </p>
  129. </div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
  130. <a id="a6a4e429313200ed6c017c5d306e26e93"></a>
  131. <h2 class="memtitle"><span class="permalink"><a href="#a6a4e429313200ed6c017c5d306e26e93">&#9670;&nbsp;</a></span>WriteOptions()</h2>
  132. <div class="memitem">
  133. <div class="memproto">
  134. <table class="mlabels">
  135. <tr>
  136. <td class="mlabels-left">
  137. <table class="memname">
  138. <tr>
  139. <td class="memname">grpc::WriteOptions::WriteOptions </td>
  140. <td>(</td>
  141. <td class="paramname"></td><td>)</td>
  142. <td></td>
  143. </tr>
  144. </table>
  145. </td>
  146. <td class="mlabels-right">
  147. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  148. </tr>
  149. </table>
  150. </div><div class="memdoc">
  151. </div>
  152. </div>
  153. <h2 class="groupheader">Member Function Documentation</h2>
  154. <a id="a9fc0e51224292b15dcfefec342fa0e02"></a>
  155. <h2 class="memtitle"><span class="permalink"><a href="#a9fc0e51224292b15dcfefec342fa0e02">&#9670;&nbsp;</a></span>Clear()</h2>
  156. <div class="memitem">
  157. <div class="memproto">
  158. <table class="mlabels">
  159. <tr>
  160. <td class="mlabels-left">
  161. <table class="memname">
  162. <tr>
  163. <td class="memname">void grpc::WriteOptions::Clear </td>
  164. <td>(</td>
  165. <td class="paramname"></td><td>)</td>
  166. <td></td>
  167. </tr>
  168. </table>
  169. </td>
  170. <td class="mlabels-right">
  171. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  172. </tr>
  173. </table>
  174. </div><div class="memdoc">
  175. <p>Clear all flags. </p>
  176. </div>
  177. </div>
  178. <a id="a897ba94e51b1f6ead41ade8f92efa89f"></a>
  179. <h2 class="memtitle"><span class="permalink"><a href="#a897ba94e51b1f6ead41ade8f92efa89f">&#9670;&nbsp;</a></span>clear_buffer_hint()</h2>
  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"><a class="el" href="classgrpc_1_1_write_options.html">WriteOptions</a>&amp; grpc::WriteOptions::clear_buffer_hint </td>
  188. <td>(</td>
  189. <td class="paramname"></td><td>)</td>
  190. <td></td>
  191. </tr>
  192. </table>
  193. </td>
  194. <td class="mlabels-right">
  195. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  196. </tr>
  197. </table>
  198. </div><div class="memdoc">
  199. <p>Clears flag indicating that the write may be buffered and need not go out on the wire immediately. </p>
  200. <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>
  201. </div>
  202. </div>
  203. <a id="aae98f2a75fa805f2ba5f7fe5202d43c2"></a>
  204. <h2 class="memtitle"><span class="permalink"><a href="#aae98f2a75fa805f2ba5f7fe5202d43c2">&#9670;&nbsp;</a></span>clear_corked()</h2>
  205. <div class="memitem">
  206. <div class="memproto">
  207. <table class="mlabels">
  208. <tr>
  209. <td class="mlabels-left">
  210. <table class="memname">
  211. <tr>
  212. <td class="memname"><a class="el" href="classgrpc_1_1_write_options.html">WriteOptions</a>&amp; grpc::WriteOptions::clear_corked </td>
  213. <td>(</td>
  214. <td class="paramname"></td><td>)</td>
  215. <td></td>
  216. </tr>
  217. </table>
  218. </td>
  219. <td class="mlabels-right">
  220. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  221. </tr>
  222. </table>
  223. </div><div class="memdoc">
  224. </div>
  225. </div>
  226. <a id="aa96dfc3eceb841fb2b5416222561684c"></a>
  227. <h2 class="memtitle"><span class="permalink"><a href="#aa96dfc3eceb841fb2b5416222561684c">&#9670;&nbsp;</a></span>clear_last_message()</h2>
  228. <div class="memitem">
  229. <div class="memproto">
  230. <table class="mlabels">
  231. <tr>
  232. <td class="mlabels-left">
  233. <table class="memname">
  234. <tr>
  235. <td class="memname"><a class="el" href="classgrpc_1_1_write_options.html">WriteOptions</a>&amp; grpc::WriteOptions::clear_last_message </td>
  236. <td>(</td>
  237. <td class="paramname"></td><td>)</td>
  238. <td></td>
  239. </tr>
  240. </table>
  241. </td>
  242. <td class="mlabels-right">
  243. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  244. </tr>
  245. </table>
  246. </div><div class="memdoc">
  247. <p>Clears flag indicating that this is the last message in a stream, disabling coalescing. </p>
  248. </div>
  249. </div>
  250. <a id="a7bc26dd151ed56bc49329ca895fe15e7"></a>
  251. <h2 class="memtitle"><span class="permalink"><a href="#a7bc26dd151ed56bc49329ca895fe15e7">&#9670;&nbsp;</a></span>clear_no_compression()</h2>
  252. <div class="memitem">
  253. <div class="memproto">
  254. <table class="mlabels">
  255. <tr>
  256. <td class="mlabels-left">
  257. <table class="memname">
  258. <tr>
  259. <td class="memname"><a class="el" href="classgrpc_1_1_write_options.html">WriteOptions</a>&amp; grpc::WriteOptions::clear_no_compression </td>
  260. <td>(</td>
  261. <td class="paramname"></td><td>)</td>
  262. <td></td>
  263. </tr>
  264. </table>
  265. </td>
  266. <td class="mlabels-right">
  267. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  268. </tr>
  269. </table>
  270. </div><div class="memdoc">
  271. <p>Clears flag for the disabling of compression for the next message write. </p>
  272. <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>
  273. </div>
  274. </div>
  275. <a id="ab5d1533a5c6d5d787435729f214474bc"></a>
  276. <h2 class="memtitle"><span class="permalink"><a href="#ab5d1533a5c6d5d787435729f214474bc">&#9670;&nbsp;</a></span>flags()</h2>
  277. <div class="memitem">
  278. <div class="memproto">
  279. <table class="mlabels">
  280. <tr>
  281. <td class="mlabels-left">
  282. <table class="memname">
  283. <tr>
  284. <td class="memname">uint32_t grpc::WriteOptions::flags </td>
  285. <td>(</td>
  286. <td class="paramname"></td><td>)</td>
  287. <td> const</td>
  288. </tr>
  289. </table>
  290. </td>
  291. <td class="mlabels-right">
  292. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  293. </tr>
  294. </table>
  295. </div><div class="memdoc">
  296. <p>Returns raw flags bitset. </p>
  297. </div>
  298. </div>
  299. <a id="a432f0759e437909f8cc30c6262b97faf"></a>
  300. <h2 class="memtitle"><span class="permalink"><a href="#a432f0759e437909f8cc30c6262b97faf">&#9670;&nbsp;</a></span>get_buffer_hint()</h2>
  301. <div class="memitem">
  302. <div class="memproto">
  303. <table class="mlabels">
  304. <tr>
  305. <td class="mlabels-left">
  306. <table class="memname">
  307. <tr>
  308. <td class="memname">bool grpc::WriteOptions::get_buffer_hint </td>
  309. <td>(</td>
  310. <td class="paramname"></td><td>)</td>
  311. <td> const</td>
  312. </tr>
  313. </table>
  314. </td>
  315. <td class="mlabels-right">
  316. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  317. </tr>
  318. </table>
  319. </div><div class="memdoc">
  320. <p>Get value for the flag indicating that the write may be buffered and need not go out on the wire immediately. </p>
  321. <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>
  322. </div>
  323. </div>
  324. <a id="a0c02bd1632cc1a239c55f06c073fe642"></a>
  325. <h2 class="memtitle"><span class="permalink"><a href="#a0c02bd1632cc1a239c55f06c073fe642">&#9670;&nbsp;</a></span>get_no_compression()</h2>
  326. <div class="memitem">
  327. <div class="memproto">
  328. <table class="mlabels">
  329. <tr>
  330. <td class="mlabels-left">
  331. <table class="memname">
  332. <tr>
  333. <td class="memname">bool grpc::WriteOptions::get_no_compression </td>
  334. <td>(</td>
  335. <td class="paramname"></td><td>)</td>
  336. <td> const</td>
  337. </tr>
  338. </table>
  339. </td>
  340. <td class="mlabels-right">
  341. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  342. </tr>
  343. </table>
  344. </div><div class="memdoc">
  345. <p>Get value for the flag indicating whether compression for the next message write is forcefully disabled. </p>
  346. <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>
  347. </div>
  348. </div>
  349. <a id="a28b60c6668d42680d8928e1cffc90db8"></a>
  350. <h2 class="memtitle"><span class="permalink"><a href="#a28b60c6668d42680d8928e1cffc90db8">&#9670;&nbsp;</a></span>is_corked()</h2>
  351. <div class="memitem">
  352. <div class="memproto">
  353. <table class="mlabels">
  354. <tr>
  355. <td class="mlabels-left">
  356. <table class="memname">
  357. <tr>
  358. <td class="memname">bool grpc::WriteOptions::is_corked </td>
  359. <td>(</td>
  360. <td class="paramname"></td><td>)</td>
  361. <td> const</td>
  362. </tr>
  363. </table>
  364. </td>
  365. <td class="mlabels-right">
  366. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  367. </tr>
  368. </table>
  369. </div><div class="memdoc">
  370. </div>
  371. </div>
  372. <a id="a7d08d7bc3a62cc4cfe8499d4bd70e0d7"></a>
  373. <h2 class="memtitle"><span class="permalink"><a href="#a7d08d7bc3a62cc4cfe8499d4bd70e0d7">&#9670;&nbsp;</a></span>is_last_message()</h2>
  374. <div class="memitem">
  375. <div class="memproto">
  376. <table class="mlabels">
  377. <tr>
  378. <td class="mlabels-left">
  379. <table class="memname">
  380. <tr>
  381. <td class="memname">bool grpc::WriteOptions::is_last_message </td>
  382. <td>(</td>
  383. <td class="paramname"></td><td>)</td>
  384. <td> const</td>
  385. </tr>
  386. </table>
  387. </td>
  388. <td class="mlabels-right">
  389. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  390. </tr>
  391. </table>
  392. </div><div class="memdoc">
  393. <p>Get value for the flag indicating that this is the last message, and should be coalesced with trailing metadata. </p>
  394. <dl class="section see"><dt>See also</dt><dd>GRPC_WRITE_LAST_MESSAGE </dd></dl>
  395. </div>
  396. </div>
  397. <a id="a1031b0d61c166df4f2699f56fbba3d0f"></a>
  398. <h2 class="memtitle"><span class="permalink"><a href="#a1031b0d61c166df4f2699f56fbba3d0f">&#9670;&nbsp;</a></span>is_write_through()</h2>
  399. <div class="memitem">
  400. <div class="memproto">
  401. <table class="mlabels">
  402. <tr>
  403. <td class="mlabels-left">
  404. <table class="memname">
  405. <tr>
  406. <td class="memname">bool grpc::WriteOptions::is_write_through </td>
  407. <td>(</td>
  408. <td class="paramname"></td><td>)</td>
  409. <td> const</td>
  410. </tr>
  411. </table>
  412. </td>
  413. <td class="mlabels-right">
  414. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  415. </tr>
  416. </table>
  417. </div><div class="memdoc">
  418. </div>
  419. </div>
  420. <a id="aecd282a8c7424e4b0c1a5f512c44b8a8"></a>
  421. <h2 class="memtitle"><span class="permalink"><a href="#aecd282a8c7424e4b0c1a5f512c44b8a8">&#9670;&nbsp;</a></span>set_buffer_hint()</h2>
  422. <div class="memitem">
  423. <div class="memproto">
  424. <table class="mlabels">
  425. <tr>
  426. <td class="mlabels-left">
  427. <table class="memname">
  428. <tr>
  429. <td class="memname"><a class="el" href="classgrpc_1_1_write_options.html">WriteOptions</a>&amp; grpc::WriteOptions::set_buffer_hint </td>
  430. <td>(</td>
  431. <td class="paramname"></td><td>)</td>
  432. <td></td>
  433. </tr>
  434. </table>
  435. </td>
  436. <td class="mlabels-right">
  437. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  438. </tr>
  439. </table>
  440. </div><div class="memdoc">
  441. <p>Sets flag indicating that the write may be buffered and need not go out on the wire immediately. </p>
  442. <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>
  443. </div>
  444. </div>
  445. <a id="abda047d0f7b1f18fbbfb5f9858c33f9d"></a>
  446. <h2 class="memtitle"><span class="permalink"><a href="#abda047d0f7b1f18fbbfb5f9858c33f9d">&#9670;&nbsp;</a></span>set_corked()</h2>
  447. <div class="memitem">
  448. <div class="memproto">
  449. <table class="mlabels">
  450. <tr>
  451. <td class="mlabels-left">
  452. <table class="memname">
  453. <tr>
  454. <td class="memname"><a class="el" href="classgrpc_1_1_write_options.html">WriteOptions</a>&amp; grpc::WriteOptions::set_corked </td>
  455. <td>(</td>
  456. <td class="paramname"></td><td>)</td>
  457. <td></td>
  458. </tr>
  459. </table>
  460. </td>
  461. <td class="mlabels-right">
  462. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  463. </tr>
  464. </table>
  465. </div><div class="memdoc">
  466. <p>corked bit: aliases set_buffer_hint currently, with the intent that set_buffer_hint will be removed in the future </p>
  467. </div>
  468. </div>
  469. <a id="ad930c28f5c32832e1d48ee30bf0858e3"></a>
  470. <h2 class="memtitle"><span class="permalink"><a href="#ad930c28f5c32832e1d48ee30bf0858e3">&#9670;&nbsp;</a></span>set_last_message()</h2>
  471. <div class="memitem">
  472. <div class="memproto">
  473. <table class="mlabels">
  474. <tr>
  475. <td class="mlabels-left">
  476. <table class="memname">
  477. <tr>
  478. <td class="memname"><a class="el" href="classgrpc_1_1_write_options.html">WriteOptions</a>&amp; grpc::WriteOptions::set_last_message </td>
  479. <td>(</td>
  480. <td class="paramname"></td><td>)</td>
  481. <td></td>
  482. </tr>
  483. </table>
  484. </td>
  485. <td class="mlabels-right">
  486. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  487. </tr>
  488. </table>
  489. </div><div class="memdoc">
  490. <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>
  491. </div>
  492. </div>
  493. <a id="afe5f12d1bf9ed01b7a833458dc889b66"></a>
  494. <h2 class="memtitle"><span class="permalink"><a href="#afe5f12d1bf9ed01b7a833458dc889b66">&#9670;&nbsp;</a></span>set_no_compression()</h2>
  495. <div class="memitem">
  496. <div class="memproto">
  497. <table class="mlabels">
  498. <tr>
  499. <td class="mlabels-left">
  500. <table class="memname">
  501. <tr>
  502. <td class="memname"><a class="el" href="classgrpc_1_1_write_options.html">WriteOptions</a>&amp; grpc::WriteOptions::set_no_compression </td>
  503. <td>(</td>
  504. <td class="paramname"></td><td>)</td>
  505. <td></td>
  506. </tr>
  507. </table>
  508. </td>
  509. <td class="mlabels-right">
  510. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  511. </tr>
  512. </table>
  513. </div><div class="memdoc">
  514. <p>Sets flag for the disabling of compression for the next message write. </p>
  515. <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>
  516. </div>
  517. </div>
  518. <a id="aaa5f7fcba7816c5d6b41b3e62b2b9b58"></a>
  519. <h2 class="memtitle"><span class="permalink"><a href="#aaa5f7fcba7816c5d6b41b3e62b2b9b58">&#9670;&nbsp;</a></span>set_write_through()</h2>
  520. <div class="memitem">
  521. <div class="memproto">
  522. <table class="mlabels">
  523. <tr>
  524. <td class="mlabels-left">
  525. <table class="memname">
  526. <tr>
  527. <td class="memname"><a class="el" href="classgrpc_1_1_write_options.html">WriteOptions</a>&amp; grpc::WriteOptions::set_write_through </td>
  528. <td>(</td>
  529. <td class="paramname"></td><td>)</td>
  530. <td></td>
  531. </tr>
  532. </table>
  533. </td>
  534. <td class="mlabels-right">
  535. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  536. </tr>
  537. </table>
  538. </div><div class="memdoc">
  539. <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>
  540. </div>
  541. </div>
  542. <hr/>The documentation for this class was generated from the following file:<ul>
  543. <li>include/grpcpp/impl/codegen/<a class="el" href="call__op__set_8h_source.html">call_op_set.h</a></li>
  544. </ul>
  545. </div><!-- contents -->
  546. <!-- start footer part -->
  547. <hr class="footer"/><address class="footer"><small>
  548. Generated on Wed Mar 3 2021 19:17:25 for GRPC C++ by &#160;<a href="http://www.doxygen.org/index.html">
  549. <img class="footer" src="doxygen.png" alt="doxygen"/>
  550. </a> 1.8.17
  551. </small></address>
  552. </body>
  553. </html>