impl_2codegen_2log_8h.html 32 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517
  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.16"/>
  7. <meta name="viewport" content="width=device-width, initial-scale=1"/>
  8. <title>GRPC Core: 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 Core
  25. &#160;<span id="projectnumber">10.0.0</span>
  26. </div>
  27. </td>
  28. </tr>
  29. </tbody>
  30. </table>
  31. </div>
  32. <!-- end header part -->
  33. <!-- Generated by Doxygen 1.8.16 -->
  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:afce870efb3d4bff38f747f79cb6c0f18"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="impl_2codegen_2log_8h.html#afce870efb3d4bff38f747f79cb6c0f18">GPR_LOG_VERBOSITY_UNSET</a>&#160;&#160;&#160;-1</td></tr>
  92. <tr class="separator:afce870efb3d4bff38f747f79cb6c0f18"><td class="memSeparator" colspan="2">&#160;</td></tr>
  93. <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>
  94. <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>
  95. <tr class="separator:a3e793245091f13bb7318a18b1166a773"><td class="memSeparator" colspan="2">&#160;</td></tr>
  96. <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>
  97. <tr class="separator:af0d0d75690f79edc9294498c88f96703"><td class="memSeparator" colspan="2">&#160;</td></tr>
  98. <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>
  99. <tr class="separator:a63faedb3eefd93d1c0e79974be80cc36"><td class="memSeparator" colspan="2">&#160;</td></tr>
  100. <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>
  101. <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>
  102. <tr class="separator:a6ccf52ff690655cc22cd9d053650876f"><td class="memSeparator" colspan="2">&#160;</td></tr>
  103. <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>
  104. <tr class="separator:a4720a11176c735c4456815394edb6bff"><td class="memSeparator" colspan="2">&#160;</td></tr>
  105. </table><table class="memberdecls">
  106. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="typedef-members"></a>
  107. Typedefs</h2></td></tr>
  108. <tr class="memitem:ad49303346a78cf4881129958214fde8d"><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#ad49303346a78cf4881129958214fde8d">gpr_log_severity</a></td></tr>
  109. <tr class="memdesc:ad49303346a78cf4881129958214fde8d"><td class="mdescLeft">&#160;</td><td class="mdescRight">GPR log API. <a href="impl_2codegen_2log_8h.html#ad49303346a78cf4881129958214fde8d">More...</a><br /></td></tr>
  110. <tr class="separator:ad49303346a78cf4881129958214fde8d"><td class="memSeparator" colspan="2">&#160;</td></tr>
  111. <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>
  112. <tr class="separator:adce8dc81f07a98265e917de7d7f3cde5"><td class="memSeparator" colspan="2">&#160;</td></tr>
  113. <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>
  114. <tr class="separator:a3bba35ee3180d11d8ff5a71cc2ee2a05"><td class="memSeparator" colspan="2">&#160;</td></tr>
  115. </table><table class="memberdecls">
  116. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="enum-members"></a>
  117. Enumerations</h2></td></tr>
  118. <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>,
  119. <a class="el" href="impl_2codegen_2log_8h.html#af10334b4085ac6985a2af9c08478ad48af6c13c67f06821c1629b7e019af4aaf1">GPR_LOG_SEVERITY_INFO</a>,
  120. <a class="el" href="impl_2codegen_2log_8h.html#af10334b4085ac6985a2af9c08478ad48a52b957eb23ac2207b5e1dcf15c2b3dd4">GPR_LOG_SEVERITY_ERROR</a>
  121. }</td></tr>
  122. <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>
  123. <tr class="separator:af10334b4085ac6985a2af9c08478ad48"><td class="memSeparator" colspan="2">&#160;</td></tr>
  124. </table><table class="memberdecls">
  125. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
  126. Functions</h2></td></tr>
  127. <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>
  128. <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>
  129. <tr class="separator:a48772229c123479748e79b8100cfe596"><td class="memSeparator" colspan="2">&#160;</td></tr>
  130. <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>
  131. <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>
  132. <tr class="separator:a938a283d9a10c3ddfe46dfc22e21077f"><td class="memSeparator" colspan="2">&#160;</td></tr>
  133. <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>
  134. <tr class="separator:a7fb54337c9f6a34074ab181eb98ace47"><td class="memSeparator" colspan="2">&#160;</td></tr>
  135. <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>
  136. <tr class="separator:a182dc49f7d429e28b35cb78133e542d8"><td class="memSeparator" colspan="2">&#160;</td></tr>
  137. <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>
  138. <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>
  139. <tr class="separator:aec0c537cb1e244060c65d9d9d153979f"><td class="memSeparator" colspan="2">&#160;</td></tr>
  140. <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>
  141. <tr class="separator:a920f1611251015a9806177ed78931aa5"><td class="memSeparator" colspan="2">&#160;</td></tr>
  142. <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>
  143. <tr class="separator:ae437062e3540eeebb4c95f119fe56be5"><td class="memSeparator" colspan="2">&#160;</td></tr>
  144. </table>
  145. <h2 class="groupheader">Macro Definition Documentation</h2>
  146. <a id="a6ccf52ff690655cc22cd9d053650876f"></a>
  147. <h2 class="memtitle"><span class="permalink"><a href="#a6ccf52ff690655cc22cd9d053650876f">&#9670;&nbsp;</a></span>GPR_ASSERT</h2>
  148. <div class="memitem">
  149. <div class="memproto">
  150. <table class="memname">
  151. <tr>
  152. <td class="memname">#define GPR_ASSERT</td>
  153. <td>(</td>
  154. <td class="paramtype">&#160;</td>
  155. <td class="paramname">x</td><td>)</td>
  156. <td></td>
  157. </tr>
  158. </table>
  159. </div><div class="memdoc">
  160. <b>Value:</b><div class="fragment"><div class="line"><span class="keywordflow">do</span> { \</div>
  161. <div class="line"> if (<a class="code" href="impl_2codegen_2port__platform_8h.html#a99b5bddfe84f8dc8ee55b35405b8fddd">GPR_UNLIKELY</a>(!(x))) { \</div>
  162. <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>
  163. <div class="line"> abort(); \</div>
  164. <div class="line"> } \</div>
  165. <div class="line"> } <span class="keywordflow">while</span> (0)</div>
  166. </div><!-- fragment -->
  167. <p>abort() the process if x is zero, having written a line to the log. </p>
  168. <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 />
  169. </p>
  170. </div>
  171. </div>
  172. <a id="a3e793245091f13bb7318a18b1166a773"></a>
  173. <h2 class="memtitle"><span class="permalink"><a href="#a3e793245091f13bb7318a18b1166a773">&#9670;&nbsp;</a></span>GPR_DEBUG</h2>
  174. <div class="memitem">
  175. <div class="memproto">
  176. <table class="memname">
  177. <tr>
  178. <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>
  179. </tr>
  180. </table>
  181. </div><div class="memdoc">
  182. <p>Macros to build log contexts at various severity levels. </p>
  183. </div>
  184. </div>
  185. <a id="a4720a11176c735c4456815394edb6bff"></a>
  186. <h2 class="memtitle"><span class="permalink"><a href="#a4720a11176c735c4456815394edb6bff">&#9670;&nbsp;</a></span>GPR_DEBUG_ASSERT</h2>
  187. <div class="memitem">
  188. <div class="memproto">
  189. <table class="memname">
  190. <tr>
  191. <td class="memname">#define GPR_DEBUG_ASSERT</td>
  192. <td>(</td>
  193. <td class="paramtype">&#160;</td>
  194. <td class="paramname">x</td><td>)</td>
  195. <td>&#160;&#160;&#160;<a class="el" href="impl_2codegen_2log_8h.html#a6ccf52ff690655cc22cd9d053650876f">GPR_ASSERT</a>(x)</td>
  196. </tr>
  197. </table>
  198. </div><div class="memdoc">
  199. </div>
  200. </div>
  201. <a id="a63faedb3eefd93d1c0e79974be80cc36"></a>
  202. <h2 class="memtitle"><span class="permalink"><a href="#a63faedb3eefd93d1c0e79974be80cc36">&#9670;&nbsp;</a></span>GPR_ERROR</h2>
  203. <div class="memitem">
  204. <div class="memproto">
  205. <table class="memname">
  206. <tr>
  207. <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>
  208. </tr>
  209. </table>
  210. </div><div class="memdoc">
  211. </div>
  212. </div>
  213. <a id="af0d0d75690f79edc9294498c88f96703"></a>
  214. <h2 class="memtitle"><span class="permalink"><a href="#af0d0d75690f79edc9294498c88f96703">&#9670;&nbsp;</a></span>GPR_INFO</h2>
  215. <div class="memitem">
  216. <div class="memproto">
  217. <table class="memname">
  218. <tr>
  219. <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>
  220. </tr>
  221. </table>
  222. </div><div class="memdoc">
  223. </div>
  224. </div>
  225. <a id="afce870efb3d4bff38f747f79cb6c0f18"></a>
  226. <h2 class="memtitle"><span class="permalink"><a href="#afce870efb3d4bff38f747f79cb6c0f18">&#9670;&nbsp;</a></span>GPR_LOG_VERBOSITY_UNSET</h2>
  227. <div class="memitem">
  228. <div class="memproto">
  229. <table class="memname">
  230. <tr>
  231. <td class="memname">#define GPR_LOG_VERBOSITY_UNSET&#160;&#160;&#160;-1</td>
  232. </tr>
  233. </table>
  234. </div><div class="memdoc">
  235. </div>
  236. </div>
  237. <h2 class="groupheader">Typedef Documentation</h2>
  238. <a id="a3bba35ee3180d11d8ff5a71cc2ee2a05"></a>
  239. <h2 class="memtitle"><span class="permalink"><a href="#a3bba35ee3180d11d8ff5a71cc2ee2a05">&#9670;&nbsp;</a></span>gpr_log_func</h2>
  240. <div class="memitem">
  241. <div class="memproto">
  242. <table class="memname">
  243. <tr>
  244. <td class="memname">typedef void(* gpr_log_func) (<a class="el" href="structgpr__log__func__args.html">gpr_log_func_args</a> *args)</td>
  245. </tr>
  246. </table>
  247. </div><div class="memdoc">
  248. </div>
  249. </div>
  250. <a id="adce8dc81f07a98265e917de7d7f3cde5"></a>
  251. <h2 class="memtitle"><span class="permalink"><a href="#adce8dc81f07a98265e917de7d7f3cde5">&#9670;&nbsp;</a></span>gpr_log_func_args</h2>
  252. <div class="memitem">
  253. <div class="memproto">
  254. <table class="memname">
  255. <tr>
  256. <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>
  257. </tr>
  258. </table>
  259. </div><div class="memdoc">
  260. </div>
  261. </div>
  262. <a id="ad49303346a78cf4881129958214fde8d"></a>
  263. <h2 class="memtitle"><span class="permalink"><a href="#ad49303346a78cf4881129958214fde8d">&#9670;&nbsp;</a></span>gpr_log_severity</h2>
  264. <div class="memitem">
  265. <div class="memproto">
  266. <table class="memname">
  267. <tr>
  268. <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>
  269. </tr>
  270. </table>
  271. </div><div class="memdoc">
  272. <p>GPR log API. </p>
  273. <p>Usage (within grpc):</p>
  274. <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>
  275. </div>
  276. </div>
  277. <h2 class="groupheader">Enumeration Type Documentation</h2>
  278. <a id="af10334b4085ac6985a2af9c08478ad48"></a>
  279. <h2 class="memtitle"><span class="permalink"><a href="#af10334b4085ac6985a2af9c08478ad48">&#9670;&nbsp;</a></span>gpr_log_severity</h2>
  280. <div class="memitem">
  281. <div class="memproto">
  282. <table class="memname">
  283. <tr>
  284. <td class="memname">enum <a class="el" href="impl_2codegen_2log_8h.html#af10334b4085ac6985a2af9c08478ad48">gpr_log_severity</a></td>
  285. </tr>
  286. </table>
  287. </div><div class="memdoc">
  288. <p>GPR log API. </p>
  289. <p>Usage (within grpc):</p>
  290. <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>
  291. <table class="fieldtable">
  292. <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>
  293. <tr><td class="fieldname"><a id="af10334b4085ac6985a2af9c08478ad48af6c13c67f06821c1629b7e019af4aaf1"></a>GPR_LOG_SEVERITY_INFO&#160;</td><td class="fielddoc"></td></tr>
  294. <tr><td class="fieldname"><a id="af10334b4085ac6985a2af9c08478ad48a52b957eb23ac2207b5e1dcf15c2b3dd4"></a>GPR_LOG_SEVERITY_ERROR&#160;</td><td class="fielddoc"></td></tr>
  295. </table>
  296. </div>
  297. </div>
  298. <h2 class="groupheader">Function Documentation</h2>
  299. <a id="a938a283d9a10c3ddfe46dfc22e21077f"></a>
  300. <h2 class="memtitle"><span class="permalink"><a href="#a938a283d9a10c3ddfe46dfc22e21077f">&#9670;&nbsp;</a></span>gpr_log()</h2>
  301. <div class="memitem">
  302. <div class="memproto">
  303. <table class="memname">
  304. <tr>
  305. <td class="memname"><a class="el" href="impl_2codegen_2port__platform_8h.html#af89d3610372fc35178e83e06916aa808">GPRAPI</a> void gpr_log </td>
  306. <td>(</td>
  307. <td class="paramtype">const char *&#160;</td>
  308. <td class="paramname"><em>file</em>, </td>
  309. </tr>
  310. <tr>
  311. <td class="paramkey"></td>
  312. <td></td>
  313. <td class="paramtype">int&#160;</td>
  314. <td class="paramname"><em>line</em>, </td>
  315. </tr>
  316. <tr>
  317. <td class="paramkey"></td>
  318. <td></td>
  319. <td class="paramtype"><a class="el" href="impl_2codegen_2log_8h.html#af10334b4085ac6985a2af9c08478ad48">gpr_log_severity</a>&#160;</td>
  320. <td class="paramname"><em>severity</em>, </td>
  321. </tr>
  322. <tr>
  323. <td class="paramkey"></td>
  324. <td></td>
  325. <td class="paramtype">const char *&#160;</td>
  326. <td class="paramname"><em>format</em>, </td>
  327. </tr>
  328. <tr>
  329. <td class="paramkey"></td>
  330. <td></td>
  331. <td class="paramtype">&#160;</td>
  332. <td class="paramname"><em>...</em>&#160;</td>
  333. </tr>
  334. <tr>
  335. <td></td>
  336. <td>)</td>
  337. <td></td><td></td>
  338. </tr>
  339. </table>
  340. </div><div class="memdoc">
  341. <p>Log a message. </p>
  342. <p>It's advised to use GPR_xxx above to generate the context for each message </p>
  343. </div>
  344. </div>
  345. <a id="a182dc49f7d429e28b35cb78133e542d8"></a>
  346. <h2 class="memtitle"><span class="permalink"><a href="#a182dc49f7d429e28b35cb78133e542d8">&#9670;&nbsp;</a></span>gpr_log_message()</h2>
  347. <div class="memitem">
  348. <div class="memproto">
  349. <table class="memname">
  350. <tr>
  351. <td class="memname"><a class="el" href="impl_2codegen_2port__platform_8h.html#af89d3610372fc35178e83e06916aa808">GPRAPI</a> void gpr_log_message </td>
  352. <td>(</td>
  353. <td class="paramtype">const char *&#160;</td>
  354. <td class="paramname"><em>file</em>, </td>
  355. </tr>
  356. <tr>
  357. <td class="paramkey"></td>
  358. <td></td>
  359. <td class="paramtype">int&#160;</td>
  360. <td class="paramname"><em>line</em>, </td>
  361. </tr>
  362. <tr>
  363. <td class="paramkey"></td>
  364. <td></td>
  365. <td class="paramtype"><a class="el" href="impl_2codegen_2log_8h.html#af10334b4085ac6985a2af9c08478ad48">gpr_log_severity</a>&#160;</td>
  366. <td class="paramname"><em>severity</em>, </td>
  367. </tr>
  368. <tr>
  369. <td class="paramkey"></td>
  370. <td></td>
  371. <td class="paramtype">const char *&#160;</td>
  372. <td class="paramname"><em>message</em>&#160;</td>
  373. </tr>
  374. <tr>
  375. <td></td>
  376. <td>)</td>
  377. <td></td><td></td>
  378. </tr>
  379. </table>
  380. </div><div class="memdoc">
  381. </div>
  382. </div>
  383. <a id="a48772229c123479748e79b8100cfe596"></a>
  384. <h2 class="memtitle"><span class="permalink"><a href="#a48772229c123479748e79b8100cfe596">&#9670;&nbsp;</a></span>gpr_log_severity_string()</h2>
  385. <div class="memitem">
  386. <div class="memproto">
  387. <table class="memname">
  388. <tr>
  389. <td class="memname">const <a class="el" href="impl_2codegen_2port__platform_8h.html#af89d3610372fc35178e83e06916aa808">GPRAPI</a> char* gpr_log_severity_string </td>
  390. <td>(</td>
  391. <td class="paramtype"><a class="el" href="impl_2codegen_2log_8h.html#af10334b4085ac6985a2af9c08478ad48">gpr_log_severity</a>&#160;</td>
  392. <td class="paramname"><em>severity</em></td><td>)</td>
  393. <td></td>
  394. </tr>
  395. </table>
  396. </div><div class="memdoc">
  397. <p>Returns a string representation of the log severity. </p>
  398. </div>
  399. </div>
  400. <a id="a920f1611251015a9806177ed78931aa5"></a>
  401. <h2 class="memtitle"><span class="permalink"><a href="#a920f1611251015a9806177ed78931aa5">&#9670;&nbsp;</a></span>gpr_log_verbosity_init()</h2>
  402. <div class="memitem">
  403. <div class="memproto">
  404. <table class="memname">
  405. <tr>
  406. <td class="memname"><a class="el" href="impl_2codegen_2port__platform_8h.html#af89d3610372fc35178e83e06916aa808">GPRAPI</a> void gpr_log_verbosity_init </td>
  407. <td>(</td>
  408. <td class="paramtype">void&#160;</td>
  409. <td class="paramname"></td><td>)</td>
  410. <td></td>
  411. </tr>
  412. </table>
  413. </div><div class="memdoc">
  414. </div>
  415. </div>
  416. <a id="ae437062e3540eeebb4c95f119fe56be5"></a>
  417. <h2 class="memtitle"><span class="permalink"><a href="#ae437062e3540eeebb4c95f119fe56be5">&#9670;&nbsp;</a></span>gpr_set_log_function()</h2>
  418. <div class="memitem">
  419. <div class="memproto">
  420. <table class="memname">
  421. <tr>
  422. <td class="memname"><a class="el" href="impl_2codegen_2port__platform_8h.html#af89d3610372fc35178e83e06916aa808">GPRAPI</a> void gpr_set_log_function </td>
  423. <td>(</td>
  424. <td class="paramtype"><a class="el" href="impl_2codegen_2log_8h.html#a3bba35ee3180d11d8ff5a71cc2ee2a05">gpr_log_func</a>&#160;</td>
  425. <td class="paramname"><em>func</em></td><td>)</td>
  426. <td></td>
  427. </tr>
  428. </table>
  429. </div><div class="memdoc">
  430. </div>
  431. </div>
  432. <a id="aec0c537cb1e244060c65d9d9d153979f"></a>
  433. <h2 class="memtitle"><span class="permalink"><a href="#aec0c537cb1e244060c65d9d9d153979f">&#9670;&nbsp;</a></span>gpr_set_log_verbosity()</h2>
  434. <div class="memitem">
  435. <div class="memproto">
  436. <table class="memname">
  437. <tr>
  438. <td class="memname"><a class="el" href="impl_2codegen_2port__platform_8h.html#af89d3610372fc35178e83e06916aa808">GPRAPI</a> void gpr_set_log_verbosity </td>
  439. <td>(</td>
  440. <td class="paramtype"><a class="el" href="impl_2codegen_2log_8h.html#af10334b4085ac6985a2af9c08478ad48">gpr_log_severity</a>&#160;</td>
  441. <td class="paramname"><em>min_severity_to_print</em></td><td>)</td>
  442. <td></td>
  443. </tr>
  444. </table>
  445. </div><div class="memdoc">
  446. <p>Set global log verbosity. </p>
  447. </div>
  448. </div>
  449. <a id="a7fb54337c9f6a34074ab181eb98ace47"></a>
  450. <h2 class="memtitle"><span class="permalink"><a href="#a7fb54337c9f6a34074ab181eb98ace47">&#9670;&nbsp;</a></span>gpr_should_log()</h2>
  451. <div class="memitem">
  452. <div class="memproto">
  453. <table class="memname">
  454. <tr>
  455. <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>
  456. <td>(</td>
  457. <td class="paramtype"><a class="el" href="impl_2codegen_2log_8h.html#af10334b4085ac6985a2af9c08478ad48">gpr_log_severity</a>&#160;</td>
  458. <td class="paramname"><em>severity</em></td><td>)</td>
  459. <td></td>
  460. </tr>
  461. </table>
  462. </div><div class="memdoc">
  463. </div>
  464. </div>
  465. </div><!-- contents -->
  466. <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:713</div></div>
  467. <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:57</div></div>
  468. <!-- start footer part -->
  469. <hr class="footer"/><address class="footer"><small>
  470. Generated on Tue Jun 30 2020 18:16:56 for GRPC Core by &#160;<a href="http://www.doxygen.org/index.html">
  471. <img class="footer" src="doxygen.png" alt="doxygen"/>
  472. </a> 1.8.16
  473. </small></address>
  474. </body>
  475. </html>