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

Set this file observer to perform a periodic log file rotation at multiples of the specified `interval`. Optionally specify a `startTime` indicating the datetime to use as the starting point for computing the periodic rotation schedule. If `isPublishInLocalTimeEnabled` is `true`, the `startTime` is interpreted as local time, and as a UTC time otherwise. If `startTime` is not specified, the current time is used. This rule replaces any rotation‐on‐time‐interval rule currently in effect. The behavior is undefined unless `0 < interval.totalMilliseconds()`. Note that `startTime` may be a fixed time in the past; e.g., a reference time of `bdlt::Datetime(1, 1, 1)` and an interval of 24 hours would configure a periodic rotation at midnight each day.

== Synopsis

Declared in `<ball_fileobserver.h>`

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


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