Home

Traffic Server Software Developers Kit

Prev — INKTextLogObjectRollingIntervalSecSet
INKTextLogObjectWrite — Next

INKTextLogObjectRollingOffsetHrSet

Sets the rolling offset for a log object.

Prototype

INKReturnCode INKTextLogObjectRollingOffsetHrSet (INKTextLogObject the_object, int rolling_offset_hr)

Arguments

INKTextLogObject the_object is the log object for which you want to set the rolling offset.

int rolling_offset_hr is the rolling interval, in seconds.

Description

This API must be used once the object is created (using INKTextLogObjectCreate) and before writing into logs (using INKTextLogObjectWrite). By default, a null header is used.

If INKTextLogObjectRollingOffsetHrSet is not called, then the defaut value (specified in records.config by parameter proxy.config.log2.rolling_offset_hr ) is used.

The rolling interval can be specified using the API INKTextLogObjectRollingIntervalSecSet.

Returns

INK_SUCCESS if the API is called successfully.

INK_ERROR if an error occurs while calling the API or if an argument is invalid.