src/OS/OverlappedEvent.hpp

   1 /*
   2 Copyright_License {
   3
   4   XCSoar Glide Computer - http://www.xcsoar.org/
   5   Copyright (C) 2000-2013 The XCSoar Project
   6   A detailed list of copyright holders can be found in the file "AUTHORS".
   7
   8   This program is free software; you can redistribute it and/or
   9   modify it under the terms of the GNU General Public License
  10   as published by the Free Software Foundation; either version 2
  11   of the License, or (at your option) any later version.
  12
  13   This program is distributed in the hope that it will be useful,
  14   but WITHOUT ANY WARRANTY; without even the implied warranty of
  15   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  16   GNU General Public License for more details.
  17
  18   You should have received a copy of the GNU General Public License
  19   along with this program; if not, write to the Free Software
  20   Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
  21 }
  22 */
  23
  24 #ifndef XCSOAR_OVERLAPPED_EVENT_HPP
  25 #define XCSOAR_OVERLAPPED_EVENT_HPP
  26
  27 #include <windows.h>
  28
  29 class OverlappedEvent {
  30   OVERLAPPED os;
  31
  32 public:
  33   enum WaitResult {
  34     FINISHED,
  35     TIMEOUT,
  36     CANCELED,
  37   };
  38
  39 public:
  40   OverlappedEvent()
  41   {
  42     os.Offset = os.OffsetHigh = 0;
  43     os.Internal = os.InternalHigh = 0;
  44
  45     os.hEvent = CreateEvent(NULL, TRUE, FALSE, NULL);
  46   }
  47
  48   ~OverlappedEvent() {
  49     ::CloseHandle(os.hEvent);
  50   }
  51
  52   bool Defined() const {
  53     return os.hEvent != NULL;
  54   }
  55
  56   OVERLAPPED *GetPointer() {
  57     return &os;
  58   }
  59
  60   WaitResult Wait(unsigned timeout_ms=INFINITE) {
  61     switch (::WaitForSingleObject(os.hEvent, timeout_ms)) {
  62     case WAIT_OBJECT_0:
  63       return FINISHED;
  64
  65     case WAIT_TIMEOUT:
  66       return TIMEOUT;
  67
  68     default:
  69       return CANCELED;
  70     }
  71   }
  72 };
  73
  74 #endif