FileLogWriter.h

Go to the documentation of this file.

#ifndef FILELOGWRITER_H_
#define FILELOGWRITER_H_

#include "io/FileOutStream.h"
#include "logger/HasFilename.h"
#include "logger/LogWriter.h"

class FileEncoder;

class FileLogWriter: public LogWriter, public HasFilename
{
public:
    enum FlushFreq
    {
        FLUSH_ONCE = 0, FLUSH_PER_CYCLE = 1, FLUSH_PER_WRITE
    };

    FileLogWriter( const Str &filename, LogWriter* logWriter, const bool append =
                       false, FileEncoder* fileEncoder = NULL );

    FileLogWriter( FILE* file, LogWriter* logWriter );

    virtual ~FileLogWriter();

    virtual void resetInputs();

    virtual bool valid( void )
    {
        return isWritable();
    }
    ;

    virtual unsigned int write( const LogEntry *entry, const Unit* unit = NULL );

    virtual void endCycle();

    unsigned int getBytesInFile( void )
    {
        return bytesInFile_;
    }
    ;

    unsigned int getEntriesWritten( void )
    {
        return entriesWritten_;
    }
    ;

    virtual const Str& getFilename()
    {
        return filename_;
    }

    void resetFilename( const Str& filename );

    bool isWritable( void )
    {
        return fileStream_.isWritable();
    }
    ;

    /*virtual void config( Logger& logger );*/

protected:

    bool open( const char *filename, const bool append );

    void close( void );

    void setFlushFreq( const FlushFreq flushFreq )
    {
        flushFreq_ = flushFreq;
    }

    FileEncoder* getFileEncoder()
    {
        return fileEncoder_;
    }

    void setFilename( const Str& filename )
    {
        filename_ = filename;
    }

    LogWriter* logWriter_;

private:
    // Note that the copy constructor below is private and not given a body.
    // Any attempt to call it will return a compiler error.
    FileLogWriter( const FileLogWriter& old ); // disallow copy constructor

    FileOutStream fileStream_;

    unsigned int entriesWritten_;

    unsigned int bytesInFile_;

    bool initFilename_;

    Str filename_;

    FlushFreq flushFreq_;

    bool writtenInCycle_;

    FileEncoder* fileEncoder_;

};

#endif /*FILELOGWRITER_H_*/