xnu-1228.9.59.tar.gz
[apple/xnu.git] / iokit / IOKit / IOEventSource.h
index e3d37759ae55408724e49fbce074813aa49ffb03..ae6060b950864f4653ed72e0db9d9c43de4e125a 100644 (file)
@@ -1,23 +1,29 @@
 /*
  * Copyright (c) 1998-2000 Apple Computer, Inc. All rights reserved.
  *
- * @APPLE_LICENSE_HEADER_START@
+ * @APPLE_OSREFERENCE_LICENSE_HEADER_START@
  * 
- * The contents of this file constitute Original Code as defined in and
- * are subject to the Apple Public Source License Version 1.1 (the
- * "License").  You may not use this file except in compliance with the
- * License.  Please obtain a copy of the License at
- * http://www.apple.com/publicsource and read it before using this file.
+ * This file contains Original Code and/or Modifications of Original Code
+ * as defined in and that are subject to the Apple Public Source License
+ * Version 2.0 (the 'License'). You may not use this file except in
+ * compliance with the License. The rights granted to you under the License
+ * may not be used to create, or enable the creation or redistribution of,
+ * unlawful or unlicensed copies of an Apple operating system, or to
+ * circumvent, violate, or enable the circumvention or violation of, any
+ * terms of an Apple operating system software license agreement.
  * 
- * This Original Code and all software distributed under the License are
- * distributed on an "AS IS" basis, WITHOUT WARRANTY OF ANY KIND, EITHER
+ * Please obtain a copy of the License at
+ * http://www.opensource.apple.com/apsl/ and read it before using this file.
+ * 
+ * The Original Code and all software distributed under the License are
+ * distributed on an 'AS IS' basis, WITHOUT WARRANTY OF ANY KIND, EITHER
  * EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
  * INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
- * FITNESS FOR A PARTICULAR PURPOSE OR NON-INFRINGEMENT.  Please see the
- * License for the specific language governing rights and limitations
- * under the License.
+ * FITNESS FOR A PARTICULAR PURPOSE, QUIET ENJOYMENT OR NON-INFRINGEMENT.
+ * Please see the License for the specific language governing rights and
+ * limitations under the License.
  * 
- * @APPLE_LICENSE_HEADER_END@
+ * @APPLE_OSREFERENCE_LICENSE_HEADER_END@
  */
 /*
 Copyright (c) 1998 Apple Computer, Inc.         All rights reserved.
@@ -68,7 +74,7 @@ attempting to move it.
        All subclasses of the IOEventSource are expected to implement the checkForWork() member function.
 
 <br><br>
-       checkForWork() is the key method in this class.  It is called by some work-loop when convienient and is expected to evaluate it's internal state and determine if an event has occured since the last call.  In the case of an event having occurred then the instance defined target(owner)/action will be called.      The action is stored as an ordinary C function pointer but the first parameter is always the owner.  This means that a C++ member function can be used as an action function though this depends on the ABI.
+       checkForWork() is the key method in this class.  It is called by some work-loop when convienient and is expected to evaluate it's internal state and determine if an event has occurred since the last call.  In the case of an event having occurred then the instance defined target(owner)/action will be called.     The action is stored as an ordinary C function pointer but the first parameter is always the owner.  This means that a C++ member function can be used as an action function though this depends on the ABI.
 <br><br>
        Although the eventChainNext variable contains a reference to the next event source in the chain this reference is not retained.  The list 'owner' i.e. the client that creates the event, not the work-loop, is expected to retain the source.
 */
@@ -176,14 +182,18 @@ IOWorkLoop that at least reacts to signalWorkAvailable() and onThread functions.
 
 protected:
     // Methods to access the IOWorkLoop exported fields
-    inline void signalWorkAvailable()  { workLoop->signalWorkAvailable(); };
-    inline void openGate()             { workLoop->openGate(); };
-    inline void closeGate()            { workLoop->closeGate(); };
-    inline bool tryCloseGate()         { return workLoop->tryCloseGate(); };
-    inline int sleepGate(void *event, UInt32 type)
-        { return workLoop->sleepGate(event, type); };
-    inline void wakeupGate(void *event, bool oneThread)
-        { workLoop->wakeupGate(event, oneThread); };
+    /* inline */ void signalWorkAvailable();
+        /* { workLoop->signalWorkAvailable(); }; */
+    /* inline */ void openGate();
+        /* { workLoop->openGate(); }; */
+    /* inline */ void closeGate();
+        /* { workLoop->closeGate(); }; */
+    /* inline */ bool tryCloseGate();
+        /* { return workLoop->tryCloseGate(); }; */
+    /* inline */ int sleepGate(void *event, UInt32 type);
+        /* { return workLoop->sleepGate(event, type); }; */
+    /* inline */ void wakeupGate(void *event, bool oneThread);
+        /* { workLoop->wakeupGate(event, oneThread); }; */
 
 public:
 /*! @function setAction