structUcxLogger.html - UNIXwork Code

1 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> 2 <html xmlns="http://www.w3.org/1999/xhtml"> 3 <head> 4 <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/> 5 <meta http-equiv="X-UA-Compatible" content="IE=9"/> 6 <meta name="generator" content="Doxygen 1.8.13"/> 7 <meta name="viewport" content="width=device-width, initial-scale=1"/> 8 <title>ucx: UcxLogger Struct Reference</title> 9 <link href="tabs.css" rel="stylesheet" type="text/css"/> 10 <script type="text/javascript" src="jquery.js"></script> 11 <script type="text/javascript" src="dynsections.js"></script> 12 <link href="search/search.css" rel="stylesheet" type="text/css"/> 13 <script type="text/javascript" src="search/searchdata.js"></script> 14 <script type="text/javascript" src="search/search.js"></script> 15 <link href="doxygen.css" rel="stylesheet" type="text/css" /> 16 </head> 17 <body> 18 <div id="top"> 19 <div id="titlearea"> 20 <table cellspacing="0" cellpadding="0"> 21 <tbody> 22 <tr style="height: 56px;"> 23 <td id="projectlogo"><img alt="Logo" src="uaplogo.png"/></td> 24 <td id="projectalign" style="padding-left: 0.5em;"> 25 <div id="projectname">ucx 26 </div> 27 <div id="projectbrief">UAP Common Extensions</div> 28 </td> 29 </tr> 30 </tbody> 31 </table> 32 </div> 33  34  35 <script type="text/javascript"> 36 var searchBox = new SearchBox("searchBox", "search",false,'Search'); 37 </script> 38 <script type="text/javascript" src="menudata.js"></script> 39 <script type="text/javascript" src="menu.js"></script> 40 <script type="text/javascript"> 41 $(function() { 42 initMenu('',true,false,'search.php','Search'); 43 $(document).ready(function() { init_search(); }); 44 }); 45 </script> 46 <div id="main-nav"></div> 47  48 <div id="MSearchSelectWindow" 49 onmouseover="return searchBox.OnSearchSelectShow()" 50 onmouseout="return searchBox.OnSearchSelectHide()" 51 onkeydown="return searchBox.OnSearchSelectKey(event)"> 52 </div> 53 54  55 <div id="MSearchResultsWindow"> 56 <iframe src="javascript:void(0)" frameborder="0" 57 name="MSearchResults" id="MSearchResults"> 58 </iframe> 59 </div> 60 61 </div> 62 <div class="header"> 63 <div class="summary"> 64 <a href="#pub-attribs">Data Fields</a> </div> 65 <div class="headertitle"> 66 <div class="title">UcxLogger Struct Reference</div> </div> 67 </div> 68 <div class="contents"> 69 70 <p>The UCX Logger object. 71 <a href="structUcxLogger.html#details">More...</a></p> 72 73 <p><code>#include <<a class="el" href="logging_8h_source.html">logging.h</a>></code></p> 74 <table class="memberdecls"> 75 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-attribs"></a> 76 Data Fields</h2></td></tr> 77 <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> 78 <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> 79 <tr class="separator:a33fddf4791e8d49e479ecc78bf5d1b9e"><td class="memSeparator" colspan="2"> </td></tr> 80 <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> 81 <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> 82 <tr class="separator:ada13bba090a9dc4f8d6cd9be73c60930"><td class="memSeparator" colspan="2"> </td></tr> 83 <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> 84 <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> 85 <tr class="separator:a086f75df0f6c81ec491f25c0a4d9262b"><td class="memSeparator" colspan="2"> </td></tr> 86 <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> 87 <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> 88 <tr class="separator:a2e0ee94c25b2307096c7970280d189cd"><td class="memSeparator" colspan="2"> </td></tr> 89 <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> 90 <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> 91 <tr class="separator:a1de0db2e02dcf03366268f6943f8b97c"><td class="memSeparator" colspan="2"> </td></tr> 92 <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> 93 <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> 94 <tr class="separator:a187129f7bc6e5064b3d92a5f1217f396"><td class="memSeparator" colspan="2"> </td></tr> 95 </table> 96 <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2> 97 <div class="textblock"><p>The UCX Logger object. </p> 98 </div><h2 class="groupheader">Field Documentation</h2> 99 <a id="a086f75df0f6c81ec491f25c0a4d9262b"></a> 100 <h2 class="memtitle"><span class="permalink"><a href="#a086f75df0f6c81ec491f25c0a4d9262b">◆ </a></span>dateformat</h2> 101 102 <div class="memitem"> 103 <div class="memproto"> 104 <table class="memname"> 105 <tr> 106 <td class="memname">char* UcxLogger::dateformat</td> 107 </tr> 108 </table> 109 </div><div class="memdoc"> 110 111 <p>The date format for timestamp outputs including the delimiter (default: <code>"%F %T %z "</code>). </p> 112 <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> 113 114 </div> 115 </div> 116 <a id="a2e0ee94c25b2307096c7970280d189cd"></a> 117 <h2 class="memtitle"><span class="permalink"><a href="#a2e0ee94c25b2307096c7970280d189cd">◆ </a></span>level</h2> 118 119 <div class="memitem"> 120 <div class="memproto"> 121 <table class="memname"> 122 <tr> 123 <td class="memname">unsigned int UcxLogger::level</td> 124 </tr> 125 </table> 126 </div><div class="memdoc"> 127 128 <p>The level, this logger operates on. </p> 129 <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> 130 131 </div> 132 </div> 133 <a id="a187129f7bc6e5064b3d92a5f1217f396"></a> 134 <h2 class="memtitle"><span class="permalink"><a href="#a187129f7bc6e5064b3d92a5f1217f396">◆ </a></span>levels</h2> 135 136 <div class="memitem"> 137 <div class="memproto"> 138 <table class="memname"> 139 <tr> 140 <td class="memname"><a class="el" href="structUcxMap.html">UcxMap</a>* UcxLogger::levels</td> 141 </tr> 142 </table> 143 </div><div class="memdoc"> 144 145 <p>A map of valid log levels for this logger. </p> 146 <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> 147 <p>The exact data types are <code>unsigned int</code> for the key and <code>const char*</code> for the value.</p> 148 <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> 149 150 </div> 151 </div> 152 <a id="a1de0db2e02dcf03366268f6943f8b97c"></a> 153 <h2 class="memtitle"><span class="permalink"><a href="#a1de0db2e02dcf03366268f6943f8b97c">◆ </a></span>mask</h2> 154 155 <div class="memitem"> 156 <div class="memproto"> 157 <table class="memname"> 158 <tr> 159 <td class="memname">unsigned int UcxLogger::mask</td> 160 </tr> 161 </table> 162 </div><div class="memdoc"> 163 164 <p>A configuration mask for automatic output. </p> 165 <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> 166 167 </div> 168 </div> 169 <a id="a33fddf4791e8d49e479ecc78bf5d1b9e"></a> 170 <h2 class="memtitle"><span class="permalink"><a href="#a33fddf4791e8d49e479ecc78bf5d1b9e">◆ </a></span>stream</h2> 171 172 <div class="memitem"> 173 <div class="memproto"> 174 <table class="memname"> 175 <tr> 176 <td class="memname">void* UcxLogger::stream</td> 177 </tr> 178 </table> 179 </div><div class="memdoc"> 180 181 <p>The stream this logger writes its messages to. </p> 182 183 </div> 184 </div> 185 <a id="ada13bba090a9dc4f8d6cd9be73c60930"></a> 186 <h2 class="memtitle"><span class="permalink"><a href="#ada13bba090a9dc4f8d6cd9be73c60930">◆ </a></span>writer</h2> 187 188 <div class="memitem"> 189 <div class="memproto"> 190 <table class="memname"> 191 <tr> 192 <td class="memname"><a class="el" href="ucx_8h.html#a989b3f0fa4d307d278378fde435641ed">write_func</a> UcxLogger::writer</td> 193 </tr> 194 </table> 195 </div><div class="memdoc"> 196 197 <p>The write function that shall be used. </p> 198 <p>For standard file or stdout loggers this might be standard fwrite (default). </p> 199 200 </div> 201 </div> 202 <hr/>The documentation for this struct was generated from the following file:<ul> 203 <li>/home/mike/workspace/c/ucx/src/ucx/<a class="el" href="logging_8h_source.html">logging.h</a></li> 204 </ul> 205 </div> 206  207 <hr class="footer"/><address class="footer"><small> 208 Generated on Thu Dec 19 2019 19:58:24 for ucx by  <a href="http://www.doxygen.org/index.html"> 209 <img class="footer" src="doxygen.png" alt="doxygen"/> 210 </a> 1.8.13 211 </small></address> 212 </body> 213 </html> 214

UNIXworkcode

UNIXwork`code`