classgrpc_1_1_call_op_set_interface.html 18 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297
  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.11"/>
  7. <title>GRPC C++: grpc::CallOpSetInterface 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/searchdata.js"></script>
  13. <script type="text/javascript" src="search/search.js"></script>
  14. <script type="text/javascript">
  15. $(document).ready(function() { init_search(); });
  16. </script>
  17. <link href="doxygen.css" rel="stylesheet" type="text/css" />
  18. </head>
  19. <body>
  20. <div id="top"><!-- do not remove this div, it is closed by doxygen! -->
  21. <div id="titlearea">
  22. <table cellspacing="0" cellpadding="0">
  23. <tbody>
  24. <tr style="height: 56px;">
  25. <td id="projectalign" style="padding-left: 0.5em;">
  26. <div id="projectname">GRPC C++
  27. &#160;<span id="projectnumber">1.0.0</span>
  28. </div>
  29. </td>
  30. </tr>
  31. </tbody>
  32. </table>
  33. </div>
  34. <!-- end header part -->
  35. <!-- Generated by Doxygen 1.8.11 -->
  36. <script type="text/javascript">
  37. var searchBox = new SearchBox("searchBox", "search",false,'Search');
  38. </script>
  39. <div id="navrow1" class="tabs">
  40. <ul class="tablist">
  41. <li><a href="index.html"><span>Main&#160;Page</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. </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_call_op_set_interface.html">CallOpSetInterface</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> &#124;
  92. <a href="#pro-attribs">Protected Attributes</a> </div>
  93. <div class="headertitle">
  94. <div class="title">grpc::CallOpSetInterface Class Reference<span class="mlabels"><span class="mlabel">abstract</span></span></div> </div>
  95. </div><!--header-->
  96. <div class="contents">
  97. <p>An abstract collection of call ops, used to generate the grpc_call_op structure to pass down to the lower layers, and as it is-a <a class="el" href="classgrpc_1_1_completion_queue_tag.html" title="An interface allowing implementors to process and filter event tags. ">CompletionQueueTag</a>, also massages the final completion into the correct form for consumption in the C++ API.
  98. <a href="classgrpc_1_1_call_op_set_interface.html#details">More...</a></p>
  99. <p><code>#include &lt;<a class="el" href="codegen_2call_8h_source.html">call.h</a>&gt;</code></p>
  100. <table class="memberdecls">
  101. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
  102. Public Member Functions</h2></td></tr>
  103. <tr class="memitem:ad331a10c0fd65f5a9db680e95682f000"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc_1_1_call_op_set_interface.html#ad331a10c0fd65f5a9db680e95682f000">CallOpSetInterface</a> ()</td></tr>
  104. <tr class="separator:ad331a10c0fd65f5a9db680e95682f000"><td class="memSeparator" colspan="2">&#160;</td></tr>
  105. <tr class="memitem:ae0c95dfc28fc2a0add3e3bec1a703874"><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc_1_1_call_op_set_interface.html#ae0c95dfc28fc2a0add3e3bec1a703874">FillOps</a> (<a class="el" href="structgrpc__op.html">grpc_op</a> *ops, size_t *nops)=0</td></tr>
  106. <tr class="memdesc:ae0c95dfc28fc2a0add3e3bec1a703874"><td class="mdescLeft">&#160;</td><td class="mdescRight">Fills in <a class="el" href="structgrpc__op.html" title="Operation data: one field for each op type (except SEND_CLOSE_FROM_CLIENT which has no arguments) ...">grpc_op</a>, starting from ops[*nops] and moving upwards. <a href="#ae0c95dfc28fc2a0add3e3bec1a703874">More...</a><br /></td></tr>
  107. <tr class="separator:ae0c95dfc28fc2a0add3e3bec1a703874"><td class="memSeparator" colspan="2">&#160;</td></tr>
  108. <tr class="memitem:ac1e3a95ce9a1727011b7e7ce76829f0a"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc_1_1_call_op_set_interface.html#ac1e3a95ce9a1727011b7e7ce76829f0a">set_max_message_size</a> (int max_message_size)</td></tr>
  109. <tr class="separator:ac1e3a95ce9a1727011b7e7ce76829f0a"><td class="memSeparator" colspan="2">&#160;</td></tr>
  110. <tr class="memitem:a7c0e4962b0ddc592cbc6469442c38268"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc_1_1_call_op_set_interface.html#a7c0e4962b0ddc592cbc6469442c38268">SetCollection</a> (std::shared_ptr&lt; <a class="el" href="classgrpc_1_1_call_op_set_collection_interface.html">CallOpSetCollectionInterface</a> &gt; collection)</td></tr>
  111. <tr class="memdesc:a7c0e4962b0ddc592cbc6469442c38268"><td class="mdescLeft">&#160;</td><td class="mdescRight">Mark this as belonging to a collection if needed. <a href="#a7c0e4962b0ddc592cbc6469442c38268">More...</a><br /></td></tr>
  112. <tr class="separator:a7c0e4962b0ddc592cbc6469442c38268"><td class="memSeparator" colspan="2">&#160;</td></tr>
  113. <tr class="inherit_header pub_methods_classgrpc_1_1_completion_queue_tag"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_classgrpc_1_1_completion_queue_tag')"><img src="closed.png" alt="-"/>&#160;Public Member Functions inherited from <a class="el" href="classgrpc_1_1_completion_queue_tag.html">grpc::CompletionQueueTag</a></td></tr>
  114. <tr class="memitem:a2cbf0212ed795c79f98c3421ed0cb4ab inherit pub_methods_classgrpc_1_1_completion_queue_tag"><td class="memItemLeft" align="right" valign="top">virtual&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc_1_1_completion_queue_tag.html#a2cbf0212ed795c79f98c3421ed0cb4ab">~CompletionQueueTag</a> ()</td></tr>
  115. <tr class="separator:a2cbf0212ed795c79f98c3421ed0cb4ab inherit pub_methods_classgrpc_1_1_completion_queue_tag"><td class="memSeparator" colspan="2">&#160;</td></tr>
  116. <tr class="memitem:af7b1abfcd9e506d118dfdcf29ce7fe8d inherit pub_methods_classgrpc_1_1_completion_queue_tag"><td class="memItemLeft" align="right" valign="top">virtual bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc_1_1_completion_queue_tag.html#af7b1abfcd9e506d118dfdcf29ce7fe8d">FinalizeResult</a> (void **tag, bool *status)=0</td></tr>
  117. <tr class="separator:af7b1abfcd9e506d118dfdcf29ce7fe8d inherit pub_methods_classgrpc_1_1_completion_queue_tag"><td class="memSeparator" colspan="2">&#160;</td></tr>
  118. </table><table class="memberdecls">
  119. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pro-attribs"></a>
  120. Protected Attributes</h2></td></tr>
  121. <tr class="memitem:a06354e63efdbbd34fa18270490aaabbf"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc_1_1_call_op_set_interface.html#a06354e63efdbbd34fa18270490aaabbf">max_message_size_</a></td></tr>
  122. <tr class="separator:a06354e63efdbbd34fa18270490aaabbf"><td class="memSeparator" colspan="2">&#160;</td></tr>
  123. <tr class="memitem:a74088df7daa571675fd994dbe3ad8b40"><td class="memItemLeft" align="right" valign="top">std::shared_ptr&lt; <a class="el" href="classgrpc_1_1_call_op_set_collection_interface.html">CallOpSetCollectionInterface</a> &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc_1_1_call_op_set_interface.html#a74088df7daa571675fd994dbe3ad8b40">collection_</a></td></tr>
  124. <tr class="separator:a74088df7daa571675fd994dbe3ad8b40"><td class="memSeparator" colspan="2">&#160;</td></tr>
  125. </table>
  126. <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
  127. <div class="textblock"><p>An abstract collection of call ops, used to generate the grpc_call_op structure to pass down to the lower layers, and as it is-a <a class="el" href="classgrpc_1_1_completion_queue_tag.html" title="An interface allowing implementors to process and filter event tags. ">CompletionQueueTag</a>, also massages the final completion into the correct form for consumption in the C++ API. </p>
  128. </div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
  129. <a class="anchor" id="ad331a10c0fd65f5a9db680e95682f000"></a>
  130. <div class="memitem">
  131. <div class="memproto">
  132. <table class="mlabels">
  133. <tr>
  134. <td class="mlabels-left">
  135. <table class="memname">
  136. <tr>
  137. <td class="memname">grpc::CallOpSetInterface::CallOpSetInterface </td>
  138. <td>(</td>
  139. <td class="paramname"></td><td>)</td>
  140. <td></td>
  141. </tr>
  142. </table>
  143. </td>
  144. <td class="mlabels-right">
  145. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  146. </tr>
  147. </table>
  148. </div><div class="memdoc">
  149. </div>
  150. </div>
  151. <h2 class="groupheader">Member Function Documentation</h2>
  152. <a class="anchor" id="ae0c95dfc28fc2a0add3e3bec1a703874"></a>
  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">virtual void grpc::CallOpSetInterface::FillOps </td>
  161. <td>(</td>
  162. <td class="paramtype"><a class="el" href="structgrpc__op.html">grpc_op</a> *&#160;</td>
  163. <td class="paramname"><em>ops</em>, </td>
  164. </tr>
  165. <tr>
  166. <td class="paramkey"></td>
  167. <td></td>
  168. <td class="paramtype">size_t *&#160;</td>
  169. <td class="paramname"><em>nops</em>&#160;</td>
  170. </tr>
  171. <tr>
  172. <td></td>
  173. <td>)</td>
  174. <td></td><td></td>
  175. </tr>
  176. </table>
  177. </td>
  178. <td class="mlabels-right">
  179. <span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
  180. </tr>
  181. </table>
  182. </div><div class="memdoc">
  183. <p>Fills in <a class="el" href="structgrpc__op.html" title="Operation data: one field for each op type (except SEND_CLOSE_FROM_CLIENT which has no arguments) ...">grpc_op</a>, starting from ops[*nops] and moving upwards. </p>
  184. <p>Implemented in <a class="el" href="classgrpc_1_1_call_op_set.html#a886b55145cdad0994ec589b4f4c7df9c">grpc::CallOpSet&lt; Op1, Op2, Op3, Op4, Op5, Op6 &gt;</a>, <a class="el" href="classgrpc_1_1_call_op_set.html#a886b55145cdad0994ec589b4f4c7df9c">grpc::CallOpSet&lt; grpc::CallOpRecvInitialMetadata, grpc::CallOpRecvMessage&lt; R &gt;, grpc::CallOpClientRecvStatus &gt;</a>, <a class="el" href="classgrpc_1_1_call_op_set.html#a886b55145cdad0994ec589b4f4c7df9c">grpc::CallOpSet&lt; grpc::CallOpSendInitialMetadata, grpc::CallOpSendMessage &gt;</a>, <a class="el" href="classgrpc_1_1_call_op_set.html#a886b55145cdad0994ec589b4f4c7df9c">grpc::CallOpSet&lt; grpc::CallOpSendInitialMetadata &gt;</a>, <a class="el" href="classgrpc_1_1_call_op_set.html#a886b55145cdad0994ec589b4f4c7df9c">grpc::CallOpSet&lt; grpc::CallOpClientSendClose &gt;</a>, <a class="el" href="classgrpc_1_1_call_op_set.html#a886b55145cdad0994ec589b4f4c7df9c">grpc::CallOpSet&lt; grpc::CallOpSendInitialMetadata, grpc::CallOpSendMessage, grpc::CallOpServerSendStatus &gt;</a>, <a class="el" href="classgrpc_1_1_call_op_set.html#a886b55145cdad0994ec589b4f4c7df9c">grpc::CallOpSet&lt; grpc::CallOpSendInitialMetadata, grpc::CallOpServerSendStatus &gt;</a>, <a class="el" href="classgrpc_1_1_call_op_set.html#a886b55145cdad0994ec589b4f4c7df9c">grpc::CallOpSet&lt; grpc::CallOpSendMessage &gt;</a>, <a class="el" href="classgrpc_1_1_call_op_set.html#a886b55145cdad0994ec589b4f4c7df9c">grpc::CallOpSet&lt; grpc::CallOpRecvInitialMetadata &gt;</a>, <a class="el" href="classgrpc_1_1_call_op_set.html#a886b55145cdad0994ec589b4f4c7df9c">grpc::CallOpSet&lt; grpc::CallOpSendInitialMetadata, grpc::CallOpSendMessage, grpc::CallOpClientSendClose, CallNoOp&lt; 4 &gt;, CallNoOp&lt; 5 &gt;, CallNoOp&lt; 6 &gt; &gt;</a>, <a class="el" href="classgrpc_1_1_call_op_set.html#a886b55145cdad0994ec589b4f4c7df9c">grpc::CallOpSet&lt; grpc::CallOpRecvInitialMetadata, grpc::CallOpClientRecvStatus &gt;</a>, <a class="el" href="classgrpc_1_1_call_op_set.html#a886b55145cdad0994ec589b4f4c7df9c">grpc::CallOpSet&lt; grpc::CallOpRecvMessage&lt; R &gt; &gt;</a>, <a class="el" href="classgrpc_1_1_call_op_set.html#a886b55145cdad0994ec589b4f4c7df9c">grpc::CallOpSet&lt; grpc::CallOpRecvInitialMetadata, grpc::CallOpGenericRecvMessage, grpc::CallOpClientRecvStatus &gt;</a>, <a class="el" href="classgrpc_1_1_call_op_set.html#a886b55145cdad0994ec589b4f4c7df9c">grpc::CallOpSet&lt; grpc::CallOpSendInitialMetadata, grpc::CallOpSendMessage, grpc::CallOpClientSendClose &gt;</a>, and <a class="el" href="classgrpc_1_1_call_op_set.html#a886b55145cdad0994ec589b4f4c7df9c">grpc::CallOpSet&lt; grpc::CallOpRecvInitialMetadata, grpc::CallOpRecvMessage&lt; R &gt; &gt;</a>.</p>
  185. </div>
  186. </div>
  187. <a class="anchor" id="ac1e3a95ce9a1727011b7e7ce76829f0a"></a>
  188. <div class="memitem">
  189. <div class="memproto">
  190. <table class="mlabels">
  191. <tr>
  192. <td class="mlabels-left">
  193. <table class="memname">
  194. <tr>
  195. <td class="memname">void grpc::CallOpSetInterface::set_max_message_size </td>
  196. <td>(</td>
  197. <td class="paramtype">int&#160;</td>
  198. <td class="paramname"><em>max_message_size</em></td><td>)</td>
  199. <td></td>
  200. </tr>
  201. </table>
  202. </td>
  203. <td class="mlabels-right">
  204. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  205. </tr>
  206. </table>
  207. </div><div class="memdoc">
  208. </div>
  209. </div>
  210. <a class="anchor" id="a7c0e4962b0ddc592cbc6469442c38268"></a>
  211. <div class="memitem">
  212. <div class="memproto">
  213. <table class="mlabels">
  214. <tr>
  215. <td class="mlabels-left">
  216. <table class="memname">
  217. <tr>
  218. <td class="memname">void grpc::CallOpSetInterface::SetCollection </td>
  219. <td>(</td>
  220. <td class="paramtype">std::shared_ptr&lt; <a class="el" href="classgrpc_1_1_call_op_set_collection_interface.html">CallOpSetCollectionInterface</a> &gt;&#160;</td>
  221. <td class="paramname"><em>collection</em></td><td>)</td>
  222. <td></td>
  223. </tr>
  224. </table>
  225. </td>
  226. <td class="mlabels-right">
  227. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  228. </tr>
  229. </table>
  230. </div><div class="memdoc">
  231. <p>Mark this as belonging to a collection if needed. </p>
  232. </div>
  233. </div>
  234. <h2 class="groupheader">Field Documentation</h2>
  235. <a class="anchor" id="a74088df7daa571675fd994dbe3ad8b40"></a>
  236. <div class="memitem">
  237. <div class="memproto">
  238. <table class="mlabels">
  239. <tr>
  240. <td class="mlabels-left">
  241. <table class="memname">
  242. <tr>
  243. <td class="memname">std::shared_ptr&lt;<a class="el" href="classgrpc_1_1_call_op_set_collection_interface.html">CallOpSetCollectionInterface</a>&gt; grpc::CallOpSetInterface::collection_</td>
  244. </tr>
  245. </table>
  246. </td>
  247. <td class="mlabels-right">
  248. <span class="mlabels"><span class="mlabel">protected</span></span> </td>
  249. </tr>
  250. </table>
  251. </div><div class="memdoc">
  252. </div>
  253. </div>
  254. <a class="anchor" id="a06354e63efdbbd34fa18270490aaabbf"></a>
  255. <div class="memitem">
  256. <div class="memproto">
  257. <table class="mlabels">
  258. <tr>
  259. <td class="mlabels-left">
  260. <table class="memname">
  261. <tr>
  262. <td class="memname">int grpc::CallOpSetInterface::max_message_size_</td>
  263. </tr>
  264. </table>
  265. </td>
  266. <td class="mlabels-right">
  267. <span class="mlabels"><span class="mlabel">protected</span></span> </td>
  268. </tr>
  269. </table>
  270. </div><div class="memdoc">
  271. </div>
  272. </div>
  273. <hr/>The documentation for this class was generated from the following file:<ul>
  274. <li>include/grpc++/impl/codegen/<a class="el" href="codegen_2call_8h_source.html">call.h</a></li>
  275. </ul>
  276. </div><!-- contents -->
  277. <!-- start footer part -->
  278. <hr class="footer"/><address class="footer"><small>
  279. Generated on Thu Aug 18 2016 21:34:58 for GRPC C++ by &#160;<a href="http://www.doxygen.org/index.html">
  280. <img class="footer" src="doxygen.png" alt="doxygen"/>
  281. </a> 1.8.11
  282. </small></address>
  283. </body>
  284. </html>