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

Last change on this file since 41:5638d7767730 was 7:e0118c752a06, checked in by István Váradi <ivaradi@…>, 12 years ago

Imported the WaitableEvent class

File size: 3.8 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_WAITABLEEVENT_H
30#define HU_VARADIISTVAN_SCPL_IO_WAITABLEEVENT_H
31//------------------------------------------------------------------------------
32
33#if 0 // The public interface of WaitableEvent
34
35//------------------------------------------------------------------------------
36
37namespace hu { namespace varadiistvan { namespace scpl { namespace io {
38
39//------------------------------------------------------------------------------
40
41/**
42 * An event on which one can wait with a waiter.
43 */
44class WaitableEvent : public Failable
45{
46public:
47 /**
48 * Construct the event.
49 *
50 * @param waiter the waiter to be used for waiting. If given, the
51 * check() function will always return immediately. If not given,
52 * the check() function may block and returns only when the event
53 * is fired.
54 */
55 WaitableEvent(Waiter* waiter = 0);
56
57 /**
58 * Destroy the event.
59 */
60 virtual ~WaitableEvent();
61
62 /**
63 * Fire the event.
64 */
65 void fire();
66
67 /**
68 * Check if the event is fired or not. If so, the fired status
69 * will be cleared.
70 */
71 bool check();
72};
73
74//------------------------------------------------------------------------------
75
76} /* namespace hu::varadiistvan::scpl::io */ } /* namespace hu::varadiistvan::scpl */ } /* namespace hu::varadiistvan */ } /* namespace hu */
77
78//------------------------------------------------------------------------------
79
80#endif // 0, The public interface of WaitableEvent
81
82//------------------------------------------------------------------------------
83
84#include "hu/varadiistvan/scpl/config.h"
85
86//------------------------------------------------------------------------------
87
88#if TARGET_API_POSIX
89
90#include "_posix/WaitableEvent.h"
91
92//------------------------------------------------------------------------------
93
94#elif TARGET_API_WIN32 || TARGET_API_WIN64
95
96#include "_win32/WaitableEvent.h"
97
98//------------------------------------------------------------------------------
99
100#else
101
102#error "Not implemented for this target!"
103
104#endif
105
106//------------------------------------------------------------------------------
107#endif // HU_VARADIISTVAN_SCPL_WAITABLEEVENT_H
108
109// Local Variables:
110// mode: C++
111// c-basic-offset: 4
112// indent-tabs-mode: nil
113// End:
Note: See TracBrowser for help on using the repository browser.