<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> <html xmlns="http://www.w3.org/1999/xhtml"> <head> <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/> <meta http-equiv="X-UA-Compatible" content="IE=9"/> <meta name="generator" content="Doxygen 1.8.3.1"/> <title>xrootd: XrdSysLogger.hh Source File</title> <link href="tabs.css" rel="stylesheet" type="text/css"/> <script type="text/javascript" src="jquery.js"></script> <script type="text/javascript" src="dynsections.js"></script> <link href="doxygen.css" rel="stylesheet" type="text/css" /> </head> <body> <div id="top"><!-- do not remove this div, it is closed by doxygen! --> <div id="titlearea"> <table cellspacing="0" cellpadding="0"> <tbody> <tr style="height: 56px;"> <td style="padding-left: 0.5em;"> <div id="projectname">xrootd </div> </td> </tr> </tbody> </table> </div> <!-- end header part --> <!-- Generated by Doxygen 1.8.3.1 --> <div id="navrow1" class="tabs"> <ul class="tablist"> <li><a href="index.html"><span>Main Page</span></a></li> <li><a href="namespaces.html"><span>Namespaces</span></a></li> <li><a href="annotated.html"><span>Classes</span></a></li> <li class="current"><a href="files.html"><span>Files</span></a></li> </ul> </div> <div id="navrow2" class="tabs2"> <ul class="tablist"> <li><a href="files.html"><span>File List</span></a></li> <li><a href="globals.html"><span>File Members</span></a></li> </ul> </div> <div id="nav-path" class="navpath"> <ul> <li class="navelem"><a class="el" href="dir_68267d1309a1af8e8297ef4c3efbcdba.html">src</a></li><li class="navelem"><a class="el" href="dir_d751caa81ddb88473173cbaf15e76961.html">XrdSys</a></li> </ul> </div> </div><!-- top --> <div class="header"> <div class="headertitle"> <div class="title">XrdSysLogger.hh</div> </div> </div><!--header--> <div class="contents"> <a href="XrdSysLogger_8hh.html">Go to the documentation of this file.</a><div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span> <span class="preprocessor">#ifndef __SYS_LOGGER_H__</span></div> <div class="line"><a name="l00002"></a><span class="lineno"> 2</span> <span class="preprocessor"></span><span class="preprocessor">#define __SYS_LOGGER_H__</span></div> <div class="line"><a name="l00003"></a><span class="lineno"> 3</span> <span class="preprocessor"></span><span class="comment">/******************************************************************************/</span></div> <div class="line"><a name="l00004"></a><span class="lineno"> 4</span> <span class="comment">/* */</span></div> <div class="line"><a name="l00005"></a><span class="lineno"> 5</span> <span class="comment">/* X r d S y s L o g g e r . h h */</span></div> <div class="line"><a name="l00006"></a><span class="lineno"> 6</span> <span class="comment">/* */</span></div> <div class="line"><a name="l00007"></a><span class="lineno"> 7</span> <span class="comment">/*(c) 2004 by the Board of Trustees of the Leland Stanford, Jr., University */</span></div> <div class="line"><a name="l00008"></a><span class="lineno"> 8</span> <span class="comment">/*Produced by Andrew Hanushevsky for Stanford University under contract */</span></div> <div class="line"><a name="l00009"></a><span class="lineno"> 9</span> <span class="comment">/* DE-AC02-76-SFO0515 with the Deprtment of Energy */</span></div> <div class="line"><a name="l00010"></a><span class="lineno"> 10</span> <span class="comment">/* */</span></div> <div class="line"><a name="l00011"></a><span class="lineno"> 11</span> <span class="comment">/* This file is part of the XRootD software suite. */</span></div> <div class="line"><a name="l00012"></a><span class="lineno"> 12</span> <span class="comment">/* */</span></div> <div class="line"><a name="l00013"></a><span class="lineno"> 13</span> <span class="comment">/* XRootD is free software: you can redistribute it and/or modify it under */</span></div> <div class="line"><a name="l00014"></a><span class="lineno"> 14</span> <span class="comment">/* the terms of the GNU Lesser General Public License as published by the */</span></div> <div class="line"><a name="l00015"></a><span class="lineno"> 15</span> <span class="comment">/* Free Software Foundation, either version 3 of the License, or (at your */</span></div> <div class="line"><a name="l00016"></a><span class="lineno"> 16</span> <span class="comment">/* option) any later version. */</span></div> <div class="line"><a name="l00017"></a><span class="lineno"> 17</span> <span class="comment">/* */</span></div> <div class="line"><a name="l00018"></a><span class="lineno"> 18</span> <span class="comment">/* XRootD is distributed in the hope that it will be useful, but WITHOUT */</span></div> <div class="line"><a name="l00019"></a><span class="lineno"> 19</span> <span class="comment">/* ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or */</span></div> <div class="line"><a name="l00020"></a><span class="lineno"> 20</span> <span class="comment">/* FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public */</span></div> <div class="line"><a name="l00021"></a><span class="lineno"> 21</span> <span class="comment">/* License for more details. */</span></div> <div class="line"><a name="l00022"></a><span class="lineno"> 22</span> <span class="comment">/* */</span></div> <div class="line"><a name="l00023"></a><span class="lineno"> 23</span> <span class="comment">/* You should have received a copy of the GNU Lesser General Public License */</span></div> <div class="line"><a name="l00024"></a><span class="lineno"> 24</span> <span class="comment">/* along with XRootD in a file called COPYING.LESSER (LGPL license) and file */</span></div> <div class="line"><a name="l00025"></a><span class="lineno"> 25</span> <span class="comment">/* COPYING (GPL license). If not, see <http://www.gnu.org/licenses/>. */</span></div> <div class="line"><a name="l00026"></a><span class="lineno"> 26</span> <span class="comment">/* */</span></div> <div class="line"><a name="l00027"></a><span class="lineno"> 27</span> <span class="comment">/* The copyright holder's institutional names and contributor's names may not */</span></div> <div class="line"><a name="l00028"></a><span class="lineno"> 28</span> <span class="comment">/* be used to endorse or promote products derived from this software without */</span></div> <div class="line"><a name="l00029"></a><span class="lineno"> 29</span> <span class="comment">/* specific prior written permission of the institution or contributor. */</span></div> <div class="line"><a name="l00030"></a><span class="lineno"> 30</span> <span class="comment">/******************************************************************************/</span></div> <div class="line"><a name="l00031"></a><span class="lineno"> 31</span> </div> <div class="line"><a name="l00032"></a><span class="lineno"> 32</span> <span class="preprocessor">#include <stdlib.h></span></div> <div class="line"><a name="l00033"></a><span class="lineno"> 33</span> <span class="preprocessor">#ifndef WIN32</span></div> <div class="line"><a name="l00034"></a><span class="lineno"> 34</span> <span class="preprocessor"></span><span class="preprocessor">#include <unistd.h></span></div> <div class="line"><a name="l00035"></a><span class="lineno"> 35</span> <span class="preprocessor">#include <string.h></span></div> <div class="line"><a name="l00036"></a><span class="lineno"> 36</span> <span class="preprocessor">#include <strings.h></span></div> <div class="line"><a name="l00037"></a><span class="lineno"> 37</span> <span class="preprocessor">#else</span></div> <div class="line"><a name="l00038"></a><span class="lineno"> 38</span> <span class="preprocessor"></span><span class="preprocessor">#include <string.h></span></div> <div class="line"><a name="l00039"></a><span class="lineno"> 39</span> <span class="preprocessor">#include <io.h></span></div> <div class="line"><a name="l00040"></a><span class="lineno"> 40</span> <span class="preprocessor">#include "XrdSys/XrdWin32.hh"</span></div> <div class="line"><a name="l00041"></a><span class="lineno"> 41</span> <span class="preprocessor">#endif</span></div> <div class="line"><a name="l00042"></a><span class="lineno"> 42</span> <span class="preprocessor"></span></div> <div class="line"><a name="l00043"></a><span class="lineno"> 43</span> <span class="preprocessor">#include "<a class="code" href="XrdSysPthread_8hh.html">XrdSys/XrdSysPthread.hh</a>"</span></div> <div class="line"><a name="l00044"></a><span class="lineno"> 44</span> </div> <div class="line"><a name="l00045"></a><span class="lineno"><a class="code" href="classXrdSysLogger.html"> 45</a></span> <span class="keyword">class </span><a class="code" href="classXrdSysLogger.html">XrdSysLogger</a></div> <div class="line"><a name="l00046"></a><span class="lineno"> 46</span> {</div> <div class="line"><a name="l00047"></a><span class="lineno"> 47</span> <span class="keyword">public</span>:</div> <div class="line"><a name="l00048"></a><span class="lineno"> 48</span>  <a class="code" href="classXrdSysLogger.html#a791e36c8410784aeeb70024f3c91091c">XrdSysLogger</a>(<span class="keywordtype">int</span> ErrFD=STDERR_FILENO, <span class="keywordtype">int</span> xrotate=1);</div> <div class="line"><a name="l00049"></a><span class="lineno"> 49</span> </div> <div class="line"><a name="l00050"></a><span class="lineno"><a class="code" href="classXrdSysLogger.html#aebaf62d5030d0e41f4df9da2ad4392b4"> 50</a></span>  <a class="code" href="classXrdSysLogger.html#aebaf62d5030d0e41f4df9da2ad4392b4">~XrdSysLogger</a>() {<span class="keywordflow">if</span> (<a class="code" href="classXrdSysLogger.html#a35ae1c29e26ac8a181de19d973d56e73">ePath</a>) free(<a class="code" href="classXrdSysLogger.html#a35ae1c29e26ac8a181de19d973d56e73">ePath</a>);}</div> <div class="line"><a name="l00051"></a><span class="lineno"> 51</span> </div> <div class="line"><a name="l00052"></a><span class="lineno"> 52</span> <span class="comment">// Bind allows you to bind standard error to a file with an optional periodic</span></div> <div class="line"><a name="l00053"></a><span class="lineno"> 53</span> <span class="comment">// closing and opening of the file.</span></div> <div class="line"><a name="l00054"></a><span class="lineno"> 54</span> <span class="comment">//</span></div> <div class="line"><a name="l00055"></a><span class="lineno"> 55</span> <span class="keywordtype">int</span> <a class="code" href="classXrdSysLogger.html#a3ce603800e2549984c1d5e531bcca696">Bind</a>(<span class="keyword">const</span> <span class="keywordtype">char</span> *path, <span class="keywordtype">int</span> intsec=0);</div> <div class="line"><a name="l00056"></a><span class="lineno"> 56</span> </div> <div class="line"><a name="l00057"></a><span class="lineno"> 57</span> <span class="comment">// Flush any pending output</span></div> <div class="line"><a name="l00058"></a><span class="lineno"> 58</span> <span class="comment">//</span></div> <div class="line"><a name="l00059"></a><span class="lineno"><a class="code" href="classXrdSysLogger.html#a47d713d6ea88334abc656ea24c614ce2"> 59</a></span> <span class="keywordtype">void</span> <a class="code" href="classXrdSysLogger.html#a47d713d6ea88334abc656ea24c614ce2">Flush</a>() {fsync(<a class="code" href="classXrdSysLogger.html#a01ded617025d14befbc32424d66c8204">eFD</a>);}</div> <div class="line"><a name="l00060"></a><span class="lineno"> 60</span> </div> <div class="line"><a name="l00061"></a><span class="lineno"> 61</span> <span class="comment">// originalFD() returns the base FD that we started with</span></div> <div class="line"><a name="l00062"></a><span class="lineno"> 62</span> <span class="comment">//</span></div> <div class="line"><a name="l00063"></a><span class="lineno"><a class="code" href="classXrdSysLogger.html#ac8c46a505594ed65a650fb5100f66164"> 63</a></span> <span class="keywordtype">int</span> <a class="code" href="classXrdSysLogger.html#ac8c46a505594ed65a650fb5100f66164">originalFD</a>() {<span class="keywordflow">return</span> <a class="code" href="classXrdSysLogger.html#ab86929e896c09fa997d5042519cab11e">baseFD</a>;}</div> <div class="line"><a name="l00064"></a><span class="lineno"> 64</span> </div> <div class="line"><a name="l00065"></a><span class="lineno"> 65</span> <span class="comment">// Output data and optionally prefix with date/time</span></div> <div class="line"><a name="l00066"></a><span class="lineno"> 66</span> <span class="comment">//</span></div> <div class="line"><a name="l00067"></a><span class="lineno"> 67</span> <span class="keywordtype">void</span> <a class="code" href="classXrdSysLogger.html#a5bd9b8a6f370c8d926a015b6204a2a16">Put</a>(<span class="keywordtype">int</span> iovcnt, <span class="keyword">struct</span> iovec *iov);</div> <div class="line"><a name="l00068"></a><span class="lineno"> 68</span> </div> <div class="line"><a name="l00069"></a><span class="lineno"> 69</span> <span class="comment">// Set log file keep value. A negative number means keep abs() files.</span></div> <div class="line"><a name="l00070"></a><span class="lineno"> 70</span> <span class="comment">// A positive number means keep no more than n bytes.</span></div> <div class="line"><a name="l00071"></a><span class="lineno"> 71</span> <span class="comment">//</span></div> <div class="line"><a name="l00072"></a><span class="lineno"><a class="code" href="classXrdSysLogger.html#a388f69866c47664a6695e76ebd29ee33"> 72</a></span> <span class="keywordtype">void</span> <a class="code" href="classXrdSysLogger.html#a388f69866c47664a6695e76ebd29ee33">setKeep</a>(<span class="keywordtype">long</span> <span class="keywordtype">long</span> knum) {<a class="code" href="classXrdSysLogger.html#a7ba7c1ca49759a93e5028f7a989ded2d">eKeep</a> = knum;}</div> <div class="line"><a name="l00073"></a><span class="lineno"> 73</span> </div> <div class="line"><a name="l00074"></a><span class="lineno"> 74</span> <span class="comment">// Set log file rotation on/off. Used by forked processes.</span></div> <div class="line"><a name="l00075"></a><span class="lineno"> 75</span> <span class="comment">//</span></div> <div class="line"><a name="l00076"></a><span class="lineno"><a class="code" href="classXrdSysLogger.html#a9a47e6f415ff7c47a0a44b5c912e298e"> 76</a></span> <span class="keywordtype">void</span> <a class="code" href="classXrdSysLogger.html#a9a47e6f415ff7c47a0a44b5c912e298e">setRotate</a>(<span class="keywordtype">int</span> onoff) {<a class="code" href="classXrdSysLogger.html#aebd1f3c3822fb6d9c628301b8194c68d">doLFR</a> = onoff;}</div> <div class="line"><a name="l00077"></a><span class="lineno"> 77</span> </div> <div class="line"><a name="l00078"></a><span class="lineno"> 78</span> <span class="comment">// Return formated date/time (tbuff must be atleast 24 characters)</span></div> <div class="line"><a name="l00079"></a><span class="lineno"> 79</span> <span class="comment">//</span></div> <div class="line"><a name="l00080"></a><span class="lineno"> 80</span> <span class="keywordtype">int</span> <a class="code" href="classXrdSysLogger.html#aeb9416dcf05a39330c8bb1631896df1d">Time</a>(<span class="keywordtype">char</span> *tbuff);</div> <div class="line"><a name="l00081"></a><span class="lineno"> 81</span> </div> <div class="line"><a name="l00082"></a><span class="lineno"> 82</span> <span class="comment">// traceBeg() obtains the logger lock and returns a message header.</span></div> <div class="line"><a name="l00083"></a><span class="lineno"> 83</span> <span class="comment">// traceEnd() releases the logger lock and returns a newline</span></div> <div class="line"><a name="l00084"></a><span class="lineno"> 84</span> <span class="comment">//</span></div> <div class="line"><a name="l00085"></a><span class="lineno"><a class="code" href="classXrdSysLogger.html#aeea9f7c5e5eff82dfe6da2314e5bd084"> 85</a></span> <span class="keywordtype">char</span> *<a class="code" href="classXrdSysLogger.html#aeea9f7c5e5eff82dfe6da2314e5bd084">traceBeg</a>() {<a class="code" href="classXrdSysLogger.html#a716019a820d3c751026e9d63658aebda">Logger_Mutex</a>.<a class="code" href="classXrdSysMutex.html#a6dcffcf5ae5370f5aca882d38935fd69">Lock</a>(); <a class="code" href="classXrdSysLogger.html#aeb9416dcf05a39330c8bb1631896df1d">Time</a>(<a class="code" href="classXrdSysLogger.html#af63fe2a30f63b45d2ca9ed7798616fdf">TBuff</a>); <span class="keywordflow">return</span> <a class="code" href="classXrdSysLogger.html#af63fe2a30f63b45d2ca9ed7798616fdf">TBuff</a>;}</div> <div class="line"><a name="l00086"></a><span class="lineno"><a class="code" href="classXrdSysLogger.html#a07c0d1ffb26d5575a16f9f9f82e66828"> 86</a></span> <span class="keywordtype">char</span> <a class="code" href="classXrdSysLogger.html#a07c0d1ffb26d5575a16f9f9f82e66828">traceEnd</a>() {<a class="code" href="classXrdSysLogger.html#a716019a820d3c751026e9d63658aebda">Logger_Mutex</a>.<a class="code" href="classXrdSysMutex.html#ab5802ffb3112a55f06b5d0679ed6a772">UnLock</a>(); <span class="keywordflow">return</span> <span class="charliteral">'\n'</span>;}</div> <div class="line"><a name="l00087"></a><span class="lineno"> 87</span> </div> <div class="line"><a name="l00088"></a><span class="lineno"> 88</span> <span class="comment">// xlogFD() returns the FD to be used by external programs as their STDERR.</span></div> <div class="line"><a name="l00089"></a><span class="lineno"> 89</span> <span class="comment">// A negative one indicates that no special FD is assigned.</span></div> <div class="line"><a name="l00090"></a><span class="lineno"> 90</span> <span class="comment">//</span></div> <div class="line"><a name="l00091"></a><span class="lineno"> 91</span> <span class="keywordtype">int</span> <a class="code" href="classXrdSysLogger.html#a5586bef2054767e78d9daae8a125a28d">xlogFD</a>();</div> <div class="line"><a name="l00092"></a><span class="lineno"> 92</span> </div> <div class="line"><a name="l00093"></a><span class="lineno"> 93</span> <span class="keyword">private</span>:</div> <div class="line"><a name="l00094"></a><span class="lineno"> 94</span> </div> <div class="line"><a name="l00095"></a><span class="lineno"><a class="code" href="classXrdSysLogger.html#a716019a820d3c751026e9d63658aebda"> 95</a></span> <a class="code" href="classXrdSysMutex.html">XrdSysMutex</a> <a class="code" href="classXrdSysLogger.html#a716019a820d3c751026e9d63658aebda">Logger_Mutex</a>;</div> <div class="line"><a name="l00096"></a><span class="lineno"><a class="code" href="classXrdSysLogger.html#a98b3f8e88362d09fc7cf83fce4ea914a"> 96</a></span> <span class="keyword">static</span> <span class="keywordtype">int</span> <a class="code" href="classXrdSysLogger.html#a98b3f8e88362d09fc7cf83fce4ea914a">extLFD</a>[4];</div> <div class="line"><a name="l00097"></a><span class="lineno"><a class="code" href="classXrdSysLogger.html#a7ba7c1ca49759a93e5028f7a989ded2d"> 97</a></span> <span class="keywordtype">long</span> <span class="keywordtype">long</span> <a class="code" href="classXrdSysLogger.html#a7ba7c1ca49759a93e5028f7a989ded2d">eKeep</a>;</div> <div class="line"><a name="l00098"></a><span class="lineno"><a class="code" href="classXrdSysLogger.html#af63fe2a30f63b45d2ca9ed7798616fdf"> 98</a></span> <span class="keywordtype">char</span> <a class="code" href="classXrdSysLogger.html#af63fe2a30f63b45d2ca9ed7798616fdf">TBuff</a>[24]; <span class="comment">// Trace header buffer</span></div> <div class="line"><a name="l00099"></a><span class="lineno"><a class="code" href="classXrdSysLogger.html#a01ded617025d14befbc32424d66c8204"> 99</a></span> <span class="keywordtype">int</span> <a class="code" href="classXrdSysLogger.html#a01ded617025d14befbc32424d66c8204">eFD</a>;</div> <div class="line"><a name="l00100"></a><span class="lineno"><a class="code" href="classXrdSysLogger.html#ab86929e896c09fa997d5042519cab11e"> 100</a></span> <span class="keywordtype">int</span> <a class="code" href="classXrdSysLogger.html#ab86929e896c09fa997d5042519cab11e">baseFD</a>;</div> <div class="line"><a name="l00101"></a><span class="lineno"><a class="code" href="classXrdSysLogger.html#a35ae1c29e26ac8a181de19d973d56e73"> 101</a></span> <span class="keywordtype">char</span> *<a class="code" href="classXrdSysLogger.html#a35ae1c29e26ac8a181de19d973d56e73">ePath</a>;</div> <div class="line"><a name="l00102"></a><span class="lineno"><a class="code" href="classXrdSysLogger.html#abe95bccc21031cb5e1f29ee85a1216ef"> 102</a></span> <span class="keywordtype">char</span> <a class="code" href="classXrdSysLogger.html#abe95bccc21031cb5e1f29ee85a1216ef">Filesfx</a>[8];</div> <div class="line"><a name="l00103"></a><span class="lineno"><a class="code" href="classXrdSysLogger.html#ae2aece443876562f11d8af50449d7145"> 103</a></span> time_t <a class="code" href="classXrdSysLogger.html#ae2aece443876562f11d8af50449d7145">eNTC</a>;</div> <div class="line"><a name="l00104"></a><span class="lineno"><a class="code" href="classXrdSysLogger.html#a05fc3d95e9ff844078cfb64ca9c57b44"> 104</a></span> <span class="keywordtype">int</span> <a class="code" href="classXrdSysLogger.html#a05fc3d95e9ff844078cfb64ca9c57b44">eInt</a>;</div> <div class="line"><a name="l00105"></a><span class="lineno"><a class="code" href="classXrdSysLogger.html#a6b050b2dac696b133905c3fcdbd04681"> 105</a></span> time_t <a class="code" href="classXrdSysLogger.html#a6b050b2dac696b133905c3fcdbd04681">eNow</a>;</div> <div class="line"><a name="l00106"></a><span class="lineno"><a class="code" href="classXrdSysLogger.html#aebd1f3c3822fb6d9c628301b8194c68d"> 106</a></span> <span class="keywordtype">int</span> <a class="code" href="classXrdSysLogger.html#aebd1f3c3822fb6d9c628301b8194c68d">doLFR</a>;</div> <div class="line"><a name="l00107"></a><span class="lineno"> 107</span> </div> <div class="line"><a name="l00108"></a><span class="lineno"> 108</span> <span class="keywordtype">void</span> <a class="code" href="classXrdSysLogger.html#a18e455edc6533eb68ed9550790b5b675">putEmsg</a>(<span class="keywordtype">char</span> *msg, <span class="keywordtype">int</span> msz);</div> <div class="line"><a name="l00109"></a><span class="lineno"> 109</span> <span class="keywordtype">int</span> <a class="code" href="classXrdSysLogger.html#aca559aa7ac23a4ddb033a6076fc929b4">ReBind</a>(<span class="keywordtype">int</span> dorename=1);</div> <div class="line"><a name="l00110"></a><span class="lineno"> 110</span> <span class="keywordtype">void</span> <a class="code" href="classXrdSysLogger.html#a21566d6277b56e751ce5b32db87de6c2">Trim</a>();</div> <div class="line"><a name="l00111"></a><span class="lineno"> 111</span> };</div> <div class="line"><a name="l00112"></a><span class="lineno"> 112</span> <span class="preprocessor">#endif</span></div> </div><!-- fragment --></div><!-- contents --> <!-- start footer part --> <hr class="footer"/><address class="footer"><small> Generated by  <a href="http://www.doxygen.org/index.html"> <img class="footer" src="doxygen.png" alt="doxygen"/> </a> 1.8.3.1 </small></address> </body> </html>