File: rt_task_suspend.2

package info (click to toggle)
rtlinux-doc 1.0-2
  • links: PTS
  • area: main
  • in suites: potato, woody
  • size: 96 kB
  • sloc: makefile: 40
file content (61 lines) | stat: -rw-r--r-- 1,882 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
.\"
.\" Copyright (C) 1997 Jerry Epplin.  All rights reserved.
.\"
.\" Permission is granted to make and distribute verbatim copies of this
.\" manual provided the copyright notice and this permission notice are
.\" preserved on all copies.
.\"
.\" Permission is granted to copy and distribute modified versions of this
.\" manual under the conditions for verbatim copying, provided that the
.\" entire resulting derived work is distributed under the terms of a
.\" permission notice identical to this one
.\" 
.\" The author assumes no responsibility for errors or omissions, or for
.\" damages resulting from the use of the information contained herein.
.\" 
.\" Formatted or processed versions of this manual, if unaccompanied by
.\" the source, must acknowledge the copyright and authors of this work.
.\"
.TH RT_TASK_SUSPEND 2 "11 July 1997" "Real-Time Linux" "Real-Time Linux"
.SH NAME
rt_task_suspend \- suspend execution of a real-time task
.SH SYNOPSIS
.nf
.B #define MODULE
.B #include <linux/module.h> 
.B #include <linux/kernel.h> 
.B #include <linux/version.h> 
.B #include <linux/errno.h> 
.B #include <linux/rt_sched.h> 
.fi
.sp
.BI "int rt_task_suspend(RT_TASK *" task ");
.SH DESCRIPTION
.B rt_task_suspend
suspends execution of the real-time task
.IR task .
The task was previously marked for execution using
.BR rt_task_make_periodic .
.PP
Unlike 
.BR rt_task_wait ,
.B rt_task_suspend
suspends execution of the task until another call to 
.B rt_task_make_periodic
is made.
.SH "RETURN VALUE"
Always returns 0.
.SH ERRORS
None.
.SH "SEE ALSO"
.BR rt_get_time (2),
.BR rt_task_delete (2), 
.BR rt_task_init (2), 
.BR rt_task_make_periodic (2),
.BR rt_task_wait (2),
.BR rt_task_wakeup (2)
.SH AUTHOR
This manual page was written by Jerry Epplin. 
.P
Copyright (C) 1997 Jerry Epplin, placed under the GNU General Public
License, see the file copyright for details.