source: vscpl/src/hu/varadiistvan/scpl/io/_win32/Overlapped.h@ 43:8e77881a3032

Last change on this file since 43:8e77881a3032 was 9:84f0dcb053b4, checked in by István Váradi <ivaradi@…>, 12 years ago

Imported the Win32-specific I/O code

File size: 4.5 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_WIN32_OVERLAPPED_H
30#define HU_VARADIISTVAN_SCPL_IO_WIN32_OVERLAPPED_H
31//------------------------------------------------------------------------------
32
33#include "Event.h"
34
35//------------------------------------------------------------------------------
36
37namespace hu { namespace varadiistvan { namespace scpl { namespace io {
38
39//------------------------------------------------------------------------------
40
41/**
42 * A wrapper for an OVERLAPPED structure which also has an event
43 * associated with it. Instances of this class can be registered into and
44 * unregistered from a Waiter. The destructor removes the object from
45 * the waiter, if it is registered.
46 */
47class Overlapped : public Event
48{
49private:
50 /**
51 * The Windows OVERLAPPED structure.
52 */
53 OVERLAPPED overlapped;
54
55public:
56 /**
57 * Construct the object. The overlapped structure will be reset to
58 * 0, and the event handle will be set.
59 */
60 Overlapped(EventFailable& eventFailable);
61
62 /**
63 * Reset the overlapped structure and set its event handle. The
64 * event is also cleared.
65 */
66 void reset();
67
68 /**
69 * Get the pointer to the overlapped structure.
70 */
71 OVERLAPPED* get();
72
73 /**
74 * Get the pointer to the overlapped structure.
75 */
76 const OVERLAPPED* get() const;
77
78 /**
79 * Get the result of the overlapped operation.
80 *
81 * If the operation has completed, the event will be cleared.
82 *
83 * @param size on successful return, it will contain the number of
84 * bytes read or written, which may be 0 for an end-of-file
85 * condition
86 * @param file the handle of the object on which the operation in
87 * question was performed
88 *
89 * @return true if the operation has completed, or false if it has
90 * not, or a failure has occured.
91 */
92 bool getResult(DWORD& size, HANDLE file);
93};
94
95//------------------------------------------------------------------------------
96// Inline definitions
97//------------------------------------------------------------------------------
98
99inline Overlapped::Overlapped(EventFailable& eventFailable) :
100 Event(eventFailable)
101{
102}
103
104//------------------------------------------------------------------------------
105
106inline OVERLAPPED* Overlapped::get()
107{
108 return &overlapped;
109}
110
111//------------------------------------------------------------------------------
112
113inline const OVERLAPPED* Overlapped::get() const
114{
115 return &overlapped;
116}
117
118//------------------------------------------------------------------------------
119
120} /* namespace hu::varadiistvan::scpl::io */ } /* namespace hu::varadiistvan::scpl */ } /* namespace hu::varadiistvan */ } /* namespace hu */
121
122//------------------------------------------------------------------------------
123#endif // HU_VARADIISTVAN_SCPL_IO_WIN32_OVERLAPPED_H
124
125// Local Variables:
126// mode: C++
127// c-basic-offset: 4
128// indent-tabs-mode: nil
129// End:
Note: See TracBrowser for help on using the repository browser.