impl_2codegen_2log_8h.html 31 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507
  1. <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://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.13"/>
  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">7.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.13 -->
  34. <script type="text/javascript">
  35. var searchBox = new SearchBox("searchBox", "search",false,'Search');
  36. </script>
  37. <script type="text/javascript" src="menudata.js"></script>
  38. <script type="text/javascript" src="menu.js"></script>
  39. <script type="text/javascript">
  40. $(function() {
  41. initMenu('',true,false,'search.php','Search');
  42. $(document).ready(function() { init_search(); });
  43. });
  44. </script>
  45. <div id="main-nav"></div>
  46. <!-- window showing the filter options -->
  47. <div id="MSearchSelectWindow"
  48. onmouseover="return searchBox.OnSearchSelectShow()"
  49. onmouseout="return searchBox.OnSearchSelectHide()"
  50. onkeydown="return searchBox.OnSearchSelectKey(event)">
  51. </div>
  52. <!-- iframe showing the search results (closed by default) -->
  53. <div id="MSearchResultsWindow">
  54. <iframe src="javascript:void(0)" frameborder="0"
  55. name="MSearchResults" id="MSearchResults">
  56. </iframe>
  57. </div>
  58. <div id="nav-path" class="navpath">
  59. <ul>
  60. <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>
  61. </div>
  62. </div><!-- top -->
  63. <div class="header">
  64. <div class="summary">
  65. <a href="#nested-classes">Data Structures</a> &#124;
  66. <a href="#define-members">Macros</a> &#124;
  67. <a href="#typedef-members">Typedefs</a> &#124;
  68. <a href="#enum-members">Enumerations</a> &#124;
  69. <a href="#func-members">Functions</a> </div>
  70. <div class="headertitle">
  71. <div class="title">log.h File Reference</div> </div>
  72. </div><!--header-->
  73. <div class="contents">
  74. <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 />
  75. <code>#include &lt;stdarg.h&gt;</code><br />
  76. <code>#include &lt;stdlib.h&gt;</code><br />
  77. </div>
  78. <p><a href="impl_2codegen_2log_8h_source.html">Go to the source code of this file.</a></p>
  79. <table class="memberdecls">
  80. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="nested-classes"></a>
  81. Data Structures</h2></td></tr>
  82. <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>
  83. <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>
  84. <tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
  85. </table><table class="memberdecls">
  86. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="define-members"></a>
  87. Macros</h2></td></tr>
  88. <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>
  89. <tr class="separator:afce870efb3d4bff38f747f79cb6c0f18"><td class="memSeparator" colspan="2">&#160;</td></tr>
  90. <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>
  91. <tr class="memdesc:a3e793245091f13bb7318a18b1166a773"><td class="mdescLeft">&#160;</td><td class="mdescRight">Macros to build log contexts at various severity levels. <a href="#a3e793245091f13bb7318a18b1166a773">More...</a><br /></td></tr>
  92. <tr class="separator:a3e793245091f13bb7318a18b1166a773"><td class="memSeparator" colspan="2">&#160;</td></tr>
  93. <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>
  94. <tr class="separator:af0d0d75690f79edc9294498c88f96703"><td class="memSeparator" colspan="2">&#160;</td></tr>
  95. <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>
  96. <tr class="separator:a63faedb3eefd93d1c0e79974be80cc36"><td class="memSeparator" colspan="2">&#160;</td></tr>
  97. <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>
  98. <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="#a6ccf52ff690655cc22cd9d053650876f">More...</a><br /></td></tr>
  99. <tr class="separator:a6ccf52ff690655cc22cd9d053650876f"><td class="memSeparator" colspan="2">&#160;</td></tr>
  100. <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>
  101. <tr class="separator:a4720a11176c735c4456815394edb6bff"><td class="memSeparator" colspan="2">&#160;</td></tr>
  102. </table><table class="memberdecls">
  103. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="typedef-members"></a>
  104. Typedefs</h2></td></tr>
  105. <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>
  106. <tr class="memdesc:ad49303346a78cf4881129958214fde8d"><td class="mdescLeft">&#160;</td><td class="mdescRight">GPR log API. <a href="#ad49303346a78cf4881129958214fde8d">More...</a><br /></td></tr>
  107. <tr class="separator:ad49303346a78cf4881129958214fde8d"><td class="memSeparator" colspan="2">&#160;</td></tr>
  108. <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>
  109. <tr class="separator:adce8dc81f07a98265e917de7d7f3cde5"><td class="memSeparator" colspan="2">&#160;</td></tr>
  110. <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>
  111. <tr class="separator:a3bba35ee3180d11d8ff5a71cc2ee2a05"><td class="memSeparator" colspan="2">&#160;</td></tr>
  112. </table><table class="memberdecls">
  113. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="enum-members"></a>
  114. Enumerations</h2></td></tr>
  115. <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>,
  116. <a class="el" href="impl_2codegen_2log_8h.html#af10334b4085ac6985a2af9c08478ad48af6c13c67f06821c1629b7e019af4aaf1">GPR_LOG_SEVERITY_INFO</a>,
  117. <a class="el" href="impl_2codegen_2log_8h.html#af10334b4085ac6985a2af9c08478ad48a52b957eb23ac2207b5e1dcf15c2b3dd4">GPR_LOG_SEVERITY_ERROR</a>
  118. }<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>
  119. </td></tr>
  120. <tr class="separator:af10334b4085ac6985a2af9c08478ad48"><td class="memSeparator" colspan="2">&#160;</td></tr>
  121. </table><table class="memberdecls">
  122. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
  123. Functions</h2></td></tr>
  124. <tr class="memitem:ae794448965328d305d0b44417199a915"><td class="memItemLeft" align="right" valign="top"><a class="el" href="impl_2codegen_2port__platform_8h.html#af89d3610372fc35178e83e06916aa808">GPRAPI</a> const char *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="impl_2codegen_2log_8h.html#ae794448965328d305d0b44417199a915">gpr_log_severity_string</a> (<a class="el" href="impl_2codegen_2log_8h.html#af10334b4085ac6985a2af9c08478ad48">gpr_log_severity</a> severity)</td></tr>
  125. <tr class="memdesc:ae794448965328d305d0b44417199a915"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns a string representation of the log severity. <a href="#ae794448965328d305d0b44417199a915">More...</a><br /></td></tr>
  126. <tr class="separator:ae794448965328d305d0b44417199a915"><td class="memSeparator" colspan="2">&#160;</td></tr>
  127. <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>
  128. <tr class="memdesc:a938a283d9a10c3ddfe46dfc22e21077f"><td class="mdescLeft">&#160;</td><td class="mdescRight">Log a message. <a href="#a938a283d9a10c3ddfe46dfc22e21077f">More...</a><br /></td></tr>
  129. <tr class="separator:a938a283d9a10c3ddfe46dfc22e21077f"><td class="memSeparator" colspan="2">&#160;</td></tr>
  130. <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>
  131. <tr class="separator:a7fb54337c9f6a34074ab181eb98ace47"><td class="memSeparator" colspan="2">&#160;</td></tr>
  132. <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>
  133. <tr class="separator:a182dc49f7d429e28b35cb78133e542d8"><td class="memSeparator" colspan="2">&#160;</td></tr>
  134. <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>
  135. <tr class="memdesc:aec0c537cb1e244060c65d9d9d153979f"><td class="mdescLeft">&#160;</td><td class="mdescRight">Set global log verbosity. <a href="#aec0c537cb1e244060c65d9d9d153979f">More...</a><br /></td></tr>
  136. <tr class="separator:aec0c537cb1e244060c65d9d9d153979f"><td class="memSeparator" colspan="2">&#160;</td></tr>
  137. <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>
  138. <tr class="separator:a920f1611251015a9806177ed78931aa5"><td class="memSeparator" colspan="2">&#160;</td></tr>
  139. <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>
  140. <tr class="separator:ae437062e3540eeebb4c95f119fe56be5"><td class="memSeparator" colspan="2">&#160;</td></tr>
  141. </table>
  142. <h2 class="groupheader">Macro Definition Documentation</h2>
  143. <a id="a6ccf52ff690655cc22cd9d053650876f"></a>
  144. <h2 class="memtitle"><span class="permalink"><a href="#a6ccf52ff690655cc22cd9d053650876f">&#9670;&nbsp;</a></span>GPR_ASSERT</h2>
  145. <div class="memitem">
  146. <div class="memproto">
  147. <table class="memname">
  148. <tr>
  149. <td class="memname">#define GPR_ASSERT</td>
  150. <td>(</td>
  151. <td class="paramtype">&#160;</td>
  152. <td class="paramname">x</td><td>)</td>
  153. <td></td>
  154. </tr>
  155. </table>
  156. </div><div class="memdoc">
  157. <b>Value:</b><div class="fragment"><div class="line"><span class="keywordflow">do</span> { \</div><div class="line"> if (<a class="code" href="impl_2codegen_2port__platform_8h.html#a99b5bddfe84f8dc8ee55b35405b8fddd">GPR_UNLIKELY</a>(!(x))) { \</div><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><div class="line"> abort(); \</div><div class="line"> } \</div><div class="line"> } <span class="keywordflow">while</span> (0)</div><div class="ttc" id="impl_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:561</div></div>
  158. <div class="ttc" id="impl_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>
  159. </div><!-- fragment -->
  160. <p>abort() the process if x is zero, having written a line to the log. </p>
  161. <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. </p>
  162. </div>
  163. </div>
  164. <a id="a3e793245091f13bb7318a18b1166a773"></a>
  165. <h2 class="memtitle"><span class="permalink"><a href="#a3e793245091f13bb7318a18b1166a773">&#9670;&nbsp;</a></span>GPR_DEBUG</h2>
  166. <div class="memitem">
  167. <div class="memproto">
  168. <table class="memname">
  169. <tr>
  170. <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>
  171. </tr>
  172. </table>
  173. </div><div class="memdoc">
  174. <p>Macros to build log contexts at various severity levels. </p>
  175. </div>
  176. </div>
  177. <a id="a4720a11176c735c4456815394edb6bff"></a>
  178. <h2 class="memtitle"><span class="permalink"><a href="#a4720a11176c735c4456815394edb6bff">&#9670;&nbsp;</a></span>GPR_DEBUG_ASSERT</h2>
  179. <div class="memitem">
  180. <div class="memproto">
  181. <table class="memname">
  182. <tr>
  183. <td class="memname">#define GPR_DEBUG_ASSERT</td>
  184. <td>(</td>
  185. <td class="paramtype">&#160;</td>
  186. <td class="paramname">x</td><td>)</td>
  187. <td>&#160;&#160;&#160;<a class="el" href="impl_2codegen_2log_8h.html#a6ccf52ff690655cc22cd9d053650876f">GPR_ASSERT</a>(x)</td>
  188. </tr>
  189. </table>
  190. </div><div class="memdoc">
  191. </div>
  192. </div>
  193. <a id="a63faedb3eefd93d1c0e79974be80cc36"></a>
  194. <h2 class="memtitle"><span class="permalink"><a href="#a63faedb3eefd93d1c0e79974be80cc36">&#9670;&nbsp;</a></span>GPR_ERROR</h2>
  195. <div class="memitem">
  196. <div class="memproto">
  197. <table class="memname">
  198. <tr>
  199. <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>
  200. </tr>
  201. </table>
  202. </div><div class="memdoc">
  203. </div>
  204. </div>
  205. <a id="af0d0d75690f79edc9294498c88f96703"></a>
  206. <h2 class="memtitle"><span class="permalink"><a href="#af0d0d75690f79edc9294498c88f96703">&#9670;&nbsp;</a></span>GPR_INFO</h2>
  207. <div class="memitem">
  208. <div class="memproto">
  209. <table class="memname">
  210. <tr>
  211. <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>
  212. </tr>
  213. </table>
  214. </div><div class="memdoc">
  215. </div>
  216. </div>
  217. <a id="afce870efb3d4bff38f747f79cb6c0f18"></a>
  218. <h2 class="memtitle"><span class="permalink"><a href="#afce870efb3d4bff38f747f79cb6c0f18">&#9670;&nbsp;</a></span>GPR_LOG_VERBOSITY_UNSET</h2>
  219. <div class="memitem">
  220. <div class="memproto">
  221. <table class="memname">
  222. <tr>
  223. <td class="memname">#define GPR_LOG_VERBOSITY_UNSET&#160;&#160;&#160;-1</td>
  224. </tr>
  225. </table>
  226. </div><div class="memdoc">
  227. </div>
  228. </div>
  229. <h2 class="groupheader">Typedef Documentation</h2>
  230. <a id="a3bba35ee3180d11d8ff5a71cc2ee2a05"></a>
  231. <h2 class="memtitle"><span class="permalink"><a href="#a3bba35ee3180d11d8ff5a71cc2ee2a05">&#9670;&nbsp;</a></span>gpr_log_func</h2>
  232. <div class="memitem">
  233. <div class="memproto">
  234. <table class="memname">
  235. <tr>
  236. <td class="memname">typedef void(* gpr_log_func) (<a class="el" href="structgpr__log__func__args.html">gpr_log_func_args</a> *args)</td>
  237. </tr>
  238. </table>
  239. </div><div class="memdoc">
  240. </div>
  241. </div>
  242. <a id="adce8dc81f07a98265e917de7d7f3cde5"></a>
  243. <h2 class="memtitle"><span class="permalink"><a href="#adce8dc81f07a98265e917de7d7f3cde5">&#9670;&nbsp;</a></span>gpr_log_func_args</h2>
  244. <div class="memitem">
  245. <div class="memproto">
  246. <table class="memname">
  247. <tr>
  248. <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>
  249. </tr>
  250. </table>
  251. </div><div class="memdoc">
  252. </div>
  253. </div>
  254. <a id="ad49303346a78cf4881129958214fde8d"></a>
  255. <h2 class="memtitle"><span class="permalink"><a href="#ad49303346a78cf4881129958214fde8d">&#9670;&nbsp;</a></span>gpr_log_severity</h2>
  256. <div class="memitem">
  257. <div class="memproto">
  258. <table class="memname">
  259. <tr>
  260. <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>
  261. </tr>
  262. </table>
  263. </div><div class="memdoc">
  264. <p>GPR log API. </p>
  265. <p>Usage (within grpc):</p>
  266. <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>
  267. </div>
  268. </div>
  269. <h2 class="groupheader">Enumeration Type Documentation</h2>
  270. <a id="af10334b4085ac6985a2af9c08478ad48"></a>
  271. <h2 class="memtitle"><span class="permalink"><a href="#af10334b4085ac6985a2af9c08478ad48">&#9670;&nbsp;</a></span>gpr_log_severity</h2>
  272. <div class="memitem">
  273. <div class="memproto">
  274. <table class="memname">
  275. <tr>
  276. <td class="memname">enum <a class="el" href="impl_2codegen_2log_8h.html#af10334b4085ac6985a2af9c08478ad48">gpr_log_severity</a></td>
  277. </tr>
  278. </table>
  279. </div><div class="memdoc">
  280. <p>GPR log API. </p>
  281. <p>Usage (within grpc):</p>
  282. <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>
  283. <table class="fieldtable">
  284. <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>
  285. <tr><td class="fieldname"><a id="af10334b4085ac6985a2af9c08478ad48af6c13c67f06821c1629b7e019af4aaf1"></a>GPR_LOG_SEVERITY_INFO&#160;</td><td class="fielddoc"></td></tr>
  286. <tr><td class="fieldname"><a id="af10334b4085ac6985a2af9c08478ad48a52b957eb23ac2207b5e1dcf15c2b3dd4"></a>GPR_LOG_SEVERITY_ERROR&#160;</td><td class="fielddoc"></td></tr>
  287. </table>
  288. </div>
  289. </div>
  290. <h2 class="groupheader">Function Documentation</h2>
  291. <a id="a938a283d9a10c3ddfe46dfc22e21077f"></a>
  292. <h2 class="memtitle"><span class="permalink"><a href="#a938a283d9a10c3ddfe46dfc22e21077f">&#9670;&nbsp;</a></span>gpr_log()</h2>
  293. <div class="memitem">
  294. <div class="memproto">
  295. <table class="memname">
  296. <tr>
  297. <td class="memname"><a class="el" href="impl_2codegen_2port__platform_8h.html#af89d3610372fc35178e83e06916aa808">GPRAPI</a> void gpr_log </td>
  298. <td>(</td>
  299. <td class="paramtype">const char *&#160;</td>
  300. <td class="paramname"><em>file</em>, </td>
  301. </tr>
  302. <tr>
  303. <td class="paramkey"></td>
  304. <td></td>
  305. <td class="paramtype">int&#160;</td>
  306. <td class="paramname"><em>line</em>, </td>
  307. </tr>
  308. <tr>
  309. <td class="paramkey"></td>
  310. <td></td>
  311. <td class="paramtype"><a class="el" href="impl_2codegen_2log_8h.html#af10334b4085ac6985a2af9c08478ad48">gpr_log_severity</a>&#160;</td>
  312. <td class="paramname"><em>severity</em>, </td>
  313. </tr>
  314. <tr>
  315. <td class="paramkey"></td>
  316. <td></td>
  317. <td class="paramtype">const char *&#160;</td>
  318. <td class="paramname"><em>format</em>, </td>
  319. </tr>
  320. <tr>
  321. <td class="paramkey"></td>
  322. <td></td>
  323. <td class="paramtype">&#160;</td>
  324. <td class="paramname"><em>...</em>&#160;</td>
  325. </tr>
  326. <tr>
  327. <td></td>
  328. <td>)</td>
  329. <td></td><td></td>
  330. </tr>
  331. </table>
  332. </div><div class="memdoc">
  333. <p>Log a message. </p>
  334. <p>It's advised to use GPR_xxx above to generate the context for each message </p>
  335. </div>
  336. </div>
  337. <a id="a182dc49f7d429e28b35cb78133e542d8"></a>
  338. <h2 class="memtitle"><span class="permalink"><a href="#a182dc49f7d429e28b35cb78133e542d8">&#9670;&nbsp;</a></span>gpr_log_message()</h2>
  339. <div class="memitem">
  340. <div class="memproto">
  341. <table class="memname">
  342. <tr>
  343. <td class="memname"><a class="el" href="impl_2codegen_2port__platform_8h.html#af89d3610372fc35178e83e06916aa808">GPRAPI</a> void gpr_log_message </td>
  344. <td>(</td>
  345. <td class="paramtype">const char *&#160;</td>
  346. <td class="paramname"><em>file</em>, </td>
  347. </tr>
  348. <tr>
  349. <td class="paramkey"></td>
  350. <td></td>
  351. <td class="paramtype">int&#160;</td>
  352. <td class="paramname"><em>line</em>, </td>
  353. </tr>
  354. <tr>
  355. <td class="paramkey"></td>
  356. <td></td>
  357. <td class="paramtype"><a class="el" href="impl_2codegen_2log_8h.html#af10334b4085ac6985a2af9c08478ad48">gpr_log_severity</a>&#160;</td>
  358. <td class="paramname"><em>severity</em>, </td>
  359. </tr>
  360. <tr>
  361. <td class="paramkey"></td>
  362. <td></td>
  363. <td class="paramtype">const char *&#160;</td>
  364. <td class="paramname"><em>message</em>&#160;</td>
  365. </tr>
  366. <tr>
  367. <td></td>
  368. <td>)</td>
  369. <td></td><td></td>
  370. </tr>
  371. </table>
  372. </div><div class="memdoc">
  373. </div>
  374. </div>
  375. <a id="ae794448965328d305d0b44417199a915"></a>
  376. <h2 class="memtitle"><span class="permalink"><a href="#ae794448965328d305d0b44417199a915">&#9670;&nbsp;</a></span>gpr_log_severity_string()</h2>
  377. <div class="memitem">
  378. <div class="memproto">
  379. <table class="memname">
  380. <tr>
  381. <td class="memname"><a class="el" href="impl_2codegen_2port__platform_8h.html#af89d3610372fc35178e83e06916aa808">GPRAPI</a> const char* gpr_log_severity_string </td>
  382. <td>(</td>
  383. <td class="paramtype"><a class="el" href="impl_2codegen_2log_8h.html#af10334b4085ac6985a2af9c08478ad48">gpr_log_severity</a>&#160;</td>
  384. <td class="paramname"><em>severity</em></td><td>)</td>
  385. <td></td>
  386. </tr>
  387. </table>
  388. </div><div class="memdoc">
  389. <p>Returns a string representation of the log severity. </p>
  390. </div>
  391. </div>
  392. <a id="a920f1611251015a9806177ed78931aa5"></a>
  393. <h2 class="memtitle"><span class="permalink"><a href="#a920f1611251015a9806177ed78931aa5">&#9670;&nbsp;</a></span>gpr_log_verbosity_init()</h2>
  394. <div class="memitem">
  395. <div class="memproto">
  396. <table class="memname">
  397. <tr>
  398. <td class="memname"><a class="el" href="impl_2codegen_2port__platform_8h.html#af89d3610372fc35178e83e06916aa808">GPRAPI</a> void gpr_log_verbosity_init </td>
  399. <td>(</td>
  400. <td class="paramtype">void&#160;</td>
  401. <td class="paramname"></td><td>)</td>
  402. <td></td>
  403. </tr>
  404. </table>
  405. </div><div class="memdoc">
  406. </div>
  407. </div>
  408. <a id="ae437062e3540eeebb4c95f119fe56be5"></a>
  409. <h2 class="memtitle"><span class="permalink"><a href="#ae437062e3540eeebb4c95f119fe56be5">&#9670;&nbsp;</a></span>gpr_set_log_function()</h2>
  410. <div class="memitem">
  411. <div class="memproto">
  412. <table class="memname">
  413. <tr>
  414. <td class="memname"><a class="el" href="impl_2codegen_2port__platform_8h.html#af89d3610372fc35178e83e06916aa808">GPRAPI</a> void gpr_set_log_function </td>
  415. <td>(</td>
  416. <td class="paramtype"><a class="el" href="impl_2codegen_2log_8h.html#a3bba35ee3180d11d8ff5a71cc2ee2a05">gpr_log_func</a>&#160;</td>
  417. <td class="paramname"><em>func</em></td><td>)</td>
  418. <td></td>
  419. </tr>
  420. </table>
  421. </div><div class="memdoc">
  422. </div>
  423. </div>
  424. <a id="aec0c537cb1e244060c65d9d9d153979f"></a>
  425. <h2 class="memtitle"><span class="permalink"><a href="#aec0c537cb1e244060c65d9d9d153979f">&#9670;&nbsp;</a></span>gpr_set_log_verbosity()</h2>
  426. <div class="memitem">
  427. <div class="memproto">
  428. <table class="memname">
  429. <tr>
  430. <td class="memname"><a class="el" href="impl_2codegen_2port__platform_8h.html#af89d3610372fc35178e83e06916aa808">GPRAPI</a> void gpr_set_log_verbosity </td>
  431. <td>(</td>
  432. <td class="paramtype"><a class="el" href="impl_2codegen_2log_8h.html#af10334b4085ac6985a2af9c08478ad48">gpr_log_severity</a>&#160;</td>
  433. <td class="paramname"><em>min_severity_to_print</em></td><td>)</td>
  434. <td></td>
  435. </tr>
  436. </table>
  437. </div><div class="memdoc">
  438. <p>Set global log verbosity. </p>
  439. </div>
  440. </div>
  441. <a id="a7fb54337c9f6a34074ab181eb98ace47"></a>
  442. <h2 class="memtitle"><span class="permalink"><a href="#a7fb54337c9f6a34074ab181eb98ace47">&#9670;&nbsp;</a></span>gpr_should_log()</h2>
  443. <div class="memitem">
  444. <div class="memproto">
  445. <table class="memname">
  446. <tr>
  447. <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>
  448. <td>(</td>
  449. <td class="paramtype"><a class="el" href="impl_2codegen_2log_8h.html#af10334b4085ac6985a2af9c08478ad48">gpr_log_severity</a>&#160;</td>
  450. <td class="paramname"><em>severity</em></td><td>)</td>
  451. <td></td>
  452. </tr>
  453. </table>
  454. </div><div class="memdoc">
  455. </div>
  456. </div>
  457. </div><!-- contents -->
  458. <!-- start footer part -->
  459. <hr class="footer"/><address class="footer"><small>
  460. Generated on Fri Jan 18 2019 16:38:51 for GRPC Core by &#160;<a href="http://www.doxygen.org/index.html">
  461. <img class="footer" src="doxygen.png" alt="doxygen"/>
  462. </a> 1.8.13
  463. </small></address>
  464. </body>
  465. </html>