osfmk/mach/mk_timer.h

   1 /*
   2  * Copyright (c) 2000-2005 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 /*
  29  * Copyright (c) 2000 Apple Computer, Inc.  All rights reserved.
  30  *
  31  * HISTORY
  32  *
  33  * 31 August 2000 (debo)
  34  *  Created.
  35  */
  36
  37 #ifndef _MACH_MK_TIMER_H_
  38 #define _MACH_MK_TIMER_H_
  39
  40 #include <mach/mach_time.h>
  41 #include <sys/cdefs.h>
  42
  43 __BEGIN_DECLS
  44
  45 mach_port_name_t        mk_timer_create(void);
  46
  47 kern_return_t   mk_timer_destroy(
  48         mach_port_name_t        name);
  49
  50 kern_return_t   mk_timer_arm(
  51         mach_port_name_t        name,
  52         uint64_t                        expire_time);
  53
  54 kern_return_t   mk_timer_cancel(
  55         mach_port_name_t        name,
  56         uint64_t                        *result_time);
  57 #define MK_TIMER_NORMAL (0)
  58 #define MK_TIMER_CRITICAL (1)
  59 kern_return_t   mk_timer_arm_leeway(
  60         mach_port_name_t        name,
  61         uint64_t                mk_timer_flags,
  62         uint64_t                mk_timer_expire_time,
  63         uint64_t                mk_timer_leeway);
  64
  65 __END_DECLS
  66
  67 #pragma pack(4)
  68 struct mk_timer_expire_msg {
  69         mach_msg_header_t       header;
  70         uint64_t                        unused[3];
  71 };
  72 #pragma pack()
  73
  74 typedef struct mk_timer_expire_msg              mk_timer_expire_msg_t;
  75
  76 #endif /* _MACH_MK_TIMER_H_ */