Now available: The Design and Implementation of the FreeBSD Operating System (Second Edition)
[ source navigation ] [ diff markup ] [ identifier search ] [ freetext search ] [ file search ] [ list types ] [ track identifier ]
FreeBSD/Linux Kernel Cross Reference
sys/man/timer_cancel.man
Version:
- FREEBSD - FREEBSD-13-STABLE - FREEBSD-13-0 - FREEBSD-12-STABLE - FREEBSD-12-0 - FREEBSD-11-STABLE - FREEBSD-11-0 - FREEBSD-10-STABLE - FREEBSD-10-0 - FREEBSD-9-STABLE - FREEBSD-9-0 - FREEBSD-8-STABLE - FREEBSD-8-0 - FREEBSD-7-STABLE - FREEBSD-7-0 - FREEBSD-6-STABLE - FREEBSD-6-0 - FREEBSD-5-STABLE - FREEBSD-5-0 - FREEBSD-4-STABLE - FREEBSD-3-STABLE - FREEBSD22 - l41 - OPENBSD - linux-2.6 - MK84 - PLAN9 - xnu-8792
SearchContext: - none - 3 - 10
SearchContext: - none - 3 - 10
1 .\" 2 .\" Mach Operating System 3 .\" Copyright (c) 1993 Carnegie Mellon University 4 .\" All Rights Reserved. 5 .\" 6 .\" Permission to use, copy, modify and distribute this software and its 7 .\" documentation is hereby granted, provided that both the copyright 8 .\" notice and this permission notice appear in all copies of the 9 .\" software, derivative works or modified versions, and any portions 10 .\" thereof, and that both notices appear in supporting documentation. 11 .\" 12 .\" CARNEGIE MELLON ALLOWS FREE USE OF THIS SOFTWARE IN ITS "AS IS" 13 .\" CONDITION. CARNEGIE MELLON DISCLAIMS ANY LIABILITY OF ANY KIND FOR 14 .\" ANY DAMAGES WHATSOEVER RESULTING FROM THE USE OF THIS SOFTWARE. 15 .\" 16 .\" Carnegie Mellon requests users of this software to return to 17 .\" 18 .\" Software Distribution Coordinator or Software.Distribution@CS.CMU.EDU 19 .\" School of Computer Science 20 .\" Carnegie Mellon University 21 .\" Pittsburgh PA 15213-3890 22 .\" 23 .\" any improvements or extensions that they make and grant Carnegie Mellon 24 .\" the rights to redistribute these changes. 25 .\" 26 .\" 27 .\" HISTORY 28 .\" $Log: timer_cancel.man,v $ 29 .\" Revision 2.2 93/12/07 14:01:03 dbg 30 .\" Created. 31 .\" 32 .\" 33 .TH timer_cancel 2 9/22/93 34 .CM 4 35 .SH NAME 36 .nf 37 timer_cancel \- cancel a timer expiration (disarm a timer) 38 .SH SYNOPSIS 39 .nf 40 .ft B 41 #include <mach.h> 42 43 .nf 44 .ft B 45 kern_return_t 46 timer_cancel( 47 mach_timer_t timer, 48 int flags); 49 50 51 .fi 52 .ft P 53 .SH ARGUMENTS 54 .TP 15 55 .B 56 timer 57 The timer to disarm. 58 .TP 15 59 .B flags 60 Whether to cancel one or all expirations of a 61 periodic timer. 62 63 64 .SH DESCRIPTION 65 .B timer_cancel 66 disarms a currently armed timer. If the timer has been 67 armed with timer_arm, the expiration message will not 68 be sent. If a thread is sleeping on the timer, the 69 thread will be awakened immediately. 70 71 If the timer has been armed to expire periodically, 72 .B flags 73 selects whether to cancel only the next expiration (if 74 .B TIMER_PERIODIC 75 is set in 76 .B flags) 77 or to cancel all expirations. If only the current expiration 78 is canceled, the timer is set to expire at the end of the 79 next period. 80 81 .SH DIAGNOSTICS 82 .TP 25 83 KERN_SUCCESS 84 Operation completed successfully 85 .TP 25 86 KERN_INVALID_ARGUMENT 87 .B timer 88 is not a timer 89 .TP 25 90 KERN_FAILURE 91 .B timer 92 is not currently armed. 93 94 .SH BUGS 95 96 .SH SEE ALSO 97 .B timer_create, timer_terminate, timer_arm, timer_sleep. 98
Cache object: 42110e672eafaca1cd09513e5a633ae5
[ source navigation ] [ diff markup ] [ identifier search ] [ freetext search ] [ file search ] [ list types ] [ track identifier ]