classgrpc_1_1_call_op_set.html 17 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279
  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.6"/>
  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/search.js"></script>
  13. <script type="text/javascript">
  14. $(document).ready(function() { searchBox.OnSelectItem(0); });
  15. </script>
  16. <link href="doxygen.css" rel="stylesheet" type="text/css" />
  17. </head>
  18. <body>
  19. <div id="top"><!-- do not remove this div, it is closed by doxygen! -->
  20. <div id="titlearea">
  21. <table cellspacing="0" cellpadding="0">
  22. <tbody>
  23. <tr style="height: 56px;">
  24. <td style="padding-left: 0.5em;">
  25. <div id="projectname">GRPC C++
  26. &#160;<span id="projectnumber">1.4.0</span>
  27. </div>
  28. </td>
  29. </tr>
  30. </tbody>
  31. </table>
  32. </div>
  33. <!-- end header part -->
  34. <!-- Generated by Doxygen 1.8.6 -->
  35. <script type="text/javascript">
  36. var searchBox = new SearchBox("searchBox", "search",false,'Search');
  37. </script>
  38. <div id="navrow1" class="tabs">
  39. <ul class="tablist">
  40. <li><a href="index.html"><span>Main&#160;Page</span></a></li>
  41. <li><a href="pages.html"><span>Related&#160;Pages</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. <a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark">&#160;</span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark">&#160;</span>Data Structures</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark">&#160;</span>Namespaces</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark">&#160;</span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark">&#160;</span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark">&#160;</span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark">&#160;</span>Typedefs</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(7)"><span class="SelectionMark">&#160;</span>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(8)"><span class="SelectionMark">&#160;</span>Enumerator</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(9)"><span class="SelectionMark">&#160;</span>Friends</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(10)"><span class="SelectionMark">&#160;</span>Macros</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(11)"><span class="SelectionMark">&#160;</span>Groups</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(12)"><span class="SelectionMark">&#160;</span>Pages</a></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:acf75ef8bf9d577455123637a0ecf8e4a"><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#acf75ef8bf9d577455123637a0ecf8e4a">FillOps</a> (<a class="el" href="grpc__types_8h.html#a122f8f4f0a585396d993d9b55848f222">grpc_call</a> *call, <a class="el" href="structgrpc__op.html">grpc_op</a> *ops, size_t *nops) override</td></tr>
  105. <tr class="memdesc:acf75ef8bf9d577455123637a0ecf8e4a"><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="#acf75ef8bf9d577455123637a0ecf8e4a">More...</a><br/></td></tr>
  106. <tr class="separator:acf75ef8bf9d577455123637a0ecf8e4a"><td class="memSeparator" colspan="2">&#160;</td></tr>
  107. <tr class="memitem:a3af136556da26df8080a419270467222"><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#a3af136556da26df8080a419270467222">FinalizeResult</a> (void **tag, bool *status) override</td></tr>
  108. <tr class="memdesc:a3af136556da26df8080a419270467222"><td class="mdescLeft">&#160;</td><td class="mdescRight">Called prior to returning from Next(), return value is the status of the operation (return status is the default thing to do). <a href="#a3af136556da26df8080a419270467222">More...</a><br/></td></tr>
  109. <tr class="separator:a3af136556da26df8080a419270467222"><td class="memSeparator" colspan="2">&#160;</td></tr>
  110. <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>
  111. <tr class="separator:a798d253af317730a5b996a4a55d86274"><td class="memSeparator" colspan="2">&#160;</td></tr>
  112. <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>
  113. <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>
  114. <tr class="separator:a2cbf0212ed795c79f98c3421ed0cb4ab inherit pub_methods_classgrpc_1_1_completion_queue_tag"><td class="memSeparator" colspan="2">&#160;</td></tr>
  115. </table>
  116. <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
  117. <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/>
  118. class grpc::CallOpSet&lt; Op1, Op2, Op3, Op4, Op5, Op6 &gt;</h3>
  119. <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>
  120. <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>
  121. </div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
  122. <a class="anchor" id="ae06e1a2d051b6b404eec88c4be303bcf"></a>
  123. <div class="memitem">
  124. <div class="memproto">
  125. <div class="memtemplate">
  126. 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>
  127. <table class="mlabels">
  128. <tr>
  129. <td class="mlabels-left">
  130. <table class="memname">
  131. <tr>
  132. <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>
  133. <td>(</td>
  134. <td class="paramname"></td><td>)</td>
  135. <td></td>
  136. </tr>
  137. </table>
  138. </td>
  139. <td class="mlabels-right">
  140. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  141. </tr>
  142. </table>
  143. </div><div class="memdoc">
  144. </div>
  145. </div>
  146. <h2 class="groupheader">Member Function Documentation</h2>
  147. <a class="anchor" id="acf75ef8bf9d577455123637a0ecf8e4a"></a>
  148. <div class="memitem">
  149. <div class="memproto">
  150. <div class="memtemplate">
  151. 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>
  152. <table class="mlabels">
  153. <tr>
  154. <td class="mlabels-left">
  155. <table class="memname">
  156. <tr>
  157. <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>
  158. <td>(</td>
  159. <td class="paramtype"><a class="el" href="grpc__types_8h.html#a122f8f4f0a585396d993d9b55848f222">grpc_call</a> *&#160;</td>
  160. <td class="paramname"><em>call</em>, </td>
  161. </tr>
  162. <tr>
  163. <td class="paramkey"></td>
  164. <td></td>
  165. <td class="paramtype"><a class="el" href="structgrpc__op.html">grpc_op</a> *&#160;</td>
  166. <td class="paramname"><em>ops</em>, </td>
  167. </tr>
  168. <tr>
  169. <td class="paramkey"></td>
  170. <td></td>
  171. <td class="paramtype">size_t *&#160;</td>
  172. <td class="paramname"><em>nops</em>&#160;</td>
  173. </tr>
  174. <tr>
  175. <td></td>
  176. <td>)</td>
  177. <td></td><td></td>
  178. </tr>
  179. </table>
  180. </td>
  181. <td class="mlabels-right">
  182. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">override</span><span class="mlabel">virtual</span></span> </td>
  183. </tr>
  184. </table>
  185. </div><div class="memdoc">
  186. <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>
  187. <p>Implements <a class="el" href="classgrpc_1_1_call_op_set_interface.html#affd9cadf51e13644b960e7d6590934ae">grpc::CallOpSetInterface</a>.</p>
  188. </div>
  189. </div>
  190. <a class="anchor" id="a3af136556da26df8080a419270467222"></a>
  191. <div class="memitem">
  192. <div class="memproto">
  193. <div class="memtemplate">
  194. 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>
  195. <table class="mlabels">
  196. <tr>
  197. <td class="mlabels-left">
  198. <table class="memname">
  199. <tr>
  200. <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>
  201. <td>(</td>
  202. <td class="paramtype">void **&#160;</td>
  203. <td class="paramname"><em>tag</em>, </td>
  204. </tr>
  205. <tr>
  206. <td class="paramkey"></td>
  207. <td></td>
  208. <td class="paramtype">bool *&#160;</td>
  209. <td class="paramname"><em>status</em>&#160;</td>
  210. </tr>
  211. <tr>
  212. <td></td>
  213. <td>)</td>
  214. <td></td><td></td>
  215. </tr>
  216. </table>
  217. </td>
  218. <td class="mlabels-right">
  219. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">override</span><span class="mlabel">virtual</span></span> </td>
  220. </tr>
  221. </table>
  222. </div><div class="memdoc">
  223. <p>Called prior to returning from Next(), return value is the status of the operation (return status is the default thing to do). </p>
  224. <p>If this function returns false, the tag is dropped and not returned from the completion queue </p>
  225. <p>Implements <a class="el" href="classgrpc_1_1_completion_queue_tag.html#af7b1abfcd9e506d118dfdcf29ce7fe8d">grpc::CompletionQueueTag</a>.</p>
  226. <p>Reimplemented in <a class="el" href="classgrpc_1_1_sneaky_call_op_set.html#a6bf4ff056bfac89b40b011301a510228">grpc::SneakyCallOpSet&lt; Op1, Op2, Op3, Op4, Op5, Op6 &gt;</a>, and <a class="el" href="classgrpc_1_1_sneaky_call_op_set.html#a6bf4ff056bfac89b40b011301a510228">grpc::SneakyCallOpSet&lt; grpc::CallOpSendInitialMetadata, grpc::CallOpSendMessage, grpc::CallOpClientSendClose &gt;</a>.</p>
  227. </div>
  228. </div>
  229. <a class="anchor" id="a798d253af317730a5b996a4a55d86274"></a>
  230. <div class="memitem">
  231. <div class="memproto">
  232. <div class="memtemplate">
  233. 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>
  234. <table class="mlabels">
  235. <tr>
  236. <td class="mlabels-left">
  237. <table class="memname">
  238. <tr>
  239. <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>
  240. <td>(</td>
  241. <td class="paramtype">void *&#160;</td>
  242. <td class="paramname"><em>return_tag</em></td><td>)</td>
  243. <td></td>
  244. </tr>
  245. </table>
  246. </td>
  247. <td class="mlabels-right">
  248. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  249. </tr>
  250. </table>
  251. </div><div class="memdoc">
  252. </div>
  253. </div>
  254. <hr/>The documentation for this class was generated from the following file:<ul>
  255. <li>include/grpc++/impl/codegen/<a class="el" href="codegen_2call_8h_source.html">call.h</a></li>
  256. </ul>
  257. </div><!-- contents -->
  258. <!-- start footer part -->
  259. <hr class="footer"/><address class="footer"><small>
  260. Generated on Wed Jun 21 2017 14:13:08 for GRPC C++ by &#160;<a href="http://www.doxygen.org/index.html">
  261. <img class="footer" src="doxygen.png" alt="doxygen"/>
  262. </a> 1.8.6
  263. </small></address>
  264. </body>
  265. </html>