File: rtf_destroy.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 (70 lines) | stat: -rw-r--r-- 2,228 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
62
63
64
65
66
67
68
69
70
.\"
.\" 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 RTF_DESTROY 2 "11 July 1997" "Real-Time Linux" "Real-Time Linux"
.SH NAME
rtf_destroy \- remove a real-time fifo created with rtf_create(2)
.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/rtf.h> 
.fi
.sp
.BI "int rtf_destroy(unsigned int " fifo ");
.SH DESCRIPTION
.B rtf_destroy
removes a real-time fifo (RT-FIFO) previously created with
.BR rtf_create(2).
.I fifo
is then available for reuse by another call to
.BR rtf_create(2).
.PP
The RT-FIFO is a mechanism, implemented as a character device, to
communicate between real-time tasks and ordinary Linux processes.  The
rtf_* functions are used by the real-time tasks; Linux processes use
standard character device access functions such as
.BR read(2) ,
.BR write(2) ,
and
.BR select(2) .
.SH "RETURN VALUE"
On success, 0 is returned.  On failure, -1 is returned, and
.I errno
is set as described below.
.SH ERRORS
.IP \fB-ENODEV\fP
.I fifo
is greater than or equal to RTF_NO.
.IP \fB-EINVAL\fP
.I fifo
is not a valid RT-FIFO identifier.
.SH "SEE ALSO"
.BR rtf_create (2), 
.BR rtf_create_handler (2), 
.BR rtf_get (2), 
.BR rtf_put (2), 
.BR rtf_resize (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.