classgrpc_1_1internal_1_1_templated_bidi_streaming_handler.html 9.8 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166
  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::TemplatedBidiStreamingHandler&lt; Streamer, WriteNeeded &gt; Class Template 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_templated_bidi_streaming_handler.html">TemplatedBidiStreamingHandler</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::internal::TemplatedBidiStreamingHandler&lt; Streamer, WriteNeeded &gt; Class Template Reference</div> </div>
  68. </div><!--header-->
  69. <div class="contents">
  70. <p>A wrapper class of an application provided bidi-streaming handler.
  71. <a href="classgrpc_1_1internal_1_1_templated_bidi_streaming_handler.html#details">More...</a></p>
  72. <p><code>#include &lt;<a class="el" href="grpcpp_2impl_2codegen_2completion__queue_8h_source.html">completion_queue.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:ae5aaa2d49f0b9b0c4616315260354c32"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc_1_1internal_1_1_templated_bidi_streaming_handler.html#ae5aaa2d49f0b9b0c4616315260354c32">TemplatedBidiStreamingHandler</a> (std::function&lt; <a class="el" href="classgrpc_1_1_status.html">Status</a>(<a class="el" href="classgrpc_1_1_server_context.html">ServerContext</a> *, Streamer *)&gt; func)</td></tr>
  77. <tr class="separator:ae5aaa2d49f0b9b0c4616315260354c32"><td class="memSeparator" colspan="2">&#160;</td></tr>
  78. <tr class="memitem:a5170e31524b287b4d1dda277ff45ab85"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc_1_1internal_1_1_templated_bidi_streaming_handler.html#a5170e31524b287b4d1dda277ff45ab85">RunHandler</a> (const <a class="el" href="structgrpc_1_1internal_1_1_method_handler_1_1_handler_parameter.html">HandlerParameter</a> &amp;param) final</td></tr>
  79. <tr class="separator:a5170e31524b287b4d1dda277ff45ab85"><td class="memSeparator" colspan="2">&#160;</td></tr>
  80. <tr class="inherit_header pub_methods_classgrpc_1_1internal_1_1_method_handler"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_classgrpc_1_1internal_1_1_method_handler')"><img src="closed.png" alt="-"/>&#160;Public Member Functions inherited from <a class="el" href="classgrpc_1_1internal_1_1_method_handler.html">grpc::internal::MethodHandler</a></td></tr>
  81. <tr class="memitem:a6c9896af1ffd8b22d0bc197fbd946a33 inherit pub_methods_classgrpc_1_1internal_1_1_method_handler"><td class="memItemLeft" align="right" valign="top">virtual&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc_1_1internal_1_1_method_handler.html#a6c9896af1ffd8b22d0bc197fbd946a33">~MethodHandler</a> ()</td></tr>
  82. <tr class="separator:a6c9896af1ffd8b22d0bc197fbd946a33 inherit pub_methods_classgrpc_1_1internal_1_1_method_handler"><td class="memSeparator" colspan="2">&#160;</td></tr>
  83. </table>
  84. <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
  85. <div class="textblock"><h3>template&lt;class Streamer, bool WriteNeeded&gt;<br />
  86. class grpc::internal::TemplatedBidiStreamingHandler&lt; Streamer, WriteNeeded &gt;</h3>
  87. <p>A wrapper class of an application provided bidi-streaming handler. </p>
  88. <p>This also applies to server-streamed implementation of a unary method with the additional requirement that such methods must have done a write for status to be ok Since this is used by more than 1 class, the service is not passed in. Instead, it is expected to be an implicitly-captured argument of func (through bind or something along those lines) </p>
  89. </div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
  90. <a id="ae5aaa2d49f0b9b0c4616315260354c32"></a>
  91. <h2 class="memtitle"><span class="permalink"><a href="#ae5aaa2d49f0b9b0c4616315260354c32">&#9670;&nbsp;</a></span>TemplatedBidiStreamingHandler()</h2>
  92. <div class="memitem">
  93. <div class="memproto">
  94. <div class="memtemplate">
  95. template&lt;class Streamer, bool WriteNeeded&gt; </div>
  96. <table class="mlabels">
  97. <tr>
  98. <td class="mlabels-left">
  99. <table class="memname">
  100. <tr>
  101. <td class="memname"><a class="el" href="classgrpc_1_1internal_1_1_templated_bidi_streaming_handler.html">grpc::internal::TemplatedBidiStreamingHandler</a>&lt; Streamer, WriteNeeded &gt;::<a class="el" href="classgrpc_1_1internal_1_1_templated_bidi_streaming_handler.html">TemplatedBidiStreamingHandler</a> </td>
  102. <td>(</td>
  103. <td class="paramtype">std::function&lt; <a class="el" href="classgrpc_1_1_status.html">Status</a>(<a class="el" href="classgrpc_1_1_server_context.html">ServerContext</a> *, Streamer *)&gt;&#160;</td>
  104. <td class="paramname"><em>func</em></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="a5170e31524b287b4d1dda277ff45ab85"></a>
  118. <h2 class="memtitle"><span class="permalink"><a href="#a5170e31524b287b4d1dda277ff45ab85">&#9670;&nbsp;</a></span>RunHandler()</h2>
  119. <div class="memitem">
  120. <div class="memproto">
  121. <div class="memtemplate">
  122. template&lt;class Streamer, bool WriteNeeded&gt; </div>
  123. <table class="mlabels">
  124. <tr>
  125. <td class="mlabels-left">
  126. <table class="memname">
  127. <tr>
  128. <td class="memname">void <a class="el" href="classgrpc_1_1internal_1_1_templated_bidi_streaming_handler.html">grpc::internal::TemplatedBidiStreamingHandler</a>&lt; Streamer, WriteNeeded &gt;::RunHandler </td>
  129. <td>(</td>
  130. <td class="paramtype">const <a class="el" href="structgrpc_1_1internal_1_1_method_handler_1_1_handler_parameter.html">HandlerParameter</a> &amp;&#160;</td>
  131. <td class="paramname"><em>param</em></td><td>)</td>
  132. <td></td>
  133. </tr>
  134. </table>
  135. </td>
  136. <td class="mlabels-right">
  137. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">final</span><span class="mlabel">virtual</span></span> </td>
  138. </tr>
  139. </table>
  140. </div><div class="memdoc">
  141. <p>Implements <a class="el" href="classgrpc_1_1internal_1_1_method_handler.html#a61b91173bcf71a512a80947a5413c6c6">grpc::internal::MethodHandler</a>.</p>
  142. </div>
  143. </div>
  144. <hr/>The documentation for this class was generated from the following files:<ul>
  145. <li>include/grpcpp/impl/codegen/<a class="el" href="grpcpp_2impl_2codegen_2completion__queue_8h_source.html">completion_queue.h</a></li>
  146. <li>include/grpcpp/impl/codegen/<a class="el" href="grpcpp_2impl_2codegen_2method__handler__impl_8h_source.html">method_handler_impl.h</a></li>
  147. </ul>
  148. </div><!-- contents -->
  149. <!-- start footer part -->
  150. <hr class="footer"/><address class="footer"><small>
  151. Generated on Tue May 15 2018 17:01:01 for GRPC C++ by &#160;<a href="http://www.doxygen.org/index.html">
  152. <img class="footer" src="doxygen.png" alt="doxygen"/>
  153. </a> 1.8.13
  154. </small></address>
  155. </body>
  156. </html>