classgrpc_1_1_write_options.html 33 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657
  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.13"/>
  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. <script type="text/javascript"> (function(i,s,o,g,r,a,m){i['GoogleAnalyticsObject']=r;i[r]=i[r]||function(){ (i[r].q=i[r].q||[]).push(arguments)},i[r].l=1*new Date();a=s.createElement(o), m=s.getElementsByTagName(o)[0];a.async=1;a.src=g;m.parentNode.insertBefore(a,m) })(window,document,'script','//www.google-analytics.com/analytics.js','ga'); ga('create', 'UA-60127042-1', 'auto'); ga('send', 'pageview'); </script></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.13.0-dev</span>
  26. </div>
  27. </td>
  28. </tr>
  29. </tbody>
  30. </table>
  31. </div>
  32. <!-- end header part -->
  33. <!-- Generated by Doxygen 1.8.13 -->
  34. <script type="text/javascript">
  35. var searchBox = new SearchBox("searchBox", "search",false,'Search');
  36. </script>
  37. <script type="text/javascript" src="menudata.js"></script>
  38. <script type="text/javascript" src="menu.js"></script>
  39. <script type="text/javascript">
  40. $(function() {
  41. initMenu('',true,false,'search.php','Search');
  42. $(document).ready(function() { init_search(); });
  43. });
  44. </script>
  45. <div id="main-nav"></div>
  46. <!-- window showing the filter options -->
  47. <div id="MSearchSelectWindow"
  48. onmouseover="return searchBox.OnSearchSelectShow()"
  49. onmouseout="return searchBox.OnSearchSelectHide()"
  50. onkeydown="return searchBox.OnSearchSelectKey(event)">
  51. </div>
  52. <!-- iframe showing the search results (closed by default) -->
  53. <div id="MSearchResultsWindow">
  54. <iframe src="javascript:void(0)" frameborder="0"
  55. name="MSearchResults" id="MSearchResults">
  56. </iframe>
  57. </div>
  58. <div id="nav-path" class="navpath">
  59. <ul>
  60. <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>
  61. </div>
  62. </div><!-- top -->
  63. <div class="header">
  64. <div class="summary">
  65. <a href="#pub-methods">Public Member Functions</a> </div>
  66. <div class="headertitle">
  67. <div class="title">grpc::WriteOptions Class Reference</div> </div>
  68. </div><!--header-->
  69. <div class="contents">
  70. <p>Per-message write options.
  71. <a href="classgrpc_1_1_write_options.html#details">More...</a></p>
  72. <p><code>#include &lt;<a class="el" href="grpcpp_2impl_2codegen_2call_8h_source.html">call.h</a>&gt;</code></p>
  73. <table class="memberdecls">
  74. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
  75. Public Member Functions</h2></td></tr>
  76. <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>
  77. <tr class="separator:a6a4e429313200ed6c017c5d306e26e93"><td class="memSeparator" colspan="2">&#160;</td></tr>
  78. <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>
  79. <tr class="separator:a4d7753bbd8d9d61e2c6d3e49e29be021"><td class="memSeparator" colspan="2">&#160;</td></tr>
  80. <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>
  81. <tr class="memdesc:a9fc0e51224292b15dcfefec342fa0e02"><td class="mdescLeft">&#160;</td><td class="mdescRight">Clear all flags. <a href="#a9fc0e51224292b15dcfefec342fa0e02">More...</a><br /></td></tr>
  82. <tr class="separator:a9fc0e51224292b15dcfefec342fa0e02"><td class="memSeparator" colspan="2">&#160;</td></tr>
  83. <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>
  84. <tr class="memdesc:ab5d1533a5c6d5d787435729f214474bc"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns raw flags bitset. <a href="#ab5d1533a5c6d5d787435729f214474bc">More...</a><br /></td></tr>
  85. <tr class="separator:ab5d1533a5c6d5d787435729f214474bc"><td class="memSeparator" colspan="2">&#160;</td></tr>
  86. <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>
  87. <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>
  88. <tr class="separator:afe5f12d1bf9ed01b7a833458dc889b66"><td class="memSeparator" colspan="2">&#160;</td></tr>
  89. <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>
  90. <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>
  91. <tr class="separator:a7bc26dd151ed56bc49329ca895fe15e7"><td class="memSeparator" colspan="2">&#160;</td></tr>
  92. <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>
  93. <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="#a0c02bd1632cc1a239c55f06c073fe642">More...</a><br /></td></tr>
  94. <tr class="separator:a0c02bd1632cc1a239c55f06c073fe642"><td class="memSeparator" colspan="2">&#160;</td></tr>
  95. <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>
  96. <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>
  97. <tr class="separator:aecd282a8c7424e4b0c1a5f512c44b8a8"><td class="memSeparator" colspan="2">&#160;</td></tr>
  98. <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>
  99. <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>
  100. <tr class="separator:a897ba94e51b1f6ead41ade8f92efa89f"><td class="memSeparator" colspan="2">&#160;</td></tr>
  101. <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>
  102. <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="#a432f0759e437909f8cc30c6262b97faf">More...</a><br /></td></tr>
  103. <tr class="separator:a432f0759e437909f8cc30c6262b97faf"><td class="memSeparator" colspan="2">&#160;</td></tr>
  104. <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>
  105. <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>
  106. <tr class="separator:abda047d0f7b1f18fbbfb5f9858c33f9d"><td class="memSeparator" colspan="2">&#160;</td></tr>
  107. <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>
  108. <tr class="separator:aae98f2a75fa805f2ba5f7fe5202d43c2"><td class="memSeparator" colspan="2">&#160;</td></tr>
  109. <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>
  110. <tr class="separator:a28b60c6668d42680d8928e1cffc90db8"><td class="memSeparator" colspan="2">&#160;</td></tr>
  111. <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>
  112. <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>
  113. <tr class="separator:ad930c28f5c32832e1d48ee30bf0858e3"><td class="memSeparator" colspan="2">&#160;</td></tr>
  114. <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>
  115. <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>
  116. <tr class="separator:aa96dfc3eceb841fb2b5416222561684c"><td class="memSeparator" colspan="2">&#160;</td></tr>
  117. <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>
  118. <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>
  119. <tr class="separator:aaa5f7fcba7816c5d6b41b3e62b2b9b58"><td class="memSeparator" colspan="2">&#160;</td></tr>
  120. <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>
  121. <tr class="separator:a1031b0d61c166df4f2699f56fbba3d0f"><td class="memSeparator" colspan="2">&#160;</td></tr>
  122. <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>
  123. <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="#a7d08d7bc3a62cc4cfe8499d4bd70e0d7">More...</a><br /></td></tr>
  124. <tr class="separator:a7d08d7bc3a62cc4cfe8499d4bd70e0d7"><td class="memSeparator" colspan="2">&#160;</td></tr>
  125. <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>
  126. <tr class="separator:abe3d32a3e5879022e7b8f1c6a7533841"><td class="memSeparator" colspan="2">&#160;</td></tr>
  127. </table>
  128. <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
  129. <div class="textblock"><p>Per-message write options. </p>
  130. </div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
  131. <a id="a6a4e429313200ed6c017c5d306e26e93"></a>
  132. <h2 class="memtitle"><span class="permalink"><a href="#a6a4e429313200ed6c017c5d306e26e93">&#9670;&nbsp;</a></span>WriteOptions() <span class="overload">[1/2]</span></h2>
  133. <div class="memitem">
  134. <div class="memproto">
  135. <table class="mlabels">
  136. <tr>
  137. <td class="mlabels-left">
  138. <table class="memname">
  139. <tr>
  140. <td class="memname">grpc::WriteOptions::WriteOptions </td>
  141. <td>(</td>
  142. <td class="paramname"></td><td>)</td>
  143. <td></td>
  144. </tr>
  145. </table>
  146. </td>
  147. <td class="mlabels-right">
  148. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  149. </tr>
  150. </table>
  151. </div><div class="memdoc">
  152. </div>
  153. </div>
  154. <a id="a4d7753bbd8d9d61e2c6d3e49e29be021"></a>
  155. <h2 class="memtitle"><span class="permalink"><a href="#a4d7753bbd8d9d61e2c6d3e49e29be021">&#9670;&nbsp;</a></span>WriteOptions() <span class="overload">[2/2]</span></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">grpc::WriteOptions::WriteOptions </td>
  164. <td>(</td>
  165. <td class="paramtype">const <a class="el" href="classgrpc_1_1_write_options.html">WriteOptions</a> &amp;&#160;</td>
  166. <td class="paramname"><em>other</em></td><td>)</td>
  167. <td></td>
  168. </tr>
  169. </table>
  170. </td>
  171. <td class="mlabels-right">
  172. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  173. </tr>
  174. </table>
  175. </div><div class="memdoc">
  176. </div>
  177. </div>
  178. <h2 class="groupheader">Member Function Documentation</h2>
  179. <a id="a9fc0e51224292b15dcfefec342fa0e02"></a>
  180. <h2 class="memtitle"><span class="permalink"><a href="#a9fc0e51224292b15dcfefec342fa0e02">&#9670;&nbsp;</a></span>Clear()</h2>
  181. <div class="memitem">
  182. <div class="memproto">
  183. <table class="mlabels">
  184. <tr>
  185. <td class="mlabels-left">
  186. <table class="memname">
  187. <tr>
  188. <td class="memname">void grpc::WriteOptions::Clear </td>
  189. <td>(</td>
  190. <td class="paramname"></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. <p>Clear all flags. </p>
  201. </div>
  202. </div>
  203. <a id="a897ba94e51b1f6ead41ade8f92efa89f"></a>
  204. <h2 class="memtitle"><span class="permalink"><a href="#a897ba94e51b1f6ead41ade8f92efa89f">&#9670;&nbsp;</a></span>clear_buffer_hint()</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_buffer_hint </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. <p>Clears flag indicating that the write may be buffered and need not go out on the wire immediately. </p>
  225. <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>
  226. </div>
  227. </div>
  228. <a id="aae98f2a75fa805f2ba5f7fe5202d43c2"></a>
  229. <h2 class="memtitle"><span class="permalink"><a href="#aae98f2a75fa805f2ba5f7fe5202d43c2">&#9670;&nbsp;</a></span>clear_corked()</h2>
  230. <div class="memitem">
  231. <div class="memproto">
  232. <table class="mlabels">
  233. <tr>
  234. <td class="mlabels-left">
  235. <table class="memname">
  236. <tr>
  237. <td class="memname"><a class="el" href="classgrpc_1_1_write_options.html">WriteOptions</a>&amp; grpc::WriteOptions::clear_corked </td>
  238. <td>(</td>
  239. <td class="paramname"></td><td>)</td>
  240. <td></td>
  241. </tr>
  242. </table>
  243. </td>
  244. <td class="mlabels-right">
  245. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  246. </tr>
  247. </table>
  248. </div><div class="memdoc">
  249. </div>
  250. </div>
  251. <a id="aa96dfc3eceb841fb2b5416222561684c"></a>
  252. <h2 class="memtitle"><span class="permalink"><a href="#aa96dfc3eceb841fb2b5416222561684c">&#9670;&nbsp;</a></span>clear_last_message()</h2>
  253. <div class="memitem">
  254. <div class="memproto">
  255. <table class="mlabels">
  256. <tr>
  257. <td class="mlabels-left">
  258. <table class="memname">
  259. <tr>
  260. <td class="memname"><a class="el" href="classgrpc_1_1_write_options.html">WriteOptions</a>&amp; grpc::WriteOptions::clear_last_message </td>
  261. <td>(</td>
  262. <td class="paramname"></td><td>)</td>
  263. <td></td>
  264. </tr>
  265. </table>
  266. </td>
  267. <td class="mlabels-right">
  268. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  269. </tr>
  270. </table>
  271. </div><div class="memdoc">
  272. <p>Clears flag indicating that this is the last message in a stream, disabling coalescing. </p>
  273. </div>
  274. </div>
  275. <a id="a7bc26dd151ed56bc49329ca895fe15e7"></a>
  276. <h2 class="memtitle"><span class="permalink"><a href="#a7bc26dd151ed56bc49329ca895fe15e7">&#9670;&nbsp;</a></span>clear_no_compression()</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"><a class="el" href="classgrpc_1_1_write_options.html">WriteOptions</a>&amp; grpc::WriteOptions::clear_no_compression </td>
  285. <td>(</td>
  286. <td class="paramname"></td><td>)</td>
  287. <td></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>Clears flag for the disabling of compression for the next message write. </p>
  297. <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>
  298. </div>
  299. </div>
  300. <a id="ab5d1533a5c6d5d787435729f214474bc"></a>
  301. <h2 class="memtitle"><span class="permalink"><a href="#ab5d1533a5c6d5d787435729f214474bc">&#9670;&nbsp;</a></span>flags()</h2>
  302. <div class="memitem">
  303. <div class="memproto">
  304. <table class="mlabels">
  305. <tr>
  306. <td class="mlabels-left">
  307. <table class="memname">
  308. <tr>
  309. <td class="memname">uint32_t grpc::WriteOptions::flags </td>
  310. <td>(</td>
  311. <td class="paramname"></td><td>)</td>
  312. <td> const</td>
  313. </tr>
  314. </table>
  315. </td>
  316. <td class="mlabels-right">
  317. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  318. </tr>
  319. </table>
  320. </div><div class="memdoc">
  321. <p>Returns raw flags bitset. </p>
  322. </div>
  323. </div>
  324. <a id="a432f0759e437909f8cc30c6262b97faf"></a>
  325. <h2 class="memtitle"><span class="permalink"><a href="#a432f0759e437909f8cc30c6262b97faf">&#9670;&nbsp;</a></span>get_buffer_hint()</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_buffer_hint </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 that the write may be buffered and need not go out on the wire immediately. </p>
  346. <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>
  347. </div>
  348. </div>
  349. <a id="a0c02bd1632cc1a239c55f06c073fe642"></a>
  350. <h2 class="memtitle"><span class="permalink"><a href="#a0c02bd1632cc1a239c55f06c073fe642">&#9670;&nbsp;</a></span>get_no_compression()</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::get_no_compression </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. <p>Get value for the flag indicating whether compression for the next message write is forcefully disabled. </p>
  371. <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>
  372. </div>
  373. </div>
  374. <a id="a28b60c6668d42680d8928e1cffc90db8"></a>
  375. <h2 class="memtitle"><span class="permalink"><a href="#a28b60c6668d42680d8928e1cffc90db8">&#9670;&nbsp;</a></span>is_corked()</h2>
  376. <div class="memitem">
  377. <div class="memproto">
  378. <table class="mlabels">
  379. <tr>
  380. <td class="mlabels-left">
  381. <table class="memname">
  382. <tr>
  383. <td class="memname">bool grpc::WriteOptions::is_corked </td>
  384. <td>(</td>
  385. <td class="paramname"></td><td>)</td>
  386. <td> const</td>
  387. </tr>
  388. </table>
  389. </td>
  390. <td class="mlabels-right">
  391. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  392. </tr>
  393. </table>
  394. </div><div class="memdoc">
  395. </div>
  396. </div>
  397. <a id="a7d08d7bc3a62cc4cfe8499d4bd70e0d7"></a>
  398. <h2 class="memtitle"><span class="permalink"><a href="#a7d08d7bc3a62cc4cfe8499d4bd70e0d7">&#9670;&nbsp;</a></span>is_last_message()</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_last_message </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. <p>Get value for the flag indicating that this is the last message, and should be coalesced with trailing metadata. </p>
  419. <dl class="section see"><dt>See also</dt><dd>GRPC_WRITE_LAST_MESSAGE </dd></dl>
  420. </div>
  421. </div>
  422. <a id="a1031b0d61c166df4f2699f56fbba3d0f"></a>
  423. <h2 class="memtitle"><span class="permalink"><a href="#a1031b0d61c166df4f2699f56fbba3d0f">&#9670;&nbsp;</a></span>is_write_through()</h2>
  424. <div class="memitem">
  425. <div class="memproto">
  426. <table class="mlabels">
  427. <tr>
  428. <td class="mlabels-left">
  429. <table class="memname">
  430. <tr>
  431. <td class="memname">bool grpc::WriteOptions::is_write_through </td>
  432. <td>(</td>
  433. <td class="paramname"></td><td>)</td>
  434. <td> const</td>
  435. </tr>
  436. </table>
  437. </td>
  438. <td class="mlabels-right">
  439. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  440. </tr>
  441. </table>
  442. </div><div class="memdoc">
  443. </div>
  444. </div>
  445. <a id="abe3d32a3e5879022e7b8f1c6a7533841"></a>
  446. <h2 class="memtitle"><span class="permalink"><a href="#abe3d32a3e5879022e7b8f1c6a7533841">&#9670;&nbsp;</a></span>operator=()</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::operator= </td>
  455. <td>(</td>
  456. <td class="paramtype">const <a class="el" href="classgrpc_1_1_write_options.html">WriteOptions</a> &amp;&#160;</td>
  457. <td class="paramname"><em>rhs</em></td><td>)</td>
  458. <td></td>
  459. </tr>
  460. </table>
  461. </td>
  462. <td class="mlabels-right">
  463. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  464. </tr>
  465. </table>
  466. </div><div class="memdoc">
  467. </div>
  468. </div>
  469. <a id="aecd282a8c7424e4b0c1a5f512c44b8a8"></a>
  470. <h2 class="memtitle"><span class="permalink"><a href="#aecd282a8c7424e4b0c1a5f512c44b8a8">&#9670;&nbsp;</a></span>set_buffer_hint()</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_buffer_hint </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>Sets flag indicating that the write may be buffered and need not go out on the wire immediately. </p>
  491. <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>
  492. </div>
  493. </div>
  494. <a id="abda047d0f7b1f18fbbfb5f9858c33f9d"></a>
  495. <h2 class="memtitle"><span class="permalink"><a href="#abda047d0f7b1f18fbbfb5f9858c33f9d">&#9670;&nbsp;</a></span>set_corked()</h2>
  496. <div class="memitem">
  497. <div class="memproto">
  498. <table class="mlabels">
  499. <tr>
  500. <td class="mlabels-left">
  501. <table class="memname">
  502. <tr>
  503. <td class="memname"><a class="el" href="classgrpc_1_1_write_options.html">WriteOptions</a>&amp; grpc::WriteOptions::set_corked </td>
  504. <td>(</td>
  505. <td class="paramname"></td><td>)</td>
  506. <td></td>
  507. </tr>
  508. </table>
  509. </td>
  510. <td class="mlabels-right">
  511. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  512. </tr>
  513. </table>
  514. </div><div class="memdoc">
  515. <p>corked bit: aliases set_buffer_hint currently, with the intent that set_buffer_hint will be removed in the future </p>
  516. </div>
  517. </div>
  518. <a id="ad930c28f5c32832e1d48ee30bf0858e3"></a>
  519. <h2 class="memtitle"><span class="permalink"><a href="#ad930c28f5c32832e1d48ee30bf0858e3">&#9670;&nbsp;</a></span>set_last_message()</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_last_message </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>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>
  540. </div>
  541. </div>
  542. <a id="afe5f12d1bf9ed01b7a833458dc889b66"></a>
  543. <h2 class="memtitle"><span class="permalink"><a href="#afe5f12d1bf9ed01b7a833458dc889b66">&#9670;&nbsp;</a></span>set_no_compression()</h2>
  544. <div class="memitem">
  545. <div class="memproto">
  546. <table class="mlabels">
  547. <tr>
  548. <td class="mlabels-left">
  549. <table class="memname">
  550. <tr>
  551. <td class="memname"><a class="el" href="classgrpc_1_1_write_options.html">WriteOptions</a>&amp; grpc::WriteOptions::set_no_compression </td>
  552. <td>(</td>
  553. <td class="paramname"></td><td>)</td>
  554. <td></td>
  555. </tr>
  556. </table>
  557. </td>
  558. <td class="mlabels-right">
  559. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  560. </tr>
  561. </table>
  562. </div><div class="memdoc">
  563. <p>Sets flag for the disabling of compression for the next message write. </p>
  564. <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>
  565. </div>
  566. </div>
  567. <a id="aaa5f7fcba7816c5d6b41b3e62b2b9b58"></a>
  568. <h2 class="memtitle"><span class="permalink"><a href="#aaa5f7fcba7816c5d6b41b3e62b2b9b58">&#9670;&nbsp;</a></span>set_write_through()</h2>
  569. <div class="memitem">
  570. <div class="memproto">
  571. <table class="mlabels">
  572. <tr>
  573. <td class="mlabels-left">
  574. <table class="memname">
  575. <tr>
  576. <td class="memname"><a class="el" href="classgrpc_1_1_write_options.html">WriteOptions</a>&amp; grpc::WriteOptions::set_write_through </td>
  577. <td>(</td>
  578. <td class="paramname"></td><td>)</td>
  579. <td></td>
  580. </tr>
  581. </table>
  582. </td>
  583. <td class="mlabels-right">
  584. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  585. </tr>
  586. </table>
  587. </div><div class="memdoc">
  588. <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>
  589. </div>
  590. </div>
  591. <hr/>The documentation for this class was generated from the following file:<ul>
  592. <li>include/grpcpp/impl/codegen/<a class="el" href="grpcpp_2impl_2codegen_2call_8h_source.html">call.h</a></li>
  593. </ul>
  594. </div><!-- contents -->
  595. <!-- start footer part -->
  596. <hr class="footer"/><address class="footer"><small>
  597. Generated on Tue May 15 2018 17:01:01 for GRPC C++ by &#160;<a href="http://www.doxygen.org/index.html">
  598. <img class="footer" src="doxygen.png" alt="doxygen"/>
  599. </a> 1.8.13
  600. </small></address>
  601. </body>
  602. </html>