1.1 --- /dev/null Thu Jan 01 00:00:00 1970 +0000
1.2 +++ b/docs/api-2.1/structUcxLogger.html Sat Feb 06 19:11:44 2021 +0100
1.3 @@ -0,0 +1,213 @@
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: UcxLogger Struct 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><!-- top -->
1.65 +<div class="header">
1.66 + <div class="summary">
1.67 +<a href="#pub-attribs">Data Fields</a> </div>
1.68 + <div class="headertitle">
1.69 +<div class="title">UcxLogger Struct Reference</div> </div>
1.70 +</div><!--header-->
1.71 +<div class="contents">
1.72 +
1.73 +<p>The UCX Logger object.
1.74 + <a href="structUcxLogger.html#details">More...</a></p>
1.75 +
1.76 +<p><code>#include <<a class="el" href="logging_8h_source.html">logging.h</a>></code></p>
1.77 +<table class="memberdecls">
1.78 +<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-attribs"></a>
1.79 +Data Fields</h2></td></tr>
1.80 +<tr class="memitem:a33fddf4791e8d49e479ecc78bf5d1b9e"><td class="memItemLeft" align="right" valign="top">void * </td><td class="memItemRight" valign="bottom"><a class="el" href="structUcxLogger.html#a33fddf4791e8d49e479ecc78bf5d1b9e">stream</a></td></tr>
1.81 +<tr class="memdesc:a33fddf4791e8d49e479ecc78bf5d1b9e"><td class="mdescLeft"> </td><td class="mdescRight">The stream this logger writes its messages to. <a href="#a33fddf4791e8d49e479ecc78bf5d1b9e">More...</a><br /></td></tr>
1.82 +<tr class="separator:a33fddf4791e8d49e479ecc78bf5d1b9e"><td class="memSeparator" colspan="2"> </td></tr>
1.83 +<tr class="memitem:ada13bba090a9dc4f8d6cd9be73c60930"><td class="memItemLeft" align="right" valign="top"><a class="el" href="ucx_8h.html#a989b3f0fa4d307d278378fde435641ed">write_func</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="structUcxLogger.html#ada13bba090a9dc4f8d6cd9be73c60930">writer</a></td></tr>
1.84 +<tr class="memdesc:ada13bba090a9dc4f8d6cd9be73c60930"><td class="mdescLeft"> </td><td class="mdescRight">The write function that shall be used. <a href="#ada13bba090a9dc4f8d6cd9be73c60930">More...</a><br /></td></tr>
1.85 +<tr class="separator:ada13bba090a9dc4f8d6cd9be73c60930"><td class="memSeparator" colspan="2"> </td></tr>
1.86 +<tr class="memitem:a086f75df0f6c81ec491f25c0a4d9262b"><td class="memItemLeft" align="right" valign="top">char * </td><td class="memItemRight" valign="bottom"><a class="el" href="structUcxLogger.html#a086f75df0f6c81ec491f25c0a4d9262b">dateformat</a></td></tr>
1.87 +<tr class="memdesc:a086f75df0f6c81ec491f25c0a4d9262b"><td class="mdescLeft"> </td><td class="mdescRight">The date format for timestamp outputs including the delimiter (default: <code>"%F %T %z "</code>). <a href="#a086f75df0f6c81ec491f25c0a4d9262b">More...</a><br /></td></tr>
1.88 +<tr class="separator:a086f75df0f6c81ec491f25c0a4d9262b"><td class="memSeparator" colspan="2"> </td></tr>
1.89 +<tr class="memitem:a2e0ee94c25b2307096c7970280d189cd"><td class="memItemLeft" align="right" valign="top">unsigned int </td><td class="memItemRight" valign="bottom"><a class="el" href="structUcxLogger.html#a2e0ee94c25b2307096c7970280d189cd">level</a></td></tr>
1.90 +<tr class="memdesc:a2e0ee94c25b2307096c7970280d189cd"><td class="mdescLeft"> </td><td class="mdescRight">The level, this logger operates on. <a href="#a2e0ee94c25b2307096c7970280d189cd">More...</a><br /></td></tr>
1.91 +<tr class="separator:a2e0ee94c25b2307096c7970280d189cd"><td class="memSeparator" colspan="2"> </td></tr>
1.92 +<tr class="memitem:a1de0db2e02dcf03366268f6943f8b97c"><td class="memItemLeft" align="right" valign="top">unsigned int </td><td class="memItemRight" valign="bottom"><a class="el" href="structUcxLogger.html#a1de0db2e02dcf03366268f6943f8b97c">mask</a></td></tr>
1.93 +<tr class="memdesc:a1de0db2e02dcf03366268f6943f8b97c"><td class="mdescLeft"> </td><td class="mdescRight">A configuration mask for automatic output. <a href="#a1de0db2e02dcf03366268f6943f8b97c">More...</a><br /></td></tr>
1.94 +<tr class="separator:a1de0db2e02dcf03366268f6943f8b97c"><td class="memSeparator" colspan="2"> </td></tr>
1.95 +<tr class="memitem:a187129f7bc6e5064b3d92a5f1217f396"><td class="memItemLeft" align="right" valign="top"><a class="el" href="structUcxMap.html">UcxMap</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="structUcxLogger.html#a187129f7bc6e5064b3d92a5f1217f396">levels</a></td></tr>
1.96 +<tr class="memdesc:a187129f7bc6e5064b3d92a5f1217f396"><td class="mdescLeft"> </td><td class="mdescRight">A map of valid log levels for this logger. <a href="#a187129f7bc6e5064b3d92a5f1217f396">More...</a><br /></td></tr>
1.97 +<tr class="separator:a187129f7bc6e5064b3d92a5f1217f396"><td class="memSeparator" colspan="2"> </td></tr>
1.98 +</table>
1.99 +<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
1.100 +<div class="textblock"><p>The UCX Logger object. </p>
1.101 +</div><h2 class="groupheader">Field Documentation</h2>
1.102 +<a id="a086f75df0f6c81ec491f25c0a4d9262b"></a>
1.103 +<h2 class="memtitle"><span class="permalink"><a href="#a086f75df0f6c81ec491f25c0a4d9262b">◆ </a></span>dateformat</h2>
1.104 +
1.105 +<div class="memitem">
1.106 +<div class="memproto">
1.107 + <table class="memname">
1.108 + <tr>
1.109 + <td class="memname">char* UcxLogger::dateformat</td>
1.110 + </tr>
1.111 + </table>
1.112 +</div><div class="memdoc">
1.113 +
1.114 +<p>The date format for timestamp outputs including the delimiter (default: <code>"%F %T %z "</code>). </p>
1.115 +<dl class="section see"><dt>See also</dt><dd><a class="el" href="logging_8h.html#a38607008268b4f776ee500fb95d2e823" title="Output flag for the timestmap. ">UCX_LOGGER_TIMESTAMP</a> </dd></dl>
1.116 +
1.117 +</div>
1.118 +</div>
1.119 +<a id="a2e0ee94c25b2307096c7970280d189cd"></a>
1.120 +<h2 class="memtitle"><span class="permalink"><a href="#a2e0ee94c25b2307096c7970280d189cd">◆ </a></span>level</h2>
1.121 +
1.122 +<div class="memitem">
1.123 +<div class="memproto">
1.124 + <table class="memname">
1.125 + <tr>
1.126 + <td class="memname">unsigned int UcxLogger::level</td>
1.127 + </tr>
1.128 + </table>
1.129 +</div><div class="memdoc">
1.130 +
1.131 +<p>The level, this logger operates on. </p>
1.132 +<p>If a log command is issued, the message will only be logged, if the log level of the message is less or equal than the log level of the logger. </p>
1.133 +
1.134 +</div>
1.135 +</div>
1.136 +<a id="a187129f7bc6e5064b3d92a5f1217f396"></a>
1.137 +<h2 class="memtitle"><span class="permalink"><a href="#a187129f7bc6e5064b3d92a5f1217f396">◆ </a></span>levels</h2>
1.138 +
1.139 +<div class="memitem">
1.140 +<div class="memproto">
1.141 + <table class="memname">
1.142 + <tr>
1.143 + <td class="memname"><a class="el" href="structUcxMap.html">UcxMap</a>* UcxLogger::levels</td>
1.144 + </tr>
1.145 + </table>
1.146 +</div><div class="memdoc">
1.147 +
1.148 +<p>A map of valid log levels for this logger. </p>
1.149 +<p>The keys represent all valid log levels and the values provide string representations, that are used, if the UCX_LOGGER_LEVEL flag is set.</p>
1.150 +<p>The exact data types are <code>unsigned int</code> for the key and <code>const char*</code> for the value.</p>
1.151 +<dl class="section see"><dt>See also</dt><dd><a class="el" href="logging_8h.html#aee18bc20e58ffb69910121512c350839" title="Output flag for the log level. ">UCX_LOGGER_LEVEL</a> </dd></dl>
1.152 +
1.153 +</div>
1.154 +</div>
1.155 +<a id="a1de0db2e02dcf03366268f6943f8b97c"></a>
1.156 +<h2 class="memtitle"><span class="permalink"><a href="#a1de0db2e02dcf03366268f6943f8b97c">◆ </a></span>mask</h2>
1.157 +
1.158 +<div class="memitem">
1.159 +<div class="memproto">
1.160 + <table class="memname">
1.161 + <tr>
1.162 + <td class="memname">unsigned int UcxLogger::mask</td>
1.163 + </tr>
1.164 + </table>
1.165 +</div><div class="memdoc">
1.166 +
1.167 +<p>A configuration mask for automatic output. </p>
1.168 +<p>For each flag that is set, the logger automatically outputs some extra information like the timestamp or the source file and line number. See the documentation for the flags for details. </p>
1.169 +
1.170 +</div>
1.171 +</div>
1.172 +<a id="a33fddf4791e8d49e479ecc78bf5d1b9e"></a>
1.173 +<h2 class="memtitle"><span class="permalink"><a href="#a33fddf4791e8d49e479ecc78bf5d1b9e">◆ </a></span>stream</h2>
1.174 +
1.175 +<div class="memitem">
1.176 +<div class="memproto">
1.177 + <table class="memname">
1.178 + <tr>
1.179 + <td class="memname">void* UcxLogger::stream</td>
1.180 + </tr>
1.181 + </table>
1.182 +</div><div class="memdoc">
1.183 +
1.184 +<p>The stream this logger writes its messages to. </p>
1.185 +
1.186 +</div>
1.187 +</div>
1.188 +<a id="ada13bba090a9dc4f8d6cd9be73c60930"></a>
1.189 +<h2 class="memtitle"><span class="permalink"><a href="#ada13bba090a9dc4f8d6cd9be73c60930">◆ </a></span>writer</h2>
1.190 +
1.191 +<div class="memitem">
1.192 +<div class="memproto">
1.193 + <table class="memname">
1.194 + <tr>
1.195 + <td class="memname"><a class="el" href="ucx_8h.html#a989b3f0fa4d307d278378fde435641ed">write_func</a> UcxLogger::writer</td>
1.196 + </tr>
1.197 + </table>
1.198 +</div><div class="memdoc">
1.199 +
1.200 +<p>The write function that shall be used. </p>
1.201 +<p>For standard file or stdout loggers this might be standard fwrite (default). </p>
1.202 +
1.203 +</div>
1.204 +</div>
1.205 +<hr/>The documentation for this struct was generated from the following file:<ul>
1.206 +<li>/home/mike/workspace/c/ucx/src/ucx/<a class="el" href="logging_8h_source.html">logging.h</a></li>
1.207 +</ul>
1.208 +</div><!-- contents -->
1.209 +<!-- start footer part -->
1.210 +<hr class="footer"/><address class="footer"><small>
1.211 +Generated on Thu Dec 19 2019 19:58:24 for ucx by  <a href="http://www.doxygen.org/index.html">
1.212 +<img class="footer" src="doxygen.png" alt="doxygen"/>
1.213 +</a> 1.8.13
1.214 +</small></address>
1.215 +</body>
1.216 +</html>
