summaryrefslogtreecommitdiffstats
path: root/lib/libUPnP/Platinum/Source/Extras/PltRingBufferStream.cpp
blob: 92eb355ff9f61fceb6a61c29d3287fc9df988815 (plain)
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
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
/*****************************************************************
|
|   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
|
****************************************************************/

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

/*----------------------------------------------------------------------
|   defines
+---------------------------------------------------------------------*/
#ifdef max
#undef max
#endif
#define max(a,b)    (((a) > (b)) ? (a) : (b))

#ifdef min
#undef min
#endif
#define min(a,b)    (((a) < (b)) ? (a) : (b))

/*----------------------------------------------------------------------
|   PLT_RingBufferStream::PLT_RingBufferStream
+---------------------------------------------------------------------*/
PLT_RingBufferStream::PLT_RingBufferStream(NPT_Size buffer_size,
                                           bool     blocking /* = true */) : 
    m_TotalBytesRead(0),
    m_TotalBytesWritten(0),
    m_Blocking(blocking),
    m_Eos(false),
    m_Aborted(false)
{
    m_RingBuffer = new NPT_RingBuffer(buffer_size);
}

/*----------------------------------------------------------------------
|   PLT_RingBufferStream::PLT_RingBufferStream
+---------------------------------------------------------------------*/
PLT_RingBufferStream::PLT_RingBufferStream(NPT_RingBufferReference& buffer,
                                           bool blocking /* = true */) : 
    m_RingBuffer(buffer),
    m_TotalBytesRead(0),
    m_TotalBytesWritten(0),
    m_Blocking(blocking),
    m_Eos(false),
    m_Aborted(false)
{
}

/*----------------------------------------------------------------------
|   PLT_RingBufferStream::~PLT_RingBufferStream
+---------------------------------------------------------------------*/
PLT_RingBufferStream::~PLT_RingBufferStream()
{
}

/*----------------------------------------------------------------------
|   PLT_RingBufferStream::Read
+---------------------------------------------------------------------*/
NPT_Result 
PLT_RingBufferStream::Read(void*     buffer, 
                           NPT_Size  max_bytes_to_read, 
                           NPT_Size* _bytes_read /*= NULL*/)
{
    NPT_Size bytes_to_read;
    NPT_Size bytes_read = 0;

    // reset output param first
    if (_bytes_read) *_bytes_read = 0;

    // wait for data
    do {
        {
            NPT_AutoLock autoLock(m_Lock);
            
            if (m_Aborted) {
                return NPT_ERROR_INTERRUPTED;
            }
            
            // check for data
            if (m_RingBuffer->GetAvailable()) 
                break;

            if (m_Eos) {
                return NPT_ERROR_EOS;
            } else if (!m_Blocking) {
                return NPT_ERROR_WOULD_BLOCK;
            }
        }
        
        // sleep and try again
        NPT_System::Sleep(NPT_TimeInterval(.1));
    } while (1);

    {
        NPT_AutoLock autoLock(m_Lock);

        // try twice in case available data was not contiguous
        for (int i=0; i<2; i++) {
            bytes_to_read = min(max_bytes_to_read - bytes_read, m_RingBuffer->GetContiguousAvailable());

            // break if nothing to read the second time
            if (bytes_to_read == 0) break;

            // read into buffer and advance
            NPT_CHECK(m_RingBuffer->Read((unsigned char*)buffer+bytes_read, bytes_to_read));

            // keep track of the total bytes we have read so far
            m_TotalBytesRead += bytes_to_read;
            bytes_read += bytes_to_read;

            if (_bytes_read) *_bytes_read += bytes_to_read;
        }
    }

    // we have read some chars, so return success
    // even if we have read less than asked
    return NPT_SUCCESS;
}

/*----------------------------------------------------------------------
|   PLT_RingBufferStream::Write
+---------------------------------------------------------------------*/
NPT_Result 
PLT_RingBufferStream::Write(const void* buffer, 
                            NPT_Size    max_bytes_to_write, 
                            NPT_Size*   _bytes_written /*= NULL*/)
{
    NPT_Size bytes_to_write;
    NPT_Size bytes_written = 0;

    // reset output param first
    if (_bytes_written) *_bytes_written = 0;

    // wait for space
    do {
        {
            NPT_AutoLock autoLock(m_Lock);
            
            if (m_Aborted) {
                return NPT_ERROR_INTERRUPTED;
            }

            // return immediately if we are told we're finished
            if (m_Eos) {
                return NPT_ERROR_EOS;
            }

            if (m_RingBuffer->GetSpace())
                break;

            if (!m_Blocking) {
                return NPT_ERROR_WOULD_BLOCK;
            }
        }

        // sleep and try again
        NPT_System::Sleep(NPT_TimeInterval(.1));
    } while (1);

    {
        NPT_AutoLock autoLock(m_Lock);

        // try twice in case available space was not contiguous
        for (int i=0; i<2; i++) {
            bytes_to_write = min(max_bytes_to_write - bytes_written, m_RingBuffer->GetContiguousSpace());

            // break if no space to write the second time
            if (bytes_to_write == 0) break;

            // write into buffer
            NPT_CHECK(m_RingBuffer->Write((unsigned char*)buffer+bytes_written, bytes_to_write));

            m_TotalBytesWritten += bytes_to_write; 
            bytes_written += bytes_to_write;

            if (_bytes_written) *_bytes_written += bytes_to_write;
        }
    }

    // we have written some chars, so return success
    // even if we have written less than provided
    return NPT_SUCCESS;
}

/*----------------------------------------------------------------------
|   PLT_RingBufferStream::Flush
+---------------------------------------------------------------------*/
NPT_Result 
PLT_RingBufferStream::Flush()
{
    NPT_AutoLock autoLock(m_Lock);

    m_RingBuffer->Flush();
    m_TotalBytesRead = 0;
    m_TotalBytesWritten = 0;
    return NPT_SUCCESS;
}

/*----------------------------------------------------------------------
|   PLT_RingBufferStream::SetEOS
+---------------------------------------------------------------------*/
NPT_Result 
PLT_RingBufferStream::SetEOS() 
{ 
    NPT_AutoLock autoLock(m_Lock); 
    
    m_Eos = true; 
    return NPT_SUCCESS; 
}


/*----------------------------------------------------------------------
 |   PLT_RingBufferStream::Abort
 +---------------------------------------------------------------------*/
NPT_Result 
PLT_RingBufferStream::Abort() 
{ 
    NPT_AutoLock autoLock(m_Lock); 
    
    m_Aborted = true; 
    return NPT_SUCCESS; 
}