| Qore FileLocationHandler Module Reference 2.1

OutputStramWrapper.qc.dox.h
1 // -*- mode: c++; indent-tabs-mode: nil -*-
3
4 /* FileLocationHandler Copyright 2021 - 2022 Qore Technologies, s.r.o.
5
6 Permission is hereby granted, free of charge, to any person obtaining a
7 copy of this software and associated documentation files (the "Software"),
8 to deal in the Software without restriction, including without limitation
9 the rights to use, copy, modify, merge, publish, distribute, sublicense,
10 and/or sell copies of the Software, and to permit persons to whom the
11 Software is furnished to do so, subject to the following conditions:
12
13 The above copyright notice and this permission notice shall be included in
14 all copies or substantial portions of the Software.
15
16 THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
17 IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
18 FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
19 AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
20 LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
21 FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
22 DEALINGS IN THE SOFTWARE.
23 */
24
26 namespace FileLocationHandler {
28 class OutputStreamWrapper : public Qore::OutputStream {
29
30 public:
31
32 private:
34 Qore::OutputStream stream;
35
37 Qore::Thread::Counter cnt;
38
39 public:
40
42 constructor(Qore::OutputStream stream, Qore::Thread::Counter cnt);
43
44
46 Qore::OutputStream getStream();
47
48
50 waitForIo();
51
52
54
56 close();
57
58
60
68 write(binary data);
69
70
72 methodGate(string m);
73
74 };
75 };
FileLocationHandler::OutputStreamWrapper
The abstract file location handler class.
Definition: OutputStramWrapper.qc.dox.h:28
FileLocationHandler::OutputStreamWrapper::waitForIo
waitForIo()
Wait for any background I/O to complete.
FileLocationHandler::OutputStreamWrapper::stream
Qore::OutputStream stream
The output stream object.
Definition: OutputStramWrapper.qc.dox.h:34
FileLocationHandler::OutputStreamWrapper::cnt
Qore::Thread::Counter cnt
The synchronization Counter.
Definition: OutputStramWrapper.qc.dox.h:37
FileLocationHandler::OutputStreamWrapper::write
write(binary data)
Writes bytes to the output stream.
FileLocationHandler::OutputStreamWrapper::close
close()
Flushes any buffered (unwritten) bytes, closes the output stream and releases all resources.
FileLocationHandler::OutputStreamWrapper::getStream
Qore::OutputStream getStream()
Returns the output stream.
FileLocationHandler::OutputStreamWrapper::methodGate
methodGate(string m)
Redirects any method calls to the stream.
FileLocationHandler::OutputStreamWrapper::constructor
constructor(Qore::OutputStream stream, Qore::Thread::Counter cnt)
Creates the output stream wrapper object.
Qore::OutputStream
Qore::Thread::Counter
binary
binary binary()
FileLocationHandler
Contains all public definitions in the FileLocationHandler module.
Definition: FileLocationHandler.qc.dox.h:26