iokit/IOKit/IOSyncer.h

   1 /*
   2  * Copyright (c) 1998-2000 Apple Computer, Inc. All rights reserved.
   3  *
   4  * @APPLE_OSREFERENCE_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. The rights granted to you under the License
  10  * may not be used to create, or enable the creation or redistribution of,
  11  * unlawful or unlicensed copies of an Apple operating system, or to
  12  * circumvent, violate, or enable the circumvention or violation of, any
  13  * terms of an Apple operating system software license agreement.
  14  *
  15  * Please obtain a copy of the License at
  16  * http://www.opensource.apple.com/apsl/ and read it before using this file.
  17  *
  18  * The Original Code and all software distributed under the License are
  19  * distributed on an 'AS IS' basis, WITHOUT WARRANTY OF ANY KIND, EITHER
  20  * EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
  21  * INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
  22  * FITNESS FOR A PARTICULAR PURPOSE, QUIET ENJOYMENT OR NON-INFRINGEMENT.
  23  * Please see the License for the specific language governing rights and
  24  * limitations under the License.
  25  *
  26  * @APPLE_OSREFERENCE_LICENSE_HEADER_END@
  27  */
  28 #ifndef _IOSYNCER_H
  29 #define _IOSYNCER_H
  30
  31 #include <libkern/c++/OSObject.h>
  32 #include <IOKit/IOTypes.h>
  33 #include <IOKit/IOLocks.h>
  34
  35 class IOSyncer : public OSObject
  36 {
  37     OSDeclareDefaultStructors(IOSyncer)
  38
  39 private:
  40     // The spin lock that is used to guard the 'threadMustStop' variable.
  41     IOSimpleLock *guardLock;
  42     volatile bool threadMustStop;
  43     IOReturn fResult;
  44     virtual void free() APPLE_KEXT_OVERRIDE;
  45     virtual void privateSignal();
  46
  47 public:
  48
  49     static IOSyncer * create(bool twoRetains = true)
  50         APPLE_KEXT_DEPRECATED;
  51
  52     virtual bool init(bool twoRetains)
  53         APPLE_KEXT_DEPRECATED;
  54     virtual void reinit()
  55         APPLE_KEXT_DEPRECATED;
  56     virtual IOReturn wait(bool autoRelease = true)
  57         APPLE_KEXT_DEPRECATED;
  58     virtual void signal(IOReturn res = kIOReturnSuccess,
  59                                         bool autoRelease = true)
  60         APPLE_KEXT_DEPRECATED;
  61 };
  62
  63 #endif /* !_IOSYNCER */
  64