grpcpp_2impl_2codegen_2grpc__library_8h_source.html 17 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154
  1. <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://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.17"/>
  7. <meta name="viewport" content="width=device-width, initial-scale=1"/>
  8. <title>GRPC C++: include/grpcpp/impl/codegen/grpc_library.h Source File</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. </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.36.1</span>
  26. </div>
  27. </td>
  28. </tr>
  29. </tbody>
  30. </table>
  31. </div>
  32. <!-- end header part -->
  33. <!-- Generated by Doxygen 1.8.17 -->
  34. <script type="text/javascript">
  35. /* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
  36. var searchBox = new SearchBox("searchBox", "search",false,'Search');
  37. /* @license-end */
  38. </script>
  39. <script type="text/javascript" src="menudata.js"></script>
  40. <script type="text/javascript" src="menu.js"></script>
  41. <script type="text/javascript">
  42. /* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
  43. $(function() {
  44. initMenu('',true,false,'search.php','Search');
  45. $(document).ready(function() { init_search(); });
  46. });
  47. /* @license-end */</script>
  48. <div id="main-nav"></div>
  49. <!-- window showing the filter options -->
  50. <div id="MSearchSelectWindow"
  51. onmouseover="return searchBox.OnSearchSelectShow()"
  52. onmouseout="return searchBox.OnSearchSelectHide()"
  53. onkeydown="return searchBox.OnSearchSelectKey(event)">
  54. </div>
  55. <!-- iframe showing the search results (closed by default) -->
  56. <div id="MSearchResultsWindow">
  57. <iframe src="javascript:void(0)" frameborder="0"
  58. name="MSearchResults" id="MSearchResults">
  59. </iframe>
  60. </div>
  61. <div id="nav-path" class="navpath">
  62. <ul>
  63. <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>
  64. </div>
  65. </div><!-- top -->
  66. <div class="header">
  67. <div class="headertitle">
  68. <div class="title">grpc_library.h</div> </div>
  69. </div><!--header-->
  70. <div class="contents">
  71. <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>&#160;<span class="comment">/*</span></div>
  72. <div class="line"><a name="l00002"></a><span class="lineno"> 2</span>&#160;<span class="comment"> *</span></div>
  73. <div class="line"><a name="l00003"></a><span class="lineno"> 3</span>&#160;<span class="comment"> * Copyright 2016 gRPC authors.</span></div>
  74. <div class="line"><a name="l00004"></a><span class="lineno"> 4</span>&#160;<span class="comment"> *</span></div>
  75. <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>
  76. <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>
  77. <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>
  78. <div class="line"><a name="l00008"></a><span class="lineno"> 8</span>&#160;<span class="comment"> *</span></div>
  79. <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>
  80. <div class="line"><a name="l00010"></a><span class="lineno"> 10</span>&#160;<span class="comment"> *</span></div>
  81. <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>
  82. <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>
  83. <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>
  84. <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>
  85. <div class="line"><a name="l00015"></a><span class="lineno"> 15</span>&#160;<span class="comment"> * limitations under the License.</span></div>
  86. <div class="line"><a name="l00016"></a><span class="lineno"> 16</span>&#160;<span class="comment"> *</span></div>
  87. <div class="line"><a name="l00017"></a><span class="lineno"> 17</span>&#160;<span class="comment"> */</span></div>
  88. <div class="line"><a name="l00018"></a><span class="lineno"> 18</span>&#160; </div>
  89. <div class="line"><a name="l00019"></a><span class="lineno"> 19</span>&#160;<span class="preprocessor">#ifndef GRPCPP_IMPL_CODEGEN_GRPC_LIBRARY_H</span></div>
  90. <div class="line"><a name="l00020"></a><span class="lineno"> 20</span>&#160;<span class="preprocessor">#define GRPCPP_IMPL_CODEGEN_GRPC_LIBRARY_H</span></div>
  91. <div class="line"><a name="l00021"></a><span class="lineno"> 21</span>&#160; </div>
  92. <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_2core__codegen__interface_8h.html">grpcpp/impl/codegen/core_codegen_interface.h</a>&gt;</span></div>
  93. <div class="line"><a name="l00023"></a><span class="lineno"> 23</span>&#160; </div>
  94. <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>
  95. <div class="line"><a name="l00025"></a><span class="lineno"> 25</span>&#160; </div>
  96. <div class="line"><a name="l00026"></a><span class="lineno"><a class="line" href="classgrpc_1_1_grpc_library_interface.html"> 26</a></span>&#160;<span class="keyword">class </span><a class="code" href="classgrpc_1_1_grpc_library_interface.html">GrpcLibraryInterface</a> {</div>
  97. <div class="line"><a name="l00027"></a><span class="lineno"> 27</span>&#160; <span class="keyword">public</span>:</div>
  98. <div class="line"><a name="l00028"></a><span class="lineno"> 28</span>&#160; <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>
  99. <div class="line"><a name="l00029"></a><span class="lineno"> 29</span>&#160; <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>
  100. <div class="line"><a name="l00030"></a><span class="lineno"> 30</span>&#160; <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>
  101. <div class="line"><a name="l00031"></a><span class="lineno"> 31</span>&#160;};</div>
  102. <div class="line"><a name="l00032"></a><span class="lineno"> 32</span>&#160; </div>
  103. <div class="line"><a name="l00035"></a><span class="lineno"> 35</span>&#160;<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>
  104. <div class="line"><a name="l00036"></a><span class="lineno"> 36</span>&#160; </div>
  105. <div class="line"><a name="l00038"></a><span class="lineno"><a class="line" href="classgrpc_1_1_grpc_library_codegen.html"> 38</a></span>&#160;<span class="keyword">class </span><a class="code" href="classgrpc_1_1_grpc_library_codegen.html">GrpcLibraryCodegen</a> {</div>
  106. <div class="line"><a name="l00039"></a><span class="lineno"> 39</span>&#160; <span class="keyword">public</span>:</div>
  107. <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>&#160; <span class="keyword">explicit</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>)</div>
  108. <div class="line"><a name="l00041"></a><span class="lineno"> 41</span>&#160; : grpc_init_called_(false) {</div>
  109. <div class="line"><a name="l00042"></a><span class="lineno"> 42</span>&#160; <span class="keywordflow">if</span> (call_grpc_init) {</div>
  110. <div class="line"><a name="l00043"></a><span class="lineno"> 43</span>&#160; <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> &amp;&amp;</div>
  111. <div class="line"><a name="l00044"></a><span class="lineno"> 44</span>&#160; <span class="stringliteral">&quot;gRPC library not initialized. See &quot;</span></div>
  112. <div class="line"><a name="l00045"></a><span class="lineno"> 45</span>&#160; <span class="stringliteral">&quot;grpc::internal::GrpcLibraryInitializer.&quot;</span>);</div>
  113. <div class="line"><a name="l00046"></a><span class="lineno"> 46</span>&#160; <a class="code" href="namespacegrpc.html#ae98af9599a8d1a02e75bae1a9250e1dc">g_glip</a>-&gt;<a class="code" href="classgrpc_1_1_grpc_library_interface.html#a5ddb5274e494472bfbb9133b82be6575">init</a>();</div>
  114. <div class="line"><a name="l00047"></a><span class="lineno"> 47</span>&#160; grpc_init_called_ = <span class="keyword">true</span>;</div>
  115. <div class="line"><a name="l00048"></a><span class="lineno"> 48</span>&#160; }</div>
  116. <div class="line"><a name="l00049"></a><span class="lineno"> 49</span>&#160; }</div>
  117. <div class="line"><a name="l00050"></a><span class="lineno"><a class="line" href="classgrpc_1_1_grpc_library_codegen.html#a81bacc4d1232580ec824d99bfa059b2d"> 50</a></span>&#160; <span class="keyword">virtual</span> <a class="code" href="classgrpc_1_1_grpc_library_codegen.html#a81bacc4d1232580ec824d99bfa059b2d">~GrpcLibraryCodegen</a>() {</div>
  118. <div class="line"><a name="l00051"></a><span class="lineno"> 51</span>&#160; <span class="keywordflow">if</span> (grpc_init_called_) {</div>
  119. <div class="line"><a name="l00052"></a><span class="lineno"> 52</span>&#160; <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> &amp;&amp;</div>
  120. <div class="line"><a name="l00053"></a><span class="lineno"> 53</span>&#160; <span class="stringliteral">&quot;gRPC library not initialized. See &quot;</span></div>
  121. <div class="line"><a name="l00054"></a><span class="lineno"> 54</span>&#160; <span class="stringliteral">&quot;grpc::internal::GrpcLibraryInitializer.&quot;</span>);</div>
  122. <div class="line"><a name="l00055"></a><span class="lineno"> 55</span>&#160; <a class="code" href="namespacegrpc.html#ae98af9599a8d1a02e75bae1a9250e1dc">g_glip</a>-&gt;<a class="code" href="classgrpc_1_1_grpc_library_interface.html#a012f005b6db4bf82a691d738ebe59fd7">shutdown</a>();</div>
  123. <div class="line"><a name="l00056"></a><span class="lineno"> 56</span>&#160; }</div>
  124. <div class="line"><a name="l00057"></a><span class="lineno"> 57</span>&#160; }</div>
  125. <div class="line"><a name="l00058"></a><span class="lineno"> 58</span>&#160; </div>
  126. <div class="line"><a name="l00059"></a><span class="lineno"> 59</span>&#160; <span class="keyword">private</span>:</div>
  127. <div class="line"><a name="l00060"></a><span class="lineno"> 60</span>&#160; <span class="keywordtype">bool</span> grpc_init_called_;</div>
  128. <div class="line"><a name="l00061"></a><span class="lineno"> 61</span>&#160;};</div>
  129. <div class="line"><a name="l00062"></a><span class="lineno"> 62</span>&#160; </div>
  130. <div class="line"><a name="l00063"></a><span class="lineno"> 63</span>&#160;} <span class="comment">// namespace grpc</span></div>
  131. <div class="line"><a name="l00064"></a><span class="lineno"> 64</span>&#160; </div>
  132. <div class="line"><a name="l00065"></a><span class="lineno"> 65</span>&#160;<span class="preprocessor">#endif // GRPCPP_IMPL_CODEGEN_GRPC_LIBRARY_H</span></div>
  133. </div><!-- fragment --></div><!-- contents -->
  134. <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>
  135. <div class="ttc" id="anamespacegrpc_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 or invokes the user-provided ...</div><div class="ttdef"><b>Definition:</b> alarm.h:33</div></div>
  136. <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:50</div></div>
  137. <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>
  138. <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>
  139. <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>
  140. <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>
  141. <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>
  142. <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 &lt;grpcpp/impl/grpc_library.h&gt;</div></div>
  143. <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>
  144. <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>
  145. <!-- start footer part -->
  146. <hr class="footer"/><address class="footer"><small>
  147. Generated on Wed Mar 3 2021 19:17:18 for GRPC C++ by &#160;<a href="http://www.doxygen.org/index.html">
  148. <img class="footer" src="doxygen.png" alt="doxygen"/>
  149. </a> 1.8.17
  150. </small></address>
  151. </body>
  152. </html>