grpc/cpp/impl_2codegen_2method__hand...

168 lines
21 KiB
HTML

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.17"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>GRPC C++: include/grpcpp/impl/codegen/method_handler.h Source File</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">GRPC C++
&#160;<span id="projectnumber">1.31.1</span>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.17 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
var searchBox = new SearchBox("searchBox", "search",false,'Search');
/* @license-end */
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(function() {
initMenu('',true,false,'search.php','Search');
$(document).ready(function() { init_search(); });
});
/* @license-end */</script>
<div id="main-nav"></div>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>
<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0"
name="MSearchResults" id="MSearchResults">
</iframe>
</div>
<div id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="dir_d44c64559bbebec7f509842c48db8b23.html">include</a></li><li class="navelem"><a class="el" href="dir_412f9a3d5dfcba8716486cd870ef4586.html">grpcpp</a></li><li class="navelem"><a class="el" href="dir_84040d6f573b73aa8d12512b533ede11.html">impl</a></li><li class="navelem"><a class="el" href="dir_a33e3e3a3b205cffecbb359564791f71.html">codegen</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="headertitle">
<div class="title">method_handler.h</div> </div>
</div><!--header-->
<div class="contents">
<a href="impl_2codegen_2method__handler_8h.html">Go to the documentation of this file.</a><div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span>&#160;<span class="comment">/*</span></div>
<div class="line"><a name="l00002"></a><span class="lineno"> 2</span>&#160;<span class="comment"> *</span></div>
<div class="line"><a name="l00003"></a><span class="lineno"> 3</span>&#160;<span class="comment"> * Copyright 2019 gRPC authors.</span></div>
<div class="line"><a name="l00004"></a><span class="lineno"> 4</span>&#160;<span class="comment"> *</span></div>
<div class="line"><a name="l00005"></a><span class="lineno"> 5</span>&#160;<span class="comment"> * Licensed under the Apache License, Version 2.0 (the &quot;License&quot;);</span></div>
<div class="line"><a name="l00006"></a><span class="lineno"> 6</span>&#160;<span class="comment"> * you may not use this file except in compliance with the License.</span></div>
<div class="line"><a name="l00007"></a><span class="lineno"> 7</span>&#160;<span class="comment"> * You may obtain a copy of the License at</span></div>
<div class="line"><a name="l00008"></a><span class="lineno"> 8</span>&#160;<span class="comment"> *</span></div>
<div class="line"><a name="l00009"></a><span class="lineno"> 9</span>&#160;<span class="comment"> * http://www.apache.org/licenses/LICENSE-2.0</span></div>
<div class="line"><a name="l00010"></a><span class="lineno"> 10</span>&#160;<span class="comment"> *</span></div>
<div class="line"><a name="l00011"></a><span class="lineno"> 11</span>&#160;<span class="comment"> * Unless required by applicable law or agreed to in writing, software</span></div>
<div class="line"><a name="l00012"></a><span class="lineno"> 12</span>&#160;<span class="comment"> * distributed under the License is distributed on an &quot;AS IS&quot; BASIS,</span></div>
<div class="line"><a name="l00013"></a><span class="lineno"> 13</span>&#160;<span class="comment"> * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.</span></div>
<div class="line"><a name="l00014"></a><span class="lineno"> 14</span>&#160;<span class="comment"> * See the License for the specific language governing permissions and</span></div>
<div class="line"><a name="l00015"></a><span class="lineno"> 15</span>&#160;<span class="comment"> * limitations under the License.</span></div>
<div class="line"><a name="l00016"></a><span class="lineno"> 16</span>&#160;<span class="comment"> *</span></div>
<div class="line"><a name="l00017"></a><span class="lineno"> 17</span>&#160;<span class="comment"> */</span></div>
<div class="line"><a name="l00018"></a><span class="lineno"> 18</span>&#160; </div>
<div class="line"><a name="l00019"></a><span class="lineno"> 19</span>&#160;<span class="preprocessor">#ifndef GRPCPP_IMPL_CODEGEN_METHOD_HANDLER_H</span></div>
<div class="line"><a name="l00020"></a><span class="lineno"> 20</span>&#160;<span class="preprocessor">#define GRPCPP_IMPL_CODEGEN_METHOD_HANDLER_H</span></div>
<div class="line"><a name="l00021"></a><span class="lineno"> 21</span>&#160; </div>
<div class="line"><a name="l00022"></a><span class="lineno"> 22</span>&#160;<span class="preprocessor">#include &lt;<a class="code" href="grpcpp_2impl_2codegen_2method__handler__impl_8h.html">grpcpp/impl/codegen/method_handler_impl.h</a>&gt;</span></div>
<div class="line"><a name="l00023"></a><span class="lineno"> 23</span>&#160; </div>
<div class="line"><a name="l00024"></a><span class="lineno"> 24</span>&#160;<span class="keyword">namespace </span><a class="code" href="namespacegrpc.html">grpc</a> {</div>
<div class="line"><a name="l00025"></a><span class="lineno"> 25</span>&#160; </div>
<div class="line"><a name="l00026"></a><span class="lineno"> 26</span>&#160;<span class="keyword">namespace </span>internal {</div>
<div class="line"><a name="l00027"></a><span class="lineno"> 27</span>&#160; </div>
<div class="line"><a name="l00028"></a><span class="lineno"> 28</span>&#160;<span class="keyword">template</span> &lt;<span class="keyword">class</span> ServiceType, <span class="keyword">class</span> RequestType, <span class="keyword">class</span> ResponseType&gt;</div>
<div class="line"><a name="l00029"></a><span class="lineno"> 29</span>&#160;<span class="keyword">using</span> <a class="code" href="namespacegrpc_1_1internal.html#a8e799399626f278e5c9f048457242015">BidiStreamingHandler</a> =</div>
<div class="line"><a name="l00030"></a><span class="lineno"> 30</span>&#160; <a class="code" href="classgrpc__impl_1_1internal_1_1_bidi_streaming_handler.html">::grpc_impl::internal::BidiStreamingHandler</a>&lt;ServiceType, RequestType,</div>
<div class="line"><a name="l00031"></a><span class="lineno"><a class="line" href="namespacegrpc_1_1internal.html#a8e799399626f278e5c9f048457242015"> 31</a></span>&#160; ResponseType&gt;;</div>
<div class="line"><a name="l00032"></a><span class="lineno"> 32</span>&#160; </div>
<div class="line"><a name="l00033"></a><span class="lineno"> 33</span>&#160;<span class="keyword">template</span> &lt;<span class="keyword">class</span> ServiceType, <span class="keyword">class</span> RequestType, <span class="keyword">class</span> ResponseType&gt;</div>
<div class="line"><a name="l00034"></a><span class="lineno"> 34</span>&#160;<span class="keyword">using</span> <a class="code" href="classgrpc__impl_1_1internal_1_1_rpc_method_handler.html">RpcMethodHandler</a> =</div>
<div class="line"><a name="l00035"></a><span class="lineno"> 35</span>&#160; <a class="code" href="classgrpc__impl_1_1internal_1_1_rpc_method_handler.html">::grpc_impl::internal::RpcMethodHandler</a>&lt;ServiceType, RequestType,</div>
<div class="line"><a name="l00036"></a><span class="lineno"><a class="line" href="namespacegrpc_1_1internal.html#a553dc761a0df3464ec0b6d4b28ad8e36"> 36</a></span>&#160; ResponseType&gt;;</div>
<div class="line"><a name="l00037"></a><span class="lineno"> 37</span>&#160; </div>
<div class="line"><a name="l00038"></a><span class="lineno"> 38</span>&#160;<span class="keyword">template</span> &lt;<span class="keyword">class</span> ServiceType, <span class="keyword">class</span> RequestType, <span class="keyword">class</span> ResponseType&gt;</div>
<div class="line"><a name="l00039"></a><span class="lineno"> 39</span>&#160;<span class="keyword">using</span> <a class="code" href="classgrpc__impl_1_1internal_1_1_client_streaming_handler.html">ClientStreamingHandler</a> =</div>
<div class="line"><a name="l00040"></a><span class="lineno"> 40</span>&#160; <a class="code" href="classgrpc__impl_1_1internal_1_1_client_streaming_handler.html">::grpc_impl::internal::ClientStreamingHandler</a>&lt;ServiceType, RequestType,</div>
<div class="line"><a name="l00041"></a><span class="lineno"><a class="line" href="namespacegrpc_1_1internal.html#af4f3323d2f74bb693372491e474ad178"> 41</a></span>&#160; ResponseType&gt;;</div>
<div class="line"><a name="l00042"></a><span class="lineno"> 42</span>&#160; </div>
<div class="line"><a name="l00043"></a><span class="lineno"> 43</span>&#160;<span class="keyword">template</span> &lt;<span class="keyword">class</span> ServiceType, <span class="keyword">class</span> RequestType, <span class="keyword">class</span> ResponseType&gt;</div>
<div class="line"><a name="l00044"></a><span class="lineno"> 44</span>&#160;<span class="keyword">using</span> <a class="code" href="classgrpc__impl_1_1internal_1_1_server_streaming_handler.html">ServerStreamingHandler</a> =</div>
<div class="line"><a name="l00045"></a><span class="lineno"> 45</span>&#160; <a class="code" href="classgrpc__impl_1_1internal_1_1_server_streaming_handler.html">::grpc_impl::internal::ServerStreamingHandler</a>&lt;ServiceType, RequestType,</div>
<div class="line"><a name="l00046"></a><span class="lineno"><a class="line" href="namespacegrpc_1_1internal.html#a1639f1a5a4c31f14b3ed5768f4ba251a"> 46</a></span>&#160; ResponseType&gt;;</div>
<div class="line"><a name="l00047"></a><span class="lineno"> 47</span>&#160; </div>
<div class="line"><a name="l00048"></a><span class="lineno"> 48</span>&#160;<span class="keyword">template</span> &lt;<span class="keyword">class</span> Streamer, <span class="keywordtype">bool</span> WriteNeeded&gt;</div>
<div class="line"><a name="l00049"></a><span class="lineno"> 49</span>&#160;<span class="keyword">using</span> <a class="code" href="classgrpc__impl_1_1internal_1_1_templated_bidi_streaming_handler.html">TemplatedBidiStreamingHandler</a> =</div>
<div class="line"><a name="l00050"></a><span class="lineno"><a class="line" href="namespacegrpc_1_1internal.html#aec74fe488c5e4c24fe63d00255576cdb"> 50</a></span>&#160; <a class="code" href="classgrpc__impl_1_1internal_1_1_templated_bidi_streaming_handler.html">::grpc_impl::internal::TemplatedBidiStreamingHandler&lt;Streamer, WriteNeeded&gt;</a>;</div>
<div class="line"><a name="l00051"></a><span class="lineno"> 51</span>&#160; </div>
<div class="line"><a name="l00052"></a><span class="lineno"> 52</span>&#160;<span class="keyword">template</span> &lt;<span class="keyword">class</span> RequestType, <span class="keyword">class</span> ResponseType&gt;</div>
<div class="line"><a name="l00053"></a><span class="lineno"> 53</span>&#160;<span class="keyword">using</span> <a class="code" href="classgrpc__impl_1_1internal_1_1_streamed_unary_handler.html">StreamedUnaryHandler</a> =</div>
<div class="line"><a name="l00054"></a><span class="lineno"><a class="line" href="namespacegrpc_1_1internal.html#aa2abaf43dce61f33cd93b37b2139fd42"> 54</a></span>&#160; <a class="code" href="classgrpc__impl_1_1internal_1_1_streamed_unary_handler.html">::grpc_impl::internal::StreamedUnaryHandler&lt;RequestType, ResponseType&gt;</a>;</div>
<div class="line"><a name="l00055"></a><span class="lineno"> 55</span>&#160; </div>
<div class="line"><a name="l00056"></a><span class="lineno"> 56</span>&#160;<span class="keyword">template</span> &lt;<span class="keyword">class</span> RequestType, <span class="keyword">class</span> ResponseType&gt;</div>
<div class="line"><a name="l00057"></a><span class="lineno"> 57</span>&#160;<span class="keyword">using</span> <a class="code" href="classgrpc__impl_1_1internal_1_1_split_server_streaming_handler.html">SplitServerStreamingHandler</a> =</div>
<div class="line"><a name="l00058"></a><span class="lineno"> 58</span>&#160; <a class="code" href="classgrpc__impl_1_1internal_1_1_split_server_streaming_handler.html">::grpc_impl::internal::SplitServerStreamingHandler</a>&lt;RequestType,</div>
<div class="line"><a name="l00059"></a><span class="lineno"><a class="line" href="namespacegrpc_1_1internal.html#ad65ee8c968ee7c4a00c2e716db9df20e"> 59</a></span>&#160; ResponseType&gt;;</div>
<div class="line"><a name="l00060"></a><span class="lineno"> 60</span>&#160; </div>
<div class="line"><a name="l00061"></a><span class="lineno"> 61</span>&#160;<span class="keyword">template</span> &lt;StatusCode code&gt;</div>
<div class="line"><a name="l00062"></a><span class="lineno"><a class="line" href="namespacegrpc_1_1internal.html#aa2a7307aac909e43ce78eb6d666e514f"> 62</a></span>&#160;<span class="keyword">using</span> <a class="code" href="classgrpc__impl_1_1internal_1_1_error_method_handler.html">ErrorMethodHandler</a> = <a class="code" href="classgrpc__impl_1_1internal_1_1_error_method_handler.html">::grpc_impl::internal::ErrorMethodHandler&lt;code&gt;</a>;</div>
<div class="line"><a name="l00063"></a><span class="lineno"> 63</span>&#160; </div>
<div class="line"><a name="l00064"></a><span class="lineno"><a class="line" href="namespacegrpc_1_1internal.html#a90b43b5b7515fd66fbbb18e208a43a52"> 64</a></span>&#160;<span class="keyword">using</span> <a class="code" href="classgrpc__impl_1_1internal_1_1_error_method_handler.html">UnknownMethodHandler</a> = <a class="code" href="namespacegrpc_1_1internal.html#a90b43b5b7515fd66fbbb18e208a43a52">::grpc_impl::internal::UnknownMethodHandler</a>;</div>
<div class="line"><a name="l00065"></a><span class="lineno"> 65</span>&#160; </div>
<div class="line"><a name="l00066"></a><span class="lineno"> 66</span>&#160;<span class="keyword">using</span> <a class="code" href="classgrpc__impl_1_1internal_1_1_error_method_handler.html">ResourceExhaustedHandler</a> =</div>
<div class="line"><a name="l00067"></a><span class="lineno"><a class="line" href="namespacegrpc_1_1internal.html#a6a193cbf9246d124a8cea85425161b05"> 67</a></span>&#160; <a class="code" href="namespacegrpc_1_1internal.html#a6a193cbf9246d124a8cea85425161b05">::grpc_impl::internal::ResourceExhaustedHandler</a>;</div>
<div class="line"><a name="l00068"></a><span class="lineno"> 68</span>&#160; </div>
<div class="line"><a name="l00069"></a><span class="lineno"> 69</span>&#160;} <span class="comment">// namespace internal</span></div>
<div class="line"><a name="l00070"></a><span class="lineno"> 70</span>&#160; </div>
<div class="line"><a name="l00071"></a><span class="lineno"> 71</span>&#160;} <span class="comment">// namespace grpc</span></div>
<div class="line"><a name="l00072"></a><span class="lineno"> 72</span>&#160; </div>
<div class="line"><a name="l00073"></a><span class="lineno"> 73</span>&#160;<span class="preprocessor">#endif // GRPCPP_IMPL_CODEGEN_METHOD_HANDLER_H</span></div>
</div><!-- fragment --></div><!-- contents -->
<div class="ttc" id="aclassgrpc__impl_1_1internal_1_1_error_method_handler_html"><div class="ttname"><a href="classgrpc__impl_1_1internal_1_1_error_method_handler.html">grpc_impl::internal::ErrorMethodHandler</a></div><div class="ttdoc">General method handler class for errors that prevent real method use e.g., handle unknown method by r...</div><div class="ttdef"><b>Definition:</b> byte_buffer.h:44</div></div>
<div class="ttc" id="anamespacegrpc_1_1internal_html_a90b43b5b7515fd66fbbb18e208a43a52"><div class="ttname"><a href="namespacegrpc_1_1internal.html#a90b43b5b7515fd66fbbb18e208a43a52">grpc::internal::UnknownMethodHandler</a></div><div class="ttdeci">::grpc_impl::internal::UnknownMethodHandler UnknownMethodHandler</div><div class="ttdef"><b>Definition:</b> method_handler.h:64</div></div>
<div class="ttc" id="aclassgrpc__impl_1_1internal_1_1_client_streaming_handler_html"><div class="ttname"><a href="classgrpc__impl_1_1internal_1_1_client_streaming_handler.html">grpc_impl::internal::ClientStreamingHandler</a></div><div class="ttdoc">A wrapper class of an application provided client streaming handler.</div><div class="ttdef"><b>Definition:</b> completion_queue_impl.h:69</div></div>
<div class="ttc" id="anamespacegrpc_html"><div class="ttname"><a href="namespacegrpc.html">grpc</a></div><div class="ttdoc">This header provides an object that reads bytes directly from a grpc::ByteBuffer, via the ZeroCopyInp...</div><div class="ttdef"><b>Definition:</b> alarm.h:24</div></div>
<div class="ttc" id="aclassgrpc__impl_1_1internal_1_1_bidi_streaming_handler_html"><div class="ttname"><a href="classgrpc__impl_1_1internal_1_1_bidi_streaming_handler.html">grpc_impl::internal::BidiStreamingHandler</a></div><div class="ttdef"><b>Definition:</b> method_handler_impl.h:296</div></div>
<div class="ttc" id="anamespacegrpc_1_1internal_html_a6a193cbf9246d124a8cea85425161b05"><div class="ttname"><a href="namespacegrpc_1_1internal.html#a6a193cbf9246d124a8cea85425161b05">grpc::internal::ResourceExhaustedHandler</a></div><div class="ttdeci">::grpc_impl::internal::ResourceExhaustedHandler ResourceExhaustedHandler</div><div class="ttdef"><b>Definition:</b> method_handler.h:67</div></div>
<div class="ttc" id="aclassgrpc__impl_1_1internal_1_1_split_server_streaming_handler_html"><div class="ttname"><a href="classgrpc__impl_1_1internal_1_1_split_server_streaming_handler.html">grpc_impl::internal::SplitServerStreamingHandler</a></div><div class="ttdef"><b>Definition:</b> method_handler_impl.h:331</div></div>
<div class="ttc" id="anamespacegrpc_1_1internal_html_a8e799399626f278e5c9f048457242015"><div class="ttname"><a href="namespacegrpc_1_1internal.html#a8e799399626f278e5c9f048457242015">grpc::internal::BidiStreamingHandler</a></div><div class="ttdeci">::grpc_impl::internal::BidiStreamingHandler&lt; ServiceType, RequestType, ResponseType &gt; BidiStreamingHandler</div><div class="ttdef"><b>Definition:</b> method_handler.h:31</div></div>
<div class="ttc" id="aclassgrpc__impl_1_1internal_1_1_rpc_method_handler_html"><div class="ttname"><a href="classgrpc__impl_1_1internal_1_1_rpc_method_handler.html">grpc_impl::internal::RpcMethodHandler</a></div><div class="ttdoc">A wrapper class of an application provided rpc method handler.</div><div class="ttdef"><b>Definition:</b> byte_buffer.h:40</div></div>
<div class="ttc" id="agrpcpp_2impl_2codegen_2method__handler__impl_8h_html"><div class="ttname"><a href="grpcpp_2impl_2codegen_2method__handler__impl_8h.html">method_handler_impl.h</a></div></div>
<div class="ttc" id="aclassgrpc__impl_1_1internal_1_1_templated_bidi_streaming_handler_html"><div class="ttname"><a href="classgrpc__impl_1_1internal_1_1_templated_bidi_streaming_handler.html">grpc_impl::internal::TemplatedBidiStreamingHandler</a></div><div class="ttdoc">A wrapper class of an application provided bidi-streaming handler.</div><div class="ttdef"><b>Definition:</b> completion_queue_impl.h:73</div></div>
<div class="ttc" id="aclassgrpc__impl_1_1internal_1_1_server_streaming_handler_html"><div class="ttname"><a href="classgrpc__impl_1_1internal_1_1_server_streaming_handler.html">grpc_impl::internal::ServerStreamingHandler</a></div><div class="ttdoc">A wrapper class of an application provided server streaming handler.</div><div class="ttdef"><b>Definition:</b> byte_buffer.h:42</div></div>
<div class="ttc" id="aclassgrpc__impl_1_1internal_1_1_streamed_unary_handler_html"><div class="ttname"><a href="classgrpc__impl_1_1internal_1_1_streamed_unary_handler.html">grpc_impl::internal::StreamedUnaryHandler</a></div><div class="ttdef"><b>Definition:</b> method_handler_impl.h:316</div></div>
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Tue Aug 18 2020 16:24:47 for GRPC C++ by &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.17
</small></address>
</body>
</html>