93 lines
20 KiB
HTML
93 lines
20 KiB
HTML
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://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.13"/>
|
|
<meta name="viewport" content="width=device-width, initial-scale=1"/>
|
|
<title>GRPC C++: include/grpcpp/impl/codegen/rpc_method.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++
|
|
 <span id="projectnumber">1.22.0</span>
|
|
</div>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<!-- end header part -->
|
|
<!-- Generated by Doxygen 1.8.13 -->
|
|
<script type="text/javascript">
|
|
var searchBox = new SearchBox("searchBox", "search",false,'Search');
|
|
</script>
|
|
<script type="text/javascript" src="menudata.js"></script>
|
|
<script type="text/javascript" src="menu.js"></script>
|
|
<script type="text/javascript">
|
|
$(function() {
|
|
initMenu('',true,false,'search.php','Search');
|
|
$(document).ready(function() { init_search(); });
|
|
});
|
|
</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">rpc_method.h</div> </div>
|
|
</div><!--header-->
|
|
<div class="contents">
|
|
<a href="grpcpp_2impl_2codegen_2rpc__method_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> <span class="comment">/*</span></div><div class="line"><a name="l00002"></a><span class="lineno"> 2</span> <span class="comment"> *</span></div><div class="line"><a name="l00003"></a><span class="lineno"> 3</span> <span class="comment"> * Copyright 2015 gRPC authors.</span></div><div class="line"><a name="l00004"></a><span class="lineno"> 4</span> <span class="comment"> *</span></div><div class="line"><a name="l00005"></a><span class="lineno"> 5</span> <span class="comment"> * Licensed under the Apache License, Version 2.0 (the "License");</span></div><div class="line"><a name="l00006"></a><span class="lineno"> 6</span> <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> <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> <span class="comment"> *</span></div><div class="line"><a name="l00009"></a><span class="lineno"> 9</span> <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> <span class="comment"> *</span></div><div class="line"><a name="l00011"></a><span class="lineno"> 11</span> <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> <span class="comment"> * distributed under the License is distributed on an "AS IS" BASIS,</span></div><div class="line"><a name="l00013"></a><span class="lineno"> 13</span> <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> <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> <span class="comment"> * limitations under the License.</span></div><div class="line"><a name="l00016"></a><span class="lineno"> 16</span> <span class="comment"> *</span></div><div class="line"><a name="l00017"></a><span class="lineno"> 17</span> <span class="comment"> */</span></div><div class="line"><a name="l00018"></a><span class="lineno"> 18</span> </div><div class="line"><a name="l00019"></a><span class="lineno"> 19</span> <span class="preprocessor">#ifndef GRPCPP_IMPL_CODEGEN_RPC_METHOD_H</span></div><div class="line"><a name="l00020"></a><span class="lineno"> 20</span> <span class="preprocessor">#define GRPCPP_IMPL_CODEGEN_RPC_METHOD_H</span></div><div class="line"><a name="l00021"></a><span class="lineno"> 21</span> </div><div class="line"><a name="l00022"></a><span class="lineno"> 22</span> <span class="preprocessor">#include <memory></span></div><div class="line"><a name="l00023"></a><span class="lineno"> 23</span> </div><div class="line"><a name="l00024"></a><span class="lineno"> 24</span> <span class="preprocessor">#include <<a class="code" href="grpcpp_2impl_2codegen_2channel__interface_8h.html">grpcpp/impl/codegen/channel_interface.h</a>></span></div><div class="line"><a name="l00025"></a><span class="lineno"> 25</span> </div><div class="line"><a name="l00026"></a><span class="lineno"> 26</span> <span class="keyword">namespace </span><a class="code" href="namespacegrpc.html">grpc</a> {</div><div class="line"><a name="l00027"></a><span class="lineno"> 27</span> <span class="keyword">namespace </span>internal {</div><div class="line"><a name="l00029"></a><span class="lineno"><a class="line" href="classgrpc_1_1internal_1_1_rpc_method.html"> 29</a></span> <span class="keyword">class </span><a class="code" href="classgrpc_1_1internal_1_1_rpc_method.html">RpcMethod</a> {</div><div class="line"><a name="l00030"></a><span class="lineno"> 30</span>  <span class="keyword">public</span>:</div><div class="line"><a name="l00031"></a><span class="lineno"><a class="line" href="classgrpc_1_1internal_1_1_rpc_method.html#a40ce84e3569f6a327468ae59f04c7dd1"> 31</a></span>  <span class="keyword">enum</span> <a class="code" href="classgrpc_1_1internal_1_1_rpc_method.html#a40ce84e3569f6a327468ae59f04c7dd1">RpcType</a> {</div><div class="line"><a name="l00032"></a><span class="lineno"><a class="line" href="classgrpc_1_1internal_1_1_rpc_method.html#a40ce84e3569f6a327468ae59f04c7dd1a73dbd8998b4364e284ade7c00a57ec37"> 32</a></span>  <a class="code" href="classgrpc_1_1internal_1_1_rpc_method.html#a40ce84e3569f6a327468ae59f04c7dd1a73dbd8998b4364e284ade7c00a57ec37">NORMAL_RPC</a> = 0,</div><div class="line"><a name="l00033"></a><span class="lineno"><a class="line" href="classgrpc_1_1internal_1_1_rpc_method.html#a40ce84e3569f6a327468ae59f04c7dd1a4138c4a820e1b96d502f32548e88d3fd"> 33</a></span>  <a class="code" href="classgrpc_1_1internal_1_1_rpc_method.html#a40ce84e3569f6a327468ae59f04c7dd1a4138c4a820e1b96d502f32548e88d3fd">CLIENT_STREAMING</a>, <span class="comment">// request streaming</span></div><div class="line"><a name="l00034"></a><span class="lineno"><a class="line" href="classgrpc_1_1internal_1_1_rpc_method.html#a40ce84e3569f6a327468ae59f04c7dd1a3b3eb41de854898c2481fb454fc8e2f6"> 34</a></span>  <a class="code" href="classgrpc_1_1internal_1_1_rpc_method.html#a40ce84e3569f6a327468ae59f04c7dd1a3b3eb41de854898c2481fb454fc8e2f6">SERVER_STREAMING</a>, <span class="comment">// response streaming</span></div><div class="line"><a name="l00035"></a><span class="lineno"><a class="line" href="classgrpc_1_1internal_1_1_rpc_method.html#a40ce84e3569f6a327468ae59f04c7dd1a8308d189db6d81509042a321ac91b00f"> 35</a></span>  <a class="code" href="classgrpc_1_1internal_1_1_rpc_method.html#a40ce84e3569f6a327468ae59f04c7dd1a8308d189db6d81509042a321ac91b00f">BIDI_STREAMING</a></div><div class="line"><a name="l00036"></a><span class="lineno"> 36</span>  };</div><div class="line"><a name="l00037"></a><span class="lineno"> 37</span> </div><div class="line"><a name="l00038"></a><span class="lineno"><a class="line" href="classgrpc_1_1internal_1_1_rpc_method.html#a1c13d569c84898f688b74958a4d7db49"> 38</a></span>  <a class="code" href="classgrpc_1_1internal_1_1_rpc_method.html#a1c13d569c84898f688b74958a4d7db49">RpcMethod</a>(<span class="keyword">const</span> <span class="keywordtype">char</span>* <a class="code" href="classgrpc_1_1internal_1_1_rpc_method.html#aa3d98227a1a0481308de6bc398163713">name</a>, <a class="code" href="classgrpc_1_1internal_1_1_rpc_method.html#a40ce84e3569f6a327468ae59f04c7dd1">RpcType</a> type)</div><div class="line"><a name="l00039"></a><span class="lineno"> 39</span>  : name_(name), method_type_(type), channel_tag_(NULL) {}</div><div class="line"><a name="l00040"></a><span class="lineno"> 40</span> </div><div class="line"><a name="l00041"></a><span class="lineno"><a class="line" href="classgrpc_1_1internal_1_1_rpc_method.html#a254b308ceaa38d17c99afb71f4fc1d73"> 41</a></span>  <a class="code" href="classgrpc_1_1internal_1_1_rpc_method.html#a254b308ceaa38d17c99afb71f4fc1d73">RpcMethod</a>(<span class="keyword">const</span> <span class="keywordtype">char</span>* <a class="code" href="classgrpc_1_1internal_1_1_rpc_method.html#aa3d98227a1a0481308de6bc398163713">name</a>, <a class="code" href="classgrpc_1_1internal_1_1_rpc_method.html#a40ce84e3569f6a327468ae59f04c7dd1">RpcType</a> type,</div><div class="line"><a name="l00042"></a><span class="lineno"> 42</span>  <span class="keyword">const</span> std::shared_ptr<ChannelInterface>& channel)</div><div class="line"><a name="l00043"></a><span class="lineno"> 43</span>  : name_(name),</div><div class="line"><a name="l00044"></a><span class="lineno"> 44</span>  method_type_(type),</div><div class="line"><a name="l00045"></a><span class="lineno"> 45</span>  channel_tag_(channel->RegisterMethod(name)) {}</div><div class="line"><a name="l00046"></a><span class="lineno"> 46</span> </div><div class="line"><a name="l00047"></a><span class="lineno"><a class="line" href="classgrpc_1_1internal_1_1_rpc_method.html#aa3d98227a1a0481308de6bc398163713"> 47</a></span>  <span class="keyword">const</span> <span class="keywordtype">char</span>* <a class="code" href="classgrpc_1_1internal_1_1_rpc_method.html#aa3d98227a1a0481308de6bc398163713">name</a>()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> name_; }</div><div class="line"><a name="l00048"></a><span class="lineno"><a class="line" href="classgrpc_1_1internal_1_1_rpc_method.html#abaf8f616c3d919da6dffc182d39a8d74"> 48</a></span>  <a class="code" href="classgrpc_1_1internal_1_1_rpc_method.html#a40ce84e3569f6a327468ae59f04c7dd1">RpcType</a> <a class="code" href="classgrpc_1_1internal_1_1_rpc_method.html#abaf8f616c3d919da6dffc182d39a8d74">method_type</a>()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> method_type_; }</div><div class="line"><a name="l00049"></a><span class="lineno"><a class="line" href="classgrpc_1_1internal_1_1_rpc_method.html#a3d84cbcc47861ba127f053bb9590ff1f"> 49</a></span>  <span class="keywordtype">void</span> <a class="code" href="classgrpc_1_1internal_1_1_rpc_method.html#a3d84cbcc47861ba127f053bb9590ff1f">SetMethodType</a>(<a class="code" href="classgrpc_1_1internal_1_1_rpc_method.html#a40ce84e3569f6a327468ae59f04c7dd1">RpcType</a> type) { method_type_ = type; }</div><div class="line"><a name="l00050"></a><span class="lineno"><a class="line" href="classgrpc_1_1internal_1_1_rpc_method.html#a32ba89bda8a4242ff6e18f66d84d671d"> 50</a></span>  <span class="keywordtype">void</span>* <a class="code" href="classgrpc_1_1internal_1_1_rpc_method.html#a32ba89bda8a4242ff6e18f66d84d671d">channel_tag</a>()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> channel_tag_; }</div><div class="line"><a name="l00051"></a><span class="lineno"> 51</span> </div><div class="line"><a name="l00052"></a><span class="lineno"> 52</span>  <span class="keyword">private</span>:</div><div class="line"><a name="l00053"></a><span class="lineno"> 53</span>  <span class="keyword">const</span> <span class="keywordtype">char</span>* <span class="keyword">const</span> name_;</div><div class="line"><a name="l00054"></a><span class="lineno"> 54</span>  <a class="code" href="classgrpc_1_1internal_1_1_rpc_method.html#a40ce84e3569f6a327468ae59f04c7dd1">RpcType</a> method_type_;</div><div class="line"><a name="l00055"></a><span class="lineno"> 55</span>  <span class="keywordtype">void</span>* <span class="keyword">const</span> channel_tag_;</div><div class="line"><a name="l00056"></a><span class="lineno"> 56</span> };</div><div class="line"><a name="l00057"></a><span class="lineno"> 57</span> </div><div class="line"><a name="l00058"></a><span class="lineno"> 58</span> } <span class="comment">// namespace internal</span></div><div class="line"><a name="l00059"></a><span class="lineno"> 59</span> } <span class="comment">// namespace grpc</span></div><div class="line"><a name="l00060"></a><span class="lineno"> 60</span> </div><div class="line"><a name="l00061"></a><span class="lineno"> 61</span> <span class="preprocessor">#endif // GRPCPP_IMPL_CODEGEN_RPC_METHOD_H</span></div><div class="ttc" id="classgrpc_1_1internal_1_1_rpc_method_html_a40ce84e3569f6a327468ae59f04c7dd1a73dbd8998b4364e284ade7c00a57ec37"><div class="ttname"><a href="classgrpc_1_1internal_1_1_rpc_method.html#a40ce84e3569f6a327468ae59f04c7dd1a73dbd8998b4364e284ade7c00a57ec37">grpc::internal::RpcMethod::NORMAL_RPC</a></div><div class="ttdef"><b>Definition:</b> rpc_method.h:32</div></div>
|
|
<div class="ttc" id="classgrpc_1_1internal_1_1_rpc_method_html_a1c13d569c84898f688b74958a4d7db49"><div class="ttname"><a href="classgrpc_1_1internal_1_1_rpc_method.html#a1c13d569c84898f688b74958a4d7db49">grpc::internal::RpcMethod::RpcMethod</a></div><div class="ttdeci">RpcMethod(const char *name, RpcType type)</div><div class="ttdef"><b>Definition:</b> rpc_method.h:38</div></div>
|
|
<div class="ttc" id="classgrpc_1_1internal_1_1_rpc_method_html_a32ba89bda8a4242ff6e18f66d84d671d"><div class="ttname"><a href="classgrpc_1_1internal_1_1_rpc_method.html#a32ba89bda8a4242ff6e18f66d84d671d">grpc::internal::RpcMethod::channel_tag</a></div><div class="ttdeci">void * channel_tag() const</div><div class="ttdef"><b>Definition:</b> rpc_method.h:50</div></div>
|
|
<div class="ttc" id="classgrpc_1_1internal_1_1_rpc_method_html_a40ce84e3569f6a327468ae59f04c7dd1a3b3eb41de854898c2481fb454fc8e2f6"><div class="ttname"><a href="classgrpc_1_1internal_1_1_rpc_method.html#a40ce84e3569f6a327468ae59f04c7dd1a3b3eb41de854898c2481fb454fc8e2f6">grpc::internal::RpcMethod::SERVER_STREAMING</a></div><div class="ttdef"><b>Definition:</b> rpc_method.h:34</div></div>
|
|
<div class="ttc" id="classgrpc_1_1internal_1_1_rpc_method_html_a40ce84e3569f6a327468ae59f04c7dd1"><div class="ttname"><a href="classgrpc_1_1internal_1_1_rpc_method.html#a40ce84e3569f6a327468ae59f04c7dd1">grpc::internal::RpcMethod::RpcType</a></div><div class="ttdeci">RpcType</div><div class="ttdef"><b>Definition:</b> rpc_method.h:31</div></div>
|
|
<div class="ttc" id="classgrpc_1_1internal_1_1_rpc_method_html_aa3d98227a1a0481308de6bc398163713"><div class="ttname"><a href="classgrpc_1_1internal_1_1_rpc_method.html#aa3d98227a1a0481308de6bc398163713">grpc::internal::RpcMethod::name</a></div><div class="ttdeci">const char * name() const</div><div class="ttdef"><b>Definition:</b> rpc_method.h:47</div></div>
|
|
<div class="ttc" id="classgrpc_1_1internal_1_1_rpc_method_html"><div class="ttname"><a href="classgrpc_1_1internal_1_1_rpc_method.html">grpc::internal::RpcMethod</a></div><div class="ttdoc">Descriptor of an RPC method. </div><div class="ttdef"><b>Definition:</b> rpc_method.h:29</div></div>
|
|
<div class="ttc" id="namespacegrpc_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="grpcpp_2impl_2codegen_2channel__interface_8h_html"><div class="ttname"><a href="grpcpp_2impl_2codegen_2channel__interface_8h.html">channel_interface.h</a></div></div>
|
|
<div class="ttc" id="classgrpc_1_1internal_1_1_rpc_method_html_a254b308ceaa38d17c99afb71f4fc1d73"><div class="ttname"><a href="classgrpc_1_1internal_1_1_rpc_method.html#a254b308ceaa38d17c99afb71f4fc1d73">grpc::internal::RpcMethod::RpcMethod</a></div><div class="ttdeci">RpcMethod(const char *name, RpcType type, const std::shared_ptr< ChannelInterface > &channel)</div><div class="ttdef"><b>Definition:</b> rpc_method.h:41</div></div>
|
|
<div class="ttc" id="classgrpc_1_1internal_1_1_rpc_method_html_a40ce84e3569f6a327468ae59f04c7dd1a4138c4a820e1b96d502f32548e88d3fd"><div class="ttname"><a href="classgrpc_1_1internal_1_1_rpc_method.html#a40ce84e3569f6a327468ae59f04c7dd1a4138c4a820e1b96d502f32548e88d3fd">grpc::internal::RpcMethod::CLIENT_STREAMING</a></div><div class="ttdef"><b>Definition:</b> rpc_method.h:33</div></div>
|
|
<div class="ttc" id="classgrpc_1_1internal_1_1_rpc_method_html_a40ce84e3569f6a327468ae59f04c7dd1a8308d189db6d81509042a321ac91b00f"><div class="ttname"><a href="classgrpc_1_1internal_1_1_rpc_method.html#a40ce84e3569f6a327468ae59f04c7dd1a8308d189db6d81509042a321ac91b00f">grpc::internal::RpcMethod::BIDI_STREAMING</a></div><div class="ttdef"><b>Definition:</b> rpc_method.h:35</div></div>
|
|
<div class="ttc" id="classgrpc_1_1internal_1_1_rpc_method_html_abaf8f616c3d919da6dffc182d39a8d74"><div class="ttname"><a href="classgrpc_1_1internal_1_1_rpc_method.html#abaf8f616c3d919da6dffc182d39a8d74">grpc::internal::RpcMethod::method_type</a></div><div class="ttdeci">RpcType method_type() const</div><div class="ttdef"><b>Definition:</b> rpc_method.h:48</div></div>
|
|
<div class="ttc" id="classgrpc_1_1internal_1_1_rpc_method_html_a3d84cbcc47861ba127f053bb9590ff1f"><div class="ttname"><a href="classgrpc_1_1internal_1_1_rpc_method.html#a3d84cbcc47861ba127f053bb9590ff1f">grpc::internal::RpcMethod::SetMethodType</a></div><div class="ttdeci">void SetMethodType(RpcType type)</div><div class="ttdef"><b>Definition:</b> rpc_method.h:49</div></div>
|
|
</div><!-- fragment --></div><!-- contents -->
|
|
<!-- start footer part -->
|
|
<hr class="footer"/><address class="footer"><small>
|
|
Generated on Wed Jul 3 2019 14:51:27 for GRPC C++ by  <a href="http://www.doxygen.org/index.html">
|
|
<img class="footer" src="doxygen.png" alt="doxygen"/>
|
|
</a> 1.8.13
|
|
</small></address>
|
|
</body>
|
|
</html>
|