rt_task_make_periodic.3

rtlinux-3.1源代码

.\" This -*- nroff -*- file has been generated from
.\" DocBook SGML with docbook-to-man on Debian GNU/Linux.
...\"
...\"	transcript compatibility for postscript use.
...\"
...\"	synopsis:  .P! <file.ps>
...\"
.de P!
\\&.
.fl			\" force out current output buffer
\\!%PB
\\!/showpage{}def
...\" the following is from Ken Flowers -- it prevents dictionary overflows
\\!/tempdict 200 dict def tempdict begin
.fl			\" prolog
.sy cat \\$1\" bring in postscript file
...\" the following line matches the tempdict above
\\!end % tempdict %
\\!PE
\\!.
.sp \\$2u	\" move below the image
..
.de pF
.ie     \\*(f1 .ds f1 \\n(.f
.el .ie \\*(f2 .ds f2 \\n(.f
.el .ie \\*(f3 .ds f3 \\n(.f
.el .ie \\*(f4 .ds f4 \\n(.f
.el .tm ? font overflow
.ft \\$1
..
.de fP
.ie     !\\*(f4 \{\
.	ft \\*(f4
.	ds f4\"
'	br \}
.el .ie !\\*(f3 \{\
.	ft \\*(f3
.	ds f3\"
'	br \}
.el .ie !\\*(f2 \{\
.	ft \\*(f2
.	ds f2\"
'	br \}
.el .ie !\\*(f1 \{\
.	ft \\*(f1
.	ds f1\"
'	br \}
.el .tm ? font underflow
..
.ds f1\"
.ds f2\"
.ds f3\"
.ds f4\"
'\" t 
.ta 8n 16n 24n 32n 40n 48n 56n 64n 72n  
.TH "rt_task_make_periodic" "2" 
.SH "NAME" 
rt_task_make_periodic \(em mark a realtime task for execution. 
.SH "SYNOPSIS" 
.PP 
.nf 
.ta 8n 16n 24n 32n 40n 48n 56n 64n 72n 
\fIWARNING\fP --  
This is an RTLinux v1.x compatibility function. 
For new programs, please see \fBpthread_make_periodic_np(3)\fP. 
 
#define MODULE 
#include <linux/module.h> 
#include <linux/kernel.h> 
#include <linux/version.h> 
#include <linux/errno.h> 
#include <linux/rtf.h> 
#include <asm/rt_irq.h> 
 
int \fBrt_task_make_periodic\fP(RT_TASK *\fBtask\fR, RTIME \fBstart_time\fR, RTIME \fBperiod\fR); 
.fi 
.SH "WARNING" 
.PP 
This is an RTLinux v1.x compatibility function. 
For new programs, please see \fBpthread_make_periodic_np(3)\fP. 
.SH "DESCRIPTION" 
.PP 
\fBrt_task_make_periodic\fP marks a task, previously created with a call to \fBrt_task_init\fP, as ready for execution.  The task will run at intervals specified by \fBperiod\fR; i.e., it will be marked for execution every \fBperiod\fR realtime clock ticks.  The desired start time is specified by \fBstart_time\fR; the first execution of the task will occur \fBstart_time\fR clock ticks from the current time.  If immediate execution is desired, the return value of \fBrt_get_time\fP can be used for \fBstart_time\fR. 
.SH "RETURN VALUE" 
.PP 
On  success,  0 is returned.  On failure, a negative value is returned as described below. 
.SH "ERRORS" 
.IP "-EINVAL" 10 
\fBtask\fR does not refer to a valid \fBRT_TASK\fR structure. 
.SH "AUTHOR" 
.PP 
Jerry Epplin, modified by Michael Barabanov (\[e-mail] (link to URL mailto:[e-mail]) \fR) 
.SH "SEE ALSO" 
\fIrt_get_time(3) (link to URL rt_get_time.3.html) \fR, \fIrt_task_delete(3) (link to URL rt_task_delete.3.html) \fR, \fIrt_task_init(3) (link to URL rt_task_init.3.html) \fR, \fIrt_task_suspend(3) (link to URL rt_task_suspend.3.html) \fR, \fIrt_task_wait(3) (link to URL rt_task_wait.3.html) \fR, \fIpthread_make_periodic_np(3) (link to URL pthread_make_periodic_np.3.html) \fR 
.PP 
\(co1997 Jerry Epplin. 
.PP 
Modifications for RTLinux 2.x and 3.x by Michael Barabanov. \(co2001 FSMLabs Inc. 
.PP 
All rights reserved. 
...\" created by instant / docbook-to-man, Thu 26 Jul 2001, 11:19