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_WIN32_WRITINGBUFFER_H
|
---|
31 | #define XPLCOMMON_WIN32_WRITINGBUFFER_H
|
---|
32 | //------------------------------------------------------------------------------
|
---|
33 |
|
---|
34 | #include "StreamBuffer.h"
|
---|
35 |
|
---|
36 | //------------------------------------------------------------------------------
|
---|
37 |
|
---|
38 | namespace xplcommon { namespace win32 {
|
---|
39 |
|
---|
40 | //------------------------------------------------------------------------------
|
---|
41 |
|
---|
42 | /**
|
---|
43 | * A buffer used for writing into a buffered stream.
|
---|
44 | *
|
---|
45 | * The data to write should be stored in the buffer. Then write()
|
---|
46 | * should be called. If it returns true, it indicates that all data
|
---|
47 | * has been written. In that case the buffer is automatically emptied.
|
---|
48 | */
|
---|
49 | class WritingBuffer : public StreamBuffer
|
---|
50 | {
|
---|
51 | protected:
|
---|
52 | /**
|
---|
53 | * Construct the buffer.
|
---|
54 | */
|
---|
55 | WritingBuffer(size_t capacity, BufferedStream* stream);
|
---|
56 |
|
---|
57 | public:
|
---|
58 | /**
|
---|
59 | * Write the contents of the buffer using the associated buffered
|
---|
60 | * stream.
|
---|
61 | *
|
---|
62 | * If the buffer is empty, the function returns indicating
|
---|
63 | * success.
|
---|
64 | *
|
---|
65 | * If the complete remaining contents could be written, it also indicates
|
---|
66 | * success, and the buffer is reset, ready to be used again.
|
---|
67 | *
|
---|
68 | * If not everything can be written and the write operation
|
---|
69 | * indicates that it would block, this function returns failure
|
---|
70 | * after the stream has been set up to handle the corresponding
|
---|
71 | * poll events.
|
---|
72 | *
|
---|
73 | * Otherwise, if the writing operation fails for some other
|
---|
74 | * reason, the buffer's error code is set to the error's code and
|
---|
75 | * false is returned.
|
---|
76 | */
|
---|
77 | bool write();
|
---|
78 |
|
---|
79 | friend class BufferedStream;
|
---|
80 | };
|
---|
81 |
|
---|
82 | //------------------------------------------------------------------------------
|
---|
83 | // Inline definitions
|
---|
84 | //------------------------------------------------------------------------------
|
---|
85 |
|
---|
86 | inline WritingBuffer::WritingBuffer(size_t capacity, BufferedStream* stream) :
|
---|
87 | StreamBuffer(capacity, stream)
|
---|
88 | {
|
---|
89 | }
|
---|
90 |
|
---|
91 | //------------------------------------------------------------------------------
|
---|
92 |
|
---|
93 | } /* namespace xplcommon::win32 */ } /* namespace xplcommon */
|
---|
94 |
|
---|
95 | //------------------------------------------------------------------------------
|
---|
96 | #endif // XPLCOMMON_WIN32_WRITINGBUFFER_H
|
---|
97 |
|
---|
98 | // Local Variables:
|
---|
99 | // mode: C++
|
---|
100 | // c-basic-offset: 4
|
---|
101 | // indent-tabs-mode: nil
|
---|
102 | // End:
|
---|