Mon, 17 Apr 2023 21:47:34 +0200
change CX_STR: use compound literal in C and ctor in C++
universe@390 | 1 | <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> |
universe@390 | 2 | <html xmlns="http://www.w3.org/1999/xhtml"> |
universe@390 | 3 | <head> |
universe@390 | 4 | <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/> |
universe@390 | 5 | <meta http-equiv="X-UA-Compatible" content="IE=9"/> |
universe@390 | 6 | <meta name="generator" content="Doxygen 1.8.13"/> |
universe@390 | 7 | <meta name="viewport" content="width=device-width, initial-scale=1"/> |
universe@390 | 8 | <title>ucx: /home/mike/workspace/c/ucx/src/ucx/logging.h File Reference</title> |
universe@390 | 9 | <link href="tabs.css" rel="stylesheet" type="text/css"/> |
universe@390 | 10 | <script type="text/javascript" src="jquery.js"></script> |
universe@390 | 11 | <script type="text/javascript" src="dynsections.js"></script> |
universe@390 | 12 | <link href="search/search.css" rel="stylesheet" type="text/css"/> |
universe@390 | 13 | <script type="text/javascript" src="search/searchdata.js"></script> |
universe@390 | 14 | <script type="text/javascript" src="search/search.js"></script> |
universe@390 | 15 | <link href="doxygen.css" rel="stylesheet" type="text/css" /> |
universe@390 | 16 | </head> |
universe@390 | 17 | <body> |
universe@390 | 18 | <div id="top"><!-- do not remove this div, it is closed by doxygen! --> |
universe@390 | 19 | <div id="titlearea"> |
universe@390 | 20 | <table cellspacing="0" cellpadding="0"> |
universe@390 | 21 | <tbody> |
universe@390 | 22 | <tr style="height: 56px;"> |
universe@390 | 23 | <td id="projectlogo"><img alt="Logo" src="uaplogo.png"/></td> |
universe@390 | 24 | <td id="projectalign" style="padding-left: 0.5em;"> |
universe@390 | 25 | <div id="projectname">ucx |
universe@390 | 26 | </div> |
universe@390 | 27 | <div id="projectbrief">UAP Common Extensions</div> |
universe@390 | 28 | </td> |
universe@390 | 29 | </tr> |
universe@390 | 30 | </tbody> |
universe@390 | 31 | </table> |
universe@390 | 32 | </div> |
universe@390 | 33 | <!-- end header part --> |
universe@390 | 34 | <!-- Generated by Doxygen 1.8.13 --> |
universe@390 | 35 | <script type="text/javascript"> |
universe@390 | 36 | var searchBox = new SearchBox("searchBox", "search",false,'Search'); |
universe@390 | 37 | </script> |
universe@390 | 38 | <script type="text/javascript" src="menudata.js"></script> |
universe@390 | 39 | <script type="text/javascript" src="menu.js"></script> |
universe@390 | 40 | <script type="text/javascript"> |
universe@390 | 41 | $(function() { |
universe@390 | 42 | initMenu('',true,false,'search.php','Search'); |
universe@390 | 43 | $(document).ready(function() { init_search(); }); |
universe@390 | 44 | }); |
universe@390 | 45 | </script> |
universe@390 | 46 | <div id="main-nav"></div> |
universe@390 | 47 | <!-- window showing the filter options --> |
universe@390 | 48 | <div id="MSearchSelectWindow" |
universe@390 | 49 | onmouseover="return searchBox.OnSearchSelectShow()" |
universe@390 | 50 | onmouseout="return searchBox.OnSearchSelectHide()" |
universe@390 | 51 | onkeydown="return searchBox.OnSearchSelectKey(event)"> |
universe@390 | 52 | </div> |
universe@390 | 53 | |
universe@390 | 54 | <!-- iframe showing the search results (closed by default) --> |
universe@390 | 55 | <div id="MSearchResultsWindow"> |
universe@390 | 56 | <iframe src="javascript:void(0)" frameborder="0" |
universe@390 | 57 | name="MSearchResults" id="MSearchResults"> |
universe@390 | 58 | </iframe> |
universe@390 | 59 | </div> |
universe@390 | 60 | |
universe@390 | 61 | <div id="nav-path" class="navpath"> |
universe@390 | 62 | <ul> |
universe@390 | 63 | <li class="navelem"><a class="el" href="dir_68267d1309a1af8e8297ef4c3efbcdba.html">src</a></li><li class="navelem"><a class="el" href="dir_69f4ea29401808fe6229564976cde3ce.html">ucx</a></li> </ul> |
universe@390 | 64 | </div> |
universe@390 | 65 | </div><!-- top --> |
universe@390 | 66 | <div class="header"> |
universe@390 | 67 | <div class="summary"> |
universe@390 | 68 | <a href="#nested-classes">Data Structures</a> | |
universe@390 | 69 | <a href="#define-members">Macros</a> | |
universe@390 | 70 | <a href="#func-members">Functions</a> </div> |
universe@390 | 71 | <div class="headertitle"> |
universe@390 | 72 | <div class="title">logging.h File Reference</div> </div> |
universe@390 | 73 | </div><!--header--> |
universe@390 | 74 | <div class="contents"> |
universe@390 | 75 | |
universe@390 | 76 | <p>Logging API. |
universe@390 | 77 | <a href="#details">More...</a></p> |
universe@390 | 78 | <div class="textblock"><code>#include "<a class="el" href="ucx_8h_source.html">ucx.h</a>"</code><br /> |
universe@390 | 79 | <code>#include "<a class="el" href="map_8h_source.html">map.h</a>"</code><br /> |
universe@390 | 80 | <code>#include "<a class="el" href="string_8h_source.html">string.h</a>"</code><br /> |
universe@390 | 81 | <code>#include <stdio.h></code><br /> |
universe@390 | 82 | </div> |
universe@390 | 83 | <p><a href="logging_8h_source.html">Go to the source code of this file.</a></p> |
universe@390 | 84 | <table class="memberdecls"> |
universe@390 | 85 | <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="nested-classes"></a> |
universe@390 | 86 | Data Structures</h2></td></tr> |
universe@390 | 87 | <tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="structUcxLogger.html">UcxLogger</a></td></tr> |
universe@390 | 88 | <tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">The UCX Logger object. <a href="structUcxLogger.html#details">More...</a><br /></td></tr> |
universe@390 | 89 | <tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr> |
universe@390 | 90 | </table><table class="memberdecls"> |
universe@390 | 91 | <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="define-members"></a> |
universe@390 | 92 | Macros</h2></td></tr> |
universe@390 | 93 | <tr class="memitem:aa254c07fe3a907613e2256a318d5c9a8"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="logging_8h.html#aa254c07fe3a907613e2256a318d5c9a8">UCX_LOGGER_ERROR</a>   0x00</td></tr> |
universe@390 | 94 | <tr class="memdesc:aa254c07fe3a907613e2256a318d5c9a8"><td class="mdescLeft"> </td><td class="mdescRight">Log level for error messages. <a href="#aa254c07fe3a907613e2256a318d5c9a8">More...</a><br /></td></tr> |
universe@390 | 95 | <tr class="separator:aa254c07fe3a907613e2256a318d5c9a8"><td class="memSeparator" colspan="2"> </td></tr> |
universe@390 | 96 | <tr class="memitem:abd01ca11486226ba34e8f7028d9fffba"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="logging_8h.html#abd01ca11486226ba34e8f7028d9fffba">UCX_LOGGER_WARN</a>   0x10</td></tr> |
universe@390 | 97 | <tr class="memdesc:abd01ca11486226ba34e8f7028d9fffba"><td class="mdescLeft"> </td><td class="mdescRight">Log level for warning messages. <a href="#abd01ca11486226ba34e8f7028d9fffba">More...</a><br /></td></tr> |
universe@390 | 98 | <tr class="separator:abd01ca11486226ba34e8f7028d9fffba"><td class="memSeparator" colspan="2"> </td></tr> |
universe@390 | 99 | <tr class="memitem:a4b0178bf60a6129373ffc59114ca4c9b"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="logging_8h.html#a4b0178bf60a6129373ffc59114ca4c9b">UCX_LOGGER_INFO</a>   0x20</td></tr> |
universe@390 | 100 | <tr class="memdesc:a4b0178bf60a6129373ffc59114ca4c9b"><td class="mdescLeft"> </td><td class="mdescRight">Log level for information messages. <a href="#a4b0178bf60a6129373ffc59114ca4c9b">More...</a><br /></td></tr> |
universe@390 | 101 | <tr class="separator:a4b0178bf60a6129373ffc59114ca4c9b"><td class="memSeparator" colspan="2"> </td></tr> |
universe@390 | 102 | <tr class="memitem:acff01d1ef919ea997cfce755fc1b83d8"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="logging_8h.html#acff01d1ef919ea997cfce755fc1b83d8">UCX_LOGGER_DEBUG</a>   0x30</td></tr> |
universe@390 | 103 | <tr class="memdesc:acff01d1ef919ea997cfce755fc1b83d8"><td class="mdescLeft"> </td><td class="mdescRight">Log level for debug messages. <a href="#acff01d1ef919ea997cfce755fc1b83d8">More...</a><br /></td></tr> |
universe@390 | 104 | <tr class="separator:acff01d1ef919ea997cfce755fc1b83d8"><td class="memSeparator" colspan="2"> </td></tr> |
universe@390 | 105 | <tr class="memitem:a55b88d1fec7036d841b3ddd6195c5586"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="logging_8h.html#a55b88d1fec7036d841b3ddd6195c5586">UCX_LOGGER_TRACE</a>   0x40</td></tr> |
universe@390 | 106 | <tr class="memdesc:a55b88d1fec7036d841b3ddd6195c5586"><td class="mdescLeft"> </td><td class="mdescRight">Log level for trace messages. <a href="#a55b88d1fec7036d841b3ddd6195c5586">More...</a><br /></td></tr> |
universe@390 | 107 | <tr class="separator:a55b88d1fec7036d841b3ddd6195c5586"><td class="memSeparator" colspan="2"> </td></tr> |
universe@390 | 108 | <tr class="memitem:aee18bc20e58ffb69910121512c350839"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="logging_8h.html#aee18bc20e58ffb69910121512c350839">UCX_LOGGER_LEVEL</a>   0x01</td></tr> |
universe@390 | 109 | <tr class="memdesc:aee18bc20e58ffb69910121512c350839"><td class="mdescLeft"> </td><td class="mdescRight">Output flag for the log level. <a href="#aee18bc20e58ffb69910121512c350839">More...</a><br /></td></tr> |
universe@390 | 110 | <tr class="separator:aee18bc20e58ffb69910121512c350839"><td class="memSeparator" colspan="2"> </td></tr> |
universe@390 | 111 | <tr class="memitem:a38607008268b4f776ee500fb95d2e823"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="logging_8h.html#a38607008268b4f776ee500fb95d2e823">UCX_LOGGER_TIMESTAMP</a>   0x02</td></tr> |
universe@390 | 112 | <tr class="memdesc:a38607008268b4f776ee500fb95d2e823"><td class="mdescLeft"> </td><td class="mdescRight">Output flag for the timestmap. <a href="#a38607008268b4f776ee500fb95d2e823">More...</a><br /></td></tr> |
universe@390 | 113 | <tr class="separator:a38607008268b4f776ee500fb95d2e823"><td class="memSeparator" colspan="2"> </td></tr> |
universe@390 | 114 | <tr class="memitem:a0e0d72b12616c1e49ff8834eaf4cb8a2"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="logging_8h.html#a0e0d72b12616c1e49ff8834eaf4cb8a2">UCX_LOGGER_SOURCE</a>   0x04</td></tr> |
universe@390 | 115 | <tr class="memdesc:a0e0d72b12616c1e49ff8834eaf4cb8a2"><td class="mdescLeft"> </td><td class="mdescRight">Output flag for the source. <a href="#a0e0d72b12616c1e49ff8834eaf4cb8a2">More...</a><br /></td></tr> |
universe@390 | 116 | <tr class="separator:a0e0d72b12616c1e49ff8834eaf4cb8a2"><td class="memSeparator" colspan="2"> </td></tr> |
universe@390 | 117 | <tr class="memitem:a5cffc19502c4c90bfb3bd3bbcd18170a"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="logging_8h.html#a5cffc19502c4c90bfb3bd3bbcd18170a">ucx_logger_register_level</a>(logger, level, name)</td></tr> |
universe@390 | 118 | <tr class="memdesc:a5cffc19502c4c90bfb3bd3bbcd18170a"><td class="mdescLeft"> </td><td class="mdescRight">Registers a custom log level. <a href="#a5cffc19502c4c90bfb3bd3bbcd18170a">More...</a><br /></td></tr> |
universe@390 | 119 | <tr class="separator:a5cffc19502c4c90bfb3bd3bbcd18170a"><td class="memSeparator" colspan="2"> </td></tr> |
universe@390 | 120 | <tr class="memitem:aa0245325031d95799b28def177fd14ec"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="logging_8h.html#aa0245325031d95799b28def177fd14ec">ucx_logger_log</a>(logger, level, ...)   <a class="el" href="logging_8h.html#ac337e5d02ebea565012d4c11bd643801">ucx_logger_logf</a>(logger, level, __FILE__, __LINE__, __VA_ARGS__)</td></tr> |
universe@390 | 121 | <tr class="memdesc:aa0245325031d95799b28def177fd14ec"><td class="mdescLeft"> </td><td class="mdescRight">Logs a message at the specified level. <a href="#aa0245325031d95799b28def177fd14ec">More...</a><br /></td></tr> |
universe@390 | 122 | <tr class="separator:aa0245325031d95799b28def177fd14ec"><td class="memSeparator" colspan="2"> </td></tr> |
universe@390 | 123 | <tr class="memitem:a6a9e472e14d6768e59d96d245e065397"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="logging_8h.html#a6a9e472e14d6768e59d96d245e065397">ucx_logger_error</a>(logger, ...)   <a class="el" href="logging_8h.html#aa0245325031d95799b28def177fd14ec">ucx_logger_log</a>(logger, <a class="el" href="logging_8h.html#aa254c07fe3a907613e2256a318d5c9a8">UCX_LOGGER_ERROR</a>, __VA_ARGS__)</td></tr> |
universe@390 | 124 | <tr class="memdesc:a6a9e472e14d6768e59d96d245e065397"><td class="mdescLeft"> </td><td class="mdescRight">Shortcut for logging an error message. <a href="#a6a9e472e14d6768e59d96d245e065397">More...</a><br /></td></tr> |
universe@390 | 125 | <tr class="separator:a6a9e472e14d6768e59d96d245e065397"><td class="memSeparator" colspan="2"> </td></tr> |
universe@390 | 126 | <tr class="memitem:a98464d8d51376ce2716dcc4eca00d5da"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="logging_8h.html#a98464d8d51376ce2716dcc4eca00d5da">ucx_logger_info</a>(logger, ...)   <a class="el" href="logging_8h.html#aa0245325031d95799b28def177fd14ec">ucx_logger_log</a>(logger, <a class="el" href="logging_8h.html#a4b0178bf60a6129373ffc59114ca4c9b">UCX_LOGGER_INFO</a>, __VA_ARGS__)</td></tr> |
universe@390 | 127 | <tr class="memdesc:a98464d8d51376ce2716dcc4eca00d5da"><td class="mdescLeft"> </td><td class="mdescRight">Shortcut for logging an information message. <a href="#a98464d8d51376ce2716dcc4eca00d5da">More...</a><br /></td></tr> |
universe@390 | 128 | <tr class="separator:a98464d8d51376ce2716dcc4eca00d5da"><td class="memSeparator" colspan="2"> </td></tr> |
universe@390 | 129 | <tr class="memitem:aca7bd861b646892813fd7310c0aa69af"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="logging_8h.html#aca7bd861b646892813fd7310c0aa69af">ucx_logger_warn</a>(logger, ...)   <a class="el" href="logging_8h.html#aa0245325031d95799b28def177fd14ec">ucx_logger_log</a>(logger, <a class="el" href="logging_8h.html#abd01ca11486226ba34e8f7028d9fffba">UCX_LOGGER_WARN</a>, __VA_ARGS__)</td></tr> |
universe@390 | 130 | <tr class="memdesc:aca7bd861b646892813fd7310c0aa69af"><td class="mdescLeft"> </td><td class="mdescRight">Shortcut for logging a warning message. <a href="#aca7bd861b646892813fd7310c0aa69af">More...</a><br /></td></tr> |
universe@390 | 131 | <tr class="separator:aca7bd861b646892813fd7310c0aa69af"><td class="memSeparator" colspan="2"> </td></tr> |
universe@390 | 132 | <tr class="memitem:a2936402799892db5138e5f1f8c25db0c"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="logging_8h.html#a2936402799892db5138e5f1f8c25db0c">ucx_logger_debug</a>(logger, ...)   <a class="el" href="logging_8h.html#aa0245325031d95799b28def177fd14ec">ucx_logger_log</a>(logger, <a class="el" href="logging_8h.html#acff01d1ef919ea997cfce755fc1b83d8">UCX_LOGGER_DEBUG</a>, __VA_ARGS__)</td></tr> |
universe@390 | 133 | <tr class="memdesc:a2936402799892db5138e5f1f8c25db0c"><td class="mdescLeft"> </td><td class="mdescRight">Shortcut for logging a debug message. <a href="#a2936402799892db5138e5f1f8c25db0c">More...</a><br /></td></tr> |
universe@390 | 134 | <tr class="separator:a2936402799892db5138e5f1f8c25db0c"><td class="memSeparator" colspan="2"> </td></tr> |
universe@390 | 135 | <tr class="memitem:a3031b7ff13f4cfae9c2916543be2877c"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="logging_8h.html#a3031b7ff13f4cfae9c2916543be2877c">ucx_logger_trace</a>(logger, ...)   <a class="el" href="logging_8h.html#aa0245325031d95799b28def177fd14ec">ucx_logger_log</a>(logger, <a class="el" href="logging_8h.html#a55b88d1fec7036d841b3ddd6195c5586">UCX_LOGGER_TRACE</a>, __VA_ARGS__)</td></tr> |
universe@390 | 136 | <tr class="memdesc:a3031b7ff13f4cfae9c2916543be2877c"><td class="mdescLeft"> </td><td class="mdescRight">Shortcut for logging a trace message. <a href="#a3031b7ff13f4cfae9c2916543be2877c">More...</a><br /></td></tr> |
universe@390 | 137 | <tr class="separator:a3031b7ff13f4cfae9c2916543be2877c"><td class="memSeparator" colspan="2"> </td></tr> |
universe@390 | 138 | </table><table class="memberdecls"> |
universe@390 | 139 | <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a> |
universe@390 | 140 | Functions</h2></td></tr> |
universe@390 | 141 | <tr class="memitem:ac560f8517d2172794c9d2691735ec48c"><td class="memItemLeft" align="right" valign="top"><a class="el" href="structUcxLogger.html">UcxLogger</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="logging_8h.html#ac560f8517d2172794c9d2691735ec48c">ucx_logger_new</a> (void *stream, unsigned int level, unsigned int mask)</td></tr> |
universe@390 | 142 | <tr class="memdesc:ac560f8517d2172794c9d2691735ec48c"><td class="mdescLeft"> </td><td class="mdescRight">Creates a new logger. <a href="#ac560f8517d2172794c9d2691735ec48c">More...</a><br /></td></tr> |
universe@390 | 143 | <tr class="separator:ac560f8517d2172794c9d2691735ec48c"><td class="memSeparator" colspan="2"> </td></tr> |
universe@390 | 144 | <tr class="memitem:ac4697b784e01ec990d2acea192e21658"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="logging_8h.html#ac4697b784e01ec990d2acea192e21658">ucx_logger_free</a> (<a class="el" href="structUcxLogger.html">UcxLogger</a> *logger)</td></tr> |
universe@390 | 145 | <tr class="memdesc:ac4697b784e01ec990d2acea192e21658"><td class="mdescLeft"> </td><td class="mdescRight">Destroys the logger. <a href="#ac4697b784e01ec990d2acea192e21658">More...</a><br /></td></tr> |
universe@390 | 146 | <tr class="separator:ac4697b784e01ec990d2acea192e21658"><td class="memSeparator" colspan="2"> </td></tr> |
universe@390 | 147 | <tr class="memitem:ac337e5d02ebea565012d4c11bd643801"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="logging_8h.html#ac337e5d02ebea565012d4c11bd643801">ucx_logger_logf</a> (<a class="el" href="structUcxLogger.html">UcxLogger</a> *logger, unsigned int level, const char *file, const unsigned int line, const char *format,...)</td></tr> |
universe@390 | 148 | <tr class="memdesc:ac337e5d02ebea565012d4c11bd643801"><td class="mdescLeft"> </td><td class="mdescRight">Internal log function - use macros instead. <a href="#ac337e5d02ebea565012d4c11bd643801">More...</a><br /></td></tr> |
universe@390 | 149 | <tr class="separator:ac337e5d02ebea565012d4c11bd643801"><td class="memSeparator" colspan="2"> </td></tr> |
universe@390 | 150 | </table> |
universe@390 | 151 | <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2> |
universe@390 | 152 | <div class="textblock"><p>Logging API. </p> |
universe@390 | 153 | <dl class="section author"><dt>Author</dt><dd>Mike Becker, Olaf Wintermann </dd></dl> |
universe@390 | 154 | </div><h2 class="groupheader">Macro Definition Documentation</h2> |
universe@390 | 155 | <a id="acff01d1ef919ea997cfce755fc1b83d8"></a> |
universe@390 | 156 | <h2 class="memtitle"><span class="permalink"><a href="#acff01d1ef919ea997cfce755fc1b83d8">◆ </a></span>UCX_LOGGER_DEBUG</h2> |
universe@390 | 157 | |
universe@390 | 158 | <div class="memitem"> |
universe@390 | 159 | <div class="memproto"> |
universe@390 | 160 | <table class="memname"> |
universe@390 | 161 | <tr> |
universe@390 | 162 | <td class="memname">#define UCX_LOGGER_DEBUG   0x30</td> |
universe@390 | 163 | </tr> |
universe@390 | 164 | </table> |
universe@390 | 165 | </div><div class="memdoc"> |
universe@390 | 166 | |
universe@390 | 167 | <p>Log level for debug messages. </p> |
universe@390 | 168 | |
universe@390 | 169 | </div> |
universe@390 | 170 | </div> |
universe@390 | 171 | <a id="a2936402799892db5138e5f1f8c25db0c"></a> |
universe@390 | 172 | <h2 class="memtitle"><span class="permalink"><a href="#a2936402799892db5138e5f1f8c25db0c">◆ </a></span>ucx_logger_debug</h2> |
universe@390 | 173 | |
universe@390 | 174 | <div class="memitem"> |
universe@390 | 175 | <div class="memproto"> |
universe@390 | 176 | <table class="memname"> |
universe@390 | 177 | <tr> |
universe@390 | 178 | <td class="memname">#define ucx_logger_debug</td> |
universe@390 | 179 | <td>(</td> |
universe@390 | 180 | <td class="paramtype"> </td> |
universe@390 | 181 | <td class="paramname">logger, </td> |
universe@390 | 182 | </tr> |
universe@390 | 183 | <tr> |
universe@390 | 184 | <td class="paramkey"></td> |
universe@390 | 185 | <td></td> |
universe@390 | 186 | <td class="paramtype"> </td> |
universe@390 | 187 | <td class="paramname"><em>...</em> </td> |
universe@390 | 188 | </tr> |
universe@390 | 189 | <tr> |
universe@390 | 190 | <td></td> |
universe@390 | 191 | <td>)</td> |
universe@390 | 192 | <td></td><td>   <a class="el" href="logging_8h.html#aa0245325031d95799b28def177fd14ec">ucx_logger_log</a>(logger, <a class="el" href="logging_8h.html#acff01d1ef919ea997cfce755fc1b83d8">UCX_LOGGER_DEBUG</a>, __VA_ARGS__)</td> |
universe@390 | 193 | </tr> |
universe@390 | 194 | </table> |
universe@390 | 195 | </div><div class="memdoc"> |
universe@390 | 196 | |
universe@390 | 197 | <p>Shortcut for logging a debug message. </p> |
universe@390 | 198 | <dl class="params"><dt>Parameters</dt><dd> |
universe@390 | 199 | <table class="params"> |
universe@390 | 200 | <tr><td class="paramname">logger</td><td>the logger to use </td></tr> |
universe@390 | 201 | <tr><td class="paramname">...</td><td>format string and arguments </td></tr> |
universe@390 | 202 | </table> |
universe@390 | 203 | </dd> |
universe@390 | 204 | </dl> |
universe@390 | 205 | <dl class="section see"><dt>See also</dt><dd><a class="el" href="logging_8h.html#ac337e5d02ebea565012d4c11bd643801" title="Internal log function - use macros instead. ">ucx_logger_logf()</a> </dd></dl> |
universe@390 | 206 | |
universe@390 | 207 | </div> |
universe@390 | 208 | </div> |
universe@390 | 209 | <a id="aa254c07fe3a907613e2256a318d5c9a8"></a> |
universe@390 | 210 | <h2 class="memtitle"><span class="permalink"><a href="#aa254c07fe3a907613e2256a318d5c9a8">◆ </a></span>UCX_LOGGER_ERROR</h2> |
universe@390 | 211 | |
universe@390 | 212 | <div class="memitem"> |
universe@390 | 213 | <div class="memproto"> |
universe@390 | 214 | <table class="memname"> |
universe@390 | 215 | <tr> |
universe@390 | 216 | <td class="memname">#define UCX_LOGGER_ERROR   0x00</td> |
universe@390 | 217 | </tr> |
universe@390 | 218 | </table> |
universe@390 | 219 | </div><div class="memdoc"> |
universe@390 | 220 | |
universe@390 | 221 | <p>Log level for error messages. </p> |
universe@390 | 222 | |
universe@390 | 223 | </div> |
universe@390 | 224 | </div> |
universe@390 | 225 | <a id="a6a9e472e14d6768e59d96d245e065397"></a> |
universe@390 | 226 | <h2 class="memtitle"><span class="permalink"><a href="#a6a9e472e14d6768e59d96d245e065397">◆ </a></span>ucx_logger_error</h2> |
universe@390 | 227 | |
universe@390 | 228 | <div class="memitem"> |
universe@390 | 229 | <div class="memproto"> |
universe@390 | 230 | <table class="memname"> |
universe@390 | 231 | <tr> |
universe@390 | 232 | <td class="memname">#define ucx_logger_error</td> |
universe@390 | 233 | <td>(</td> |
universe@390 | 234 | <td class="paramtype"> </td> |
universe@390 | 235 | <td class="paramname">logger, </td> |
universe@390 | 236 | </tr> |
universe@390 | 237 | <tr> |
universe@390 | 238 | <td class="paramkey"></td> |
universe@390 | 239 | <td></td> |
universe@390 | 240 | <td class="paramtype"> </td> |
universe@390 | 241 | <td class="paramname"><em>...</em> </td> |
universe@390 | 242 | </tr> |
universe@390 | 243 | <tr> |
universe@390 | 244 | <td></td> |
universe@390 | 245 | <td>)</td> |
universe@390 | 246 | <td></td><td>   <a class="el" href="logging_8h.html#aa0245325031d95799b28def177fd14ec">ucx_logger_log</a>(logger, <a class="el" href="logging_8h.html#aa254c07fe3a907613e2256a318d5c9a8">UCX_LOGGER_ERROR</a>, __VA_ARGS__)</td> |
universe@390 | 247 | </tr> |
universe@390 | 248 | </table> |
universe@390 | 249 | </div><div class="memdoc"> |
universe@390 | 250 | |
universe@390 | 251 | <p>Shortcut for logging an error message. </p> |
universe@390 | 252 | <dl class="params"><dt>Parameters</dt><dd> |
universe@390 | 253 | <table class="params"> |
universe@390 | 254 | <tr><td class="paramname">logger</td><td>the logger to use </td></tr> |
universe@390 | 255 | <tr><td class="paramname">...</td><td>format string and arguments </td></tr> |
universe@390 | 256 | </table> |
universe@390 | 257 | </dd> |
universe@390 | 258 | </dl> |
universe@390 | 259 | <dl class="section see"><dt>See also</dt><dd><a class="el" href="logging_8h.html#ac337e5d02ebea565012d4c11bd643801" title="Internal log function - use macros instead. ">ucx_logger_logf()</a> </dd></dl> |
universe@390 | 260 | |
universe@390 | 261 | </div> |
universe@390 | 262 | </div> |
universe@390 | 263 | <a id="a4b0178bf60a6129373ffc59114ca4c9b"></a> |
universe@390 | 264 | <h2 class="memtitle"><span class="permalink"><a href="#a4b0178bf60a6129373ffc59114ca4c9b">◆ </a></span>UCX_LOGGER_INFO</h2> |
universe@390 | 265 | |
universe@390 | 266 | <div class="memitem"> |
universe@390 | 267 | <div class="memproto"> |
universe@390 | 268 | <table class="memname"> |
universe@390 | 269 | <tr> |
universe@390 | 270 | <td class="memname">#define UCX_LOGGER_INFO   0x20</td> |
universe@390 | 271 | </tr> |
universe@390 | 272 | </table> |
universe@390 | 273 | </div><div class="memdoc"> |
universe@390 | 274 | |
universe@390 | 275 | <p>Log level for information messages. </p> |
universe@390 | 276 | |
universe@390 | 277 | </div> |
universe@390 | 278 | </div> |
universe@390 | 279 | <a id="a98464d8d51376ce2716dcc4eca00d5da"></a> |
universe@390 | 280 | <h2 class="memtitle"><span class="permalink"><a href="#a98464d8d51376ce2716dcc4eca00d5da">◆ </a></span>ucx_logger_info</h2> |
universe@390 | 281 | |
universe@390 | 282 | <div class="memitem"> |
universe@390 | 283 | <div class="memproto"> |
universe@390 | 284 | <table class="memname"> |
universe@390 | 285 | <tr> |
universe@390 | 286 | <td class="memname">#define ucx_logger_info</td> |
universe@390 | 287 | <td>(</td> |
universe@390 | 288 | <td class="paramtype"> </td> |
universe@390 | 289 | <td class="paramname">logger, </td> |
universe@390 | 290 | </tr> |
universe@390 | 291 | <tr> |
universe@390 | 292 | <td class="paramkey"></td> |
universe@390 | 293 | <td></td> |
universe@390 | 294 | <td class="paramtype"> </td> |
universe@390 | 295 | <td class="paramname"><em>...</em> </td> |
universe@390 | 296 | </tr> |
universe@390 | 297 | <tr> |
universe@390 | 298 | <td></td> |
universe@390 | 299 | <td>)</td> |
universe@390 | 300 | <td></td><td>   <a class="el" href="logging_8h.html#aa0245325031d95799b28def177fd14ec">ucx_logger_log</a>(logger, <a class="el" href="logging_8h.html#a4b0178bf60a6129373ffc59114ca4c9b">UCX_LOGGER_INFO</a>, __VA_ARGS__)</td> |
universe@390 | 301 | </tr> |
universe@390 | 302 | </table> |
universe@390 | 303 | </div><div class="memdoc"> |
universe@390 | 304 | |
universe@390 | 305 | <p>Shortcut for logging an information message. </p> |
universe@390 | 306 | <dl class="params"><dt>Parameters</dt><dd> |
universe@390 | 307 | <table class="params"> |
universe@390 | 308 | <tr><td class="paramname">logger</td><td>the logger to use </td></tr> |
universe@390 | 309 | <tr><td class="paramname">...</td><td>format string and arguments </td></tr> |
universe@390 | 310 | </table> |
universe@390 | 311 | </dd> |
universe@390 | 312 | </dl> |
universe@390 | 313 | <dl class="section see"><dt>See also</dt><dd><a class="el" href="logging_8h.html#ac337e5d02ebea565012d4c11bd643801" title="Internal log function - use macros instead. ">ucx_logger_logf()</a> </dd></dl> |
universe@390 | 314 | |
universe@390 | 315 | </div> |
universe@390 | 316 | </div> |
universe@390 | 317 | <a id="aee18bc20e58ffb69910121512c350839"></a> |
universe@390 | 318 | <h2 class="memtitle"><span class="permalink"><a href="#aee18bc20e58ffb69910121512c350839">◆ </a></span>UCX_LOGGER_LEVEL</h2> |
universe@390 | 319 | |
universe@390 | 320 | <div class="memitem"> |
universe@390 | 321 | <div class="memproto"> |
universe@390 | 322 | <table class="memname"> |
universe@390 | 323 | <tr> |
universe@390 | 324 | <td class="memname">#define UCX_LOGGER_LEVEL   0x01</td> |
universe@390 | 325 | </tr> |
universe@390 | 326 | </table> |
universe@390 | 327 | </div><div class="memdoc"> |
universe@390 | 328 | |
universe@390 | 329 | <p>Output flag for the log level. </p> |
universe@390 | 330 | <p>If this flag is set, the log message will contain the log level. </p><dl class="section see"><dt>See also</dt><dd><a class="el" href="structUcxLogger.html#a1de0db2e02dcf03366268f6943f8b97c" title="A configuration mask for automatic output. ">UcxLogger.mask</a> </dd></dl> |
universe@390 | 331 | |
universe@390 | 332 | </div> |
universe@390 | 333 | </div> |
universe@390 | 334 | <a id="aa0245325031d95799b28def177fd14ec"></a> |
universe@390 | 335 | <h2 class="memtitle"><span class="permalink"><a href="#aa0245325031d95799b28def177fd14ec">◆ </a></span>ucx_logger_log</h2> |
universe@390 | 336 | |
universe@390 | 337 | <div class="memitem"> |
universe@390 | 338 | <div class="memproto"> |
universe@390 | 339 | <table class="memname"> |
universe@390 | 340 | <tr> |
universe@390 | 341 | <td class="memname">#define ucx_logger_log</td> |
universe@390 | 342 | <td>(</td> |
universe@390 | 343 | <td class="paramtype"> </td> |
universe@390 | 344 | <td class="paramname">logger, </td> |
universe@390 | 345 | </tr> |
universe@390 | 346 | <tr> |
universe@390 | 347 | <td class="paramkey"></td> |
universe@390 | 348 | <td></td> |
universe@390 | 349 | <td class="paramtype"> </td> |
universe@390 | 350 | <td class="paramname">level, </td> |
universe@390 | 351 | </tr> |
universe@390 | 352 | <tr> |
universe@390 | 353 | <td class="paramkey"></td> |
universe@390 | 354 | <td></td> |
universe@390 | 355 | <td class="paramtype"> </td> |
universe@390 | 356 | <td class="paramname"><em>...</em> </td> |
universe@390 | 357 | </tr> |
universe@390 | 358 | <tr> |
universe@390 | 359 | <td></td> |
universe@390 | 360 | <td>)</td> |
universe@390 | 361 | <td></td><td>   <a class="el" href="logging_8h.html#ac337e5d02ebea565012d4c11bd643801">ucx_logger_logf</a>(logger, level, __FILE__, __LINE__, __VA_ARGS__)</td> |
universe@390 | 362 | </tr> |
universe@390 | 363 | </table> |
universe@390 | 364 | </div><div class="memdoc"> |
universe@390 | 365 | |
universe@390 | 366 | <p>Logs a message at the specified level. </p> |
universe@390 | 367 | <dl class="params"><dt>Parameters</dt><dd> |
universe@390 | 368 | <table class="params"> |
universe@390 | 369 | <tr><td class="paramname">logger</td><td>the logger to use </td></tr> |
universe@390 | 370 | <tr><td class="paramname">level</td><td>the level to log the message on </td></tr> |
universe@390 | 371 | <tr><td class="paramname">...</td><td>format string and arguments </td></tr> |
universe@390 | 372 | </table> |
universe@390 | 373 | </dd> |
universe@390 | 374 | </dl> |
universe@390 | 375 | <dl class="section see"><dt>See also</dt><dd><a class="el" href="logging_8h.html#ac337e5d02ebea565012d4c11bd643801" title="Internal log function - use macros instead. ">ucx_logger_logf()</a> </dd></dl> |
universe@390 | 376 | |
universe@390 | 377 | </div> |
universe@390 | 378 | </div> |
universe@390 | 379 | <a id="a5cffc19502c4c90bfb3bd3bbcd18170a"></a> |
universe@390 | 380 | <h2 class="memtitle"><span class="permalink"><a href="#a5cffc19502c4c90bfb3bd3bbcd18170a">◆ </a></span>ucx_logger_register_level</h2> |
universe@390 | 381 | |
universe@390 | 382 | <div class="memitem"> |
universe@390 | 383 | <div class="memproto"> |
universe@390 | 384 | <table class="memname"> |
universe@390 | 385 | <tr> |
universe@390 | 386 | <td class="memname">#define ucx_logger_register_level</td> |
universe@390 | 387 | <td>(</td> |
universe@390 | 388 | <td class="paramtype"> </td> |
universe@390 | 389 | <td class="paramname">logger, </td> |
universe@390 | 390 | </tr> |
universe@390 | 391 | <tr> |
universe@390 | 392 | <td class="paramkey"></td> |
universe@390 | 393 | <td></td> |
universe@390 | 394 | <td class="paramtype"> </td> |
universe@390 | 395 | <td class="paramname">level, </td> |
universe@390 | 396 | </tr> |
universe@390 | 397 | <tr> |
universe@390 | 398 | <td class="paramkey"></td> |
universe@390 | 399 | <td></td> |
universe@390 | 400 | <td class="paramtype"> </td> |
universe@390 | 401 | <td class="paramname">name </td> |
universe@390 | 402 | </tr> |
universe@390 | 403 | <tr> |
universe@390 | 404 | <td></td> |
universe@390 | 405 | <td>)</td> |
universe@390 | 406 | <td></td><td></td> |
universe@390 | 407 | </tr> |
universe@390 | 408 | </table> |
universe@390 | 409 | </div><div class="memdoc"> |
universe@390 | 410 | <b>Value:</b><div class="fragment"><div class="line">{\</div><div class="line"> unsigned <span class="keywordtype">int</span> l; \</div><div class="line"> l = level; \</div><div class="line"> ucx_map_int_put(logger->levels, l, (<span class="keywordtype">void</span>*) <span class="stringliteral">"["</span> name <span class="stringliteral">"]"</span>); \</div><div class="line"> } <span class="keywordflow">while</span> (0);</div></div><!-- fragment --> |
universe@390 | 411 | <p>Registers a custom log level. </p> |
universe@390 | 412 | <dl class="params"><dt>Parameters</dt><dd> |
universe@390 | 413 | <table class="params"> |
universe@390 | 414 | <tr><td class="paramname">logger</td><td>the logger </td></tr> |
universe@390 | 415 | <tr><td class="paramname">level</td><td>the log level as unsigned integer </td></tr> |
universe@390 | 416 | <tr><td class="paramname">name</td><td>a string literal describing the level </td></tr> |
universe@390 | 417 | </table> |
universe@390 | 418 | </dd> |
universe@390 | 419 | </dl> |
universe@390 | 420 | |
universe@390 | 421 | </div> |
universe@390 | 422 | </div> |
universe@390 | 423 | <a id="a0e0d72b12616c1e49ff8834eaf4cb8a2"></a> |
universe@390 | 424 | <h2 class="memtitle"><span class="permalink"><a href="#a0e0d72b12616c1e49ff8834eaf4cb8a2">◆ </a></span>UCX_LOGGER_SOURCE</h2> |
universe@390 | 425 | |
universe@390 | 426 | <div class="memitem"> |
universe@390 | 427 | <div class="memproto"> |
universe@390 | 428 | <table class="memname"> |
universe@390 | 429 | <tr> |
universe@390 | 430 | <td class="memname">#define UCX_LOGGER_SOURCE   0x04</td> |
universe@390 | 431 | </tr> |
universe@390 | 432 | </table> |
universe@390 | 433 | </div><div class="memdoc"> |
universe@390 | 434 | |
universe@390 | 435 | <p>Output flag for the source. </p> |
universe@390 | 436 | <p>If this flag is set, the log message will contain the source file and line number. </p><dl class="section see"><dt>See also</dt><dd><a class="el" href="structUcxLogger.html#a1de0db2e02dcf03366268f6943f8b97c" title="A configuration mask for automatic output. ">UcxLogger.mask</a> </dd></dl> |
universe@390 | 437 | |
universe@390 | 438 | </div> |
universe@390 | 439 | </div> |
universe@390 | 440 | <a id="a38607008268b4f776ee500fb95d2e823"></a> |
universe@390 | 441 | <h2 class="memtitle"><span class="permalink"><a href="#a38607008268b4f776ee500fb95d2e823">◆ </a></span>UCX_LOGGER_TIMESTAMP</h2> |
universe@390 | 442 | |
universe@390 | 443 | <div class="memitem"> |
universe@390 | 444 | <div class="memproto"> |
universe@390 | 445 | <table class="memname"> |
universe@390 | 446 | <tr> |
universe@390 | 447 | <td class="memname">#define UCX_LOGGER_TIMESTAMP   0x02</td> |
universe@390 | 448 | </tr> |
universe@390 | 449 | </table> |
universe@390 | 450 | </div><div class="memdoc"> |
universe@390 | 451 | |
universe@390 | 452 | <p>Output flag for the timestmap. </p> |
universe@390 | 453 | <p>If this flag is set, the log message will contain the timestmap. </p><dl class="section see"><dt>See also</dt><dd><a class="el" href="structUcxLogger.html#a1de0db2e02dcf03366268f6943f8b97c" title="A configuration mask for automatic output. ">UcxLogger.mask</a> </dd></dl> |
universe@390 | 454 | |
universe@390 | 455 | </div> |
universe@390 | 456 | </div> |
universe@390 | 457 | <a id="a55b88d1fec7036d841b3ddd6195c5586"></a> |
universe@390 | 458 | <h2 class="memtitle"><span class="permalink"><a href="#a55b88d1fec7036d841b3ddd6195c5586">◆ </a></span>UCX_LOGGER_TRACE</h2> |
universe@390 | 459 | |
universe@390 | 460 | <div class="memitem"> |
universe@390 | 461 | <div class="memproto"> |
universe@390 | 462 | <table class="memname"> |
universe@390 | 463 | <tr> |
universe@390 | 464 | <td class="memname">#define UCX_LOGGER_TRACE   0x40</td> |
universe@390 | 465 | </tr> |
universe@390 | 466 | </table> |
universe@390 | 467 | </div><div class="memdoc"> |
universe@390 | 468 | |
universe@390 | 469 | <p>Log level for trace messages. </p> |
universe@390 | 470 | |
universe@390 | 471 | </div> |
universe@390 | 472 | </div> |
universe@390 | 473 | <a id="a3031b7ff13f4cfae9c2916543be2877c"></a> |
universe@390 | 474 | <h2 class="memtitle"><span class="permalink"><a href="#a3031b7ff13f4cfae9c2916543be2877c">◆ </a></span>ucx_logger_trace</h2> |
universe@390 | 475 | |
universe@390 | 476 | <div class="memitem"> |
universe@390 | 477 | <div class="memproto"> |
universe@390 | 478 | <table class="memname"> |
universe@390 | 479 | <tr> |
universe@390 | 480 | <td class="memname">#define ucx_logger_trace</td> |
universe@390 | 481 | <td>(</td> |
universe@390 | 482 | <td class="paramtype"> </td> |
universe@390 | 483 | <td class="paramname">logger, </td> |
universe@390 | 484 | </tr> |
universe@390 | 485 | <tr> |
universe@390 | 486 | <td class="paramkey"></td> |
universe@390 | 487 | <td></td> |
universe@390 | 488 | <td class="paramtype"> </td> |
universe@390 | 489 | <td class="paramname"><em>...</em> </td> |
universe@390 | 490 | </tr> |
universe@390 | 491 | <tr> |
universe@390 | 492 | <td></td> |
universe@390 | 493 | <td>)</td> |
universe@390 | 494 | <td></td><td>   <a class="el" href="logging_8h.html#aa0245325031d95799b28def177fd14ec">ucx_logger_log</a>(logger, <a class="el" href="logging_8h.html#a55b88d1fec7036d841b3ddd6195c5586">UCX_LOGGER_TRACE</a>, __VA_ARGS__)</td> |
universe@390 | 495 | </tr> |
universe@390 | 496 | </table> |
universe@390 | 497 | </div><div class="memdoc"> |
universe@390 | 498 | |
universe@390 | 499 | <p>Shortcut for logging a trace message. </p> |
universe@390 | 500 | <dl class="params"><dt>Parameters</dt><dd> |
universe@390 | 501 | <table class="params"> |
universe@390 | 502 | <tr><td class="paramname">logger</td><td>the logger to use </td></tr> |
universe@390 | 503 | <tr><td class="paramname">...</td><td>format string and arguments </td></tr> |
universe@390 | 504 | </table> |
universe@390 | 505 | </dd> |
universe@390 | 506 | </dl> |
universe@390 | 507 | <dl class="section see"><dt>See also</dt><dd><a class="el" href="logging_8h.html#ac337e5d02ebea565012d4c11bd643801" title="Internal log function - use macros instead. ">ucx_logger_logf()</a> </dd></dl> |
universe@390 | 508 | |
universe@390 | 509 | </div> |
universe@390 | 510 | </div> |
universe@390 | 511 | <a id="abd01ca11486226ba34e8f7028d9fffba"></a> |
universe@390 | 512 | <h2 class="memtitle"><span class="permalink"><a href="#abd01ca11486226ba34e8f7028d9fffba">◆ </a></span>UCX_LOGGER_WARN</h2> |
universe@390 | 513 | |
universe@390 | 514 | <div class="memitem"> |
universe@390 | 515 | <div class="memproto"> |
universe@390 | 516 | <table class="memname"> |
universe@390 | 517 | <tr> |
universe@390 | 518 | <td class="memname">#define UCX_LOGGER_WARN   0x10</td> |
universe@390 | 519 | </tr> |
universe@390 | 520 | </table> |
universe@390 | 521 | </div><div class="memdoc"> |
universe@390 | 522 | |
universe@390 | 523 | <p>Log level for warning messages. </p> |
universe@390 | 524 | |
universe@390 | 525 | </div> |
universe@390 | 526 | </div> |
universe@390 | 527 | <a id="aca7bd861b646892813fd7310c0aa69af"></a> |
universe@390 | 528 | <h2 class="memtitle"><span class="permalink"><a href="#aca7bd861b646892813fd7310c0aa69af">◆ </a></span>ucx_logger_warn</h2> |
universe@390 | 529 | |
universe@390 | 530 | <div class="memitem"> |
universe@390 | 531 | <div class="memproto"> |
universe@390 | 532 | <table class="memname"> |
universe@390 | 533 | <tr> |
universe@390 | 534 | <td class="memname">#define ucx_logger_warn</td> |
universe@390 | 535 | <td>(</td> |
universe@390 | 536 | <td class="paramtype"> </td> |
universe@390 | 537 | <td class="paramname">logger, </td> |
universe@390 | 538 | </tr> |
universe@390 | 539 | <tr> |
universe@390 | 540 | <td class="paramkey"></td> |
universe@390 | 541 | <td></td> |
universe@390 | 542 | <td class="paramtype"> </td> |
universe@390 | 543 | <td class="paramname"><em>...</em> </td> |
universe@390 | 544 | </tr> |
universe@390 | 545 | <tr> |
universe@390 | 546 | <td></td> |
universe@390 | 547 | <td>)</td> |
universe@390 | 548 | <td></td><td>   <a class="el" href="logging_8h.html#aa0245325031d95799b28def177fd14ec">ucx_logger_log</a>(logger, <a class="el" href="logging_8h.html#abd01ca11486226ba34e8f7028d9fffba">UCX_LOGGER_WARN</a>, __VA_ARGS__)</td> |
universe@390 | 549 | </tr> |
universe@390 | 550 | </table> |
universe@390 | 551 | </div><div class="memdoc"> |
universe@390 | 552 | |
universe@390 | 553 | <p>Shortcut for logging a warning message. </p> |
universe@390 | 554 | <dl class="params"><dt>Parameters</dt><dd> |
universe@390 | 555 | <table class="params"> |
universe@390 | 556 | <tr><td class="paramname">logger</td><td>the logger to use </td></tr> |
universe@390 | 557 | <tr><td class="paramname">...</td><td>format string and arguments </td></tr> |
universe@390 | 558 | </table> |
universe@390 | 559 | </dd> |
universe@390 | 560 | </dl> |
universe@390 | 561 | <dl class="section see"><dt>See also</dt><dd><a class="el" href="logging_8h.html#ac337e5d02ebea565012d4c11bd643801" title="Internal log function - use macros instead. ">ucx_logger_logf()</a> </dd></dl> |
universe@390 | 562 | |
universe@390 | 563 | </div> |
universe@390 | 564 | </div> |
universe@390 | 565 | <h2 class="groupheader">Function Documentation</h2> |
universe@390 | 566 | <a id="ac4697b784e01ec990d2acea192e21658"></a> |
universe@390 | 567 | <h2 class="memtitle"><span class="permalink"><a href="#ac4697b784e01ec990d2acea192e21658">◆ </a></span>ucx_logger_free()</h2> |
universe@390 | 568 | |
universe@390 | 569 | <div class="memitem"> |
universe@390 | 570 | <div class="memproto"> |
universe@390 | 571 | <table class="memname"> |
universe@390 | 572 | <tr> |
universe@390 | 573 | <td class="memname">void ucx_logger_free </td> |
universe@390 | 574 | <td>(</td> |
universe@390 | 575 | <td class="paramtype"><a class="el" href="structUcxLogger.html">UcxLogger</a> * </td> |
universe@390 | 576 | <td class="paramname"><em>logger</em></td><td>)</td> |
universe@390 | 577 | <td></td> |
universe@390 | 578 | </tr> |
universe@390 | 579 | </table> |
universe@390 | 580 | </div><div class="memdoc"> |
universe@390 | 581 | |
universe@390 | 582 | <p>Destroys the logger. </p> |
universe@390 | 583 | <p>The map containing the valid log levels is also automatically destroyed.</p> |
universe@390 | 584 | <dl class="params"><dt>Parameters</dt><dd> |
universe@390 | 585 | <table class="params"> |
universe@390 | 586 | <tr><td class="paramname">logger</td><td>the logger to destroy </td></tr> |
universe@390 | 587 | </table> |
universe@390 | 588 | </dd> |
universe@390 | 589 | </dl> |
universe@390 | 590 | |
universe@390 | 591 | </div> |
universe@390 | 592 | </div> |
universe@390 | 593 | <a id="ac337e5d02ebea565012d4c11bd643801"></a> |
universe@390 | 594 | <h2 class="memtitle"><span class="permalink"><a href="#ac337e5d02ebea565012d4c11bd643801">◆ </a></span>ucx_logger_logf()</h2> |
universe@390 | 595 | |
universe@390 | 596 | <div class="memitem"> |
universe@390 | 597 | <div class="memproto"> |
universe@390 | 598 | <table class="memname"> |
universe@390 | 599 | <tr> |
universe@390 | 600 | <td class="memname">void ucx_logger_logf </td> |
universe@390 | 601 | <td>(</td> |
universe@390 | 602 | <td class="paramtype"><a class="el" href="structUcxLogger.html">UcxLogger</a> * </td> |
universe@390 | 603 | <td class="paramname"><em>logger</em>, </td> |
universe@390 | 604 | </tr> |
universe@390 | 605 | <tr> |
universe@390 | 606 | <td class="paramkey"></td> |
universe@390 | 607 | <td></td> |
universe@390 | 608 | <td class="paramtype">unsigned int </td> |
universe@390 | 609 | <td class="paramname"><em>level</em>, </td> |
universe@390 | 610 | </tr> |
universe@390 | 611 | <tr> |
universe@390 | 612 | <td class="paramkey"></td> |
universe@390 | 613 | <td></td> |
universe@390 | 614 | <td class="paramtype">const char * </td> |
universe@390 | 615 | <td class="paramname"><em>file</em>, </td> |
universe@390 | 616 | </tr> |
universe@390 | 617 | <tr> |
universe@390 | 618 | <td class="paramkey"></td> |
universe@390 | 619 | <td></td> |
universe@390 | 620 | <td class="paramtype">const unsigned int </td> |
universe@390 | 621 | <td class="paramname"><em>line</em>, </td> |
universe@390 | 622 | </tr> |
universe@390 | 623 | <tr> |
universe@390 | 624 | <td class="paramkey"></td> |
universe@390 | 625 | <td></td> |
universe@390 | 626 | <td class="paramtype">const char * </td> |
universe@390 | 627 | <td class="paramname"><em>format</em>, </td> |
universe@390 | 628 | </tr> |
universe@390 | 629 | <tr> |
universe@390 | 630 | <td class="paramkey"></td> |
universe@390 | 631 | <td></td> |
universe@390 | 632 | <td class="paramtype"> </td> |
universe@390 | 633 | <td class="paramname"><em>...</em> </td> |
universe@390 | 634 | </tr> |
universe@390 | 635 | <tr> |
universe@390 | 636 | <td></td> |
universe@390 | 637 | <td>)</td> |
universe@390 | 638 | <td></td><td></td> |
universe@390 | 639 | </tr> |
universe@390 | 640 | </table> |
universe@390 | 641 | </div><div class="memdoc"> |
universe@390 | 642 | |
universe@390 | 643 | <p>Internal log function - use macros instead. </p> |
universe@390 | 644 | <p>This function uses the <code>format</code> and variadic arguments for a printf()-style output of the log message.</p> |
universe@390 | 645 | <p>Dependent on the <a class="el" href="structUcxLogger.html#a1de0db2e02dcf03366268f6943f8b97c" title="A configuration mask for automatic output. ">UcxLogger.mask</a> some information is prepended. The complete format is:</p> |
universe@390 | 646 | <p><code>[LEVEL] [TIMESTAMP] [SOURCEFILE]:[LINENO] message</code></p> |
universe@390 | 647 | <p><b>Attention:</b> the message (including automatically generated information) is limited to 4096 characters. The level description is limited to 256 characters and the timestamp string is limited to 128 characters.</p> |
universe@390 | 648 | <dl class="params"><dt>Parameters</dt><dd> |
universe@390 | 649 | <table class="params"> |
universe@390 | 650 | <tr><td class="paramname">logger</td><td>the logger to use </td></tr> |
universe@390 | 651 | <tr><td class="paramname">level</td><td>the level to log on </td></tr> |
universe@390 | 652 | <tr><td class="paramname">file</td><td>information about the source file </td></tr> |
universe@390 | 653 | <tr><td class="paramname">line</td><td>information about the source line number </td></tr> |
universe@390 | 654 | <tr><td class="paramname">format</td><td>format string </td></tr> |
universe@390 | 655 | <tr><td class="paramname">...</td><td>arguments </td></tr> |
universe@390 | 656 | </table> |
universe@390 | 657 | </dd> |
universe@390 | 658 | </dl> |
universe@390 | 659 | <dl class="section see"><dt>See also</dt><dd><a class="el" href="logging_8h.html#aa0245325031d95799b28def177fd14ec" title="Logs a message at the specified level. ">ucx_logger_log()</a> </dd></dl> |
universe@390 | 660 | |
universe@390 | 661 | </div> |
universe@390 | 662 | </div> |
universe@390 | 663 | <a id="ac560f8517d2172794c9d2691735ec48c"></a> |
universe@390 | 664 | <h2 class="memtitle"><span class="permalink"><a href="#ac560f8517d2172794c9d2691735ec48c">◆ </a></span>ucx_logger_new()</h2> |
universe@390 | 665 | |
universe@390 | 666 | <div class="memitem"> |
universe@390 | 667 | <div class="memproto"> |
universe@390 | 668 | <table class="memname"> |
universe@390 | 669 | <tr> |
universe@390 | 670 | <td class="memname"><a class="el" href="structUcxLogger.html">UcxLogger</a>* ucx_logger_new </td> |
universe@390 | 671 | <td>(</td> |
universe@390 | 672 | <td class="paramtype">void * </td> |
universe@390 | 673 | <td class="paramname"><em>stream</em>, </td> |
universe@390 | 674 | </tr> |
universe@390 | 675 | <tr> |
universe@390 | 676 | <td class="paramkey"></td> |
universe@390 | 677 | <td></td> |
universe@390 | 678 | <td class="paramtype">unsigned int </td> |
universe@390 | 679 | <td class="paramname"><em>level</em>, </td> |
universe@390 | 680 | </tr> |
universe@390 | 681 | <tr> |
universe@390 | 682 | <td class="paramkey"></td> |
universe@390 | 683 | <td></td> |
universe@390 | 684 | <td class="paramtype">unsigned int </td> |
universe@390 | 685 | <td class="paramname"><em>mask</em> </td> |
universe@390 | 686 | </tr> |
universe@390 | 687 | <tr> |
universe@390 | 688 | <td></td> |
universe@390 | 689 | <td>)</td> |
universe@390 | 690 | <td></td><td></td> |
universe@390 | 691 | </tr> |
universe@390 | 692 | </table> |
universe@390 | 693 | </div><div class="memdoc"> |
universe@390 | 694 | |
universe@390 | 695 | <p>Creates a new logger. </p> |
universe@390 | 696 | <dl class="params"><dt>Parameters</dt><dd> |
universe@390 | 697 | <table class="params"> |
universe@390 | 698 | <tr><td class="paramname">stream</td><td>the stream, which the logger shall write to </td></tr> |
universe@390 | 699 | <tr><td class="paramname">level</td><td>the level on which the logger shall operate </td></tr> |
universe@390 | 700 | <tr><td class="paramname">mask</td><td>configuration mask (cf. <a class="el" href="structUcxLogger.html#a1de0db2e02dcf03366268f6943f8b97c" title="A configuration mask for automatic output. ">UcxLogger.mask</a>) </td></tr> |
universe@390 | 701 | </table> |
universe@390 | 702 | </dd> |
universe@390 | 703 | </dl> |
universe@390 | 704 | <dl class="section return"><dt>Returns</dt><dd>a new logger object </dd></dl> |
universe@390 | 705 | |
universe@390 | 706 | </div> |
universe@390 | 707 | </div> |
universe@390 | 708 | </div><!-- contents --> |
universe@390 | 709 | <!-- start footer part --> |
universe@390 | 710 | <hr class="footer"/><address class="footer"><small> |
universe@390 | 711 | Generated on Thu Dec 19 2019 19:58:24 for ucx by  <a href="http://www.doxygen.org/index.html"> |
universe@390 | 712 | <img class="footer" src="doxygen.png" alt="doxygen"/> |
universe@390 | 713 | </a> 1.8.13 |
universe@390 | 714 | </small></address> |
universe@390 | 715 | </body> |
universe@390 | 716 | </html> |