source: vscpl/src/hu/varadiistvan/scpl/io/_posix/ReadingBuffer.h@ 21:22a8774452ac

Last change on this file since 21:22a8774452ac was 6:53519b47b166, checked in by István Váradi <ivaradi@…>, 12 years ago

Imported some further stuff from the IO code

File size: 4.0 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_POSIX_READINGBUFFER_H
30#define HU_VARADIISTVAN_SCPL_IO_POSIX_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.
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 read is 0, that indicates and end-of-file condition.
47 */
48class ReadingBuffer : public StreamBuffer
49{
50protected:
51 /**
52 * Construct the buffer.
53 */
54 ReadingBuffer(size_t capacity, BufferedStream* stream);
55
56public:
57 /**
58 * Read into the buffer using the buffered stream if possible.
59 *
60 * If the buffer contains data, this function returns immediately
61 * with success, so the buffer should be reset before reading.
62 *
63 * If some data can be read immediately, that is stored in the
64 * buffer, and success is indicated. Success is indicated even if
65 * the amount of data read is 0, allowing for signalling the
66 * end-of-file or end-of-connection condition.
67 *
68 * If the reading operation would block, the stream is set up so
69 * that it would read, and failure is returned.
70 *
71 * Otherwise, if the reading operation fails for some other
72 * reason, the buffer's error code is set, so it should always be
73 * checked on a failure!
74 */
75 bool read();
76
77 friend class BufferedStream;
78};
79
80//------------------------------------------------------------------------------
81// Inline definitions
82//------------------------------------------------------------------------------
83
84inline ReadingBuffer::ReadingBuffer(size_t capacity, BufferedStream* stream) :
85 StreamBuffer(capacity, stream)
86{
87}
88
89//------------------------------------------------------------------------------
90
91} /* namespace hu::varadiistvan::scpl::io */ } /* namespace hu::varadiistvan::scpl */ } /* namespace hu::varadiistvan */ } /* namespace hu */
92
93//------------------------------------------------------------------------------
94#endif // HU_VARADIISTVAN_SCPL_IO_POSIX_READINGBUFFER_H
95
96// Local Variables:
97// mode: C++
98// c-basic-offset: 4
99// indent-tabs-mode: nil
100// End:
Note: See TracBrowser for help on using the repository browser.