iokit/IOKit/IOSyncer.h

   1 /*
   2  * Copyright (c) 1998-2000 Apple Computer, Inc. All rights reserved.
   3  *
   4  * @APPLE_LICENSE_HEADER_START@
   5  *
   6  * This file contains Original Code and/or Modifications of Original Code
   7  * as defined in and that are subject to the Apple Public Source License
   8  * Version 2.0 (the 'License'). You may not use this file except in
   9  * compliance with the License. Please obtain a copy of the License at
  10  * http://www.opensource.apple.com/apsl/ and read it before using this
  11  * file.
  12  *
  13  * The Original Code and all software distributed under the License are
  14  * distributed on an 'AS IS' basis, WITHOUT WARRANTY OF ANY KIND, EITHER
  15  * EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
  16  * INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
  17  * FITNESS FOR A PARTICULAR PURPOSE, QUIET ENJOYMENT OR NON-INFRINGEMENT.
  18  * Please see the License for the specific language governing rights and
  19  * limitations under the License.
  20  *
  21  * @APPLE_LICENSE_HEADER_END@
  22  */
  23 #ifndef _IOSYNCER_H
  24 #define _IOSYNCER_H
  25
  26 #include <libkern/c++/OSObject.h>
  27 #include <IOKit/IOTypes.h>
  28 #include <IOKit/IOLocks.h>
  29
  30 class IOSyncer : public OSObject
  31 {
  32     OSDeclareDefaultStructors(IOSyncer)
  33
  34 private:
  35     // The spin lock that is used to guard the 'threadMustStop' variable.
  36     IOSimpleLock *guardLock;
  37     volatile bool threadMustStop;
  38     IOReturn fResult;
  39     virtual void free();
  40     virtual void privateSignal();
  41
  42 public:
  43
  44     static IOSyncer * create(bool twoRetains = true);
  45
  46     virtual bool init(bool twoRetains);
  47     virtual void reinit();
  48     virtual IOReturn wait(bool autoRelease = true);
  49     virtual void signal(IOReturn res = kIOReturnSuccess,
  50                                         bool autoRelease = true);
  51 };
  52
  53 #endif /* !_IOSYNCER */
  54