1
  2
  3
  4
  5
  6
  7
  8
  9
 10
 11
 12
 13
 14
 15
 16
 17
 18
 19
 20
 21
 22
 23
 24
 25
 26
 27
 28
 29
 30
 31
 32
 33
 34
 35
 36
 37
 38
 39
 40
 41
 42
 43
 44
 45
 46
 47
 48
 49
 50
 51
 52
 53
 54
 55
 56
 57
 58
 59
 60
 61
 62
 63
 64
 65
 66
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
/*****************************************************************
|
|   Platinum - Ring buffer stream
|
| Copyright (c) 2004-2010, Plutinosoft, LLC.
| All rights reserved.
| http://www.plutinosoft.com
|
| This program is free software; you can redistribute it and/or
| modify it under the terms of the GNU General Public License
| as published by the Free Software Foundation; either version 2
| of the License, or (at your option) any later version.
|
| OEMs, ISVs, VARs and other distributors that combine and
| distribute commercially licensed software with Platinum software
| and do not wish to distribute the source code for the commercially
| licensed software under version 2, or (at your option) any later
| version, of the GNU General Public License (the "GPL") must enter
| into a commercial license agreement with Plutinosoft, LLC.
| licensing@plutinosoft.com
|
| This program 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 General Public License for more details.
|
| You should have received a copy of the GNU General Public License
| along with this program; see the file LICENSE.txt. If not, write to
| the Free Software Foundation, Inc.,
| 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
| http://www.gnu.org/licenses/gpl-2.0.html
|
****************************************************************/

#ifndef _PLT_RING_BUFFER_STREAM_H_
#define _PLT_RING_BUFFER_STREAM_H_

/*----------------------------------------------------------------------
|   includes
+---------------------------------------------------------------------*/
#include "Neptune.h"

/*----------------------------------------------------------------------
|   PLT_RingBufferStream class
+---------------------------------------------------------------------*/
class PLT_RingBufferStream : public NPT_DelegatingInputStream,
                             public NPT_DelegatingOutputStream
{
public:
    PLT_RingBufferStream(NPT_Size buffer_size = 4096, bool blocking = true);
    PLT_RingBufferStream(NPT_RingBufferReference& buffer, bool blocking = true);
    virtual ~PLT_RingBufferStream();<--- Destructor in derived class

    // methods
    bool IsAborted() { return m_Aborted; }

    // NPT_InputStream methods
    NPT_Result Read(void*     buffer,<--- Function in derived class
                    NPT_Size  bytes_to_read,
                    NPT_Size* bytes_read = NULL);
    NPT_Result GetSize(NPT_LargeSize& size)  {<--- Function in derived class
        NPT_COMPILER_UNUSED(size);
        return NPT_ERROR_NOT_SUPPORTED;
    }
    NPT_Result GetSpace(NPT_LargeSize& space) {
        NPT_AutoLock autoLock(m_Lock);
        space = m_RingBuffer->GetSpace();
        return NPT_SUCCESS;
    }
    NPT_Result GetAvailable(NPT_LargeSize& available) {<--- Function in derived class
        NPT_AutoLock autoLock(m_Lock);
        available = m_RingBuffer->GetAvailable();
        return NPT_SUCCESS;
    }

    // NPT_OutputStream methods
    NPT_Result Write(const void* buffer,<--- Function in derived class
                     NPT_Size    bytes_to_write,
                     NPT_Size*   bytes_written = NULL);
    NPT_Result Flush();<--- Function in derived class
    NPT_Result SetEOS();
    NPT_Result Abort();

protected:
    // NPT_DelegatingInputStream methods
    NPT_Result InputSeek(NPT_Position offset) {<--- Function in derived class
        NPT_COMPILER_UNUSED(offset);
        return NPT_ERROR_NOT_SUPPORTED;
    }
    NPT_Result InputTell(NPT_Position& offset) {<--- Function in derived class
        NPT_AutoLock autoLock(m_Lock);
        offset = m_TotalBytesRead;
        return NPT_SUCCESS;
    }

    // NPT_DelegatingOutputStream methods
    NPT_Result OutputSeek(NPT_Position offset) {<--- Function in derived class
        NPT_COMPILER_UNUSED(offset);
        return NPT_ERROR_NOT_SUPPORTED;
    }
    NPT_Result OutputTell(NPT_Position& offset) {<--- Function in derived class
        NPT_AutoLock autoLock(m_Lock);
        offset = m_TotalBytesWritten;
        return NPT_SUCCESS;
    }

private:
    NPT_RingBufferReference m_RingBuffer;
    NPT_Offset              m_TotalBytesRead;
    NPT_Offset              m_TotalBytesWritten;
    NPT_Mutex               m_Lock;
    bool                    m_Blocking;
    bool                    m_Eos;
    bool                    m_Aborted;
};

typedef NPT_Reference<PLT_RingBufferStream> PLT_RingBufferStreamReference;

#endif // _PLT_RING_BUFFER_STREAM_H_