source: vscpl/src/hu/varadiistvan/scpl/io/_win32/ReadingBuffer.h@ 30:f043778c833a

Last change on this file since 30:f043778c833a was 9:84f0dcb053b4, checked in by István Váradi <ivaradi@…>, 12 years ago

Imported the Win32-specific I/O code

File size: 4.2 KB
Line 
1// Copyright (c) 2013 by István Váradi
2
3// This file is part of VSCPL, a simple cross-platform utility library
4
5// Redistribution and use in source and binary forms, with or without
6// modification, are permitted provided that the following conditions are met:
7
8// 1. Redistributions of source code must retain the above copyright notice, this
9// list of conditions and the following disclaimer.
10// 2. Redistributions in binary form must reproduce the above copyright notice,
11// this list of conditions and the following disclaimer in the documentation
12// and/or other materials provided with the distribution.
13
14// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
15// ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
16// WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
17// DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR
18// ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
19// (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
20// LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
21// ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
22// (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
23// SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
24
25// The views and conclusions contained in the software and documentation are those
26// of the authors and should not be interpreted as representing official policies,
27// either expressed or implied, of the FreeBSD Project.
28
29#ifndef HU_VARADIISTVAN_SCPL_IO_WIN32_READINGBUFFER_H
30#define HU_VARADIISTVAN_SCPL_IO_WIN32_READINGBUFFER_H
31//------------------------------------------------------------------------------
32
33#include "StreamBuffer.h"
34
35//------------------------------------------------------------------------------
36
37namespace hu { namespace varadiistvan { namespace scpl { namespace io {
38
39//------------------------------------------------------------------------------
40
41/**
42 * A buffer used for reading from a stream buffer.
43 *
44 * It should be made empty, and then the function read() should be
45 * called on it. If it returns true, some data could be read. If the
46 * amount of data in the buffer is then 0, that indicates and
47 * end-of-file condition.
48 */
49class ReadingBuffer : public StreamBuffer
50{
51protected:
52 /**
53 * Construct the buffer.
54 */
55 ReadingBuffer(size_t capacity, BufferedStream* stream);
56
57public:
58 /**
59 * Read into the buffer using the buffered stream if possible.
60 *
61 * If the buffer contains data, this function returns immediately
62 * with success, so the buffer should be reset before reading.
63 *
64 * If some data can be read immediately, that is stored in the
65 * buffer, and success is indicated. Success is indicated even if
66 * the amount of data read is 0, allowing for signalling the
67 * end-of-file or end-of-connection condition.
68 *
69 * If the reading operation would block, the stream is set up so
70 * that it would read, and failure is returned.
71 *
72 * Otherwise, if the reading operation fails for some other
73 * reason, the buffer's error code is set, so it should always be
74 * checked on a failure!
75 */
76 bool read();
77
78protected:
79 /**
80 * Set the buffer's length to the given value.
81 *
82 * @see Completer::handleWaitedResult
83 */
84 virtual void handleWaitedResult(DWORD size);
85
86 friend class BufferedStream;
87};
88
89//------------------------------------------------------------------------------
90// Inline definitions
91//------------------------------------------------------------------------------
92
93inline ReadingBuffer::ReadingBuffer(size_t capacity, BufferedStream* stream) :
94 StreamBuffer(capacity, stream)
95{
96}
97
98//------------------------------------------------------------------------------
99
100} /* namespace hu::varadiistvan::scpl::io */ } /* namespace hu::varadiistvan::scpl */ } /* namespace hu::varadiistvan */ } /* namespace hu */
101
102//------------------------------------------------------------------------------
103#endif // HU_VARADIISTVAN_SCPL_IO_WIN32_READINGBUFFER_H
104
105// Local Variables:
106// mode: C++
107// c-basic-offset: 4
108// indent-tabs-mode: nil
109// End:
Note: See TracBrowser for help on using the repository browser.