include/barrett/log/real_time_writer.h

Go to the documentation of this file.

#ifndef BARRETT_LOG_REAL_TIME_WRITER_H_
#define BARRETT_LOG_REAL_TIME_WRITER_H_


#include <boost/thread.hpp>

#include <barrett/detail/ca_macro.h>
#include <barrett/log/traits.h>
#include <barrett/log/writer.h>


namespace barrett {
namespace log {


// A log writer that is real-time safe. The data is double-buffered and is written to disk in a separate thread.
template<typename T, typename Traits = Traits<T> >
class RealTimeWriter : public Writer<T, Traits> {
public:
        typedef typename Writer<T, Traits>::parameter_type parameter_type;
        static const int DEFAULT_PRIORITY = 20;

        RealTimeWriter(const char* fileName, double recordPeriod_s, int priority_ = DEFAULT_PRIORITY);
        RealTimeWriter(const char* fileName, double approxPeriod_s, size_t recordsInSingleBuffer, int priority_ = DEFAULT_PRIORITY);
        ~RealTimeWriter();

        void putRecord(parameter_type data);
        void close();

protected:
        void init(size_t recordsInSingleBuffer);
        void writeToDiskEntryPoint();

        double period;
        size_t singleBufferSize;
        char* inBuff;
        char* outBuff;
        char* endInBuff;
        char* endOutBuff;
        char* currentPos;
        bool writeToDisk;

        boost::thread thread;
        int priority;

private:
        DISALLOW_COPY_AND_ASSIGN(RealTimeWriter);
};


}
}


// include template definitions
#include <barrett/log/detail/real_time_writer-inl.h>


#endif /* BARRETT_LOG_REAL_TIME_WRITER_H_ */