CFileLog Class Reference

#include <FileLog.h>

Inheritance diagram for CFileLog:

[legend]

Collaboration diagram for CFileLog:

[legend]

List of all members.

Public Member Functions
bool	WriteLog (const std::string &rData)
void	SetMaxLogSize (DWORD dwSize)
void	SetLogTruncate (BOOL bTruncate)
BOOL	Initialize (const std::string &rFileName)
	CFileLog ()
virtual	~CFileLog ()
void	SetAutoFlush (BOOL bFlush)
BOOL	GetAutoFlush () const
Protected Member Functions
virtual void	WriteError (const std::string &rError)
virtual void	WriteMessage (const std::string &rMessage)

---

Detailed Description

Definition at line 55 of file FileLog.h.

---

Constructor & Destructor Documentation

KOMODIA_NAMESPACE_START CFileLog::CFileLog

(

)

Definition at line 54 of file FileLog.cpp.

                   : CErrorHandler::CErrorLog(),
                       m_pFile(NULL),
                       m_pCSection(NULL),
                       m_dwMaxLogSize(5000000),
                       m_bTruncate(FALSE)
{
    //Create the CS
    m_pCSection=COSManager::CreateCriticalSection();
}

CFileLog::~CFileLog

(

)

[virtual]

Definition at line 64 of file FileLog.cpp.

{
    try
    {
        //Close the file
        fclose(m_pFile);

        //Delete the CS
        delete m_pCSection;
    }
    ERROR_UNKNOWN("~CFileLog")
}

---

Member Function Documentation

BOOL CErrorHandler::CErrorHandler::CErrorLog::GetAutoFlush

(

)

const [inherited]

Definition at line 80 of file ErrorHandler.cpp.

{
    return m_bAutoFlush;
}

BOOL CFileLog::Initialize

(

const std::string &

rFileName

)

Definition at line 77 of file FileLog.cpp.

{
    //Open's the log file
    try
    {
        //Check if the file is open
        if (m_pFile)
            //close is
            fclose(m_pFile);

        //Which open mode
        BOOL bTruncate;
        bTruncate=FALSE;

        //Do we need to get the file size
        if (m_dwMaxLogSize)
        {
            //Open the file
            HANDLE hFile; 
            hFile=CreateFile(rFileName.c_str(),
                             GENERIC_READ,
                             FILE_SHARE_READ,
                             NULL,
                             OPEN_EXISTING,
                             FILE_ATTRIBUTE_NORMAL,
                             NULL);
 
            //Do we have it?
            if (hFile!=INVALID_HANDLE_VALUE) 
            { 
                //Get the file size
                DWORD dwSize;
                dwSize=GetFileSize(hFile,
                                   NULL);

                //Close the file
                CloseHandle(hFile);

                //Is it bigger
                if (dwSize>m_dwMaxLogSize)
                    bTruncate=TRUE;
            }
        }

        //Now open the file
        if (!bTruncate)
            m_pFile=fopen(rFileName.c_str(),"at");
        else
            m_pFile=fopen(rFileName.c_str(),"wt");

        //Save the file name
        m_sFileName=rFileName;

        //Did we manage to open it?
        if (!m_pFile)
            return FALSE;
        else
            return TRUE;
    }
    ERROR_UNKNOWN_RETURN("ReportError",FALSE)
}

void CErrorHandler::CErrorHandler::CErrorLog::SetAutoFlush

(

BOOL

bFlush

)

[inherited]

Definition at line 75 of file ErrorHandler.cpp.

{
    m_bAutoFlush=bFlush;
}

void CFileLog::SetLogTruncate

(

BOOL

bTruncate

)

Definition at line 192 of file FileLog.cpp.

{
    m_bTruncate=bTruncate;
}

void CFileLog::SetMaxLogSize

(

DWORD

dwSize

)

Definition at line 187 of file FileLog.cpp.

{
    m_dwMaxLogSize=dwSize;
}

void CFileLog::WriteError

(

const std::string &

rError

)

[protected, virtual]

Implements CErrorHandler::CErrorHandler::CErrorLog.

Definition at line 177 of file FileLog.cpp.

{
    WriteLog(rError);
}

bool CFileLog::WriteLog

(

const std::string &

rData

)

Definition at line 139 of file FileLog.cpp.

{
    try
    {
#ifdef _DEBUG
        m_aLog.WriteLog(rData);
#endif
        //Lock it
        CCriticalAutoRelease aRelease(m_pCSection);
    
        //Write to log
        fprintf(m_pFile,"%s\n",rData.c_str());

        //If error, or auto flush - then flush the data
        if (GetAutoFlush())
            fflush(m_pFile);

        //Do we need to truncate?
        if (m_bTruncate &&
            m_dwMaxLogSize &&
            ftell(m_pFile)>m_dwMaxLogSize)
        {
            //Reopen and close the log
            //Reinitialize if
            Initialize(m_sFileName);

            //Rewrite to the file
            WriteLog(CErrorHandler::FormatData("CFileLog",
                                               "WriteLog",
                                               "Log truncated!"));
        }

        //Done
        return true;
    }
    ERROR_UNKNOWN_RETURN("WriteLog",false)
}

void CFileLog::WriteMessage

(

const std::string &

rMessage

)

[protected, virtual]

Implements CErrorHandler::CErrorHandler::CErrorLog.

Definition at line 182 of file FileLog.cpp.

{
    WriteLog(rMessage);
}

---

The documentation for this class was generated from the following files:

• FileLog.h
• FileLog.cpp