logfile.h

Go to the documentation of this file.

#pragma once
 
 
#include <cx/fs/vfs.h>
#include <cx/log/log.h>
 
enum LOG_DATE_FORMATS {
    LOG_DateISO,             
    LOG_DateISOCompact,      
    LOG_DateNCSA,            
    LOG_DateSyslog,          
    LOG_DateISOCompactMsec   
};
 
enum LOG_FLAGS {
    LOG_LocalTime       = 0x0001,   
    LOG_OmitLevel       = 0x0002,   
    LOG_ShortLevel      = 0x0004,   
    LOG_BracketLevel    = 0x0008,   
    LOG_JustifyLevel    = 0x0010,   
    LOG_IncludeCategory = 0x0020,   
    LOG_BracketCategory = 0x0040,   
    LOG_AddColon        = 0x0080,   
    LOG_CategoryFirst   = 0x0100,   
};
 
enum LOG_ROTATE_MODE {
    LOG_RotateSize = 1,   
    LOG_RotateTime,       
};
 
typedef struct LogFileConfig {
    int dateFormat;         
    int rotateMode;         
    int spacing;            
 
    uint32 flags;           
 
    int64 rotateSize;       
    uint8 rotateHour;       
    uint8 rotateMinute;     
    uint8 rotateSecond;     
 
    int rotateKeepFiles;    
    int64 rotateKeepTime;   
} LogFileConfig;
 
typedef struct LogFileData LogFileData;
 
// ============================================================================
// High Level Interface
// ============================================================================
 
LogFileData* logfileCreate(_Inout_ VFS* vfs, _In_ strref filename, _In_ LogFileConfig* config);
 
LogDest* logfileRegister(int maxlevel, _In_opt_ LogCategory* catfilter, _In_ LogFileData* logfile);
 
LogDest* logfileRegisterWithDefer(int maxlevel, _In_opt_ LogCategory* catfilter,
                                  _In_ LogFileData* logfile, _In_ LogDest* deferdest);
 
// ============================================================================
// Low Level Interface
// ============================================================================
//
// These callbacks can be used directly with logRegisterDest() for custom
// destination handling. Most users should use the high-level interface above.
 
void logfileMsgFunc(int level, _In_opt_ LogCategory* cat, int64 timestamp, _In_opt_ strref msg,
                    uint32 batchid, _In_opt_ void* userdata);
 
void logfileBatchFunc(uint32 batchid, _In_opt_ void* userdata);
 
void logfileCloseFunc(_In_opt_ void* userdata);