File: sem_timedwait.3.html

package info (click to toggle)
rtlinux 3.1pre3-3
  • links: PTS
  • area: non-free
  • in suites: etch, etch-m68k
  • size: 4,896 kB
  • ctags: 4,228
  • sloc: ansic: 26,204; sh: 2,069; makefile: 1,414; perl: 855; tcl: 489; asm: 380; cpp: 42
file content (178 lines) | stat: -rw-r--r-- 2,280 bytes parent folder | download | duplicates (2)
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
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
<HTML
><HEAD
><TITLE
>sem_timedwait</TITLE
><META
NAME="GENERATOR"
CONTENT="Modular DocBook HTML Stylesheet Version 1.64
"></HEAD
><BODY
CLASS="REFENTRY"
><H1
><A
NAME="AEN1"
>sem_timedwait</A
></H1
><DIV
CLASS="REFNAMEDIV"
><A
NAME="AEN5"
></A
><H2
>Name</H2
>sem_timedwait&nbsp;--&nbsp;lock a semaphore with a timeout</DIV
><DIV
CLASS="REFSYNOPSISDIV"
><A
NAME="AEN8"
></A
><H2
>Synopsis</H2
><TABLE
BORDER="0"
BGCOLOR="#E0E0E0"
WIDTH="100%"
><TR
><TD
><PRE
CLASS="SYNOPSIS"
>       #include &#60;semaphore.h&#62;

       int <TT
CLASS="FUNCTION"
>sem_timedwait</TT
>(sem_t *<TT
CLASS="PARAMETER"
><I
>sem</I
></TT
>, const struct timespec *<TT
CLASS="PARAMETER"
><I
>abs_timeout</I
></TT
>);</PRE
></TD
></TR
></TABLE
></DIV
><DIV
CLASS="REFSECT1"
><A
NAME="AEN13"
></A
><H2
>DESCRIPTION</H2
><P
> The <TT
CLASS="FUNCTION"
>sem_timedwait</TT
> function locks the semaphore referenced by <TT
CLASS="PARAMETER"
><I
>sem</I
></TT
> like <TT
CLASS="FUNCTION"
>sem_wait</TT
>.
If the semaphore is not locked at the time specified by the
<TT
CLASS="PARAMETER"
><I
>abs_timeout</I
></TT
>, <TT
CLASS="FUNCTION"
>sem_timedwait</TT
> returns
with the <TT
CLASS="PARAMETER"
><I
>ETIMEDOUT</I
></TT
> error.

The absolute timeout is expressed with respect to the
 <TT
CLASS="PARAMETER"
><I
>CLOCK_REALTIME</I
></TT
> clock.</P
></DIV
><DIV
CLASS="REFSECT1"
><A
NAME="AEN23"
></A
><H2
>RETURN VALUE</H2
><P
>On success, zero is returned. On error, -1 is returned, and errno is set
appropriately.</P
></DIV
><DIV
CLASS="REFSECT1"
><A
NAME="AEN26"
></A
><H2
>ERRORS</H2
><P
>All error values of <TT
CLASS="FUNCTION"
>sem_wait</TT
> apply.
In addition, the following errors defined.</P
><P
></P
><DIV
CLASS="VARIABLELIST"
><DL
><DT
>ETIMEDOUT</DT
><DD
><P
>The semaphore lock operation timed out.</P
></DD
></DL
></DIV
></DIV
><DIV
CLASS="REFSECT1"
><A
NAME="AEN35"
></A
><H2
>AUTHOR</H2
><P
>Michael Barabanov (<A
HREF="mailto:baraban@fsmlabs.com"
TARGET="_top"
>baraban@fsmlabs.com</A
>)</P
></DIV
><DIV
CLASS="REFSECT1"
><A
NAME="AEN39"
></A
><H2
>SEE ALSO</H2
><A
HREF="../susv2/xsh/sem_wait.html"
TARGET="_top"
>sem_wait(3)</A
>, <A
HREF="../susv2/xsh/clock_gettime.html"
TARGET="_top"
>clock_gettime(3)</A
><P
>2001 FSMLabs Inc.</P
><P
>All rights reserved.</P
></DIV
></BODY
></HTML
>