iokit/IOKit/IOSyncer.h

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