source: vscpl/src/hu/varadiistvan/scpl/io/Waiter.h@ 19:0739d3edb6b7

Last change on this file since 19:0739d3edb6b7 was 6:53519b47b166, checked in by István Váradi <ivaradi@…>, 12 years ago

Imported some further stuff from the IO code

File size: 3.6 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_WAITER_H
30#define HU_VARADIISTVAN_SCPL_IO_WAITER_H
31//------------------------------------------------------------------------------
32
33#if 0 // The public interface of Waiter
34
35//------------------------------------------------------------------------------
36
37namespace hu { namespace varadiistvan { namespace scpl { namespace io {
38
39//------------------------------------------------------------------------------
40
41/**
42 * Class that can be used to register waitable objects and then wait
43 * for them. The objects are registered when they created and a Waiter
44 * instance is passed to them.
45 */
46class Waiter : public Failable
47{
48public:
49 /**
50 * Wait for any if the waitables to become ready or until a
51 * timeout expires.
52 *
53 * If any of the waitables are ready, the function returns immediately.
54 *
55 * @return true if any of the waitables has become ready, false if
56 * the timeout occurs.
57 */
58 bool wait(int timeout = -1);
59};
60
61//------------------------------------------------------------------------------
62
63} /* namespace hu::varadiistvan::scpl::io */ } /* namespace hu::varadiistvan::scpl */ } /* namespace hu::varadiistvan */ } /* namespace hu */
64
65//------------------------------------------------------------------------------
66
67#endif // 0, The public interface of Waiter
68
69//------------------------------------------------------------------------------
70
71#include "hu/varadiistvan/scpl/config.h"
72
73//------------------------------------------------------------------------------
74
75#if TARGET_API_POSIX
76
77#include "_posix/Waiter.h"
78
79//------------------------------------------------------------------------------
80
81#elif TARGET_API_WIN32 || TARGET_API_WIN64
82
83#include "_win32/Waiter.h"
84
85//------------------------------------------------------------------------------
86
87#else
88
89#error "Not implemented for this target!"
90
91#endif
92
93//------------------------------------------------------------------------------
94#endif // HU_VARADIISTVAN_SCPL_WAITER_H
95
96// Local Variables:
97// mode: C++
98// c-basic-offset: 4
99// indent-tabs-mode: nil
100// End:
Note: See TracBrowser for help on using the repository browser.