carto
/
grpc


			
				
					
						
						
							1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495
							<!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/generic/async_generic_service.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" />
<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>
<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.13.0-dev</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_d0687bfb49a2d724b4c01763956c068f.html">generic</a></li>  </ul>
</div>
</div><!-- top -->
<div class="header">
  <div class="headertitle">
<div class="title">async_generic_service.h</div>  </div>
</div><!--header-->
<div class="contents">
<a href="grpcpp_2generic_2async__generic__service_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 2015 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_GENERIC_ASYNC_GENERIC_SERVICE_H</span></div><div class="line"><a name="l00020"></a><span class="lineno">   20</span>&#160;<span class="preprocessor">#define GRPCPP_GENERIC_ASYNC_GENERIC_SERVICE_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_2support_2async__stream_8h.html">grpcpp/support/async_stream.h</a>&gt;</span></div><div class="line"><a name="l00023"></a><span class="lineno">   23</span>&#160;<span class="preprocessor">#include &lt;<a class="code" href="grpcpp_2support_2byte__buffer_8h.html">grpcpp/support/byte_buffer.h</a>&gt;</span></div><div class="line"><a name="l00024"></a><span class="lineno">   24</span>&#160;</div><div class="line"><a name="l00025"></a><span class="lineno">   25</span>&#160;<span class="keyword">struct </span><a class="code" href="grpc__types_8h.html#a2bbbaad8f7a806f6c834b68c5dd916d8">grpc_server</a>;</div><div class="line"><a name="l00026"></a><span class="lineno">   26</span>&#160;</div><div class="line"><a name="l00027"></a><span class="lineno">   27</span>&#160;<span class="keyword">namespace </span><a class="code" href="namespacegrpc.html">grpc</a> {</div><div class="line"><a name="l00028"></a><span class="lineno">   28</span>&#160;</div><div class="line"><a name="l00029"></a><span class="lineno">   29</span>&#160;<span class="keyword">typedef</span> ServerAsyncReaderWriter&lt;ByteBuffer, ByteBuffer&gt;</div><div class="line"><a name="l00030"></a><span class="lineno"><a class="line" href="namespacegrpc.html#a7b3db9e9e4d0c7faf701c9ebd455196a">   30</a></span>&#160;    <a class="code" href="namespacegrpc.html#a7b3db9e9e4d0c7faf701c9ebd455196a">GenericServerAsyncReaderWriter</a>;</div><div class="line"><a name="l00031"></a><span class="lineno">   31</span>&#160;</div><div class="line"><a name="l00032"></a><span class="lineno"><a class="line" href="classgrpc_1_1_generic_server_context.html">   32</a></span>&#160;<span class="keyword">class </span><a class="code" href="classgrpc_1_1_generic_server_context.html">GenericServerContext</a> final : <span class="keyword">public</span> <a class="code" href="classgrpc_1_1_server_context.html">ServerContext</a> {</div><div class="line"><a name="l00033"></a><span class="lineno">   33</span>&#160; <span class="keyword">public</span>:</div><div class="line"><a name="l00034"></a><span class="lineno"><a class="line" href="classgrpc_1_1_generic_server_context.html#ae83fb986d603198af0444f3bd7e9bdd4">   34</a></span>&#160;  <span class="keyword">const</span> <a class="code" href="namespacegrpc.html#ab04a87625da3bf85cdaf5e7856b00203">grpc::string</a>&amp; <a class="code" href="classgrpc_1_1_generic_server_context.html#ae83fb986d603198af0444f3bd7e9bdd4">method</a>()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> method_; }</div><div class="line"><a name="l00035"></a><span class="lineno"><a class="line" href="classgrpc_1_1_generic_server_context.html#acc7ee1e906701857429c25067f244d26">   35</a></span>&#160;  <span class="keyword">const</span> <a class="code" href="namespacegrpc.html#ab04a87625da3bf85cdaf5e7856b00203">grpc::string</a>&amp; <a class="code" href="classgrpc_1_1_generic_server_context.html#acc7ee1e906701857429c25067f244d26">host</a>()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> host_; }</div><div class="line"><a name="l00036"></a><span class="lineno">   36</span>&#160;</div><div class="line"><a name="l00037"></a><span class="lineno">   37</span>&#160; <span class="keyword">private</span>:</div><div class="line"><a name="l00038"></a><span class="lineno"><a class="line" href="classgrpc_1_1_generic_server_context.html#ac2055578ac48afabe5af487878450f68">   38</a></span>&#160;  <span class="keyword">friend</span> <span class="keyword">class </span><a class="code" href="classgrpc_1_1_server.html">Server</a>;</div><div class="line"><a name="l00039"></a><span class="lineno"><a class="line" href="classgrpc_1_1_generic_server_context.html#ad0907065db479dc47b2fa752d7782b6f">   39</a></span>&#160;  <span class="keyword">friend</span> <span class="keyword">class </span><a class="code" href="classgrpc_1_1_server_interface.html">ServerInterface</a>;</div><div class="line"><a name="l00040"></a><span class="lineno">   40</span>&#160;</div><div class="line"><a name="l00041"></a><span class="lineno">   41</span>&#160;  <a class="code" href="namespacegrpc.html#ab04a87625da3bf85cdaf5e7856b00203">grpc::string</a> method_;</div><div class="line"><a name="l00042"></a><span class="lineno">   42</span>&#160;  <a class="code" href="namespacegrpc.html#ab04a87625da3bf85cdaf5e7856b00203">grpc::string</a> host_;</div><div class="line"><a name="l00043"></a><span class="lineno">   43</span>&#160;};</div><div class="line"><a name="l00044"></a><span class="lineno">   44</span>&#160;</div><div class="line"><a name="l00045"></a><span class="lineno">   45</span>&#160;<span class="comment">// A generic service at the server side accepts all RPC methods and hosts. It is</span></div><div class="line"><a name="l00046"></a><span class="lineno">   46</span>&#160;<span class="comment">// typically used in proxies. The generic service can be registered to a server</span></div><div class="line"><a name="l00047"></a><span class="lineno">   47</span>&#160;<span class="comment">// which also has other services.</span></div><div class="line"><a name="l00048"></a><span class="lineno">   48</span>&#160;<span class="comment">// Sample usage:</span></div><div class="line"><a name="l00049"></a><span class="lineno">   49</span>&#160;<span class="comment">//   ServerBuilder builder;</span></div><div class="line"><a name="l00050"></a><span class="lineno">   50</span>&#160;<span class="comment">//   auto cq = builder.AddCompletionQueue();</span></div><div class="line"><a name="l00051"></a><span class="lineno">   51</span>&#160;<span class="comment">//   AsyncGenericService generic_service;</span></div><div class="line"><a name="l00052"></a><span class="lineno">   52</span>&#160;<span class="comment">//   builder.RegisterAsyncGeneicService(&amp;generic_service);</span></div><div class="line"><a name="l00053"></a><span class="lineno">   53</span>&#160;<span class="comment">//   auto server = builder.BuildAndStart();</span></div><div class="line"><a name="l00054"></a><span class="lineno">   54</span>&#160;<span class="comment">//</span></div><div class="line"><a name="l00055"></a><span class="lineno">   55</span>&#160;<span class="comment">//   // request a new call</span></div><div class="line"><a name="l00056"></a><span class="lineno">   56</span>&#160;<span class="comment">//   GenericServerContext context;</span></div><div class="line"><a name="l00057"></a><span class="lineno">   57</span>&#160;<span class="comment">//   GenericAsyncReaderWriter stream;</span></div><div class="line"><a name="l00058"></a><span class="lineno">   58</span>&#160;<span class="comment">//   generic_service.RequestCall(&amp;context, &amp;stream, cq.get(), cq.get(), tag);</span></div><div class="line"><a name="l00059"></a><span class="lineno">   59</span>&#160;<span class="comment">//</span></div><div class="line"><a name="l00060"></a><span class="lineno">   60</span>&#160;<span class="comment">// When tag is retrieved from cq-&gt;Next(), context.method() can be used to look</span></div><div class="line"><a name="l00061"></a><span class="lineno">   61</span>&#160;<span class="comment">// at the method and the RPC can be handled accordingly.</span></div><div class="line"><a name="l00062"></a><span class="lineno"><a class="line" href="classgrpc_1_1_async_generic_service.html">   62</a></span>&#160;<span class="keyword">class </span><a class="code" href="classgrpc_1_1_async_generic_service.html">AsyncGenericService</a> final {</div><div class="line"><a name="l00063"></a><span class="lineno">   63</span>&#160; <span class="keyword">public</span>:</div><div class="line"><a name="l00064"></a><span class="lineno"><a class="line" href="classgrpc_1_1_async_generic_service.html#a8e7ae6f6010c1a6a0c98a7a252001315">   64</a></span>&#160;  <a class="code" href="classgrpc_1_1_async_generic_service.html#a8e7ae6f6010c1a6a0c98a7a252001315">AsyncGenericService</a>() : server_(nullptr) {}</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="keywordtype">void</span> RequestCall(<a class="code" href="classgrpc_1_1_generic_server_context.html">GenericServerContext</a>* ctx,</div><div class="line"><a name="l00067"></a><span class="lineno">   67</span>&#160;                   <a class="code" href="classgrpc_1_1_server_async_reader_writer.html">GenericServerAsyncReaderWriter</a>* reader_writer,</div><div class="line"><a name="l00068"></a><span class="lineno">   68</span>&#160;                   <a class="code" href="classgrpc_1_1_completion_queue.html">CompletionQueue</a>* call_cq,</div><div class="line"><a name="l00069"></a><span class="lineno">   69</span>&#160;                   <a class="code" href="classgrpc_1_1_server_completion_queue.html">ServerCompletionQueue</a>* notification_cq, <span class="keywordtype">void</span>* tag);</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="keyword">private</span>:</div><div class="line"><a name="l00072"></a><span class="lineno"><a class="line" href="classgrpc_1_1_async_generic_service.html#ac2055578ac48afabe5af487878450f68">   72</a></span>&#160;  <span class="keyword">friend</span> <span class="keyword">class </span><a class="code" href="classgrpc_1_1_server.html">Server</a>;</div><div class="line"><a name="l00073"></a><span class="lineno">   73</span>&#160;  <a class="code" href="classgrpc_1_1_server.html">Server</a>* server_;</div><div class="line"><a name="l00074"></a><span class="lineno">   74</span>&#160;};</div><div class="line"><a name="l00075"></a><span class="lineno">   75</span>&#160;</div><div class="line"><a name="l00076"></a><span class="lineno">   76</span>&#160;}  <span class="comment">// namespace grpc</span></div><div class="line"><a name="l00077"></a><span class="lineno">   77</span>&#160;</div><div class="line"><a name="l00078"></a><span class="lineno">   78</span>&#160;<span class="preprocessor">#endif  // GRPCPP_GENERIC_ASYNC_GENERIC_SERVICE_H</span></div><div class="ttc" id="classgrpc_1_1_async_generic_service_html_a8e7ae6f6010c1a6a0c98a7a252001315"><div class="ttname"><a href="classgrpc_1_1_async_generic_service.html#a8e7ae6f6010c1a6a0c98a7a252001315">grpc::AsyncGenericService::AsyncGenericService</a></div><div class="ttdeci">AsyncGenericService()</div><div class="ttdef"><b>Definition:</b> async_generic_service.h:64</div></div>
<div class="ttc" id="classgrpc_1_1_generic_server_context_html_acc7ee1e906701857429c25067f244d26"><div class="ttname"><a href="classgrpc_1_1_generic_server_context.html#acc7ee1e906701857429c25067f244d26">grpc::GenericServerContext::host</a></div><div class="ttdeci">const grpc::string &amp; host() const</div><div class="ttdef"><b>Definition:</b> async_generic_service.h:35</div></div>
<div class="ttc" id="namespacegrpc_html_ab04a87625da3bf85cdaf5e7856b00203"><div class="ttname"><a href="namespacegrpc.html#ab04a87625da3bf85cdaf5e7856b00203">grpc::string</a></div><div class="ttdeci">std::string string</div><div class="ttdef"><b>Definition:</b> config.h:35</div></div>
<div class="ttc" id="classgrpc_1_1_server_async_reader_writer_html"><div class="ttname"><a href="classgrpc_1_1_server_async_reader_writer.html">grpc::ServerAsyncReaderWriter</a></div><div class="ttdoc">Async server-side API for doing bidirectional streaming RPCs, where the incoming message stream comin...</div><div class="ttdef"><b>Definition:</b> async_stream.h:951</div></div>
<div class="ttc" id="grpc__types_8h_html_a2bbbaad8f7a806f6c834b68c5dd916d8"><div class="ttname"><a href="grpc__types_8h.html#a2bbbaad8f7a806f6c834b68c5dd916d8">grpc_server</a></div><div class="ttdeci">struct grpc_server grpc_server</div><div class="ttdoc">A server listens to some port and responds to request calls. </div><div class="ttdef"><b>Definition:</b> grpc_types.h:65</div></div>
<div class="ttc" id="classgrpc_1_1_async_generic_service_html"><div class="ttname"><a href="classgrpc_1_1_async_generic_service.html">grpc::AsyncGenericService</a></div><div class="ttdef"><b>Definition:</b> async_generic_service.h:62</div></div>
<div class="ttc" id="classgrpc_1_1_server_html"><div class="ttname"><a href="classgrpc_1_1_server.html">grpc::Server</a></div><div class="ttdoc">Represents a gRPC server. </div><div class="ttdef"><b>Definition:</b> server.h:52</div></div>
<div class="ttc" id="namespacegrpc_html"><div class="ttname"><a href="namespacegrpc.html">grpc</a></div><div class="ttdoc">An Alarm posts the user provided tag to its associated completion queue upon expiry or cancellation...</div><div class="ttdef"><b>Definition:</b> alarm.h:31</div></div>
<div class="ttc" id="grpcpp_2support_2async__stream_8h_html"><div class="ttname"><a href="grpcpp_2support_2async__stream_8h.html">async_stream.h</a></div></div>
<div class="ttc" id="namespacegrpc_html_a7b3db9e9e4d0c7faf701c9ebd455196a"><div class="ttname"><a href="namespacegrpc.html#a7b3db9e9e4d0c7faf701c9ebd455196a">grpc::GenericServerAsyncReaderWriter</a></div><div class="ttdeci">ServerAsyncReaderWriter&lt; ByteBuffer, ByteBuffer &gt; GenericServerAsyncReaderWriter</div><div class="ttdef"><b>Definition:</b> async_generic_service.h:30</div></div>
<div class="ttc" id="classgrpc_1_1_server_context_html"><div class="ttname"><a href="classgrpc_1_1_server_context.html">grpc::ServerContext</a></div><div class="ttdoc">A ServerContext allows the person implementing a service handler to: </div><div class="ttdef"><b>Definition:</b> server_context.h:96</div></div>
<div class="ttc" id="classgrpc_1_1_server_interface_html"><div class="ttname"><a href="classgrpc_1_1_server_interface.html">grpc::ServerInterface</a></div><div class="ttdef"><b>Definition:</b> server_interface.h:48</div></div>
<div class="ttc" id="grpcpp_2support_2byte__buffer_8h_html"><div class="ttname"><a href="grpcpp_2support_2byte__buffer_8h.html">byte_buffer.h</a></div></div>
<div class="ttc" id="classgrpc_1_1_generic_server_context_html"><div class="ttname"><a href="classgrpc_1_1_generic_server_context.html">grpc::GenericServerContext</a></div><div class="ttdef"><b>Definition:</b> async_generic_service.h:32</div></div>
<div class="ttc" id="classgrpc_1_1_completion_queue_html"><div class="ttname"><a href="classgrpc_1_1_completion_queue.html">grpc::CompletionQueue</a></div><div class="ttdoc">A thin wrapper around grpc_completion_queue (see src/core/lib/surface/completion_queue.h). </div><div class="ttdef"><b>Definition:</b> completion_queue.h:94</div></div>
<div class="ttc" id="classgrpc_1_1_generic_server_context_html_ae83fb986d603198af0444f3bd7e9bdd4"><div class="ttname"><a href="classgrpc_1_1_generic_server_context.html#ae83fb986d603198af0444f3bd7e9bdd4">grpc::GenericServerContext::method</a></div><div class="ttdeci">const grpc::string &amp; method() const</div><div class="ttdef"><b>Definition:</b> async_generic_service.h:34</div></div>
<div class="ttc" id="classgrpc_1_1_server_completion_queue_html"><div class="ttname"><a href="classgrpc_1_1_server_completion_queue.html">grpc::ServerCompletionQueue</a></div><div class="ttdoc">A specific type of completion queue used by the processing of notifications by servers. </div><div class="ttdef"><b>Definition:</b> completion_queue.h:364</div></div>
</div><!-- fragment --></div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Tue May 15 2018 17:01:01 for GRPC C++ by &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.13
</small></address>
</body>
</html>