/usr/share/doc/liblog4c-doc/html/rollingpolicy_8h.html is in liblog4c-doc 1.2.1-3.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 | <!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"/>
<title>log4c: rollingpolicy.h File Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<link href="doxygen.css" rel="stylesheet" type="text/css"/>
</head>
<body>
<!-- Generated by Doxygen 1.7.4 -->
<div id="top">
<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.1</span></div>
</td>
</tr>
</tbody>
</table>
</div>
<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>
<div class="header">
<div class="summary">
<a href="#nested-classes">Data Structures</a> |
<a href="#define-members">Defines</a> |
<a href="#typedef-members">Typedefs</a> |
<a href="#func-members">Functions</a> </div>
<div class="headertitle">
<div class="title">rollingpolicy.h File Reference</div> </div>
</div>
<div class="contents">
<p>Log4c rolling policy interface. Defines the interface for managing and providing rolling policies.
<a href="#details">More...</a></p>
<div class="textblock"><code>#include <stdio.h></code><br/>
<code>#include <log4c/defs.h></code><br/>
<code>#include <<a class="el" href="layout_8h_source.html">log4c/layout.h</a>></code><br/>
</div>
<p><a href="rollingpolicy_8h_source.html">Go to the source code of this file.</a></p>
<table class="memberdecls">
<tr><td colspan="2"><h2><a name="nested-classes"></a>
Data Structures</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="structlog4c__rollingpolicy__type.html">log4c_rollingpolicy_type</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">log4c rollingpolicy type. Defines the interface a specific policy must provide to the rollingfile appender. <a href="structlog4c__rollingpolicy__type.html#details">More...</a><br/></td></tr>
<tr><td colspan="2"><h2><a name="define-members"></a>
Defines</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="rollingpolicy_8h.html#a9d60b2e1decada3c0bdaa80b4d1f7d0a">ROLLINGPOLICY_ROLLOVER_ERR_CAN_LOG</a>   0x05</td></tr>
<tr><td colspan="2"><h2><a name="typedef-members"></a>
Typedefs</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">typedef struct <br class="typebreak"/>
__log4c_rollingpolicy </td><td class="memItemRight" valign="bottom"><a class="el" href="rollingpolicy_8h.html#a1c3cf54a065c84e6b4f0c85cbe3832c9">log4c_rollingpolicy_t</a></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">typedef struct <br class="typebreak"/>
<a class="el" href="structlog4c__rollingpolicy__type.html">log4c_rollingpolicy_type</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="rollingpolicy_8h.html#a9bfa38cb333223f222f20db356ef887b">log4c_rollingpolicy_type_t</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">log4c rollingpolicy type. Defines the interface a specific policy must provide to the rollingfile appender. <a href="#a9bfa38cb333223f222f20db356ef887b"></a><br/></td></tr>
<tr><td colspan="2"><h2><a name="func-members"></a>
Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">LOG4C_API <a class="el" href="rollingpolicy_8h.html#a1c3cf54a065c84e6b4f0c85cbe3832c9">log4c_rollingpolicy_t</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="rollingpolicy_8h.html#a811ae9f5b3dd337d42d0c3ef915c2569">log4c_rollingpolicy_get</a> (const char *policy_name)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">LOG4C_API const <br class="typebreak"/>
<a class="el" href="structlog4c__rollingpolicy__type.html">log4c_rollingpolicy_type_t</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="rollingpolicy_8h.html#ae510027f8cf0728e5881e829e8e7b36d">log4c_rollingpolicy_type_set</a> (const <a class="el" href="structlog4c__rollingpolicy__type.html">log4c_rollingpolicy_type_t</a> *a_type)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">LOG4C_API void </td><td class="memItemRight" valign="bottom"><a class="el" href="rollingpolicy_8h.html#abfb26041ddf14de7d1f8524fafa251fd">log4c_rollingpolicy_set_udata</a> (<a class="el" href="rollingpolicy_8h.html#a1c3cf54a065c84e6b4f0c85cbe3832c9">log4c_rollingpolicy_t</a> *policyp, void *udatap)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">LOG4C_API int </td><td class="memItemRight" valign="bottom"><a class="el" href="rollingpolicy_8h.html#a6676c861dd6ed57d1b3387f4f0b087e4">log4c_rollingpolicy_init</a> (<a class="el" href="rollingpolicy_8h.html#a1c3cf54a065c84e6b4f0c85cbe3832c9">log4c_rollingpolicy_t</a> *policyp, rollingfile_udata_t *rfup)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">LOG4C_API int </td><td class="memItemRight" valign="bottom"><a class="el" href="rollingpolicy_8h.html#ab8f8b2f83ad654cfec4e0ada4726a29e">log4c_rollingpolicy_fini</a> (<a class="el" href="rollingpolicy_8h.html#a1c3cf54a065c84e6b4f0c85cbe3832c9">log4c_rollingpolicy_t</a> *a_this)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">LOG4C_API int </td><td class="memItemRight" valign="bottom"><a class="el" href="rollingpolicy_8h.html#a8cf302296c1134416fb91d6e1f08d036">log4c_rollingpolicy_is_triggering_event</a> (<a class="el" href="rollingpolicy_8h.html#a1c3cf54a065c84e6b4f0c85cbe3832c9">log4c_rollingpolicy_t</a> *policyp, const <a class="el" href="structlog4c__logging__event__t.html">log4c_logging_event_t</a> *evtp, long current_file_size)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">LOG4C_API const <br class="typebreak"/>
<a class="el" href="structlog4c__rollingpolicy__type.html">log4c_rollingpolicy_type_t</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="rollingpolicy_8h.html#aebf28b341098372842c3b80cb4b0e83e">log4c_rollingpolicy_set_type</a> (<a class="el" href="rollingpolicy_8h.html#a1c3cf54a065c84e6b4f0c85cbe3832c9">log4c_rollingpolicy_t</a> *a_rollingpolicy, const <a class="el" href="structlog4c__rollingpolicy__type.html">log4c_rollingpolicy_type_t</a> *a_type)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">LOG4C_API const <br class="typebreak"/>
<a class="el" href="structlog4c__rollingpolicy__type.html">log4c_rollingpolicy_type_t</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="rollingpolicy_8h.html#aa60c0c87158ffac426b42ccd5debd732">log4c_rollingpolicy_type_get</a> (const char *a_name)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">LOG4C_API void * </td><td class="memItemRight" valign="bottom"><a class="el" href="rollingpolicy_8h.html#a8858624575850bd86fb33225e283154c">log4c_rollingpolicy_get_udata</a> (const <a class="el" href="rollingpolicy_8h.html#a1c3cf54a065c84e6b4f0c85cbe3832c9">log4c_rollingpolicy_t</a> *policyp)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">LOG4C_API rollingfile_udata_t * </td><td class="memItemRight" valign="bottom"><a class="el" href="rollingpolicy_8h.html#a608e0f4d8ae3a6e1c06e607d2a0ce232">log4c_rollingpolicy_get_rfudata</a> (const <a class="el" href="rollingpolicy_8h.html#a1c3cf54a065c84e6b4f0c85cbe3832c9">log4c_rollingpolicy_t</a> *policyp)</td></tr>
</table>
<hr/><a name="details" id="details"></a><h2>Detailed Description</h2>
<div class="textblock"><p>Log4c rolling policy interface. Defines the interface for managing and providing rolling policies. </p>
<p>A rolling policy is used to confogure a rollingfile appender to tell it when to trigger a rolover event. </p>
</div><hr/><h2>Define Documentation</h2>
<a class="anchor" id="a9d60b2e1decada3c0bdaa80b4d1f7d0a"></a><!-- doxytag: member="rollingpolicy.h::ROLLINGPOLICY_ROLLOVER_ERR_CAN_LOG" ref="a9d60b2e1decada3c0bdaa80b4d1f7d0a" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define ROLLINGPOLICY_ROLLOVER_ERR_CAN_LOG   0x05</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Effect a rollover according to policyp on the given file stream. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">policyp</td><td>pointer to the rolling policy </td></tr>
<tr><td class="paramname">fp</td><td>filestream to rollover. </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>zero if successful, non-zero otherwise. The policy can return an indication that something went wrong but that the rollingfile appender can stull go ahead and log by returning an error code <= ROLLINGPOLICY_ROLLOVER_ERR_CAN_LOG. Anything greater than means that the rolling file appender will not try to log it's message. </dd></dl>
</div>
</div>
<hr/><h2>Typedef Documentation</h2>
<a class="anchor" id="a1c3cf54a065c84e6b4f0c85cbe3832c9"></a><!-- doxytag: member="rollingpolicy.h::log4c_rollingpolicy_t" ref="a1c3cf54a065c84e6b4f0c85cbe3832c9" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">typedef struct __log4c_rollingpolicy <a class="el" href="rollingpolicy_8h.html#a1c3cf54a065c84e6b4f0c85cbe3832c9">log4c_rollingpolicy_t</a></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>log4c rollingpolicy type </p>
</div>
</div>
<a class="anchor" id="a9bfa38cb333223f222f20db356ef887b"></a><!-- doxytag: member="rollingpolicy.h::log4c_rollingpolicy_type_t" ref="a9bfa38cb333223f222f20db356ef887b" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">typedef struct <a class="el" href="structlog4c__rollingpolicy__type.html">log4c_rollingpolicy_type</a> <a class="el" href="structlog4c__rollingpolicy__type.html">log4c_rollingpolicy_type_t</a></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>log4c rollingpolicy type. Defines the interface a specific policy must provide to the rollingfile appender. </p>
<p>Attributes description:</p>
<ul>
<li><code>name</code> rollingpolicy type name </li>
<li><code>init()</code> init the rollingpolicy </li>
<li><code>is_triggering_event()</code> </li>
<li><code>rollover()</code> </li>
</ul>
</div>
</div>
<hr/><h2>Function Documentation</h2>
<a class="anchor" id="ab8f8b2f83ad654cfec4e0ada4726a29e"></a><!-- doxytag: member="rollingpolicy.h::log4c_rollingpolicy_fini" ref="ab8f8b2f83ad654cfec4e0ada4726a29e" args="(log4c_rollingpolicy_t *a_this)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">LOG4C_API int log4c_rollingpolicy_fini </td>
<td>(</td>
<td class="paramtype"><a class="el" href="rollingpolicy_8h.html#a1c3cf54a065c84e6b4f0c85cbe3832c9">log4c_rollingpolicy_t</a> * </td>
<td class="paramname"><em>a_this</em></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Call the un initialization code of a rolling policy. This will call the fini routine of the particular rollingpolicy type to allow it to free up resources. If the call to fini in the rollingpolicy type fails then the rollingpolicy is not uninitialized. Try again later model... </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">policyp</td><td>pointer to the rolling policy </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>zero if successful, non-zero otherwise. </dd></dl>
</div>
</div>
<a class="anchor" id="a811ae9f5b3dd337d42d0c3ef915c2569"></a><!-- doxytag: member="rollingpolicy.h::log4c_rollingpolicy_get" ref="a811ae9f5b3dd337d42d0c3ef915c2569" args="(const char *policy_name)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">LOG4C_API <a class="el" href="rollingpolicy_8h.html#a1c3cf54a065c84e6b4f0c85cbe3832c9">log4c_rollingpolicy_t</a>* log4c_rollingpolicy_get </td>
<td>(</td>
<td class="paramtype">const char * </td>
<td class="paramname"><em>policy_name</em></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Get a new rolling policy </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">policy_name</td><td>a name for the policy </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>a new rolling policy, otherwise NULL. </dd></dl>
</div>
</div>
<a class="anchor" id="a608e0f4d8ae3a6e1c06e607d2a0ce232"></a><!-- doxytag: member="rollingpolicy.h::log4c_rollingpolicy_get_rfudata" ref="a608e0f4d8ae3a6e1c06e607d2a0ce232" args="(const log4c_rollingpolicy_t *policyp)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">LOG4C_API rollingfile_udata_t* log4c_rollingpolicy_get_rfudata </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="rollingpolicy_8h.html#a1c3cf54a065c84e6b4f0c85cbe3832c9">log4c_rollingpolicy_t</a> * </td>
<td class="paramname"><em>policyp</em></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Get the rollingfile appender associated with this policy. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">policyp</td><td>pointer to the rolling policy </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>pointer to the rolling file appender associated with this policy </dd></dl>
</div>
</div>
<a class="anchor" id="a8858624575850bd86fb33225e283154c"></a><!-- doxytag: member="rollingpolicy.h::log4c_rollingpolicy_get_udata" ref="a8858624575850bd86fb33225e283154c" args="(const log4c_rollingpolicy_t *policyp)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">LOG4C_API void* log4c_rollingpolicy_get_udata </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="rollingpolicy_8h.html#a1c3cf54a065c84e6b4f0c85cbe3832c9">log4c_rollingpolicy_t</a> * </td>
<td class="paramname"><em>policyp</em></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Get the rolling policy configuration. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">policyp</td><td>pointer to the rolling policy </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>pointer to the rolling policy configuration. </dd></dl>
</div>
</div>
<a class="anchor" id="a6676c861dd6ed57d1b3387f4f0b087e4"></a><!-- doxytag: member="rollingpolicy.h::log4c_rollingpolicy_init" ref="a6676c861dd6ed57d1b3387f4f0b087e4" args="(log4c_rollingpolicy_t *policyp, rollingfile_udata_t *rfup)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">LOG4C_API int log4c_rollingpolicy_init </td>
<td>(</td>
<td class="paramtype"><a class="el" href="rollingpolicy_8h.html#a1c3cf54a065c84e6b4f0c85cbe3832c9">log4c_rollingpolicy_t</a> * </td>
<td class="paramname"><em>policyp</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">rollingfile_udata_t * </td>
<td class="paramname"><em>rfup</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Call the initialization code of a rolling policy. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">policyp</td><td>pointer to the rolling policy </td></tr>
<tr><td class="paramname">app</td><td>the rolling appender this policy is used with </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>zero if successful, non-zero otherwise. </dd></dl>
</div>
</div>
<a class="anchor" id="a8cf302296c1134416fb91d6e1f08d036"></a><!-- doxytag: member="rollingpolicy.h::log4c_rollingpolicy_is_triggering_event" ref="a8cf302296c1134416fb91d6e1f08d036" args="(log4c_rollingpolicy_t *policyp, const log4c_logging_event_t *evtp, long current_file_size)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">LOG4C_API int log4c_rollingpolicy_is_triggering_event </td>
<td>(</td>
<td class="paramtype"><a class="el" href="rollingpolicy_8h.html#a1c3cf54a065c84e6b4f0c85cbe3832c9">log4c_rollingpolicy_t</a> * </td>
<td class="paramname"><em>policyp</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="structlog4c__logging__event__t.html">log4c_logging_event_t</a> * </td>
<td class="paramname"><em>evtp</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">long </td>
<td class="paramname"><em>current_file_size</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Determine if a logging event should trigger a rollover according to the given policy. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">policyp</td><td>pointer to the rolling policy </td></tr>
<tr><td class="paramname">evtp</td><td>the logging event pointer. </td></tr>
<tr><td class="paramname">current_file_size</td><td>the size of the current file being logged to. </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>non-zero if rollover required, zero otherwise. </dd></dl>
</div>
</div>
<a class="anchor" id="aebf28b341098372842c3b80cb4b0e83e"></a><!-- doxytag: member="rollingpolicy.h::log4c_rollingpolicy_set_type" ref="aebf28b341098372842c3b80cb4b0e83e" args="(log4c_rollingpolicy_t *a_rollingpolicy, const log4c_rollingpolicy_type_t *a_type)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">LOG4C_API const <a class="el" href="structlog4c__rollingpolicy__type.html">log4c_rollingpolicy_type_t</a>* log4c_rollingpolicy_set_type </td>
<td>(</td>
<td class="paramtype"><a class="el" href="rollingpolicy_8h.html#a1c3cf54a065c84e6b4f0c85cbe3832c9">log4c_rollingpolicy_t</a> * </td>
<td class="paramname"><em>a_rollingpolicy</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="structlog4c__rollingpolicy__type.html">log4c_rollingpolicy_type_t</a> * </td>
<td class="paramname"><em>a_type</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>sets the rolling policy type</p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">a_rollingpolicy</td><td>the log4c_rollingpolicy_t object </td></tr>
<tr><td class="paramname">a_type</td><td>the new rollingpolicy type </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>the previous appender type </dd></dl>
</div>
</div>
<a class="anchor" id="abfb26041ddf14de7d1f8524fafa251fd"></a><!-- doxytag: member="rollingpolicy.h::log4c_rollingpolicy_set_udata" ref="abfb26041ddf14de7d1f8524fafa251fd" args="(log4c_rollingpolicy_t *policyp, void *udatap)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">LOG4C_API void log4c_rollingpolicy_set_udata </td>
<td>(</td>
<td class="paramtype"><a class="el" href="rollingpolicy_8h.html#a1c3cf54a065c84e6b4f0c85cbe3832c9">log4c_rollingpolicy_t</a> * </td>
<td class="paramname"><em>policyp</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">void * </td>
<td class="paramname"><em>udatap</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Configure a rolling policy with a specific policy. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">policyp</td><td>pointer to the rolling policy </td></tr>
<tr><td class="paramname">udatap</td><td>a specific policy type, for example sizewin. </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>zero if successful, non-zero otherwise. </dd></dl>
</div>
</div>
<a class="anchor" id="aa60c0c87158ffac426b42ccd5debd732"></a><!-- doxytag: member="rollingpolicy.h::log4c_rollingpolicy_type_get" ref="aa60c0c87158ffac426b42ccd5debd732" args="(const char *a_name)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">LOG4C_API const <a class="el" href="structlog4c__rollingpolicy__type.html">log4c_rollingpolicy_type_t</a>* log4c_rollingpolicy_type_get </td>
<td>(</td>
<td class="paramtype">const char * </td>
<td class="paramname"><em>a_name</em></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Get a pointer to an existing rollingpolicy type.</p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">a_name</td><td>the name of the rollingpolicy type to return. </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>a pointer to an existing rollingpolicy type, or NULL if no rollingpolicy type with the specified name exists. </dd></dl>
</div>
</div>
<a class="anchor" id="ae510027f8cf0728e5881e829e8e7b36d"></a><!-- doxytag: member="rollingpolicy.h::log4c_rollingpolicy_type_set" ref="ae510027f8cf0728e5881e829e8e7b36d" args="(const log4c_rollingpolicy_type_t *a_type)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">LOG4C_API const <a class="el" href="structlog4c__rollingpolicy__type.html">log4c_rollingpolicy_type_t</a>* log4c_rollingpolicy_type_set </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="structlog4c__rollingpolicy__type.html">log4c_rollingpolicy_type_t</a> * </td>
<td class="paramname"><em>a_type</em></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Use this function to register a rollingpolicy type with log4c. Once this is done you may refer to this type by name both programmatically and in the log4c configuration file.</p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">a_type</td><td>a pointer to the new rollingpolicy type to register. </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>a pointer to the previous rollingpolicy type of same name.</dd></dl>
<p>Example code fragment: </p>
<div class="fragment"><pre class="fragment"> <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_sizewin = {
<span class="stringliteral">"sizewin"</span>,
sizewin_init,
sizewin_is_triggering_event,
sizewin_rollover
};
log4c_rollingpolicy_type_set(&log4c_rollingpolicy_type_sizewin);
</pre></div>
</div>
</div>
</div>
<hr class="footer"/><address class="footer"><small>Generated on Mon May 2 2011 16:16:03 for log4c by 
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.7.4 </small></address>
</body>
</html>
|