source: vscpl/src/hu/varadiistvan/scpl/io/WritingBuffer.h@ 41:5638d7767730

Last change on this file since 41:5638d7767730 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.4 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_WRITINGBUFFER_H
30#define HU_VARADIISTVAN_SCPL_IO_WRITINGBUFFER_H
31//------------------------------------------------------------------------------
32
33#if 0 // The public interface of WritingBuffer
34
35//------------------------------------------------------------------------------
36
37namespace hu { namespace varadiistvan { namespace scpl { namespace io {
38
39//------------------------------------------------------------------------------
40
41/**
42 * A buffer used for writing into a buffered stream. It cannot be
43 * created directly, only acquired from the 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 */
49class WritingBuffer : public Buffer, public FailableReference<WritingBuffer>
50{
51public:
52 /**
53 * Reset the buffer. It resets the offset too.
54 */
55 void reset();
56
57 /**
58 * Write the contents of the buffer using the associated buffered
59 * stream.
60 *
61 * If the buffer is empty, the function returns indicating
62 * success.
63 *
64 * If the complete remaining contents could be written, it also indicates
65 * success, and the buffer is reset, ready to be used again.
66 *
67 * If not everything can be written and the write operation
68 * indicates that it would block, this function returns failure
69 * after the stream has been set up to handle the corresponding
70 * poll events.
71 *
72 * Otherwise, if the writing operation fails for some other
73 * reason, the buffer's error code is set to the error's code and
74 * false is returned.
75 */
76 bool write();
77};
78
79//------------------------------------------------------------------------------
80
81} /* namespace hu::varadiistvan::scpl::io */ } /* namespace hu::varadiistvan::scpl */ } /* namespace hu::varadiistvan */ } /* namespace hu */
82
83//------------------------------------------------------------------------------
84
85#endif // 0, The public interface of WritingBuffer
86
87//------------------------------------------------------------------------------
88
89#include "hu/varadiistvan/scpl/config.h"
90
91//------------------------------------------------------------------------------
92
93#if TARGET_API_POSIX
94
95#include "_posix/WritingBuffer.h"
96
97//------------------------------------------------------------------------------
98
99#elif TARGET_API_WIN32 || TARGET_API_WIN64
100
101#include "_win32/WritingBuffer.h"
102
103//------------------------------------------------------------------------------
104
105#else
106
107#error "Not implemented for this target!"
108
109#endif
110
111//------------------------------------------------------------------------------
112#endif // HU_VARADIISTVAN_SCPL_WRITINGBUFFER_H
113
114// Local Variables:
115// mode: C++
116// c-basic-offset: 4
117// indent-tabs-mode: nil
118// End:
Note: See TracBrowser for help on using the repository browser.