classgrpc_1_1internal_1_1_call_op_send_message.html 12 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248
  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::internal::CallOpSendMessage 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="namespacegrpc_1_1internal.html">internal</a></li><li class="navelem"><a class="el" href="classgrpc_1_1internal_1_1_call_op_send_message.html">CallOpSendMessage</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> &#124;
  66. <a href="#pro-methods">Protected Member Functions</a> </div>
  67. <div class="headertitle">
  68. <div class="title">grpc::internal::CallOpSendMessage Class Reference</div> </div>
  69. </div><!--header-->
  70. <div class="contents">
  71. <p><code>#include &lt;<a class="el" href="grpcpp_2impl_2codegen_2call_8h_source.html">call.h</a>&gt;</code></p>
  72. <table class="memberdecls">
  73. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
  74. Public Member Functions</h2></td></tr>
  75. <tr class="memitem:aa01329229f6593fc55f073f92b27dc17"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc_1_1internal_1_1_call_op_send_message.html#aa01329229f6593fc55f073f92b27dc17">CallOpSendMessage</a> ()</td></tr>
  76. <tr class="separator:aa01329229f6593fc55f073f92b27dc17"><td class="memSeparator" colspan="2">&#160;</td></tr>
  77. <tr class="memitem:ac33bee02bc0b6e0892365dc5f50f7f43"><td class="memTemplParams" colspan="2">template&lt;class M &gt; </td></tr>
  78. <tr class="memitem:ac33bee02bc0b6e0892365dc5f50f7f43"><td class="memTemplItemLeft" align="right" valign="top"><a class="el" href="classgrpc_1_1_status.html">Status</a>&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="classgrpc_1_1internal_1_1_call_op_send_message.html#ac33bee02bc0b6e0892365dc5f50f7f43">SendMessage</a> (const M &amp;message, <a class="el" href="classgrpc_1_1_write_options.html">WriteOptions</a> options) <a class="el" href="impl_2codegen_2port__platform_8h.html#aef49047a3be38448a61332117b306686">GRPC_MUST_USE_RESULT</a></td></tr>
  79. <tr class="memdesc:ac33bee02bc0b6e0892365dc5f50f7f43"><td class="mdescLeft">&#160;</td><td class="mdescRight">Send <em>message</em> using <em>options</em> for the write. <a href="#ac33bee02bc0b6e0892365dc5f50f7f43">More...</a><br /></td></tr>
  80. <tr class="separator:ac33bee02bc0b6e0892365dc5f50f7f43"><td class="memSeparator" colspan="2">&#160;</td></tr>
  81. <tr class="memitem:a52db0710a21166b732bf5af66a69ca1f"><td class="memTemplParams" colspan="2">template&lt;class M &gt; </td></tr>
  82. <tr class="memitem:a52db0710a21166b732bf5af66a69ca1f"><td class="memTemplItemLeft" align="right" valign="top"><a class="el" href="classgrpc_1_1_status.html">Status</a>&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="classgrpc_1_1internal_1_1_call_op_send_message.html#a52db0710a21166b732bf5af66a69ca1f">SendMessage</a> (const M &amp;message) <a class="el" href="impl_2codegen_2port__platform_8h.html#aef49047a3be38448a61332117b306686">GRPC_MUST_USE_RESULT</a></td></tr>
  83. <tr class="separator:a52db0710a21166b732bf5af66a69ca1f"><td class="memSeparator" colspan="2">&#160;</td></tr>
  84. </table><table class="memberdecls">
  85. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pro-methods"></a>
  86. Protected Member Functions</h2></td></tr>
  87. <tr class="memitem:a5fea20848b8bddddd5ffc9e410e000d2"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc_1_1internal_1_1_call_op_send_message.html#a5fea20848b8bddddd5ffc9e410e000d2">AddOp</a> (<a class="el" href="structgrpc__op.html">grpc_op</a> *ops, size_t *nops)</td></tr>
  88. <tr class="separator:a5fea20848b8bddddd5ffc9e410e000d2"><td class="memSeparator" colspan="2">&#160;</td></tr>
  89. <tr class="memitem:a7829132b79dacba8f5f1de00978daea8"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc_1_1internal_1_1_call_op_send_message.html#a7829132b79dacba8f5f1de00978daea8">FinishOp</a> (bool *status)</td></tr>
  90. <tr class="separator:a7829132b79dacba8f5f1de00978daea8"><td class="memSeparator" colspan="2">&#160;</td></tr>
  91. </table>
  92. <h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
  93. <a id="aa01329229f6593fc55f073f92b27dc17"></a>
  94. <h2 class="memtitle"><span class="permalink"><a href="#aa01329229f6593fc55f073f92b27dc17">&#9670;&nbsp;</a></span>CallOpSendMessage()</h2>
  95. <div class="memitem">
  96. <div class="memproto">
  97. <table class="mlabels">
  98. <tr>
  99. <td class="mlabels-left">
  100. <table class="memname">
  101. <tr>
  102. <td class="memname">grpc::internal::CallOpSendMessage::CallOpSendMessage </td>
  103. <td>(</td>
  104. <td class="paramname"></td><td>)</td>
  105. <td></td>
  106. </tr>
  107. </table>
  108. </td>
  109. <td class="mlabels-right">
  110. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  111. </tr>
  112. </table>
  113. </div><div class="memdoc">
  114. </div>
  115. </div>
  116. <h2 class="groupheader">Member Function Documentation</h2>
  117. <a id="a5fea20848b8bddddd5ffc9e410e000d2"></a>
  118. <h2 class="memtitle"><span class="permalink"><a href="#a5fea20848b8bddddd5ffc9e410e000d2">&#9670;&nbsp;</a></span>AddOp()</h2>
  119. <div class="memitem">
  120. <div class="memproto">
  121. <table class="mlabels">
  122. <tr>
  123. <td class="mlabels-left">
  124. <table class="memname">
  125. <tr>
  126. <td class="memname">void grpc::internal::CallOpSendMessage::AddOp </td>
  127. <td>(</td>
  128. <td class="paramtype"><a class="el" href="structgrpc__op.html">grpc_op</a> *&#160;</td>
  129. <td class="paramname"><em>ops</em>, </td>
  130. </tr>
  131. <tr>
  132. <td class="paramkey"></td>
  133. <td></td>
  134. <td class="paramtype">size_t *&#160;</td>
  135. <td class="paramname"><em>nops</em>&#160;</td>
  136. </tr>
  137. <tr>
  138. <td></td>
  139. <td>)</td>
  140. <td></td><td></td>
  141. </tr>
  142. </table>
  143. </td>
  144. <td class="mlabels-right">
  145. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">protected</span></span> </td>
  146. </tr>
  147. </table>
  148. </div><div class="memdoc">
  149. </div>
  150. </div>
  151. <a id="a7829132b79dacba8f5f1de00978daea8"></a>
  152. <h2 class="memtitle"><span class="permalink"><a href="#a7829132b79dacba8f5f1de00978daea8">&#9670;&nbsp;</a></span>FinishOp()</h2>
  153. <div class="memitem">
  154. <div class="memproto">
  155. <table class="mlabels">
  156. <tr>
  157. <td class="mlabels-left">
  158. <table class="memname">
  159. <tr>
  160. <td class="memname">void grpc::internal::CallOpSendMessage::FinishOp </td>
  161. <td>(</td>
  162. <td class="paramtype">bool *&#160;</td>
  163. <td class="paramname"><em>status</em></td><td>)</td>
  164. <td></td>
  165. </tr>
  166. </table>
  167. </td>
  168. <td class="mlabels-right">
  169. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">protected</span></span> </td>
  170. </tr>
  171. </table>
  172. </div><div class="memdoc">
  173. </div>
  174. </div>
  175. <a id="ac33bee02bc0b6e0892365dc5f50f7f43"></a>
  176. <h2 class="memtitle"><span class="permalink"><a href="#ac33bee02bc0b6e0892365dc5f50f7f43">&#9670;&nbsp;</a></span>SendMessage() <span class="overload">[1/2]</span></h2>
  177. <div class="memitem">
  178. <div class="memproto">
  179. <div class="memtemplate">
  180. template&lt;class M &gt; </div>
  181. <table class="memname">
  182. <tr>
  183. <td class="memname"><a class="el" href="classgrpc_1_1_status.html">Status</a> grpc::internal::CallOpSendMessage::SendMessage </td>
  184. <td>(</td>
  185. <td class="paramtype">const M &amp;&#160;</td>
  186. <td class="paramname"><em>message</em>, </td>
  187. </tr>
  188. <tr>
  189. <td class="paramkey"></td>
  190. <td></td>
  191. <td class="paramtype"><a class="el" href="classgrpc_1_1_write_options.html">WriteOptions</a>&#160;</td>
  192. <td class="paramname"><em>options</em>&#160;</td>
  193. </tr>
  194. <tr>
  195. <td></td>
  196. <td>)</td>
  197. <td></td><td></td>
  198. </tr>
  199. </table>
  200. </div><div class="memdoc">
  201. <p>Send <em>message</em> using <em>options</em> for the write. </p>
  202. <p>The <em>options</em> are cleared after use. </p>
  203. </div>
  204. </div>
  205. <a id="a52db0710a21166b732bf5af66a69ca1f"></a>
  206. <h2 class="memtitle"><span class="permalink"><a href="#a52db0710a21166b732bf5af66a69ca1f">&#9670;&nbsp;</a></span>SendMessage() <span class="overload">[2/2]</span></h2>
  207. <div class="memitem">
  208. <div class="memproto">
  209. <div class="memtemplate">
  210. template&lt;class M &gt; </div>
  211. <table class="memname">
  212. <tr>
  213. <td class="memname"><a class="el" href="classgrpc_1_1_status.html">Status</a> grpc::internal::CallOpSendMessage::SendMessage </td>
  214. <td>(</td>
  215. <td class="paramtype">const M &amp;&#160;</td>
  216. <td class="paramname"><em>message</em></td><td>)</td>
  217. <td></td>
  218. </tr>
  219. </table>
  220. </div><div class="memdoc">
  221. </div>
  222. </div>
  223. <hr/>The documentation for this class was generated from the following file:<ul>
  224. <li>include/grpcpp/impl/codegen/<a class="el" href="grpcpp_2impl_2codegen_2call_8h_source.html">call.h</a></li>
  225. </ul>
  226. </div><!-- contents -->
  227. <!-- start footer part -->
  228. <hr class="footer"/><address class="footer"><small>
  229. Generated on Tue May 15 2018 17:01:01 for GRPC C++ by &#160;<a href="http://www.doxygen.org/index.html">
  230. <img class="footer" src="doxygen.png" alt="doxygen"/>
  231. </a> 1.8.13
  232. </small></address>
  233. </body>
  234. </html>