Module mochilogfile2

Write newline delimited log files, ensuring that if a truncated entry is found on log open then it is fixed before writing.

Copyright © 2010 Mochi Media, Inc. Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

Authors: Bob Ippolito (bob@mochimedia.com).

Description

Write newline delimited log files, ensuring that if a truncated entry is found on log open then it is fixed before writing. Uses delayed writes and raw files for performance.

Function Index

close/1Close the log file referenced by Handle.
name/1Return the path of the log file.
open/1Open the log file Name, creating or appending as necessary.
write/2Write IoData to the log file referenced by Handle.

Function Details

close/1

close(X1::Handle) -> ok

Close the log file referenced by Handle.

name/1

name(X1::Handle) -> string()

Return the path of the log file.

open/1

open(Name) -> Handle

Open the log file Name, creating or appending as necessary. All data at the end of the file will be truncated until a newline is found, to ensure that all records are complete.

write/2

write(X1::Handle, IoData) -> ok

Write IoData to the log file referenced by Handle.


Generated by EDoc