1 | // Copyright (c) 2012 by István Váradi
|
---|
2 |
|
---|
3 | // This file is part of libxplcommon, a common utility library for
|
---|
4 | // development related to X-Plane
|
---|
5 |
|
---|
6 | // Redistribution and use in source and binary forms, with or without
|
---|
7 | // modification, are permitted provided that the following conditions are met:
|
---|
8 |
|
---|
9 | // 1. Redistributions of source code must retain the above copyright notice, this
|
---|
10 | // list of conditions and the following disclaimer.
|
---|
11 | // 2. Redistributions in binary form must reproduce the above copyright notice,
|
---|
12 | // this list of conditions and the following disclaimer in the documentation
|
---|
13 | // and/or other materials provided with the distribution.
|
---|
14 |
|
---|
15 | // THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
|
---|
16 | // ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
|
---|
17 | // WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
|
---|
18 | // DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR
|
---|
19 | // ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
|
---|
20 | // (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
|
---|
21 | // LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
|
---|
22 | // ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
|
---|
23 | // (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
|
---|
24 | // SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
|
---|
25 |
|
---|
26 | // The views and conclusions contained in the software and documentation are those
|
---|
27 | // of the authors and should not be interpreted as representing official policies,
|
---|
28 | // either expressed or implied, of the FreeBSD Project.
|
---|
29 |
|
---|
30 | #ifndef XPLCOMMON_READINGBUFFER_H
|
---|
31 | #define XPLCOMMON_READINGBUFFER_H
|
---|
32 | //------------------------------------------------------------------------------
|
---|
33 |
|
---|
34 | #include "Buffer.h"
|
---|
35 | #include "Failable.h"
|
---|
36 |
|
---|
37 | //------------------------------------------------------------------------------
|
---|
38 |
|
---|
39 | #if 0 // The public interface of a reading buffer
|
---|
40 |
|
---|
41 | //------------------------------------------------------------------------------
|
---|
42 |
|
---|
43 | namespace xplcommon {
|
---|
44 |
|
---|
45 | //------------------------------------------------------------------------------
|
---|
46 |
|
---|
47 | /**
|
---|
48 | * A buffer used for reading from a buffered stream. It cannot be
|
---|
49 | * created directly, only acquired from the stream.
|
---|
50 | *
|
---|
51 | * It should be made empty, and then the function read() should be
|
---|
52 | * called on it. If it returns true, some data could be read. If the
|
---|
53 | * amount of data read is 0, that indicates and end-of-file condition.
|
---|
54 | */
|
---|
55 | class ReadingBuffer : public Buffer, public FailableReference<ReadingBuffer>
|
---|
56 | {
|
---|
57 | public:
|
---|
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 | };
|
---|
78 |
|
---|
79 | //------------------------------------------------------------------------------
|
---|
80 |
|
---|
81 | } /* namespace xplcommon */
|
---|
82 |
|
---|
83 | //------------------------------------------------------------------------------
|
---|
84 |
|
---|
85 | #endif // 0, The public interface of a reading buffer
|
---|
86 |
|
---|
87 | //------------------------------------------------------------------------------
|
---|
88 |
|
---|
89 | #include "config.h"
|
---|
90 |
|
---|
91 | //------------------------------------------------------------------------------
|
---|
92 |
|
---|
93 | #if TARGET_API_WIN32
|
---|
94 |
|
---|
95 | //------------------------------------------------------------------------------
|
---|
96 |
|
---|
97 | #include "win32/ReadingBuffer.h"
|
---|
98 |
|
---|
99 | namespace xplcommon { typedef win32::ReadingBuffer ReadingBuffer; }
|
---|
100 |
|
---|
101 | //------------------------------------------------------------------------------
|
---|
102 |
|
---|
103 | #else // TARGET_API_WIN32
|
---|
104 |
|
---|
105 | //------------------------------------------------------------------------------
|
---|
106 |
|
---|
107 | #include "posix/ReadingBuffer.h"
|
---|
108 |
|
---|
109 | namespace xplcommon { typedef posix::ReadingBuffer ReadingBuffer; }
|
---|
110 |
|
---|
111 | //------------------------------------------------------------------------------
|
---|
112 |
|
---|
113 | #endif // TARGET_API_WIN32
|
---|
114 |
|
---|
115 | //------------------------------------------------------------------------------
|
---|
116 | #endif // XPLCOMMON_READINGBUFFER_H
|
---|
117 |
|
---|
118 | // Local Variables:
|
---|
119 | // mode: C++
|
---|
120 | // c-basic-offset: 4
|
---|
121 | // indent-tabs-mode: nil
|
---|
122 | // End:
|
---|