Home

Traffic Server Software Developers Kit

INKTextLogObjectFlush

Flushes the contents of a specified log file’s log write buffer.

Prototype

INKReturnCode INKTextLogObjectFlush (INKTextLogObject the_object)

Arguments

INKTextLogObject the_object is the log file whose write buffer you want to flush. You have to first create this object with INKTextLogObjectCreate.

Description

This immediately flushes to disk the contents of the log write buffer for the_object ; use this call only if you want to make sure that log entries are flushed immediately. Also be aware that this call has a performance cost. Traffic Server automatically flushes the log buffer about every second.

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.