LogWriter.h

Go to the documentation of this file.

#ifndef LOGWRITER_H_
#define LOGWRITER_H_

#include "LogEntry.h"
#include "utils/AuvMath.h"
#include "utils/FlexArray.h"
#include "utils/Mutex.h"

class OutStream;
class Unit;

class LogWriter
{
public:

    enum ServiceType
    {
        NO_SERVICE = -1,
        SERVICE_COURIER,
        SERVICE_EXPRESS,
        SERVICE_PRIORITY,
        SERVICE_NORMAL,
        SERVICE_BULK,
        SERVICE_COUNT,
        SERVICE_MULTI
    };

    static ServiceType Str2ServiceType( const char* const serviceTypeStr, int len = -1 );

    static const char* ServiceType2Str( LogWriter::ServiceType serviceType );

    static size_t ServiceType2Strlen( LogWriter::ServiceType serviceType );

    static const char* const SERVICE_TYPE_STRS[SERVICE_COUNT];

    static size_t const SERVICE_TYPE_STRLEN[SERVICE_COUNT];

    virtual ~LogWriter();

    virtual unsigned int writeHeader()
    {
        return 0;
    }

    virtual void setOutStream( OutStream& outStream );

    virtual bool isValid();

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

    virtual void endCycle() {}

    virtual unsigned int writeFooter()
    {
        return 0;
    }

    virtual void config( Logger& logger ) {}

    virtual void resetInputs() {}

    void addParent()
    {
        ++parentCount_;
    }

    void removeParent()
    {
        --parentCount_;
    }

    int getParentCount()
    {
        return parentCount_;
    }

    virtual void activate()
    {
        active_ = true;
    }

    virtual void deactivate()
    {
        active_ = false;
    }

    virtual bool isActive()
    {
        return active_;
    }

    virtual void lockWrites()
    {
        writeMutex_.lock();
    }

    virtual void unlockWrites()
    {
        writeMutex_.unlock();
    }

protected:

    LogWriter();

    LogWriter( OutStream& outStream );

    OutStream* logStream_;

    bool wroteHeader_;

    bool wroteFooter_;

    Mutex writeMutex_;

    int parentCount_;

    bool active_;

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

};

#endif /*LOGWRITER_H_*/