154 lines
17 KiB
HTML
154 lines
17 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/grpc_library.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.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&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&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">grpc_library.h</div> </div>
|
|
</div><!--header-->
|
|
<div class="contents">
|
|
<a href="grpcpp_2impl_2codegen_2grpc__library_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 2016 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_GRPC_LIBRARY_H</span></div>
|
|
<div class="line"><a name="l00020"></a><span class="lineno"> 20</span> <span class="preprocessor">#define GRPCPP_IMPL_CODEGEN_GRPC_LIBRARY_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 <<a class="code" href="grpcpp_2impl_2codegen_2core__codegen__interface_8h.html">grpcpp/impl/codegen/core_codegen_interface.h</a>></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="keyword">namespace </span><a class="code" href="namespacegrpc.html">grpc</a> {</div>
|
|
<div class="line"><a name="l00025"></a><span class="lineno"> 25</span>  </div>
|
|
<div class="line"><a name="l00026"></a><span class="lineno"><a class="line" href="classgrpc_1_1_grpc_library_interface.html"> 26</a></span> <span class="keyword">class </span><a class="code" href="classgrpc_1_1_grpc_library_interface.html">GrpcLibraryInterface</a> {</div>
|
|
<div class="line"><a name="l00027"></a><span class="lineno"> 27</span>  <span class="keyword">public</span>:</div>
|
|
<div class="line"><a name="l00028"></a><span class="lineno"> 28</span>  <span class="keyword">virtual</span> <a class="code" href="classgrpc_1_1_grpc_library_interface.html#a55ae51e9658394117748904ddf9de448">~GrpcLibraryInterface</a>() = <span class="keywordflow">default</span>;</div>
|
|
<div class="line"><a name="l00029"></a><span class="lineno"> 29</span>  <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="classgrpc_1_1_grpc_library_interface.html#a5ddb5274e494472bfbb9133b82be6575">init</a>() = 0;</div>
|
|
<div class="line"><a name="l00030"></a><span class="lineno"> 30</span>  <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="classgrpc_1_1_grpc_library_interface.html#a012f005b6db4bf82a691d738ebe59fd7">shutdown</a>() = 0;</div>
|
|
<div class="line"><a name="l00031"></a><span class="lineno"> 31</span> };</div>
|
|
<div class="line"><a name="l00032"></a><span class="lineno"> 32</span>  </div>
|
|
<div class="line"><a name="l00035"></a><span class="lineno"> 35</span> <span class="keyword">extern</span> <a class="code" href="classgrpc_1_1_grpc_library_interface.html">GrpcLibraryInterface</a>* <a class="code" href="namespacegrpc.html#ae98af9599a8d1a02e75bae1a9250e1dc">g_glip</a>;</div>
|
|
<div class="line"><a name="l00036"></a><span class="lineno"> 36</span>  </div>
|
|
<div class="line"><a name="l00038"></a><span class="lineno"><a class="line" href="classgrpc_1_1_grpc_library_codegen.html"> 38</a></span> <span class="keyword">class </span><a class="code" href="classgrpc_1_1_grpc_library_codegen.html">GrpcLibraryCodegen</a> {</div>
|
|
<div class="line"><a name="l00039"></a><span class="lineno"> 39</span>  <span class="keyword">public</span>:</div>
|
|
<div class="line"><a name="l00040"></a><span class="lineno"><a class="line" href="classgrpc_1_1_grpc_library_codegen.html#a6cbc48b7ceffedeb68abd5a21daac729"> 40</a></span>  <a class="code" href="classgrpc_1_1_grpc_library_codegen.html#a6cbc48b7ceffedeb68abd5a21daac729">GrpcLibraryCodegen</a>(<span class="keywordtype">bool</span> call_grpc_init = <span class="keyword">true</span>) : grpc_init_called_(false) {</div>
|
|
<div class="line"><a name="l00041"></a><span class="lineno"> 41</span>  <span class="keywordflow">if</span> (call_grpc_init) {</div>
|
|
<div class="line"><a name="l00042"></a><span class="lineno"> 42</span>  <a class="code" href="grpcpp_2impl_2codegen_2core__codegen__interface_8h.html#a39c1421e7081b57c503487659e2653a5">GPR_CODEGEN_ASSERT</a>(<a class="code" href="namespacegrpc.html#ae98af9599a8d1a02e75bae1a9250e1dc">g_glip</a> &&</div>
|
|
<div class="line"><a name="l00043"></a><span class="lineno"> 43</span>  <span class="stringliteral">"gRPC library not initialized. See "</span></div>
|
|
<div class="line"><a name="l00044"></a><span class="lineno"> 44</span>  <span class="stringliteral">"grpc::internal::GrpcLibraryInitializer."</span>);</div>
|
|
<div class="line"><a name="l00045"></a><span class="lineno"> 45</span>  <a class="code" href="namespacegrpc.html#ae98af9599a8d1a02e75bae1a9250e1dc">g_glip</a>-><a class="code" href="classgrpc_1_1_grpc_library_interface.html#a5ddb5274e494472bfbb9133b82be6575">init</a>();</div>
|
|
<div class="line"><a name="l00046"></a><span class="lineno"> 46</span>  grpc_init_called_ = <span class="keyword">true</span>;</div>
|
|
<div class="line"><a name="l00047"></a><span class="lineno"> 47</span>  }</div>
|
|
<div class="line"><a name="l00048"></a><span class="lineno"> 48</span>  }</div>
|
|
<div class="line"><a name="l00049"></a><span class="lineno"><a class="line" href="classgrpc_1_1_grpc_library_codegen.html#a81bacc4d1232580ec824d99bfa059b2d"> 49</a></span>  <span class="keyword">virtual</span> <a class="code" href="classgrpc_1_1_grpc_library_codegen.html#a81bacc4d1232580ec824d99bfa059b2d">~GrpcLibraryCodegen</a>() {</div>
|
|
<div class="line"><a name="l00050"></a><span class="lineno"> 50</span>  <span class="keywordflow">if</span> (grpc_init_called_) {</div>
|
|
<div class="line"><a name="l00051"></a><span class="lineno"> 51</span>  <a class="code" href="grpcpp_2impl_2codegen_2core__codegen__interface_8h.html#a39c1421e7081b57c503487659e2653a5">GPR_CODEGEN_ASSERT</a>(<a class="code" href="namespacegrpc.html#ae98af9599a8d1a02e75bae1a9250e1dc">g_glip</a> &&</div>
|
|
<div class="line"><a name="l00052"></a><span class="lineno"> 52</span>  <span class="stringliteral">"gRPC library not initialized. See "</span></div>
|
|
<div class="line"><a name="l00053"></a><span class="lineno"> 53</span>  <span class="stringliteral">"grpc::internal::GrpcLibraryInitializer."</span>);</div>
|
|
<div class="line"><a name="l00054"></a><span class="lineno"> 54</span>  <a class="code" href="namespacegrpc.html#ae98af9599a8d1a02e75bae1a9250e1dc">g_glip</a>-><a class="code" href="classgrpc_1_1_grpc_library_interface.html#a012f005b6db4bf82a691d738ebe59fd7">shutdown</a>();</div>
|
|
<div class="line"><a name="l00055"></a><span class="lineno"> 55</span>  }</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="keyword">private</span>:</div>
|
|
<div class="line"><a name="l00059"></a><span class="lineno"> 59</span>  <span class="keywordtype">bool</span> grpc_init_called_;</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>  </div>
|
|
<div class="line"><a name="l00062"></a><span class="lineno"> 62</span> } <span class="comment">// namespace grpc</span></div>
|
|
<div class="line"><a name="l00063"></a><span class="lineno"> 63</span>  </div>
|
|
<div class="line"><a name="l00064"></a><span class="lineno"> 64</span> <span class="preprocessor">#endif // GRPCPP_IMPL_CODEGEN_GRPC_LIBRARY_H</span></div>
|
|
</div><!-- fragment --></div><!-- contents -->
|
|
<div class="ttc" id="aclassgrpc_1_1_grpc_library_codegen_html"><div class="ttname"><a href="classgrpc_1_1_grpc_library_codegen.html">grpc::GrpcLibraryCodegen</a></div><div class="ttdoc">Classes that require gRPC to be initialized should inherit from this class.</div><div class="ttdef"><b>Definition:</b> grpc_library.h:38</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_1_1_grpc_library_codegen_html_a81bacc4d1232580ec824d99bfa059b2d"><div class="ttname"><a href="classgrpc_1_1_grpc_library_codegen.html#a81bacc4d1232580ec824d99bfa059b2d">grpc::GrpcLibraryCodegen::~GrpcLibraryCodegen</a></div><div class="ttdeci">virtual ~GrpcLibraryCodegen()</div><div class="ttdef"><b>Definition:</b> grpc_library.h:49</div></div>
|
|
<div class="ttc" id="aclassgrpc_1_1_grpc_library_codegen_html_a6cbc48b7ceffedeb68abd5a21daac729"><div class="ttname"><a href="classgrpc_1_1_grpc_library_codegen.html#a6cbc48b7ceffedeb68abd5a21daac729">grpc::GrpcLibraryCodegen::GrpcLibraryCodegen</a></div><div class="ttdeci">GrpcLibraryCodegen(bool call_grpc_init=true)</div><div class="ttdef"><b>Definition:</b> grpc_library.h:40</div></div>
|
|
<div class="ttc" id="agrpcpp_2impl_2codegen_2core__codegen__interface_8h_html"><div class="ttname"><a href="grpcpp_2impl_2codegen_2core__codegen__interface_8h.html">core_codegen_interface.h</a></div></div>
|
|
<div class="ttc" id="aclassgrpc_1_1_grpc_library_interface_html"><div class="ttname"><a href="classgrpc_1_1_grpc_library_interface.html">grpc::GrpcLibraryInterface</a></div><div class="ttdef"><b>Definition:</b> grpc_library.h:26</div></div>
|
|
<div class="ttc" id="aclassgrpc_1_1_grpc_library_interface_html_a55ae51e9658394117748904ddf9de448"><div class="ttname"><a href="classgrpc_1_1_grpc_library_interface.html#a55ae51e9658394117748904ddf9de448">grpc::GrpcLibraryInterface::~GrpcLibraryInterface</a></div><div class="ttdeci">virtual ~GrpcLibraryInterface()=default</div></div>
|
|
<div class="ttc" id="aclassgrpc_1_1_grpc_library_interface_html_a012f005b6db4bf82a691d738ebe59fd7"><div class="ttname"><a href="classgrpc_1_1_grpc_library_interface.html#a012f005b6db4bf82a691d738ebe59fd7">grpc::GrpcLibraryInterface::shutdown</a></div><div class="ttdeci">virtual void shutdown()=0</div></div>
|
|
<div class="ttc" id="anamespacegrpc_html_ae98af9599a8d1a02e75bae1a9250e1dc"><div class="ttname"><a href="namespacegrpc.html#ae98af9599a8d1a02e75bae1a9250e1dc">grpc::g_glip</a></div><div class="ttdeci">GrpcLibraryInterface * g_glip</div><div class="ttdoc">Initialized by grpc::GrpcLibraryInitializer from <grpcpp/impl/grpc_library.h></div></div>
|
|
<div class="ttc" id="agrpcpp_2impl_2codegen_2core__codegen__interface_8h_html_a39c1421e7081b57c503487659e2653a5"><div class="ttname"><a href="grpcpp_2impl_2codegen_2core__codegen__interface_8h.html#a39c1421e7081b57c503487659e2653a5">GPR_CODEGEN_ASSERT</a></div><div class="ttdeci">#define GPR_CODEGEN_ASSERT(x)</div><div class="ttdoc">Codegen specific version of GPR_ASSERT.</div><div class="ttdef"><b>Definition:</b> core_codegen_interface.h:146</div></div>
|
|
<div class="ttc" id="aclassgrpc_1_1_grpc_library_interface_html_a5ddb5274e494472bfbb9133b82be6575"><div class="ttname"><a href="classgrpc_1_1_grpc_library_interface.html#a5ddb5274e494472bfbb9133b82be6575">grpc::GrpcLibraryInterface::init</a></div><div class="ttdeci">virtual void init()=0</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  <a href="http://www.doxygen.org/index.html">
|
|
<img class="footer" src="doxygen.png" alt="doxygen"/>
|
|
</a> 1.8.17
|
|
</small></address>
|
|
</body>
|
|
</html>
|