1.1 --- /dev/null Thu Jan 01 00:00:00 1970 +0000
1.2 +++ b/docs/api-2.1/logging_8h.html Sat Feb 06 19:11:44 2021 +0100
1.3 @@ -0,0 +1,716 @@
1.4 +<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
1.5 +<html xmlns="http://www.w3.org/1999/xhtml">
1.6 +<head>
1.7 +<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
1.8 +<meta http-equiv="X-UA-Compatible" content="IE=9"/>
1.9 +<meta name="generator" content="Doxygen 1.8.13"/>
1.10 +<meta name="viewport" content="width=device-width, initial-scale=1"/>
1.11 +<title>ucx: /home/mike/workspace/c/ucx/src/ucx/logging.h File Reference</title>
1.12 +<link href="tabs.css" rel="stylesheet" type="text/css"/>
1.13 +<script type="text/javascript" src="jquery.js"></script>
1.14 +<script type="text/javascript" src="dynsections.js"></script>
1.15 +<link href="search/search.css" rel="stylesheet" type="text/css"/>
1.16 +<script type="text/javascript" src="search/searchdata.js"></script>
1.17 +<script type="text/javascript" src="search/search.js"></script>
1.18 +<link href="doxygen.css" rel="stylesheet" type="text/css" />
1.19 +</head>
1.20 +<body>
1.21 +<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
1.22 +<div id="titlearea">
1.23 +<table cellspacing="0" cellpadding="0">
1.24 + <tbody>
1.25 + <tr style="height: 56px;">
1.26 + <td id="projectlogo"><img alt="Logo" src="uaplogo.png"/></td>
1.27 + <td id="projectalign" style="padding-left: 0.5em;">
1.28 + <div id="projectname">ucx
1.29 + </div>
1.30 + <div id="projectbrief">UAP Common Extensions</div>
1.31 + </td>
1.32 + </tr>
1.33 + </tbody>
1.34 +</table>
1.35 +</div>
1.36 +<!-- end header part -->
1.37 +<!-- Generated by Doxygen 1.8.13 -->
1.38 +<script type="text/javascript">
1.39 +var searchBox = new SearchBox("searchBox", "search",false,'Search');
1.40 +</script>
1.41 +<script type="text/javascript" src="menudata.js"></script>
1.42 +<script type="text/javascript" src="menu.js"></script>
1.43 +<script type="text/javascript">
1.44 +$(function() {
1.45 + initMenu('',true,false,'search.php','Search');
1.46 + $(document).ready(function() { init_search(); });
1.47 +});
1.48 +</script>
1.49 +<div id="main-nav"></div>
1.50 +<!-- window showing the filter options -->
1.51 +<div id="MSearchSelectWindow"
1.52 + onmouseover="return searchBox.OnSearchSelectShow()"
1.53 + onmouseout="return searchBox.OnSearchSelectHide()"
1.54 + onkeydown="return searchBox.OnSearchSelectKey(event)">
1.55 +</div>
1.56 +
1.57 +<!-- iframe showing the search results (closed by default) -->
1.58 +<div id="MSearchResultsWindow">
1.59 +<iframe src="javascript:void(0)" frameborder="0"
1.60 + name="MSearchResults" id="MSearchResults">
1.61 +</iframe>
1.62 +</div>
1.63 +
1.64 +<div id="nav-path" class="navpath">
1.65 + <ul>
1.66 +<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>
1.67 +</div>
1.68 +</div><!-- top -->
1.69 +<div class="header">
1.70 + <div class="summary">
1.71 +<a href="#nested-classes">Data Structures</a> |
1.72 +<a href="#define-members">Macros</a> |
1.73 +<a href="#func-members">Functions</a> </div>
1.74 + <div class="headertitle">
1.75 +<div class="title">logging.h File Reference</div> </div>
1.76 +</div><!--header-->
1.77 +<div class="contents">
1.78 +
1.79 +<p>Logging API.
1.80 +<a href="#details">More...</a></p>
1.81 +<div class="textblock"><code>#include "<a class="el" href="ucx_8h_source.html">ucx.h</a>"</code><br />
1.82 +<code>#include "<a class="el" href="map_8h_source.html">map.h</a>"</code><br />
1.83 +<code>#include "<a class="el" href="string_8h_source.html">string.h</a>"</code><br />
1.84 +<code>#include <stdio.h></code><br />
1.85 +</div>
1.86 +<p><a href="logging_8h_source.html">Go to the source code of this file.</a></p>
1.87 +<table class="memberdecls">
1.88 +<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="nested-classes"></a>
1.89 +Data Structures</h2></td></tr>
1.90 +<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>
1.91 +<tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">The UCX Logger object. <a href="structUcxLogger.html#details">More...</a><br /></td></tr>
1.92 +<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
1.93 +</table><table class="memberdecls">
1.94 +<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="define-members"></a>
1.95 +Macros</h2></td></tr>
1.96 +<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>
1.97 +<tr class="memdesc:aa254c07fe3a907613e2256a318d5c9a8"><td class="mdescLeft"> </td><td class="mdescRight">Log level for error messages. <a href="#aa254c07fe3a907613e2256a318d5c9a8">More...</a><br /></td></tr>
1.98 +<tr class="separator:aa254c07fe3a907613e2256a318d5c9a8"><td class="memSeparator" colspan="2"> </td></tr>
1.99 +<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>
1.100 +<tr class="memdesc:abd01ca11486226ba34e8f7028d9fffba"><td class="mdescLeft"> </td><td class="mdescRight">Log level for warning messages. <a href="#abd01ca11486226ba34e8f7028d9fffba">More...</a><br /></td></tr>
1.101 +<tr class="separator:abd01ca11486226ba34e8f7028d9fffba"><td class="memSeparator" colspan="2"> </td></tr>
1.102 +<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>
1.103 +<tr class="memdesc:a4b0178bf60a6129373ffc59114ca4c9b"><td class="mdescLeft"> </td><td class="mdescRight">Log level for information messages. <a href="#a4b0178bf60a6129373ffc59114ca4c9b">More...</a><br /></td></tr>
1.104 +<tr class="separator:a4b0178bf60a6129373ffc59114ca4c9b"><td class="memSeparator" colspan="2"> </td></tr>
1.105 +<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>
1.106 +<tr class="memdesc:acff01d1ef919ea997cfce755fc1b83d8"><td class="mdescLeft"> </td><td class="mdescRight">Log level for debug messages. <a href="#acff01d1ef919ea997cfce755fc1b83d8">More...</a><br /></td></tr>
1.107 +<tr class="separator:acff01d1ef919ea997cfce755fc1b83d8"><td class="memSeparator" colspan="2"> </td></tr>
1.108 +<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>
1.109 +<tr class="memdesc:a55b88d1fec7036d841b3ddd6195c5586"><td class="mdescLeft"> </td><td class="mdescRight">Log level for trace messages. <a href="#a55b88d1fec7036d841b3ddd6195c5586">More...</a><br /></td></tr>
1.110 +<tr class="separator:a55b88d1fec7036d841b3ddd6195c5586"><td class="memSeparator" colspan="2"> </td></tr>
1.111 +<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>
1.112 +<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>
1.113 +<tr class="separator:aee18bc20e58ffb69910121512c350839"><td class="memSeparator" colspan="2"> </td></tr>
1.114 +<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>
1.115 +<tr class="memdesc:a38607008268b4f776ee500fb95d2e823"><td class="mdescLeft"> </td><td class="mdescRight">Output flag for the timestmap. <a href="#a38607008268b4f776ee500fb95d2e823">More...</a><br /></td></tr>
1.116 +<tr class="separator:a38607008268b4f776ee500fb95d2e823"><td class="memSeparator" colspan="2"> </td></tr>
1.117 +<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>
1.118 +<tr class="memdesc:a0e0d72b12616c1e49ff8834eaf4cb8a2"><td class="mdescLeft"> </td><td class="mdescRight">Output flag for the source. <a href="#a0e0d72b12616c1e49ff8834eaf4cb8a2">More...</a><br /></td></tr>
1.119 +<tr class="separator:a0e0d72b12616c1e49ff8834eaf4cb8a2"><td class="memSeparator" colspan="2"> </td></tr>
1.120 +<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>
1.121 +<tr class="memdesc:a5cffc19502c4c90bfb3bd3bbcd18170a"><td class="mdescLeft"> </td><td class="mdescRight">Registers a custom log level. <a href="#a5cffc19502c4c90bfb3bd3bbcd18170a">More...</a><br /></td></tr>
1.122 +<tr class="separator:a5cffc19502c4c90bfb3bd3bbcd18170a"><td class="memSeparator" colspan="2"> </td></tr>
1.123 +<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>
1.124 +<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>
1.125 +<tr class="separator:aa0245325031d95799b28def177fd14ec"><td class="memSeparator" colspan="2"> </td></tr>
1.126 +<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>
1.127 +<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>
1.128 +<tr class="separator:a6a9e472e14d6768e59d96d245e065397"><td class="memSeparator" colspan="2"> </td></tr>
1.129 +<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>
1.130 +<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>
1.131 +<tr class="separator:a98464d8d51376ce2716dcc4eca00d5da"><td class="memSeparator" colspan="2"> </td></tr>
1.132 +<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>
1.133 +<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>
1.134 +<tr class="separator:aca7bd861b646892813fd7310c0aa69af"><td class="memSeparator" colspan="2"> </td></tr>
1.135 +<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>
1.136 +<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>
1.137 +<tr class="separator:a2936402799892db5138e5f1f8c25db0c"><td class="memSeparator" colspan="2"> </td></tr>
1.138 +<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>
1.139 +<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>
1.140 +<tr class="separator:a3031b7ff13f4cfae9c2916543be2877c"><td class="memSeparator" colspan="2"> </td></tr>
1.141 +</table><table class="memberdecls">
1.142 +<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
1.143 +Functions</h2></td></tr>
1.144 +<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>
1.145 +<tr class="memdesc:ac560f8517d2172794c9d2691735ec48c"><td class="mdescLeft"> </td><td class="mdescRight">Creates a new logger. <a href="#ac560f8517d2172794c9d2691735ec48c">More...</a><br /></td></tr>
1.146 +<tr class="separator:ac560f8517d2172794c9d2691735ec48c"><td class="memSeparator" colspan="2"> </td></tr>
1.147 +<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>
1.148 +<tr class="memdesc:ac4697b784e01ec990d2acea192e21658"><td class="mdescLeft"> </td><td class="mdescRight">Destroys the logger. <a href="#ac4697b784e01ec990d2acea192e21658">More...</a><br /></td></tr>
1.149 +<tr class="separator:ac4697b784e01ec990d2acea192e21658"><td class="memSeparator" colspan="2"> </td></tr>
1.150 +<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>
1.151 +<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>
1.152 +<tr class="separator:ac337e5d02ebea565012d4c11bd643801"><td class="memSeparator" colspan="2"> </td></tr>
1.153 +</table>
1.154 +<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
1.155 +<div class="textblock"><p>Logging API. </p>
1.156 +<dl class="section author"><dt>Author</dt><dd>Mike Becker, Olaf Wintermann </dd></dl>
1.157 +</div><h2 class="groupheader">Macro Definition Documentation</h2>
1.158 +<a id="acff01d1ef919ea997cfce755fc1b83d8"></a>
1.159 +<h2 class="memtitle"><span class="permalink"><a href="#acff01d1ef919ea997cfce755fc1b83d8">◆ </a></span>UCX_LOGGER_DEBUG</h2>
1.160 +
1.161 +<div class="memitem">
1.162 +<div class="memproto">
1.163 + <table class="memname">
1.164 + <tr>
1.165 + <td class="memname">#define UCX_LOGGER_DEBUG   0x30</td>
1.166 + </tr>
1.167 + </table>
1.168 +</div><div class="memdoc">
1.169 +
1.170 +<p>Log level for debug messages. </p>
1.171 +
1.172 +</div>
1.173 +</div>
1.174 +<a id="a2936402799892db5138e5f1f8c25db0c"></a>
1.175 +<h2 class="memtitle"><span class="permalink"><a href="#a2936402799892db5138e5f1f8c25db0c">◆ </a></span>ucx_logger_debug</h2>
1.176 +
1.177 +<div class="memitem">
1.178 +<div class="memproto">
1.179 + <table class="memname">
1.180 + <tr>
1.181 + <td class="memname">#define ucx_logger_debug</td>
1.182 + <td>(</td>
1.183 + <td class="paramtype"> </td>
1.184 + <td class="paramname">logger, </td>
1.185 + </tr>
1.186 + <tr>
1.187 + <td class="paramkey"></td>
1.188 + <td></td>
1.189 + <td class="paramtype"> </td>
1.190 + <td class="paramname"><em>...</em> </td>
1.191 + </tr>
1.192 + <tr>
1.193 + <td></td>
1.194 + <td>)</td>
1.195 + <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>
1.196 + </tr>
1.197 + </table>
1.198 +</div><div class="memdoc">
1.199 +
1.200 +<p>Shortcut for logging a debug message. </p>
1.201 +<dl class="params"><dt>Parameters</dt><dd>
1.202 + <table class="params">
1.203 + <tr><td class="paramname">logger</td><td>the logger to use </td></tr>
1.204 + <tr><td class="paramname">...</td><td>format string and arguments </td></tr>
1.205 + </table>
1.206 + </dd>
1.207 +</dl>
1.208 +<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>
1.209 +
1.210 +</div>
1.211 +</div>
1.212 +<a id="aa254c07fe3a907613e2256a318d5c9a8"></a>
1.213 +<h2 class="memtitle"><span class="permalink"><a href="#aa254c07fe3a907613e2256a318d5c9a8">◆ </a></span>UCX_LOGGER_ERROR</h2>
1.214 +
1.215 +<div class="memitem">
1.216 +<div class="memproto">
1.217 + <table class="memname">
1.218 + <tr>
1.219 + <td class="memname">#define UCX_LOGGER_ERROR   0x00</td>
1.220 + </tr>
1.221 + </table>
1.222 +</div><div class="memdoc">
1.223 +
1.224 +<p>Log level for error messages. </p>
1.225 +
1.226 +</div>
1.227 +</div>
1.228 +<a id="a6a9e472e14d6768e59d96d245e065397"></a>
1.229 +<h2 class="memtitle"><span class="permalink"><a href="#a6a9e472e14d6768e59d96d245e065397">◆ </a></span>ucx_logger_error</h2>
1.230 +
1.231 +<div class="memitem">
1.232 +<div class="memproto">
1.233 + <table class="memname">
1.234 + <tr>
1.235 + <td class="memname">#define ucx_logger_error</td>
1.236 + <td>(</td>
1.237 + <td class="paramtype"> </td>
1.238 + <td class="paramname">logger, </td>
1.239 + </tr>
1.240 + <tr>
1.241 + <td class="paramkey"></td>
1.242 + <td></td>
1.243 + <td class="paramtype"> </td>
1.244 + <td class="paramname"><em>...</em> </td>
1.245 + </tr>
1.246 + <tr>
1.247 + <td></td>
1.248 + <td>)</td>
1.249 + <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>
1.250 + </tr>
1.251 + </table>
1.252 +</div><div class="memdoc">
1.253 +
1.254 +<p>Shortcut for logging an error message. </p>
1.255 +<dl class="params"><dt>Parameters</dt><dd>
1.256 + <table class="params">
1.257 + <tr><td class="paramname">logger</td><td>the logger to use </td></tr>
1.258 + <tr><td class="paramname">...</td><td>format string and arguments </td></tr>
1.259 + </table>
1.260 + </dd>
1.261 +</dl>
1.262 +<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>
1.263 +
1.264 +</div>
1.265 +</div>
1.266 +<a id="a4b0178bf60a6129373ffc59114ca4c9b"></a>
1.267 +<h2 class="memtitle"><span class="permalink"><a href="#a4b0178bf60a6129373ffc59114ca4c9b">◆ </a></span>UCX_LOGGER_INFO</h2>
1.268 +
1.269 +<div class="memitem">
1.270 +<div class="memproto">
1.271 + <table class="memname">
1.272 + <tr>
1.273 + <td class="memname">#define UCX_LOGGER_INFO   0x20</td>
1.274 + </tr>
1.275 + </table>
1.276 +</div><div class="memdoc">
1.277 +
1.278 +<p>Log level for information messages. </p>
1.279 +
1.280 +</div>
1.281 +</div>
1.282 +<a id="a98464d8d51376ce2716dcc4eca00d5da"></a>
1.283 +<h2 class="memtitle"><span class="permalink"><a href="#a98464d8d51376ce2716dcc4eca00d5da">◆ </a></span>ucx_logger_info</h2>
1.284 +
1.285 +<div class="memitem">
1.286 +<div class="memproto">
1.287 + <table class="memname">
1.288 + <tr>
1.289 + <td class="memname">#define ucx_logger_info</td>
1.290 + <td>(</td>
1.291 + <td class="paramtype"> </td>
1.292 + <td class="paramname">logger, </td>
1.293 + </tr>
1.294 + <tr>
1.295 + <td class="paramkey"></td>
1.296 + <td></td>
1.297 + <td class="paramtype"> </td>
1.298 + <td class="paramname"><em>...</em> </td>
1.299 + </tr>
1.300 + <tr>
1.301 + <td></td>
1.302 + <td>)</td>
1.303 + <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>
1.304 + </tr>
1.305 + </table>
1.306 +</div><div class="memdoc">
1.307 +
1.308 +<p>Shortcut for logging an information message. </p>
1.309 +<dl class="params"><dt>Parameters</dt><dd>
1.310 + <table class="params">
1.311 + <tr><td class="paramname">logger</td><td>the logger to use </td></tr>
1.312 + <tr><td class="paramname">...</td><td>format string and arguments </td></tr>
1.313 + </table>
1.314 + </dd>
1.315 +</dl>
1.316 +<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>
1.317 +
1.318 +</div>
1.319 +</div>
1.320 +<a id="aee18bc20e58ffb69910121512c350839"></a>
1.321 +<h2 class="memtitle"><span class="permalink"><a href="#aee18bc20e58ffb69910121512c350839">◆ </a></span>UCX_LOGGER_LEVEL</h2>
1.322 +
1.323 +<div class="memitem">
1.324 +<div class="memproto">
1.325 + <table class="memname">
1.326 + <tr>
1.327 + <td class="memname">#define UCX_LOGGER_LEVEL   0x01</td>
1.328 + </tr>
1.329 + </table>
1.330 +</div><div class="memdoc">
1.331 +
1.332 +<p>Output flag for the log level. </p>
1.333 +<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>
1.334 +
1.335 +</div>
1.336 +</div>
1.337 +<a id="aa0245325031d95799b28def177fd14ec"></a>
1.338 +<h2 class="memtitle"><span class="permalink"><a href="#aa0245325031d95799b28def177fd14ec">◆ </a></span>ucx_logger_log</h2>
1.339 +
1.340 +<div class="memitem">
1.341 +<div class="memproto">
1.342 + <table class="memname">
1.343 + <tr>
1.344 + <td class="memname">#define ucx_logger_log</td>
1.345 + <td>(</td>
1.346 + <td class="paramtype"> </td>
1.347 + <td class="paramname">logger, </td>
1.348 + </tr>
1.349 + <tr>
1.350 + <td class="paramkey"></td>
1.351 + <td></td>
1.352 + <td class="paramtype"> </td>
1.353 + <td class="paramname">level, </td>
1.354 + </tr>
1.355 + <tr>
1.356 + <td class="paramkey"></td>
1.357 + <td></td>
1.358 + <td class="paramtype"> </td>
1.359 + <td class="paramname"><em>...</em> </td>
1.360 + </tr>
1.361 + <tr>
1.362 + <td></td>
1.363 + <td>)</td>
1.364 + <td></td><td>   <a class="el" href="logging_8h.html#ac337e5d02ebea565012d4c11bd643801">ucx_logger_logf</a>(logger, level, __FILE__, __LINE__, __VA_ARGS__)</td>
1.365 + </tr>
1.366 + </table>
1.367 +</div><div class="memdoc">
1.368 +
1.369 +<p>Logs a message at the specified level. </p>
1.370 +<dl class="params"><dt>Parameters</dt><dd>
1.371 + <table class="params">
1.372 + <tr><td class="paramname">logger</td><td>the logger to use </td></tr>
1.373 + <tr><td class="paramname">level</td><td>the level to log the message on </td></tr>
1.374 + <tr><td class="paramname">...</td><td>format string and arguments </td></tr>
1.375 + </table>
1.376 + </dd>
1.377 +</dl>
1.378 +<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>
1.379 +
1.380 +</div>
1.381 +</div>
1.382 +<a id="a5cffc19502c4c90bfb3bd3bbcd18170a"></a>
1.383 +<h2 class="memtitle"><span class="permalink"><a href="#a5cffc19502c4c90bfb3bd3bbcd18170a">◆ </a></span>ucx_logger_register_level</h2>
1.384 +
1.385 +<div class="memitem">
1.386 +<div class="memproto">
1.387 + <table class="memname">
1.388 + <tr>
1.389 + <td class="memname">#define ucx_logger_register_level</td>
1.390 + <td>(</td>
1.391 + <td class="paramtype"> </td>
1.392 + <td class="paramname">logger, </td>
1.393 + </tr>
1.394 + <tr>
1.395 + <td class="paramkey"></td>
1.396 + <td></td>
1.397 + <td class="paramtype"> </td>
1.398 + <td class="paramname">level, </td>
1.399 + </tr>
1.400 + <tr>
1.401 + <td class="paramkey"></td>
1.402 + <td></td>
1.403 + <td class="paramtype"> </td>
1.404 + <td class="paramname">name </td>
1.405 + </tr>
1.406 + <tr>
1.407 + <td></td>
1.408 + <td>)</td>
1.409 + <td></td><td></td>
1.410 + </tr>
1.411 + </table>
1.412 +</div><div class="memdoc">
1.413 +<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 -->
1.414 +<p>Registers a custom log level. </p>
1.415 +<dl class="params"><dt>Parameters</dt><dd>
1.416 + <table class="params">
1.417 + <tr><td class="paramname">logger</td><td>the logger </td></tr>
1.418 + <tr><td class="paramname">level</td><td>the log level as unsigned integer </td></tr>
1.419 + <tr><td class="paramname">name</td><td>a string literal describing the level </td></tr>
1.420 + </table>
1.421 + </dd>
1.422 +</dl>
1.423 +
1.424 +</div>
1.425 +</div>
1.426 +<a id="a0e0d72b12616c1e49ff8834eaf4cb8a2"></a>
1.427 +<h2 class="memtitle"><span class="permalink"><a href="#a0e0d72b12616c1e49ff8834eaf4cb8a2">◆ </a></span>UCX_LOGGER_SOURCE</h2>
1.428 +
1.429 +<div class="memitem">
1.430 +<div class="memproto">
1.431 + <table class="memname">
1.432 + <tr>
1.433 + <td class="memname">#define UCX_LOGGER_SOURCE   0x04</td>
1.434 + </tr>
1.435 + </table>
1.436 +</div><div class="memdoc">
1.437 +
1.438 +<p>Output flag for the source. </p>
1.439 +<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>
1.440 +
1.441 +</div>
1.442 +</div>
1.443 +<a id="a38607008268b4f776ee500fb95d2e823"></a>
1.444 +<h2 class="memtitle"><span class="permalink"><a href="#a38607008268b4f776ee500fb95d2e823">◆ </a></span>UCX_LOGGER_TIMESTAMP</h2>
1.445 +
1.446 +<div class="memitem">
1.447 +<div class="memproto">
1.448 + <table class="memname">
1.449 + <tr>
1.450 + <td class="memname">#define UCX_LOGGER_TIMESTAMP   0x02</td>
1.451 + </tr>
1.452 + </table>
1.453 +</div><div class="memdoc">
1.454 +
1.455 +<p>Output flag for the timestmap. </p>
1.456 +<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>
1.457 +
1.458 +</div>
1.459 +</div>
1.460 +<a id="a55b88d1fec7036d841b3ddd6195c5586"></a>
1.461 +<h2 class="memtitle"><span class="permalink"><a href="#a55b88d1fec7036d841b3ddd6195c5586">◆ </a></span>UCX_LOGGER_TRACE</h2>
1.462 +
1.463 +<div class="memitem">
1.464 +<div class="memproto">
1.465 + <table class="memname">
1.466 + <tr>
1.467 + <td class="memname">#define UCX_LOGGER_TRACE   0x40</td>
1.468 + </tr>
1.469 + </table>
1.470 +</div><div class="memdoc">
1.471 +
1.472 +<p>Log level for trace messages. </p>
1.473 +
1.474 +</div>
1.475 +</div>
1.476 +<a id="a3031b7ff13f4cfae9c2916543be2877c"></a>
1.477 +<h2 class="memtitle"><span class="permalink"><a href="#a3031b7ff13f4cfae9c2916543be2877c">◆ </a></span>ucx_logger_trace</h2>
1.478 +
1.479 +<div class="memitem">
1.480 +<div class="memproto">
1.481 + <table class="memname">
1.482 + <tr>
1.483 + <td class="memname">#define ucx_logger_trace</td>
1.484 + <td>(</td>
1.485 + <td class="paramtype"> </td>
1.486 + <td class="paramname">logger, </td>
1.487 + </tr>
1.488 + <tr>
1.489 + <td class="paramkey"></td>
1.490 + <td></td>
1.491 + <td class="paramtype"> </td>
1.492 + <td class="paramname"><em>...</em> </td>
1.493 + </tr>
1.494 + <tr>
1.495 + <td></td>
1.496 + <td>)</td>
1.497 + <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>
1.498 + </tr>
1.499 + </table>
1.500 +</div><div class="memdoc">
1.501 +
1.502 +<p>Shortcut for logging a trace message. </p>
1.503 +<dl class="params"><dt>Parameters</dt><dd>
1.504 + <table class="params">
1.505 + <tr><td class="paramname">logger</td><td>the logger to use </td></tr>
1.506 + <tr><td class="paramname">...</td><td>format string and arguments </td></tr>
1.507 + </table>
1.508 + </dd>
1.509 +</dl>
1.510 +<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>
1.511 +
1.512 +</div>
1.513 +</div>
1.514 +<a id="abd01ca11486226ba34e8f7028d9fffba"></a>
1.515 +<h2 class="memtitle"><span class="permalink"><a href="#abd01ca11486226ba34e8f7028d9fffba">◆ </a></span>UCX_LOGGER_WARN</h2>
1.516 +
1.517 +<div class="memitem">
1.518 +<div class="memproto">
1.519 + <table class="memname">
1.520 + <tr>
1.521 + <td class="memname">#define UCX_LOGGER_WARN   0x10</td>
1.522 + </tr>
1.523 + </table>
1.524 +</div><div class="memdoc">
1.525 +
1.526 +<p>Log level for warning messages. </p>
1.527 +
1.528 +</div>
1.529 +</div>
1.530 +<a id="aca7bd861b646892813fd7310c0aa69af"></a>
1.531 +<h2 class="memtitle"><span class="permalink"><a href="#aca7bd861b646892813fd7310c0aa69af">◆ </a></span>ucx_logger_warn</h2>
1.532 +
1.533 +<div class="memitem">
1.534 +<div class="memproto">
1.535 + <table class="memname">
1.536 + <tr>
1.537 + <td class="memname">#define ucx_logger_warn</td>
1.538 + <td>(</td>
1.539 + <td class="paramtype"> </td>
1.540 + <td class="paramname">logger, </td>
1.541 + </tr>
1.542 + <tr>
1.543 + <td class="paramkey"></td>
1.544 + <td></td>
1.545 + <td class="paramtype"> </td>
1.546 + <td class="paramname"><em>...</em> </td>
1.547 + </tr>
1.548 + <tr>
1.549 + <td></td>
1.550 + <td>)</td>
1.551 + <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>
1.552 + </tr>
1.553 + </table>
1.554 +</div><div class="memdoc">
1.555 +
1.556 +<p>Shortcut for logging a warning message. </p>
1.557 +<dl class="params"><dt>Parameters</dt><dd>
1.558 + <table class="params">
1.559 + <tr><td class="paramname">logger</td><td>the logger to use </td></tr>
1.560 + <tr><td class="paramname">...</td><td>format string and arguments </td></tr>
1.561 + </table>
1.562 + </dd>
1.563 +</dl>
1.564 +<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>
1.565 +
1.566 +</div>
1.567 +</div>
1.568 +<h2 class="groupheader">Function Documentation</h2>
1.569 +<a id="ac4697b784e01ec990d2acea192e21658"></a>
1.570 +<h2 class="memtitle"><span class="permalink"><a href="#ac4697b784e01ec990d2acea192e21658">◆ </a></span>ucx_logger_free()</h2>
1.571 +
1.572 +<div class="memitem">
1.573 +<div class="memproto">
1.574 + <table class="memname">
1.575 + <tr>
1.576 + <td class="memname">void ucx_logger_free </td>
1.577 + <td>(</td>
1.578 + <td class="paramtype"><a class="el" href="structUcxLogger.html">UcxLogger</a> * </td>
1.579 + <td class="paramname"><em>logger</em></td><td>)</td>
1.580 + <td></td>
1.581 + </tr>
1.582 + </table>
1.583 +</div><div class="memdoc">
1.584 +
1.585 +<p>Destroys the logger. </p>
1.586 +<p>The map containing the valid log levels is also automatically destroyed.</p>
1.587 +<dl class="params"><dt>Parameters</dt><dd>
1.588 + <table class="params">
1.589 + <tr><td class="paramname">logger</td><td>the logger to destroy </td></tr>
1.590 + </table>
1.591 + </dd>
1.592 +</dl>
1.593 +
1.594 +</div>
1.595 +</div>
1.596 +<a id="ac337e5d02ebea565012d4c11bd643801"></a>
1.597 +<h2 class="memtitle"><span class="permalink"><a href="#ac337e5d02ebea565012d4c11bd643801">◆ </a></span>ucx_logger_logf()</h2>
1.598 +
1.599 +<div class="memitem">
1.600 +<div class="memproto">
1.601 + <table class="memname">
1.602 + <tr>
1.603 + <td class="memname">void ucx_logger_logf </td>
1.604 + <td>(</td>
1.605 + <td class="paramtype"><a class="el" href="structUcxLogger.html">UcxLogger</a> * </td>
1.606 + <td class="paramname"><em>logger</em>, </td>
1.607 + </tr>
1.608 + <tr>
1.609 + <td class="paramkey"></td>
1.610 + <td></td>
1.611 + <td class="paramtype">unsigned int </td>
1.612 + <td class="paramname"><em>level</em>, </td>
1.613 + </tr>
1.614 + <tr>
1.615 + <td class="paramkey"></td>
1.616 + <td></td>
1.617 + <td class="paramtype">const char * </td>
1.618 + <td class="paramname"><em>file</em>, </td>
1.619 + </tr>
1.620 + <tr>
1.621 + <td class="paramkey"></td>
1.622 + <td></td>
1.623 + <td class="paramtype">const unsigned int </td>
1.624 + <td class="paramname"><em>line</em>, </td>
1.625 + </tr>
1.626 + <tr>
1.627 + <td class="paramkey"></td>
1.628 + <td></td>
1.629 + <td class="paramtype">const char * </td>
1.630 + <td class="paramname"><em>format</em>, </td>
1.631 + </tr>
1.632 + <tr>
1.633 + <td class="paramkey"></td>
1.634 + <td></td>
1.635 + <td class="paramtype"> </td>
1.636 + <td class="paramname"><em>...</em> </td>
1.637 + </tr>
1.638 + <tr>
1.639 + <td></td>
1.640 + <td>)</td>
1.641 + <td></td><td></td>
1.642 + </tr>
1.643 + </table>
1.644 +</div><div class="memdoc">
1.645 +
1.646 +<p>Internal log function - use macros instead. </p>
1.647 +<p>This function uses the <code>format</code> and variadic arguments for a printf()-style output of the log message.</p>
1.648 +<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>
1.649 +<p><code>[LEVEL] [TIMESTAMP] [SOURCEFILE]:[LINENO] message</code></p>
1.650 +<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>
1.651 +<dl class="params"><dt>Parameters</dt><dd>
1.652 + <table class="params">
1.653 + <tr><td class="paramname">logger</td><td>the logger to use </td></tr>
1.654 + <tr><td class="paramname">level</td><td>the level to log on </td></tr>
1.655 + <tr><td class="paramname">file</td><td>information about the source file </td></tr>
1.656 + <tr><td class="paramname">line</td><td>information about the source line number </td></tr>
1.657 + <tr><td class="paramname">format</td><td>format string </td></tr>
1.658 + <tr><td class="paramname">...</td><td>arguments </td></tr>
1.659 + </table>
1.660 + </dd>
1.661 +</dl>
1.662 +<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>
1.663 +
1.664 +</div>
1.665 +</div>
1.666 +<a id="ac560f8517d2172794c9d2691735ec48c"></a>
1.667 +<h2 class="memtitle"><span class="permalink"><a href="#ac560f8517d2172794c9d2691735ec48c">◆ </a></span>ucx_logger_new()</h2>
1.668 +
1.669 +<div class="memitem">
1.670 +<div class="memproto">
1.671 + <table class="memname">
1.672 + <tr>
1.673 + <td class="memname"><a class="el" href="structUcxLogger.html">UcxLogger</a>* ucx_logger_new </td>
1.674 + <td>(</td>
1.675 + <td class="paramtype">void * </td>
1.676 + <td class="paramname"><em>stream</em>, </td>
1.677 + </tr>
1.678 + <tr>
1.679 + <td class="paramkey"></td>
1.680 + <td></td>
1.681 + <td class="paramtype">unsigned int </td>
1.682 + <td class="paramname"><em>level</em>, </td>
1.683 + </tr>
1.684 + <tr>
1.685 + <td class="paramkey"></td>
1.686 + <td></td>
1.687 + <td class="paramtype">unsigned int </td>
1.688 + <td class="paramname"><em>mask</em> </td>
1.689 + </tr>
1.690 + <tr>
1.691 + <td></td>
1.692 + <td>)</td>
1.693 + <td></td><td></td>
1.694 + </tr>
1.695 + </table>
1.696 +</div><div class="memdoc">
1.697 +
1.698 +<p>Creates a new logger. </p>
1.699 +<dl class="params"><dt>Parameters</dt><dd>
1.700 + <table class="params">
1.701 + <tr><td class="paramname">stream</td><td>the stream, which the logger shall write to </td></tr>
1.702 + <tr><td class="paramname">level</td><td>the level on which the logger shall operate </td></tr>
1.703 + <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>
1.704 + </table>
1.705 + </dd>
1.706 +</dl>
1.707 +<dl class="section return"><dt>Returns</dt><dd>a new logger object </dd></dl>
1.708 +
1.709 +</div>
1.710 +</div>
1.711 +</div><!-- contents -->
1.712 +<!-- start footer part -->
1.713 +<hr class="footer"/><address class="footer"><small>
1.714 +Generated on Thu Dec 19 2019 19:58:24 for ucx by  <a href="http://www.doxygen.org/index.html">
1.715 +<img class="footer" src="doxygen.png" alt="doxygen"/>
1.716 +</a> 1.8.13
1.717 +</small></address>
1.718 +</body>
1.719 +</html>
