/*
- * Copyright (c) 1998-2000 Apple Computer, Inc. All rights reserved.
+ * Copyright (c) 1998-2016 Apple Inc. All rights reserved.
*
- * @APPLE_LICENSE_HEADER_START@
+ * @APPLE_OSREFERENCE_LICENSE_HEADER_START@
*
* 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. Please obtain a copy of the License at
- * http://www.opensource.apple.com/apsl/ and read it before using this
- * file.
+ * 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.
+ *
+ * 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
* 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) 1999 Apple Computer, Inc. All rights reserved.
/*! @function free
@abstract Sub-class implementation of free method, frees calloutEntry */
- virtual void free();
-
-/*! @function checkForWork
- @abstract Have to implement it is mandatory in $link IOEventSource, but IOTimerEventSources don't actually use this work-loop mechanism. */
- virtual bool checkForWork();
+ virtual void free() APPLE_KEXT_OVERRIDE;
- virtual void setWorkLoop(IOWorkLoop *workLoop);
+ virtual void setWorkLoop(IOWorkLoop *workLoop) APPLE_KEXT_OVERRIDE;
public:
/*! @function timerEventSource
@abstract Allocates and returns an initialized timer instance.
- @param owner
- @param action */
+ */
static IOTimerEventSource *
timerEventSource(OSObject *owner, Action action = 0);
/*! @function init
@abstract Initializes the timer with an owner, and a handler to call when the timeout expires.
- @param owner
- @param action */
+ */
virtual bool init(OSObject *owner, Action action = 0);
/*! @function enable
@abstract Enables a call to the action.
@discussion Allows the action function to be called. If the timer event source was disabled while a call was outstanding and the call wasn't cancelled then it will be rescheduled. So a disable/enable pair will disable calls from this event source. */
- virtual void enable();
+ virtual void enable() APPLE_KEXT_OVERRIDE;
/*! @function disable
@abstract Disable a timed callout.
@discussion When disable returns the action will not be called until the next time enable(qv) is called. */
- virtual void disable();
+ virtual void disable() APPLE_KEXT_OVERRIDE;
/*! @function setTimeoutTicks
@abstract Setup a callback at after the delay in scheduler ticks. See wakeAtTime(AbsoluteTime).
- @param interval Delay from now to wake up, in scheduler ticks, whatever that may be.
+ @param ticks Delay from now to wake up, in scheduler ticks, whatever that may be.
@result kIOReturnSuccess if everything is fine, kIOReturnNoResources if action hasn't been declared. */
virtual IOReturn setTimeoutTicks(UInt32 ticks);
/*! @function setTimeoutMS
@abstract Setup a callback at after the delay in milliseconds. See wakeAtTime(AbsoluteTime).
- @param interval Delay from now to wake up, time in milliseconds.
+ @param ms Delay from now to wake up, time in milliseconds.
@result kIOReturnSuccess if everything is fine, kIOReturnNoResources if action hasn't been declared. */
virtual IOReturn setTimeoutMS(UInt32 ms);
/*! @function setTimeoutUS
@abstract Setup a callback at after the delay in microseconds. See wakeAtTime(AbsoluteTime).
- @param interval Delay from now to wake up, time in microseconds.
+ @param us Delay from now to wake up, time in microseconds.
@result kIOReturnSuccess if everything is fine, kIOReturnNoResources if action hasn't been declared. */
virtual IOReturn setTimeoutUS(UInt32 us);
virtual IOReturn setTimeout(UInt32 interval,
UInt32 scale_factor = kNanosecondScale);
-/*! @function setTimeout
- @abstract Setup a callback at after the delay in decrementer ticks. See wakeAtTime(AbsoluteTime).
- @param interval Delay from now to wake up.
- @result kIOReturnSuccess if everything is fine, kIOReturnNoResources if action hasn't been declared. */
- virtual IOReturn setTimeout(mach_timespec_t interval);
+#if !defined(__LP64__)
+ virtual IOReturn setTimeout(mach_timespec_t interval)
+ APPLE_KEXT_DEPRECATED;
+#endif
/*! @function setTimeout
@abstract Setup a callback at after the delay in decrementer ticks. See wakeAtTime(AbsoluteTime).
/*! @function wakeAtTimeTicks
@abstract Setup a callback at this absolute time. See wakeAtTime(AbsoluteTime).
- @param abstime Time to wake up in scheduler quantums, whatever that is?
+ @param ticks Time to wake up in scheduler quantums, whatever that is?
@result kIOReturnSuccess if everything is fine, kIOReturnNoResources if action hasn't been declared. */
virtual IOReturn wakeAtTimeTicks(UInt32 ticks);
/*! @function wakeAtTimeMS
@abstract Setup a callback at this absolute time. See wakeAtTime(AbsoluteTime).
- @param abstime Time to wake up in milliseconds.
+ @param ms Time to wake up in milliseconds.
@result kIOReturnSuccess if everything is fine, kIOReturnNoResources if action hasn't been declared. */
virtual IOReturn wakeAtTimeMS(UInt32 ms);
/*! @function wakeAtTimeUS
@abstract Setup a callback at this absolute time. See wakeAtTime(AbsoluteTime).
- @param abstime Time to wake up in microseconds.
+ @param us Time to wake up in microseconds.
@result kIOReturnSuccess if everything is fine, kIOReturnNoResources if action hasn't been declared. */
virtual IOReturn wakeAtTimeUS(UInt32 us);
virtual IOReturn wakeAtTime(UInt32 abstime,
UInt32 scale_factor = kNanosecondScale);
-/*! @function wakeAtTime
- @abstract Setup a callback at this absolute time. See wakeAtTime(AbsoluteTime).
- @param abstime mach_timespec_t of the desired callout time.
- @result kIOReturnSuccess if everything is fine, kIOReturnNoResources if action hasn't been declared. */
- virtual IOReturn wakeAtTime(mach_timespec_t abstime);
+#if !defined(__LP64__)
+ virtual IOReturn wakeAtTime(mach_timespec_t abstime)
+ APPLE_KEXT_DEPRECATED;
+#endif
/*! @function wakeAtTime
@abstract Setup a callback at this absolute time.
projects / apple / xnu.git / blobdiff