<!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>log4c: rollingpolicy.h 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">log4c  <span id="projectnumber">1.2.4</span> </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="pages.html"><span>Related Pages</span></a></li> <li><a href="annotated.html"><span>Data Structures</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>Globals</span></a></li> </ul> </div> <div id="nav-path" class="navpath"> <ul> <li class="navelem"><a class="el" href="dir_6ba53b81c010ccbbf4e80737d395d27b.html">log4c</a></li> </ul> </div> </div><!-- top --> <div class="header"> <div class="headertitle"> <div class="title">rollingpolicy.h</div> </div> </div><!--header--> <div class="contents"> <a href="rollingpolicy_8h.html">Go to the documentation of this file.</a><div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span> </div> <div class="line"><a name="l00002"></a><span class="lineno"> 2</span> <span class="comment">/*</span></div> <div class="line"><a name="l00003"></a><span class="lineno"> 3</span> <span class="comment"> * rollingpolicy.h</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"> * See the COPYING file for the terms of usage and distribution.</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> </div> <div class="line"><a name="l00008"></a><span class="lineno"> 8</span> <span class="preprocessor">#ifndef log4c_rollingpolicy_h</span></div> <div class="line"><a name="l00009"></a><span class="lineno"> 9</span> <span class="preprocessor"></span><span class="preprocessor">#define log4c_rollingpolicy_h</span></div> <div class="line"><a name="l00010"></a><span class="lineno"> 10</span> <span class="preprocessor"></span></div> <div class="line"><a name="l00021"></a><span class="lineno"> 21</span> <span class="preprocessor">#include <stdio.h></span></div> <div class="line"><a name="l00022"></a><span class="lineno"> 22</span> <span class="preprocessor">#include <log4c/defs.h></span></div> <div class="line"><a name="l00023"></a><span class="lineno"> 23</span> <span class="preprocessor">#include <<a class="code" href="layout_8h.html" title="Interface for user specific layout format of log4c_logging_event events.">log4c/layout.h</a>></span></div> <div class="line"><a name="l00024"></a><span class="lineno"> 24</span> </div> <div class="line"><a name="l00025"></a><span class="lineno"> 25</span> __LOG4C_BEGIN_DECLS</div> <div class="line"><a name="l00026"></a><span class="lineno"> 26</span> </div> <div class="line"><a name="l00027"></a><span class="lineno"> 27</span> <span class="keyword">struct </span>__log4c_rollingpolicy;</div> <div class="line"><a name="l00028"></a><span class="lineno"> 28</span> </div> <div class="line"><a name="l00032"></a><span class="lineno"><a class="code" href="rollingpolicy_8h.html#a1c3cf54a065c84e6b4f0c85cbe3832c9"> 32</a></span> <span class="keyword">typedef</span> <span class="keyword">struct </span>__log4c_rollingpolicy <a class="code" href="rollingpolicy_8h.html#a1c3cf54a065c84e6b4f0c85cbe3832c9">log4c_rollingpolicy_t</a>;</div> <div class="line"><a name="l00033"></a><span class="lineno"> 33</span> </div> <div class="line"><a name="l00034"></a><span class="lineno"> 34</span> </div> <div class="line"><a name="l00035"></a><span class="lineno"> 35</span> <span class="preprocessor">#define ROLLINGFILE_DEFAULT_LOG_DIR "."</span></div> <div class="line"><a name="l00036"></a><span class="lineno"> 36</span> <span class="preprocessor"></span><span class="preprocessor">#define ROLLINGFILE_DEFAULT_LOG_PREFIX "log"</span></div> <div class="line"><a name="l00037"></a><span class="lineno"> 37</span> <span class="preprocessor"></span></div> <div class="line"><a name="l00038"></a><span class="lineno"> 38</span> <span class="keyword">typedef</span> <span class="keyword">struct </span>__rollingfile_udata rollingfile_udata_t; <span class="comment">/* opaque */</span></div> <div class="line"><a name="l00039"></a><span class="lineno"> 39</span> </div> <div class="line"><a name="l00040"></a><span class="lineno"> 40</span> </div> <div class="line"><a name="l00053"></a><span class="lineno"><a class="code" href="structlog4c__rollingpolicy__type.html"> 53</a></span> <span class="keyword">typedef</span> <span class="keyword">struct </span><a class="code" href="structlog4c__rollingpolicy__type.html" title="log4c rollingpolicy type. Defines the interface a specific policy must provide to the rollingfile app...">log4c_rollingpolicy_type</a> {</div> <div class="line"><a name="l00054"></a><span class="lineno"> 54</span>  <span class="keyword">const</span> <span class="keywordtype">char</span>* name;</div> <div class="line"><a name="l00055"></a><span class="lineno"> 55</span>  int (*init)(<a class="code" href="rollingpolicy_8h.html#a1c3cf54a065c84e6b4f0c85cbe3832c9">log4c_rollingpolicy_t</a> *a_this, rollingfile_udata_t* rfudatap );</div> <div class="line"><a name="l00056"></a><span class="lineno"> 56</span>  int (*is_triggering_event)( <a class="code" href="rollingpolicy_8h.html#a1c3cf54a065c84e6b4f0c85cbe3832c9">log4c_rollingpolicy_t</a>* a_policy,</div> <div class="line"><a name="l00057"></a><span class="lineno"> 57</span>  <span class="keyword">const</span> <a class="code" href="structlog4c__logging__event__t.html" title="logging event object">log4c_logging_event_t</a>*,</div> <div class="line"><a name="l00058"></a><span class="lineno"> 58</span>  <span class="keywordtype">long</span> current_file_size );</div> <div class="line"><a name="l00059"></a><span class="lineno"> 59</span>  int (*rollover)(<a class="code" href="rollingpolicy_8h.html#a1c3cf54a065c84e6b4f0c85cbe3832c9">log4c_rollingpolicy_t</a>* a_policy, FILE **); </div> <div class="line"><a name="l00060"></a><span class="lineno"> 60</span>  int (*fini)(<a class="code" href="rollingpolicy_8h.html#a1c3cf54a065c84e6b4f0c85cbe3832c9">log4c_rollingpolicy_t</a> *a_this);</div> <div class="line"><a name="l00061"></a><span class="lineno"> 61</span> } <a class="code" href="rollingpolicy_8h.html#a9bfa38cb333223f222f20db356ef887b" title="log4c rollingpolicy type. Defines the interface a specific policy must provide to the rollingfile app...">log4c_rollingpolicy_type_t</a>;</div> <div class="line"><a name="l00062"></a><span class="lineno"> 62</span> </div> <div class="line"><a name="l00068"></a><span class="lineno"> 68</span> LOG4C_API <a class="code" href="rollingpolicy_8h.html#a1c3cf54a065c84e6b4f0c85cbe3832c9">log4c_rollingpolicy_t</a>* log4c_rollingpolicy_get(</div> <div class="line"><a name="l00069"></a><span class="lineno"> 69</span>  <span class="keyword">const</span> <span class="keywordtype">char</span>* policy_name);</div> <div class="line"><a name="l00070"></a><span class="lineno"> 70</span> </div> <div class="line"><a name="l00093"></a><span class="lineno"> 93</span> LOG4C_API <span class="keyword">const</span> <a class="code" href="structlog4c__rollingpolicy__type.html" title="log4c rollingpolicy type. Defines the interface a specific policy must provide to the rollingfile app...">log4c_rollingpolicy_type_t</a>* log4c_rollingpolicy_type_set(</div> <div class="line"><a name="l00094"></a><span class="lineno"> 94</span>  <span class="keyword">const</span> <a class="code" href="structlog4c__rollingpolicy__type.html" title="log4c rollingpolicy type. Defines the interface a specific policy must provide to the rollingfile app...">log4c_rollingpolicy_type_t</a>* a_type);</div> <div class="line"><a name="l00095"></a><span class="lineno"> 95</span>  </div> <div class="line"><a name="l00102"></a><span class="lineno"> 102</span> LOG4C_API <span class="keywordtype">void</span> log4c_rollingpolicy_set_udata(<a class="code" href="rollingpolicy_8h.html#a1c3cf54a065c84e6b4f0c85cbe3832c9">log4c_rollingpolicy_t</a>* policyp,</div> <div class="line"><a name="l00103"></a><span class="lineno"> 103</span>  <span class="keywordtype">void</span> *udatap);</div> <div class="line"><a name="l00110"></a><span class="lineno"> 110</span> LOG4C_API <span class="keywordtype">int</span> log4c_rollingpolicy_init(<a class="code" href="rollingpolicy_8h.html#a1c3cf54a065c84e6b4f0c85cbe3832c9">log4c_rollingpolicy_t</a> *policyp,</div> <div class="line"><a name="l00111"></a><span class="lineno"> 111</span>  rollingfile_udata_t* rfup );</div> <div class="line"><a name="l00112"></a><span class="lineno"> 112</span> </div> <div class="line"><a name="l00122"></a><span class="lineno"> 122</span> LOG4C_API <span class="keywordtype">int</span> log4c_rollingpolicy_fini(<a class="code" href="rollingpolicy_8h.html#a1c3cf54a065c84e6b4f0c85cbe3832c9">log4c_rollingpolicy_t</a> *policyp);</div> <div class="line"><a name="l00123"></a><span class="lineno"> 123</span> </div> <div class="line"><a name="l00132"></a><span class="lineno"> 132</span> LOG4C_API <span class="keywordtype">int</span> log4c_rollingpolicy_is_triggering_event(</div> <div class="line"><a name="l00133"></a><span class="lineno"> 133</span>  <a class="code" href="rollingpolicy_8h.html#a1c3cf54a065c84e6b4f0c85cbe3832c9">log4c_rollingpolicy_t</a>* policyp,</div> <div class="line"><a name="l00134"></a><span class="lineno"> 134</span>  <span class="keyword">const</span> <a class="code" href="structlog4c__logging__event__t.html" title="logging event object">log4c_logging_event_t</a>* evtp,</div> <div class="line"><a name="l00135"></a><span class="lineno"> 135</span>  <span class="keywordtype">long</span> current_file_size );</div> <div class="line"><a name="l00147"></a><span class="lineno"><a class="code" href="rollingpolicy_8h.html#a9d60b2e1decada3c0bdaa80b4d1f7d0a"> 147</a></span> <span class="preprocessor">#define ROLLINGPOLICY_ROLLOVER_ERR_CAN_LOG 0x05</span></div> <div class="line"><a name="l00148"></a><span class="lineno"> 148</span> <span class="preprocessor"></span>LOG4C_API <span class="keywordtype">int</span> log4c_rollingpolicy_rollover(<a class="code" href="rollingpolicy_8h.html#a1c3cf54a065c84e6b4f0c85cbe3832c9">log4c_rollingpolicy_t</a>* policyp,</div> <div class="line"><a name="l00149"></a><span class="lineno"> 149</span>  FILE ** fp);</div> <div class="line"><a name="l00150"></a><span class="lineno"> 150</span> </div> <div class="line"><a name="l00158"></a><span class="lineno"> 158</span> LOG4C_API <span class="keyword">const</span> <a class="code" href="structlog4c__rollingpolicy__type.html" title="log4c rollingpolicy type. Defines the interface a specific policy must provide to the rollingfile app...">log4c_rollingpolicy_type_t</a>* log4c_rollingpolicy_set_type(</div> <div class="line"><a name="l00159"></a><span class="lineno"> 159</span>  <a class="code" href="rollingpolicy_8h.html#a1c3cf54a065c84e6b4f0c85cbe3832c9">log4c_rollingpolicy_t</a>* a_rollingpolicy,</div> <div class="line"><a name="l00160"></a><span class="lineno"> 160</span>  <span class="keyword">const</span> <a class="code" href="structlog4c__rollingpolicy__type.html" title="log4c rollingpolicy type. Defines the interface a specific policy must provide to the rollingfile app...">log4c_rollingpolicy_type_t</a>* a_type);</div> <div class="line"><a name="l00161"></a><span class="lineno"> 161</span>  </div> <div class="line"><a name="l00169"></a><span class="lineno"> 169</span> LOG4C_API <span class="keyword">const</span> <a class="code" href="structlog4c__rollingpolicy__type.html" title="log4c rollingpolicy type. Defines the interface a specific policy must provide to the rollingfile app...">log4c_rollingpolicy_type_t</a>* log4c_rollingpolicy_type_get(</div> <div class="line"><a name="l00170"></a><span class="lineno"> 170</span>  <span class="keyword">const</span> <span class="keywordtype">char</span>* a_name);</div> <div class="line"><a name="l00171"></a><span class="lineno"> 171</span>  </div> <div class="line"><a name="l00177"></a><span class="lineno"> 177</span> LOG4C_API <span class="keywordtype">void</span>* log4c_rollingpolicy_get_udata(</div> <div class="line"><a name="l00178"></a><span class="lineno"> 178</span>  <span class="keyword">const</span> <a class="code" href="rollingpolicy_8h.html#a1c3cf54a065c84e6b4f0c85cbe3832c9">log4c_rollingpolicy_t</a>* policyp);</div> <div class="line"><a name="l00179"></a><span class="lineno"> 179</span>  </div> <div class="line"><a name="l00185"></a><span class="lineno"> 185</span> LOG4C_API rollingfile_udata_t* log4c_rollingpolicy_get_rfudata(</div> <div class="line"><a name="l00186"></a><span class="lineno"> 186</span>  <span class="keyword">const</span> <a class="code" href="rollingpolicy_8h.html#a1c3cf54a065c84e6b4f0c85cbe3832c9">log4c_rollingpolicy_t</a>* policyp);</div> <div class="line"><a name="l00187"></a><span class="lineno"> 187</span>  </div> <div class="line"><a name="l00188"></a><span class="lineno"> 188</span> LOG4C_API <span class="keywordtype">void</span>* log4c_rollingpolicy_get_name(<span class="keyword">const</span> <a class="code" href="rollingpolicy_8h.html#a1c3cf54a065c84e6b4f0c85cbe3832c9">log4c_rollingpolicy_t</a>* a_this); </div> <div class="line"><a name="l00189"></a><span class="lineno"> 189</span> </div> <div class="line"><a name="l00190"></a><span class="lineno"> 190</span> LOG4C_API <a class="code" href="rollingpolicy_8h.html#a1c3cf54a065c84e6b4f0c85cbe3832c9">log4c_rollingpolicy_t</a>* log4c_rollingpolicy_new(<span class="keyword">const</span> <span class="keywordtype">char</span>* a_name);</div> <div class="line"><a name="l00191"></a><span class="lineno"> 191</span> LOG4C_API <span class="keywordtype">void</span> log4c_rollingpolicy_delete(<a class="code" href="rollingpolicy_8h.html#a1c3cf54a065c84e6b4f0c85cbe3832c9">log4c_rollingpolicy_t</a>* a_this);</div> <div class="line"><a name="l00192"></a><span class="lineno"> 192</span> LOG4C_API <span class="keywordtype">void</span> log4c_rollingpolicy_print(<span class="keyword">const</span> <a class="code" href="rollingpolicy_8h.html#a1c3cf54a065c84e6b4f0c85cbe3832c9">log4c_rollingpolicy_t</a>* a_this,</div> <div class="line"><a name="l00193"></a><span class="lineno"> 193</span> FILE* a_stream);</div> <div class="line"><a name="l00194"></a><span class="lineno"> 194</span> </div> <div class="line"><a name="l00195"></a><span class="lineno"> 195</span> LOG4C_API <span class="keywordtype">int</span> log4c_rollingpolicy_is_initialized(<a class="code" href="rollingpolicy_8h.html#a1c3cf54a065c84e6b4f0c85cbe3832c9">log4c_rollingpolicy_t</a>* a_this);</div> <div class="line"><a name="l00196"></a><span class="lineno"> 196</span> LOG4C_API <span class="keywordtype">void</span> log4c_rollingpolicy_types_free(<span class="keywordtype">void</span>);</div> <div class="line"><a name="l00197"></a><span class="lineno"> 197</span> LOG4C_API <span class="keywordtype">void</span> log4c_rollingpolicy_types_print(FILE *fp);</div> <div class="line"><a name="l00201"></a><span class="lineno"> 201</span> <span class="keyword">struct </span>__sd_factory;</div> <div class="line"><a name="l00202"></a><span class="lineno"> 202</span> LOG4C_API <span class="keyword">struct </span>__sd_factory* log4c_rollingpolicy_factory;</div> <div class="line"><a name="l00203"></a><span class="lineno"> 203</span> </div> <div class="line"><a name="l00204"></a><span class="lineno"> 204</span> __LOG4C_END_DECLS</div> <div class="line"><a name="l00205"></a><span class="lineno"> 205</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>