impl_2codegen_2log_8h.html 31 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501
  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/grpc/impl/codegen/log.h File Reference</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_9d7a14d6d9adcbe4c35dbdb88d867e2e.html">grpc</a></li><li class="navelem"><a class="el" href="dir_4b3e2ed696753daba329e2683e0f6479.html">impl</a></li><li class="navelem"><a class="el" href="dir_7a167954ab48275cc692d783196d1f28.html">codegen</a></li> </ul>
  64. </div>
  65. </div><!-- top -->
  66. <div class="header">
  67. <div class="summary">
  68. <a href="#nested-classes">Data Structures</a> &#124;
  69. <a href="#define-members">Macros</a> &#124;
  70. <a href="#typedef-members">Typedefs</a> &#124;
  71. <a href="#enum-members">Enumerations</a> &#124;
  72. <a href="#func-members">Functions</a> </div>
  73. <div class="headertitle">
  74. <div class="title">log.h File Reference</div> </div>
  75. </div><!--header-->
  76. <div class="contents">
  77. <div class="textblock"><code>#include &lt;<a class="el" href="impl_2codegen_2port__platform_8h_source.html">grpc/impl/codegen/port_platform.h</a>&gt;</code><br />
  78. <code>#include &lt;stdarg.h&gt;</code><br />
  79. <code>#include &lt;stdlib.h&gt;</code><br />
  80. </div>
  81. <p><a href="impl_2codegen_2log_8h_source.html">Go to the source code of this file.</a></p>
  82. <table class="memberdecls">
  83. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="nested-classes"></a>
  84. Data Structures</h2></td></tr>
  85. <tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structgpr__log__func__args.html">gpr_log_func_args</a></td></tr>
  86. <tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">Log overrides: applications can use this API to intercept logging calls and use their own implementations. <a href="structgpr__log__func__args.html#details">More...</a><br /></td></tr>
  87. <tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
  88. </table><table class="memberdecls">
  89. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="define-members"></a>
  90. Macros</h2></td></tr>
  91. <tr class="memitem:a3e793245091f13bb7318a18b1166a773"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="impl_2codegen_2log_8h.html#a3e793245091f13bb7318a18b1166a773">GPR_DEBUG</a>&#160;&#160;&#160;__FILE__, __LINE__, <a class="el" href="impl_2codegen_2log_8h.html#af10334b4085ac6985a2af9c08478ad48af7d2a0ad91b0787398220ddcd91f06d6">GPR_LOG_SEVERITY_DEBUG</a></td></tr>
  92. <tr class="memdesc:a3e793245091f13bb7318a18b1166a773"><td class="mdescLeft">&#160;</td><td class="mdescRight">Macros to build log contexts at various severity levels. <a href="impl_2codegen_2log_8h.html#a3e793245091f13bb7318a18b1166a773">More...</a><br /></td></tr>
  93. <tr class="separator:a3e793245091f13bb7318a18b1166a773"><td class="memSeparator" colspan="2">&#160;</td></tr>
  94. <tr class="memitem:af0d0d75690f79edc9294498c88f96703"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="impl_2codegen_2log_8h.html#af0d0d75690f79edc9294498c88f96703">GPR_INFO</a>&#160;&#160;&#160;__FILE__, __LINE__, <a class="el" href="impl_2codegen_2log_8h.html#af10334b4085ac6985a2af9c08478ad48af6c13c67f06821c1629b7e019af4aaf1">GPR_LOG_SEVERITY_INFO</a></td></tr>
  95. <tr class="separator:af0d0d75690f79edc9294498c88f96703"><td class="memSeparator" colspan="2">&#160;</td></tr>
  96. <tr class="memitem:a63faedb3eefd93d1c0e79974be80cc36"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="impl_2codegen_2log_8h.html#a63faedb3eefd93d1c0e79974be80cc36">GPR_ERROR</a>&#160;&#160;&#160;__FILE__, __LINE__, <a class="el" href="impl_2codegen_2log_8h.html#af10334b4085ac6985a2af9c08478ad48a52b957eb23ac2207b5e1dcf15c2b3dd4">GPR_LOG_SEVERITY_ERROR</a></td></tr>
  97. <tr class="separator:a63faedb3eefd93d1c0e79974be80cc36"><td class="memSeparator" colspan="2">&#160;</td></tr>
  98. <tr class="memitem:a6ccf52ff690655cc22cd9d053650876f"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="impl_2codegen_2log_8h.html#a6ccf52ff690655cc22cd9d053650876f">GPR_ASSERT</a>(x)</td></tr>
  99. <tr class="memdesc:a6ccf52ff690655cc22cd9d053650876f"><td class="mdescLeft">&#160;</td><td class="mdescRight">abort() the process if x is zero, having written a line to the log. <a href="impl_2codegen_2log_8h.html#a6ccf52ff690655cc22cd9d053650876f">More...</a><br /></td></tr>
  100. <tr class="separator:a6ccf52ff690655cc22cd9d053650876f"><td class="memSeparator" colspan="2">&#160;</td></tr>
  101. <tr class="memitem:a4720a11176c735c4456815394edb6bff"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="impl_2codegen_2log_8h.html#a4720a11176c735c4456815394edb6bff">GPR_DEBUG_ASSERT</a>(x)&#160;&#160;&#160;<a class="el" href="impl_2codegen_2log_8h.html#a6ccf52ff690655cc22cd9d053650876f">GPR_ASSERT</a>(x)</td></tr>
  102. <tr class="separator:a4720a11176c735c4456815394edb6bff"><td class="memSeparator" colspan="2">&#160;</td></tr>
  103. </table><table class="memberdecls">
  104. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="typedef-members"></a>
  105. Typedefs</h2></td></tr>
  106. <tr class="memitem:a3a2a87a76a9906f50b33472e2e68381d"><td class="memItemLeft" align="right" valign="top">typedef enum <a class="el" href="impl_2codegen_2log_8h.html#af10334b4085ac6985a2af9c08478ad48">gpr_log_severity</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="impl_2codegen_2log_8h.html#a3a2a87a76a9906f50b33472e2e68381d">gpr_log_severity</a></td></tr>
  107. <tr class="memdesc:a3a2a87a76a9906f50b33472e2e68381d"><td class="mdescLeft">&#160;</td><td class="mdescRight">GPR log API. <a href="impl_2codegen_2log_8h.html#a3a2a87a76a9906f50b33472e2e68381d">More...</a><br /></td></tr>
  108. <tr class="separator:a3a2a87a76a9906f50b33472e2e68381d"><td class="memSeparator" colspan="2">&#160;</td></tr>
  109. <tr class="memitem:adce8dc81f07a98265e917de7d7f3cde5"><td class="memItemLeft" align="right" valign="top">typedef struct <a class="el" href="structgpr__log__func__args.html">gpr_log_func_args</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="impl_2codegen_2log_8h.html#adce8dc81f07a98265e917de7d7f3cde5">gpr_log_func_args</a></td></tr>
  110. <tr class="separator:adce8dc81f07a98265e917de7d7f3cde5"><td class="memSeparator" colspan="2">&#160;</td></tr>
  111. <tr class="memitem:a3bba35ee3180d11d8ff5a71cc2ee2a05"><td class="memItemLeft" align="right" valign="top">typedef void(*&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="impl_2codegen_2log_8h.html#a3bba35ee3180d11d8ff5a71cc2ee2a05">gpr_log_func</a>) (<a class="el" href="structgpr__log__func__args.html">gpr_log_func_args</a> *args)</td></tr>
  112. <tr class="separator:a3bba35ee3180d11d8ff5a71cc2ee2a05"><td class="memSeparator" colspan="2">&#160;</td></tr>
  113. </table><table class="memberdecls">
  114. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="enum-members"></a>
  115. Enumerations</h2></td></tr>
  116. <tr class="memitem:af10334b4085ac6985a2af9c08478ad48"><td class="memItemLeft" align="right" valign="top">enum &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="impl_2codegen_2log_8h.html#af10334b4085ac6985a2af9c08478ad48">gpr_log_severity</a> { <a class="el" href="impl_2codegen_2log_8h.html#af10334b4085ac6985a2af9c08478ad48af7d2a0ad91b0787398220ddcd91f06d6">GPR_LOG_SEVERITY_DEBUG</a>,
  117. <a class="el" href="impl_2codegen_2log_8h.html#af10334b4085ac6985a2af9c08478ad48af6c13c67f06821c1629b7e019af4aaf1">GPR_LOG_SEVERITY_INFO</a>,
  118. <a class="el" href="impl_2codegen_2log_8h.html#af10334b4085ac6985a2af9c08478ad48a52b957eb23ac2207b5e1dcf15c2b3dd4">GPR_LOG_SEVERITY_ERROR</a>
  119. }</td></tr>
  120. <tr class="memdesc:af10334b4085ac6985a2af9c08478ad48"><td class="mdescLeft">&#160;</td><td class="mdescRight">GPR log API. <a href="impl_2codegen_2log_8h.html#af10334b4085ac6985a2af9c08478ad48">More...</a><br /></td></tr>
  121. <tr class="separator:af10334b4085ac6985a2af9c08478ad48"><td class="memSeparator" colspan="2">&#160;</td></tr>
  122. </table><table class="memberdecls">
  123. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
  124. Functions</h2></td></tr>
  125. <tr class="memitem:a48772229c123479748e79b8100cfe596"><td class="memItemLeft" align="right" valign="top">const <a class="el" href="impl_2codegen_2port__platform_8h.html#af89d3610372fc35178e83e06916aa808">GPRAPI</a> char *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="impl_2codegen_2log_8h.html#a48772229c123479748e79b8100cfe596">gpr_log_severity_string</a> (<a class="el" href="impl_2codegen_2log_8h.html#af10334b4085ac6985a2af9c08478ad48">gpr_log_severity</a> severity)</td></tr>
  126. <tr class="memdesc:a48772229c123479748e79b8100cfe596"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns a string representation of the log severity. <a href="impl_2codegen_2log_8h.html#a48772229c123479748e79b8100cfe596">More...</a><br /></td></tr>
  127. <tr class="separator:a48772229c123479748e79b8100cfe596"><td class="memSeparator" colspan="2">&#160;</td></tr>
  128. <tr class="memitem:a938a283d9a10c3ddfe46dfc22e21077f"><td class="memItemLeft" align="right" valign="top"><a class="el" href="impl_2codegen_2port__platform_8h.html#af89d3610372fc35178e83e06916aa808">GPRAPI</a> void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="impl_2codegen_2log_8h.html#a938a283d9a10c3ddfe46dfc22e21077f">gpr_log</a> (const char *file, int line, <a class="el" href="impl_2codegen_2log_8h.html#af10334b4085ac6985a2af9c08478ad48">gpr_log_severity</a> severity, const char *format,...) <a class="el" href="impl_2codegen_2port__platform_8h.html#a3364659cddcdfeae3897c3300de03d05">GPR_PRINT_FORMAT_CHECK</a>(4</td></tr>
  129. <tr class="memdesc:a938a283d9a10c3ddfe46dfc22e21077f"><td class="mdescLeft">&#160;</td><td class="mdescRight">Log a message. <a href="impl_2codegen_2log_8h.html#a938a283d9a10c3ddfe46dfc22e21077f">More...</a><br /></td></tr>
  130. <tr class="separator:a938a283d9a10c3ddfe46dfc22e21077f"><td class="memSeparator" colspan="2">&#160;</td></tr>
  131. <tr class="memitem:a7fb54337c9f6a34074ab181eb98ace47"><td class="memItemLeft" align="right" valign="top"><a class="el" href="impl_2codegen_2port__platform_8h.html#af89d3610372fc35178e83e06916aa808">GPRAPI</a> void <a class="el" href="impl_2codegen_2port__platform_8h.html#af89d3610372fc35178e83e06916aa808">GPRAPI</a> int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="impl_2codegen_2log_8h.html#a7fb54337c9f6a34074ab181eb98ace47">gpr_should_log</a> (<a class="el" href="impl_2codegen_2log_8h.html#af10334b4085ac6985a2af9c08478ad48">gpr_log_severity</a> severity)</td></tr>
  132. <tr class="separator:a7fb54337c9f6a34074ab181eb98ace47"><td class="memSeparator" colspan="2">&#160;</td></tr>
  133. <tr class="memitem:a182dc49f7d429e28b35cb78133e542d8"><td class="memItemLeft" align="right" valign="top"><a class="el" href="impl_2codegen_2port__platform_8h.html#af89d3610372fc35178e83e06916aa808">GPRAPI</a> void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="impl_2codegen_2log_8h.html#a182dc49f7d429e28b35cb78133e542d8">gpr_log_message</a> (const char *file, int line, <a class="el" href="impl_2codegen_2log_8h.html#af10334b4085ac6985a2af9c08478ad48">gpr_log_severity</a> severity, const char *message)</td></tr>
  134. <tr class="separator:a182dc49f7d429e28b35cb78133e542d8"><td class="memSeparator" colspan="2">&#160;</td></tr>
  135. <tr class="memitem:aec0c537cb1e244060c65d9d9d153979f"><td class="memItemLeft" align="right" valign="top"><a class="el" href="impl_2codegen_2port__platform_8h.html#af89d3610372fc35178e83e06916aa808">GPRAPI</a> void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="impl_2codegen_2log_8h.html#aec0c537cb1e244060c65d9d9d153979f">gpr_set_log_verbosity</a> (<a class="el" href="impl_2codegen_2log_8h.html#af10334b4085ac6985a2af9c08478ad48">gpr_log_severity</a> min_severity_to_print)</td></tr>
  136. <tr class="memdesc:aec0c537cb1e244060c65d9d9d153979f"><td class="mdescLeft">&#160;</td><td class="mdescRight">Set global log verbosity. <a href="impl_2codegen_2log_8h.html#aec0c537cb1e244060c65d9d9d153979f">More...</a><br /></td></tr>
  137. <tr class="separator:aec0c537cb1e244060c65d9d9d153979f"><td class="memSeparator" colspan="2">&#160;</td></tr>
  138. <tr class="memitem:a920f1611251015a9806177ed78931aa5"><td class="memItemLeft" align="right" valign="top"><a class="el" href="impl_2codegen_2port__platform_8h.html#af89d3610372fc35178e83e06916aa808">GPRAPI</a> void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="impl_2codegen_2log_8h.html#a920f1611251015a9806177ed78931aa5">gpr_log_verbosity_init</a> (void)</td></tr>
  139. <tr class="separator:a920f1611251015a9806177ed78931aa5"><td class="memSeparator" colspan="2">&#160;</td></tr>
  140. <tr class="memitem:ae437062e3540eeebb4c95f119fe56be5"><td class="memItemLeft" align="right" valign="top"><a class="el" href="impl_2codegen_2port__platform_8h.html#af89d3610372fc35178e83e06916aa808">GPRAPI</a> void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="impl_2codegen_2log_8h.html#ae437062e3540eeebb4c95f119fe56be5">gpr_set_log_function</a> (<a class="el" href="impl_2codegen_2log_8h.html#a3bba35ee3180d11d8ff5a71cc2ee2a05">gpr_log_func</a> func)</td></tr>
  141. <tr class="separator:ae437062e3540eeebb4c95f119fe56be5"><td class="memSeparator" colspan="2">&#160;</td></tr>
  142. </table>
  143. <h2 class="groupheader">Macro Definition Documentation</h2>
  144. <a id="a6ccf52ff690655cc22cd9d053650876f"></a>
  145. <h2 class="memtitle"><span class="permalink"><a href="#a6ccf52ff690655cc22cd9d053650876f">&#9670;&nbsp;</a></span>GPR_ASSERT</h2>
  146. <div class="memitem">
  147. <div class="memproto">
  148. <table class="memname">
  149. <tr>
  150. <td class="memname">#define GPR_ASSERT</td>
  151. <td>(</td>
  152. <td class="paramtype">&#160;</td>
  153. <td class="paramname">x</td><td>)</td>
  154. <td></td>
  155. </tr>
  156. </table>
  157. </div><div class="memdoc">
  158. <b>Value:</b><div class="fragment"><div class="line"> <span class="keywordflow">do</span> { \</div>
  159. <div class="line"> if (<a class="code" href="impl_2codegen_2port__platform_8h.html#a99b5bddfe84f8dc8ee55b35405b8fddd">GPR_UNLIKELY</a>(!(x))) { \</div>
  160. <div class="line"> gpr_log(<a class="code" href="impl_2codegen_2log_8h.html#a63faedb3eefd93d1c0e79974be80cc36">GPR_ERROR</a>, <span class="stringliteral">&quot;assertion failed: %s&quot;</span>, #x); \</div>
  161. <div class="line"> abort(); \</div>
  162. <div class="line"> } \</div>
  163. <div class="line"> } <span class="keywordflow">while</span> (0)</div>
  164. </div><!-- fragment -->
  165. <p>abort() the process if x is zero, having written a line to the log. </p>
  166. <p>Intended for internal invariants. If the error can be recovered from, without the possibility of corruption, or might best be reflected via an exception in a higher-level language, consider returning error code. <br />
  167. </p>
  168. </div>
  169. </div>
  170. <a id="a3e793245091f13bb7318a18b1166a773"></a>
  171. <h2 class="memtitle"><span class="permalink"><a href="#a3e793245091f13bb7318a18b1166a773">&#9670;&nbsp;</a></span>GPR_DEBUG</h2>
  172. <div class="memitem">
  173. <div class="memproto">
  174. <table class="memname">
  175. <tr>
  176. <td class="memname">#define GPR_DEBUG&#160;&#160;&#160;__FILE__, __LINE__, <a class="el" href="impl_2codegen_2log_8h.html#af10334b4085ac6985a2af9c08478ad48af7d2a0ad91b0787398220ddcd91f06d6">GPR_LOG_SEVERITY_DEBUG</a></td>
  177. </tr>
  178. </table>
  179. </div><div class="memdoc">
  180. <p>Macros to build log contexts at various severity levels. </p>
  181. </div>
  182. </div>
  183. <a id="a4720a11176c735c4456815394edb6bff"></a>
  184. <h2 class="memtitle"><span class="permalink"><a href="#a4720a11176c735c4456815394edb6bff">&#9670;&nbsp;</a></span>GPR_DEBUG_ASSERT</h2>
  185. <div class="memitem">
  186. <div class="memproto">
  187. <table class="memname">
  188. <tr>
  189. <td class="memname">#define GPR_DEBUG_ASSERT</td>
  190. <td>(</td>
  191. <td class="paramtype">&#160;</td>
  192. <td class="paramname">x</td><td>)</td>
  193. <td>&#160;&#160;&#160;<a class="el" href="impl_2codegen_2log_8h.html#a6ccf52ff690655cc22cd9d053650876f">GPR_ASSERT</a>(x)</td>
  194. </tr>
  195. </table>
  196. </div><div class="memdoc">
  197. </div>
  198. </div>
  199. <a id="a63faedb3eefd93d1c0e79974be80cc36"></a>
  200. <h2 class="memtitle"><span class="permalink"><a href="#a63faedb3eefd93d1c0e79974be80cc36">&#9670;&nbsp;</a></span>GPR_ERROR</h2>
  201. <div class="memitem">
  202. <div class="memproto">
  203. <table class="memname">
  204. <tr>
  205. <td class="memname">#define GPR_ERROR&#160;&#160;&#160;__FILE__, __LINE__, <a class="el" href="impl_2codegen_2log_8h.html#af10334b4085ac6985a2af9c08478ad48a52b957eb23ac2207b5e1dcf15c2b3dd4">GPR_LOG_SEVERITY_ERROR</a></td>
  206. </tr>
  207. </table>
  208. </div><div class="memdoc">
  209. </div>
  210. </div>
  211. <a id="af0d0d75690f79edc9294498c88f96703"></a>
  212. <h2 class="memtitle"><span class="permalink"><a href="#af0d0d75690f79edc9294498c88f96703">&#9670;&nbsp;</a></span>GPR_INFO</h2>
  213. <div class="memitem">
  214. <div class="memproto">
  215. <table class="memname">
  216. <tr>
  217. <td class="memname">#define GPR_INFO&#160;&#160;&#160;__FILE__, __LINE__, <a class="el" href="impl_2codegen_2log_8h.html#af10334b4085ac6985a2af9c08478ad48af6c13c67f06821c1629b7e019af4aaf1">GPR_LOG_SEVERITY_INFO</a></td>
  218. </tr>
  219. </table>
  220. </div><div class="memdoc">
  221. </div>
  222. </div>
  223. <h2 class="groupheader">Typedef Documentation</h2>
  224. <a id="a3bba35ee3180d11d8ff5a71cc2ee2a05"></a>
  225. <h2 class="memtitle"><span class="permalink"><a href="#a3bba35ee3180d11d8ff5a71cc2ee2a05">&#9670;&nbsp;</a></span>gpr_log_func</h2>
  226. <div class="memitem">
  227. <div class="memproto">
  228. <table class="memname">
  229. <tr>
  230. <td class="memname">typedef void(* gpr_log_func) (<a class="el" href="structgpr__log__func__args.html">gpr_log_func_args</a> *args)</td>
  231. </tr>
  232. </table>
  233. </div><div class="memdoc">
  234. </div>
  235. </div>
  236. <a id="adce8dc81f07a98265e917de7d7f3cde5"></a>
  237. <h2 class="memtitle"><span class="permalink"><a href="#adce8dc81f07a98265e917de7d7f3cde5">&#9670;&nbsp;</a></span>gpr_log_func_args</h2>
  238. <div class="memitem">
  239. <div class="memproto">
  240. <table class="memname">
  241. <tr>
  242. <td class="memname">typedef struct <a class="el" href="structgpr__log__func__args.html">gpr_log_func_args</a> <a class="el" href="structgpr__log__func__args.html">gpr_log_func_args</a></td>
  243. </tr>
  244. </table>
  245. </div><div class="memdoc">
  246. </div>
  247. </div>
  248. <a id="a3a2a87a76a9906f50b33472e2e68381d"></a>
  249. <h2 class="memtitle"><span class="permalink"><a href="#a3a2a87a76a9906f50b33472e2e68381d">&#9670;&nbsp;</a></span>gpr_log_severity</h2>
  250. <div class="memitem">
  251. <div class="memproto">
  252. <table class="memname">
  253. <tr>
  254. <td class="memname">typedef enum <a class="el" href="impl_2codegen_2log_8h.html#af10334b4085ac6985a2af9c08478ad48">gpr_log_severity</a> <a class="el" href="impl_2codegen_2log_8h.html#af10334b4085ac6985a2af9c08478ad48">gpr_log_severity</a></td>
  255. </tr>
  256. </table>
  257. </div><div class="memdoc">
  258. <p>GPR log API. </p>
  259. <p>Usage (within grpc):</p>
  260. <p>int argument1 = 3; char* argument2 = "hello"; gpr_log(GPR_DEBUG, "format string %d", argument1); gpr_log(GPR_INFO, "hello world"); gpr_log(GPR_ERROR, "%d %s!!", argument1, argument2); The severity of a log message - use the #defines below when calling into gpr_log to additionally supply file and line data </p>
  261. </div>
  262. </div>
  263. <h2 class="groupheader">Enumeration Type Documentation</h2>
  264. <a id="af10334b4085ac6985a2af9c08478ad48"></a>
  265. <h2 class="memtitle"><span class="permalink"><a href="#af10334b4085ac6985a2af9c08478ad48">&#9670;&nbsp;</a></span>gpr_log_severity</h2>
  266. <div class="memitem">
  267. <div class="memproto">
  268. <table class="memname">
  269. <tr>
  270. <td class="memname">enum <a class="el" href="impl_2codegen_2log_8h.html#af10334b4085ac6985a2af9c08478ad48">gpr_log_severity</a></td>
  271. </tr>
  272. </table>
  273. </div><div class="memdoc">
  274. <p>GPR log API. </p>
  275. <p>Usage (within grpc):</p>
  276. <p>int argument1 = 3; char* argument2 = "hello"; gpr_log(GPR_DEBUG, "format string %d", argument1); gpr_log(GPR_INFO, "hello world"); gpr_log(GPR_ERROR, "%d %s!!", argument1, argument2); The severity of a log message - use the #defines below when calling into gpr_log to additionally supply file and line data </p>
  277. <table class="fieldtable">
  278. <tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><a id="af10334b4085ac6985a2af9c08478ad48af7d2a0ad91b0787398220ddcd91f06d6"></a>GPR_LOG_SEVERITY_DEBUG&#160;</td><td class="fielddoc"></td></tr>
  279. <tr><td class="fieldname"><a id="af10334b4085ac6985a2af9c08478ad48af6c13c67f06821c1629b7e019af4aaf1"></a>GPR_LOG_SEVERITY_INFO&#160;</td><td class="fielddoc"></td></tr>
  280. <tr><td class="fieldname"><a id="af10334b4085ac6985a2af9c08478ad48a52b957eb23ac2207b5e1dcf15c2b3dd4"></a>GPR_LOG_SEVERITY_ERROR&#160;</td><td class="fielddoc"></td></tr>
  281. </table>
  282. </div>
  283. </div>
  284. <h2 class="groupheader">Function Documentation</h2>
  285. <a id="a938a283d9a10c3ddfe46dfc22e21077f"></a>
  286. <h2 class="memtitle"><span class="permalink"><a href="#a938a283d9a10c3ddfe46dfc22e21077f">&#9670;&nbsp;</a></span>gpr_log()</h2>
  287. <div class="memitem">
  288. <div class="memproto">
  289. <table class="memname">
  290. <tr>
  291. <td class="memname"><a class="el" href="impl_2codegen_2port__platform_8h.html#af89d3610372fc35178e83e06916aa808">GPRAPI</a> void gpr_log </td>
  292. <td>(</td>
  293. <td class="paramtype">const char *&#160;</td>
  294. <td class="paramname"><em>file</em>, </td>
  295. </tr>
  296. <tr>
  297. <td class="paramkey"></td>
  298. <td></td>
  299. <td class="paramtype">int&#160;</td>
  300. <td class="paramname"><em>line</em>, </td>
  301. </tr>
  302. <tr>
  303. <td class="paramkey"></td>
  304. <td></td>
  305. <td class="paramtype"><a class="el" href="impl_2codegen_2log_8h.html#af10334b4085ac6985a2af9c08478ad48">gpr_log_severity</a>&#160;</td>
  306. <td class="paramname"><em>severity</em>, </td>
  307. </tr>
  308. <tr>
  309. <td class="paramkey"></td>
  310. <td></td>
  311. <td class="paramtype">const char *&#160;</td>
  312. <td class="paramname"><em>format</em>, </td>
  313. </tr>
  314. <tr>
  315. <td class="paramkey"></td>
  316. <td></td>
  317. <td class="paramtype">&#160;</td>
  318. <td class="paramname"><em>...</em>&#160;</td>
  319. </tr>
  320. <tr>
  321. <td></td>
  322. <td>)</td>
  323. <td></td><td></td>
  324. </tr>
  325. </table>
  326. </div><div class="memdoc">
  327. <p>Log a message. </p>
  328. <p>It's advised to use GPR_xxx above to generate the context for each message </p>
  329. </div>
  330. </div>
  331. <a id="a182dc49f7d429e28b35cb78133e542d8"></a>
  332. <h2 class="memtitle"><span class="permalink"><a href="#a182dc49f7d429e28b35cb78133e542d8">&#9670;&nbsp;</a></span>gpr_log_message()</h2>
  333. <div class="memitem">
  334. <div class="memproto">
  335. <table class="memname">
  336. <tr>
  337. <td class="memname"><a class="el" href="impl_2codegen_2port__platform_8h.html#af89d3610372fc35178e83e06916aa808">GPRAPI</a> void gpr_log_message </td>
  338. <td>(</td>
  339. <td class="paramtype">const char *&#160;</td>
  340. <td class="paramname"><em>file</em>, </td>
  341. </tr>
  342. <tr>
  343. <td class="paramkey"></td>
  344. <td></td>
  345. <td class="paramtype">int&#160;</td>
  346. <td class="paramname"><em>line</em>, </td>
  347. </tr>
  348. <tr>
  349. <td class="paramkey"></td>
  350. <td></td>
  351. <td class="paramtype"><a class="el" href="impl_2codegen_2log_8h.html#af10334b4085ac6985a2af9c08478ad48">gpr_log_severity</a>&#160;</td>
  352. <td class="paramname"><em>severity</em>, </td>
  353. </tr>
  354. <tr>
  355. <td class="paramkey"></td>
  356. <td></td>
  357. <td class="paramtype">const char *&#160;</td>
  358. <td class="paramname"><em>message</em>&#160;</td>
  359. </tr>
  360. <tr>
  361. <td></td>
  362. <td>)</td>
  363. <td></td><td></td>
  364. </tr>
  365. </table>
  366. </div><div class="memdoc">
  367. </div>
  368. </div>
  369. <a id="a48772229c123479748e79b8100cfe596"></a>
  370. <h2 class="memtitle"><span class="permalink"><a href="#a48772229c123479748e79b8100cfe596">&#9670;&nbsp;</a></span>gpr_log_severity_string()</h2>
  371. <div class="memitem">
  372. <div class="memproto">
  373. <table class="memname">
  374. <tr>
  375. <td class="memname">const <a class="el" href="impl_2codegen_2port__platform_8h.html#af89d3610372fc35178e83e06916aa808">GPRAPI</a> char* gpr_log_severity_string </td>
  376. <td>(</td>
  377. <td class="paramtype"><a class="el" href="impl_2codegen_2log_8h.html#af10334b4085ac6985a2af9c08478ad48">gpr_log_severity</a>&#160;</td>
  378. <td class="paramname"><em>severity</em></td><td>)</td>
  379. <td></td>
  380. </tr>
  381. </table>
  382. </div><div class="memdoc">
  383. <p>Returns a string representation of the log severity. </p>
  384. </div>
  385. </div>
  386. <a id="a920f1611251015a9806177ed78931aa5"></a>
  387. <h2 class="memtitle"><span class="permalink"><a href="#a920f1611251015a9806177ed78931aa5">&#9670;&nbsp;</a></span>gpr_log_verbosity_init()</h2>
  388. <div class="memitem">
  389. <div class="memproto">
  390. <table class="memname">
  391. <tr>
  392. <td class="memname"><a class="el" href="impl_2codegen_2port__platform_8h.html#af89d3610372fc35178e83e06916aa808">GPRAPI</a> void gpr_log_verbosity_init </td>
  393. <td>(</td>
  394. <td class="paramtype">void&#160;</td>
  395. <td class="paramname"></td><td>)</td>
  396. <td></td>
  397. </tr>
  398. </table>
  399. </div><div class="memdoc">
  400. </div>
  401. </div>
  402. <a id="ae437062e3540eeebb4c95f119fe56be5"></a>
  403. <h2 class="memtitle"><span class="permalink"><a href="#ae437062e3540eeebb4c95f119fe56be5">&#9670;&nbsp;</a></span>gpr_set_log_function()</h2>
  404. <div class="memitem">
  405. <div class="memproto">
  406. <table class="memname">
  407. <tr>
  408. <td class="memname"><a class="el" href="impl_2codegen_2port__platform_8h.html#af89d3610372fc35178e83e06916aa808">GPRAPI</a> void gpr_set_log_function </td>
  409. <td>(</td>
  410. <td class="paramtype"><a class="el" href="impl_2codegen_2log_8h.html#a3bba35ee3180d11d8ff5a71cc2ee2a05">gpr_log_func</a>&#160;</td>
  411. <td class="paramname"><em>func</em></td><td>)</td>
  412. <td></td>
  413. </tr>
  414. </table>
  415. </div><div class="memdoc">
  416. </div>
  417. </div>
  418. <a id="aec0c537cb1e244060c65d9d9d153979f"></a>
  419. <h2 class="memtitle"><span class="permalink"><a href="#aec0c537cb1e244060c65d9d9d153979f">&#9670;&nbsp;</a></span>gpr_set_log_verbosity()</h2>
  420. <div class="memitem">
  421. <div class="memproto">
  422. <table class="memname">
  423. <tr>
  424. <td class="memname"><a class="el" href="impl_2codegen_2port__platform_8h.html#af89d3610372fc35178e83e06916aa808">GPRAPI</a> void gpr_set_log_verbosity </td>
  425. <td>(</td>
  426. <td class="paramtype"><a class="el" href="impl_2codegen_2log_8h.html#af10334b4085ac6985a2af9c08478ad48">gpr_log_severity</a>&#160;</td>
  427. <td class="paramname"><em>min_severity_to_print</em></td><td>)</td>
  428. <td></td>
  429. </tr>
  430. </table>
  431. </div><div class="memdoc">
  432. <p>Set global log verbosity. </p>
  433. </div>
  434. </div>
  435. <a id="a7fb54337c9f6a34074ab181eb98ace47"></a>
  436. <h2 class="memtitle"><span class="permalink"><a href="#a7fb54337c9f6a34074ab181eb98ace47">&#9670;&nbsp;</a></span>gpr_should_log()</h2>
  437. <div class="memitem">
  438. <div class="memproto">
  439. <table class="memname">
  440. <tr>
  441. <td class="memname"><a class="el" href="impl_2codegen_2port__platform_8h.html#af89d3610372fc35178e83e06916aa808">GPRAPI</a> void <a class="el" href="impl_2codegen_2port__platform_8h.html#af89d3610372fc35178e83e06916aa808">GPRAPI</a> int gpr_should_log </td>
  442. <td>(</td>
  443. <td class="paramtype"><a class="el" href="impl_2codegen_2log_8h.html#af10334b4085ac6985a2af9c08478ad48">gpr_log_severity</a>&#160;</td>
  444. <td class="paramname"><em>severity</em></td><td>)</td>
  445. <td></td>
  446. </tr>
  447. </table>
  448. </div><div class="memdoc">
  449. </div>
  450. </div>
  451. </div><!-- contents -->
  452. <div class="ttc" id="aimpl_2codegen_2port__platform_8h_html_a99b5bddfe84f8dc8ee55b35405b8fddd"><div class="ttname"><a href="impl_2codegen_2port__platform_8h.html#a99b5bddfe84f8dc8ee55b35405b8fddd">GPR_UNLIKELY</a></div><div class="ttdeci">#define GPR_UNLIKELY(x)</div><div class="ttdef"><b>Definition:</b> port_platform.h:653</div></div>
  453. <div class="ttc" id="aimpl_2codegen_2log_8h_html_a63faedb3eefd93d1c0e79974be80cc36"><div class="ttname"><a href="impl_2codegen_2log_8h.html#a63faedb3eefd93d1c0e79974be80cc36">GPR_ERROR</a></div><div class="ttdeci">#define GPR_ERROR</div><div class="ttdef"><b>Definition:</b> log.h:55</div></div>
  454. <!-- start footer part -->
  455. <hr class="footer"/><address class="footer"><small>
  456. Generated on Wed Mar 3 2021 19:17:22 for GRPC C++ by &#160;<a href="http://www.doxygen.org/index.html">
  457. <img class="footer" src="doxygen.png" alt="doxygen"/>
  458. </a> 1.8.17
  459. </small></address>
  460. </body>
  461. </html>