source: box/trunk/lib/common/ReadLoggingStream.h @ 2245

// --------------------------------------------------------------------------
//
// File
//              Name:    ReadLoggingStream.h
//              Purpose: Wrapper around IOStreams that logs read progress
//              Created: 2007/01/16
//
// --------------------------------------------------------------------------

#ifndef READLOGGINGSTREAM__H
#define READLOGGINGSTREAM__H

#include "IOStream.h"
#include "BoxTime.h"

class ReadLoggingStream : public IOStream
{
public:
        class Logger
        {
        public:
                virtual ~Logger() { }
                virtual void Log(int64_t readSize, int64_t offset,
                        int64_t length, box_time_t elapsed,
                        box_time_t finish) = 0;
                virtual void Log(int64_t readSize, int64_t offset,
                        int64_t length) = 0;
                virtual void Log(int64_t readSize, int64_t offset) = 0;
        };

private:
        IOStream& mrSource;
        IOStream::pos_type mOffset, mLength, mTotalRead;
        box_time_t mStartTime;
        Logger& mrLogger;

public:
        ReadLoggingStream(IOStream& rSource, Logger& rLogger);
        
        virtual int Read(void *pBuffer, int NBytes, int Timeout = IOStream::TimeOutInfinite);
        virtual pos_type BytesLeftToRead();
        virtual void Write(const void *pBuffer, int NBytes);
        virtual pos_type GetPosition() const;
        virtual void Seek(IOStream::pos_type Offset, int SeekType);
        virtual void Close();
        
        virtual bool StreamDataLeft();
        virtual bool StreamClosed();

private:
        ReadLoggingStream(const ReadLoggingStream &rToCopy) 
        : mrSource(rToCopy.mrSource), mrLogger(rToCopy.mrLogger)
        { /* do not call */ }
};

#endif // READLOGGINGSTREAM__H