[#BloombergLP-ball-FileObserver-rotateOnLifetime]
= xref:BloombergLP.adoc[BloombergLP]::xref:BloombergLP/ball.adoc[ball]::xref:BloombergLP/ball/FileObserver.adoc[FileObserver]::rotateOnLifetime
:relfileprefix: ../../../
:mrdocs:

Configure periodic log file rotation at the specified `timeInterval`.

== Synopsis

Declared in `<ball_fileobserver.h>`

[source,cpp,subs="verbatim,replacements,macros,-callouts"]
----
void
rotateOnLifetime(xref:BloombergLP/bdlt/DatetimeInterval.adoc[bdlt::DatetimeInterval] const& timeInterval);
----

== Description

Set this file observer to perform a periodic log file rotation at multiples of the specified `timeInterval`. The behavior is undefined unless `0 < timeInterval.totalMilliseconds()`. This rule replaces any rotation‐on‐time‐interval rule currently in effect.

DEPRECATED: Use `rotateOnTimeInterval` instead.

== Parameters

[cols="1,4"]
|===
| Name| Description
| *timeInterval*
| periodic interval between log file rotations
|===


[.small]#Created with https://www.mrdocs.com[MrDocs]#