rtl_setclockmode.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 "rtl_setclockmode" "3" 
.SH "NAME" 
rtl_setclockmode \(em set the RTLinux clock mode 
.SH "SYNOPSIS" 
.PP 
.nf 
.ta 8n 16n 24n 32n 40n 48n 56n 64n 72n 
#include <rtl_sched.h> 
 
int \fBrtl_setclockmode\fP(clockid_t \fBclock\fR, int \fBmode\fR, hrtime_t \fBmode_param\fR); 
.fi 
.SH "DESCRIPTION" 
.PP 
This function is a non-portable Realtime Linux extension. 
.PP 
\fBrtl_setclockmode\fP sets the mode of the specified clock.  The allowed modes depend on the clock.  Generally, the following modes are supported: 
.IP "RTL_CLOCK_MODE_ONESHOT" 10 
The clock is in the oneshot mode.  The \fBmode_param\fR is ignored. 
.IP "RTL_CLOCK_MODE_PERIODIC" 10 
The clock is in the periodic mode.  The \fBmode_param\fR is the period expressed in nanoseconds. 
.SH "RETURN VALUE" 
.PP 
This function returns 0 on success and a negative error code on error. 
.SH "ERRORS" 
.IP "-EINVAL" 10 
The mode or the parameter is invalid. 
.SH "AUTHOR" 
.PP 
Michael Barabanov (\[e-mail] (link to URL mailto:[e-mail]) \fR) 
.SH "SEE ALSO" 
\fIUNIX spec clock_gettime(3) (link to URL ../susv2/xsh/clock_gettime.html) \fR, \fIrtl_getschedclock(3) (link to URL rtl_getschedclock.3.html) \fR, \fIclock_gethrtime(3) (link to URL clock_gethrtime.3.html) \fR 
.PP 
\(co2001 FSMLabs Inc. 
.PP 
All rights reserved. 
...\" created by instant / docbook-to-man, Thu 26 Jul 2001, 11:20