Stream.h

Go to the documentation of this file.

//-----------------------------------------------------------------------------
//
//  Stream.h
//
//  Cross-platform circular buffer with signalling
//
//  Copyright (c) 2010 Mal Lansell <mal@lansell.org>
//  All rights reserved.
//
//  SOFTWARE NOTICE AND LICENSE
//
//  This file is part of OpenZWave.
//
//  OpenZWave is free software: you can redistribute it and/or modify
//  it under the terms of the GNU Lesser General Public License as published
//  by the Free Software Foundation, either version 3 of the License,
//  or (at your option) any later version.
//
//  OpenZWave is distributed in the hope that it will be useful,
//  but WITHOUT ANY WARRANTY; without even the implied warranty of
//  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
//  GNU Lesser General Public License for more details.
//
//  You should have received a copy of the GNU Lesser General Public License
//  along with OpenZWave.  If not, see <http://www.gnu.org/licenses/>.
//
//-----------------------------------------------------------------------------
#ifndef _Stream_H
#define _Stream_H

#include "Defs.h"
#include "platform/Wait.h"

#include <string>

namespace OpenZWave
{
    namespace Internal
    {
        namespace Platform
        {
            class Mutex;

            class Stream: public Wait
            {
                    friend class Wait;

                public:
                    Stream(uint32 _bufferSize);

                    void SetSignalThreshold(uint32 _size);

                    bool Get(uint8* _buffer, uint32 _size);

                    bool Put(uint8* _buffer, uint32 _size);

                    uint32 GetDataSize() const
                    {
                        return m_dataSize;
                    }

                    void Purge();

                protected:
                    void LogData(uint8* _buffer, uint32 _size, const string &_function);

                    virtual bool IsSignalled();

                    ~Stream();

                private:
                    Stream(Stream const&);                  // prevent copy
                    Stream& operator =(Stream const&);      // prevent assignment

                    uint8* m_buffer;
                    uint32 m_bufferSize;
                    uint32 m_signalSize;
                    uint32 m_dataSize;
                    uint32 m_head;
                    uint32 m_tail;
                    Mutex* m_mutex;
            };
        } // namespace Platform
    } // namespace Internal
} // namespace OpenZWave

#endif //_Event_H