classgrpc_1_1_call_op_set.html 18 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285
  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::CallOpSet&lt; Op1, Op2, Op3, Op4, Op5, Op6 &gt; Class Template 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.html">CallOpSet</a></li> </ul>
  87. </div>
  88. </div><!-- top -->
  89. <div class="header">
  90. <div class="summary">
  91. <a href="#pub-methods">Public Member Functions</a> </div>
  92. <div class="headertitle">
  93. <div class="title">grpc::CallOpSet&lt; Op1, Op2, Op3, Op4, Op5, Op6 &gt; Class Template Reference</div> </div>
  94. </div><!--header-->
  95. <div class="contents">
  96. <p>Primary implementaiton of <a class="el" href="classgrpc_1_1_call_op_set_interface.html" title="An abstract collection of call ops, used to generate the grpc_call_op structure to pass down to the l...">CallOpSetInterface</a>.
  97. <a href="classgrpc_1_1_call_op_set.html#details">More...</a></p>
  98. <p><code>#include &lt;<a class="el" href="codegen_2call_8h_source.html">call.h</a>&gt;</code></p>
  99. <table class="memberdecls">
  100. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
  101. Public Member Functions</h2></td></tr>
  102. <tr class="memitem:ae06e1a2d051b6b404eec88c4be303bcf"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc_1_1_call_op_set.html#ae06e1a2d051b6b404eec88c4be303bcf">CallOpSet</a> ()</td></tr>
  103. <tr class="separator:ae06e1a2d051b6b404eec88c4be303bcf"><td class="memSeparator" colspan="2">&#160;</td></tr>
  104. <tr class="memitem:a886b55145cdad0994ec589b4f4c7df9c"><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.html#a886b55145cdad0994ec589b4f4c7df9c">FillOps</a> (<a class="el" href="structgrpc__op.html">grpc_op</a> *ops, size_t *nops) <a class="el" href="impl_2codegen_2config_8h.html#a9a884d706be26697c9c892365a3402a9">GRPC_OVERRIDE</a></td></tr>
  105. <tr class="memdesc:a886b55145cdad0994ec589b4f4c7df9c"><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="#a886b55145cdad0994ec589b4f4c7df9c">More...</a><br /></td></tr>
  106. <tr class="separator:a886b55145cdad0994ec589b4f4c7df9c"><td class="memSeparator" colspan="2">&#160;</td></tr>
  107. <tr class="memitem:a66575110fdb84b974182154a01464180"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc_1_1_call_op_set.html#a66575110fdb84b974182154a01464180">FinalizeResult</a> (void **tag, bool *status) <a class="el" href="impl_2codegen_2config_8h.html#a9a884d706be26697c9c892365a3402a9">GRPC_OVERRIDE</a></td></tr>
  108. <tr class="separator:a66575110fdb84b974182154a01464180"><td class="memSeparator" colspan="2">&#160;</td></tr>
  109. <tr class="memitem:a798d253af317730a5b996a4a55d86274"><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.html#a798d253af317730a5b996a4a55d86274">set_output_tag</a> (void *return_tag)</td></tr>
  110. <tr class="separator:a798d253af317730a5b996a4a55d86274"><td class="memSeparator" colspan="2">&#160;</td></tr>
  111. <tr class="inherit_header pub_methods_classgrpc_1_1_call_op_set_interface"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_classgrpc_1_1_call_op_set_interface')"><img src="closed.png" alt="-"/>&#160;Public Member Functions inherited from <a class="el" href="classgrpc_1_1_call_op_set_interface.html">grpc::CallOpSetInterface</a></td></tr>
  112. <tr class="memitem:ad331a10c0fd65f5a9db680e95682f000 inherit pub_methods_classgrpc_1_1_call_op_set_interface"><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>
  113. <tr class="separator:ad331a10c0fd65f5a9db680e95682f000 inherit pub_methods_classgrpc_1_1_call_op_set_interface"><td class="memSeparator" colspan="2">&#160;</td></tr>
  114. <tr class="memitem:ac1e3a95ce9a1727011b7e7ce76829f0a inherit pub_methods_classgrpc_1_1_call_op_set_interface"><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>
  115. <tr class="separator:ac1e3a95ce9a1727011b7e7ce76829f0a inherit pub_methods_classgrpc_1_1_call_op_set_interface"><td class="memSeparator" colspan="2">&#160;</td></tr>
  116. <tr class="memitem:a7c0e4962b0ddc592cbc6469442c38268 inherit pub_methods_classgrpc_1_1_call_op_set_interface"><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>
  117. <tr class="memdesc:a7c0e4962b0ddc592cbc6469442c38268 inherit pub_methods_classgrpc_1_1_call_op_set_interface"><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>
  118. <tr class="separator:a7c0e4962b0ddc592cbc6469442c38268 inherit pub_methods_classgrpc_1_1_call_op_set_interface"><td class="memSeparator" colspan="2">&#160;</td></tr>
  119. <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>
  120. <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>
  121. <tr class="separator:a2cbf0212ed795c79f98c3421ed0cb4ab inherit pub_methods_classgrpc_1_1_completion_queue_tag"><td class="memSeparator" colspan="2">&#160;</td></tr>
  122. </table><table class="memberdecls">
  123. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="inherited"></a>
  124. Additional Inherited Members</h2></td></tr>
  125. <tr class="inherit_header pro_attribs_classgrpc_1_1_call_op_set_interface"><td colspan="2" onclick="javascript:toggleInherit('pro_attribs_classgrpc_1_1_call_op_set_interface')"><img src="closed.png" alt="-"/>&#160;Protected Attributes inherited from <a class="el" href="classgrpc_1_1_call_op_set_interface.html">grpc::CallOpSetInterface</a></td></tr>
  126. <tr class="memitem:a06354e63efdbbd34fa18270490aaabbf inherit pro_attribs_classgrpc_1_1_call_op_set_interface"><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>
  127. <tr class="separator:a06354e63efdbbd34fa18270490aaabbf inherit pro_attribs_classgrpc_1_1_call_op_set_interface"><td class="memSeparator" colspan="2">&#160;</td></tr>
  128. <tr class="memitem:a74088df7daa571675fd994dbe3ad8b40 inherit pro_attribs_classgrpc_1_1_call_op_set_interface"><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>
  129. <tr class="separator:a74088df7daa571675fd994dbe3ad8b40 inherit pro_attribs_classgrpc_1_1_call_op_set_interface"><td class="memSeparator" colspan="2">&#160;</td></tr>
  130. </table>
  131. <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
  132. <div class="textblock"><h3>template&lt;class Op1 = CallNoOp&lt;1&gt;, class Op2 = CallNoOp&lt;2&gt;, class Op3 = CallNoOp&lt;3&gt;, class Op4 = CallNoOp&lt;4&gt;, class Op5 = CallNoOp&lt;5&gt;, class Op6 = CallNoOp&lt;6&gt;&gt;<br />
  133. class grpc::CallOpSet&lt; Op1, Op2, Op3, Op4, Op5, Op6 &gt;</h3>
  134. <p>Primary implementaiton of <a class="el" href="classgrpc_1_1_call_op_set_interface.html" title="An abstract collection of call ops, used to generate the grpc_call_op structure to pass down to the l...">CallOpSetInterface</a>. </p>
  135. <p>Since we cannot use variadic templates, we declare slots up to the maximum count of ops we'll need in a set. We leverage the empty base class optimization to slim this class (especially when there are many unused slots used). To avoid duplicate base classes, the template parmeter for <a class="el" href="classgrpc_1_1_call_no_op.html" title="Default argument for CallOpSet. ">CallNoOp</a> is varied by argument position. </p>
  136. </div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
  137. <a class="anchor" id="ae06e1a2d051b6b404eec88c4be303bcf"></a>
  138. <div class="memitem">
  139. <div class="memproto">
  140. <div class="memtemplate">
  141. template&lt;class Op1 = CallNoOp&lt;1&gt;, class Op2 = CallNoOp&lt;2&gt;, class Op3 = CallNoOp&lt;3&gt;, class Op4 = CallNoOp&lt;4&gt;, class Op5 = CallNoOp&lt;5&gt;, class Op6 = CallNoOp&lt;6&gt;&gt; </div>
  142. <table class="mlabels">
  143. <tr>
  144. <td class="mlabels-left">
  145. <table class="memname">
  146. <tr>
  147. <td class="memname"><a class="el" href="classgrpc_1_1_call_op_set.html">grpc::CallOpSet</a>&lt; Op1, Op2, Op3, Op4, Op5, Op6 &gt;::<a class="el" href="classgrpc_1_1_call_op_set.html">CallOpSet</a> </td>
  148. <td>(</td>
  149. <td class="paramname"></td><td>)</td>
  150. <td></td>
  151. </tr>
  152. </table>
  153. </td>
  154. <td class="mlabels-right">
  155. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  156. </tr>
  157. </table>
  158. </div><div class="memdoc">
  159. </div>
  160. </div>
  161. <h2 class="groupheader">Member Function Documentation</h2>
  162. <a class="anchor" id="a886b55145cdad0994ec589b4f4c7df9c"></a>
  163. <div class="memitem">
  164. <div class="memproto">
  165. <div class="memtemplate">
  166. template&lt;class Op1 = CallNoOp&lt;1&gt;, class Op2 = CallNoOp&lt;2&gt;, class Op3 = CallNoOp&lt;3&gt;, class Op4 = CallNoOp&lt;4&gt;, class Op5 = CallNoOp&lt;5&gt;, class Op6 = CallNoOp&lt;6&gt;&gt; </div>
  167. <table class="mlabels">
  168. <tr>
  169. <td class="mlabels-left">
  170. <table class="memname">
  171. <tr>
  172. <td class="memname">void <a class="el" href="classgrpc_1_1_call_op_set.html">grpc::CallOpSet</a>&lt; Op1, Op2, Op3, Op4, Op5, Op6 &gt;::FillOps </td>
  173. <td>(</td>
  174. <td class="paramtype"><a class="el" href="structgrpc__op.html">grpc_op</a> *&#160;</td>
  175. <td class="paramname"><em>ops</em>, </td>
  176. </tr>
  177. <tr>
  178. <td class="paramkey"></td>
  179. <td></td>
  180. <td class="paramtype">size_t *&#160;</td>
  181. <td class="paramname"><em>nops</em>&#160;</td>
  182. </tr>
  183. <tr>
  184. <td></td>
  185. <td>)</td>
  186. <td></td><td></td>
  187. </tr>
  188. </table>
  189. </td>
  190. <td class="mlabels-right">
  191. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">virtual</span></span> </td>
  192. </tr>
  193. </table>
  194. </div><div class="memdoc">
  195. <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>
  196. <p>Implements <a class="el" href="classgrpc_1_1_call_op_set_interface.html#ae0c95dfc28fc2a0add3e3bec1a703874">grpc::CallOpSetInterface</a>.</p>
  197. </div>
  198. </div>
  199. <a class="anchor" id="a66575110fdb84b974182154a01464180"></a>
  200. <div class="memitem">
  201. <div class="memproto">
  202. <div class="memtemplate">
  203. template&lt;class Op1 = CallNoOp&lt;1&gt;, class Op2 = CallNoOp&lt;2&gt;, class Op3 = CallNoOp&lt;3&gt;, class Op4 = CallNoOp&lt;4&gt;, class Op5 = CallNoOp&lt;5&gt;, class Op6 = CallNoOp&lt;6&gt;&gt; </div>
  204. <table class="mlabels">
  205. <tr>
  206. <td class="mlabels-left">
  207. <table class="memname">
  208. <tr>
  209. <td class="memname">bool <a class="el" href="classgrpc_1_1_call_op_set.html">grpc::CallOpSet</a>&lt; Op1, Op2, Op3, Op4, Op5, Op6 &gt;::FinalizeResult </td>
  210. <td>(</td>
  211. <td class="paramtype">void **&#160;</td>
  212. <td class="paramname"><em>tag</em>, </td>
  213. </tr>
  214. <tr>
  215. <td class="paramkey"></td>
  216. <td></td>
  217. <td class="paramtype">bool *&#160;</td>
  218. <td class="paramname"><em>status</em>&#160;</td>
  219. </tr>
  220. <tr>
  221. <td></td>
  222. <td>)</td>
  223. <td></td><td></td>
  224. </tr>
  225. </table>
  226. </td>
  227. <td class="mlabels-right">
  228. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">virtual</span></span> </td>
  229. </tr>
  230. </table>
  231. </div><div class="memdoc">
  232. <p>Implements <a class="el" href="classgrpc_1_1_completion_queue_tag.html#af7b1abfcd9e506d118dfdcf29ce7fe8d">grpc::CompletionQueueTag</a>.</p>
  233. <p>Reimplemented in <a class="el" href="classgrpc_1_1_sneaky_call_op_set.html#a0ade5b329d43a4002388bac90a8bbafd">grpc::SneakyCallOpSet&lt; Op1, Op2, Op3, Op4, Op5, Op6 &gt;</a>, and <a class="el" href="classgrpc_1_1_sneaky_call_op_set.html#a0ade5b329d43a4002388bac90a8bbafd">grpc::SneakyCallOpSet&lt; grpc::CallOpSendInitialMetadata, grpc::CallOpSendMessage, grpc::CallOpClientSendClose &gt;</a>.</p>
  234. </div>
  235. </div>
  236. <a class="anchor" id="a798d253af317730a5b996a4a55d86274"></a>
  237. <div class="memitem">
  238. <div class="memproto">
  239. <div class="memtemplate">
  240. template&lt;class Op1 = CallNoOp&lt;1&gt;, class Op2 = CallNoOp&lt;2&gt;, class Op3 = CallNoOp&lt;3&gt;, class Op4 = CallNoOp&lt;4&gt;, class Op5 = CallNoOp&lt;5&gt;, class Op6 = CallNoOp&lt;6&gt;&gt; </div>
  241. <table class="mlabels">
  242. <tr>
  243. <td class="mlabels-left">
  244. <table class="memname">
  245. <tr>
  246. <td class="memname">void <a class="el" href="classgrpc_1_1_call_op_set.html">grpc::CallOpSet</a>&lt; Op1, Op2, Op3, Op4, Op5, Op6 &gt;::set_output_tag </td>
  247. <td>(</td>
  248. <td class="paramtype">void *&#160;</td>
  249. <td class="paramname"><em>return_tag</em></td><td>)</td>
  250. <td></td>
  251. </tr>
  252. </table>
  253. </td>
  254. <td class="mlabels-right">
  255. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  256. </tr>
  257. </table>
  258. </div><div class="memdoc">
  259. </div>
  260. </div>
  261. <hr/>The documentation for this class was generated from the following file:<ul>
  262. <li>include/grpc++/impl/codegen/<a class="el" href="codegen_2call_8h_source.html">call.h</a></li>
  263. </ul>
  264. </div><!-- contents -->
  265. <!-- start footer part -->
  266. <hr class="footer"/><address class="footer"><small>
  267. Generated on Thu Aug 18 2016 21:34:58 for GRPC C++ by &#160;<a href="http://www.doxygen.org/index.html">
  268. <img class="footer" src="doxygen.png" alt="doxygen"/>
  269. </a> 1.8.11
  270. </small></address>
  271. </body>
  272. </html>