Last change on this file since 13728 was 13728, checked in by Mark Evenson, 11 years ago

Backport changes to manual en masse.

File size: 5.7 KB
Line
1\subsection{Exported Symbols from the THREADS package}
2
3\paragraph{}
5\index{MAILBOX-EMPTY-P}
7
9Returns non-NIL if the mailbox can be read from, NIL otherwise.
11
12\paragraph{}
16
18NOT-DOCUMENTED
20
21\paragraph{}
25
27NOT-DOCUMENTED
29
30\paragraph{}
32\index{WITH-MUTEX}
34
36NOT-DOCUMENTED
38
39\paragraph{}
43
47
48\paragraph{}
50\index{RELEASE-MUTEX}
52
54Releases a lock on the mutex'.
56
57\paragraph{}
59\index{OBJECT-WAIT}
61
63NOT-DOCUMENTED
65
66\paragraph{}
70
72NOT-DOCUMENTED
74
75\paragraph{}
79
81Returns an object to be used with the with-thread-lock' macro.
83
84\paragraph{}
86\index{OBJECT-NOTIFY-ALL}
88
90NOT-DOCUMENTED
92
93\paragraph{}
95\index{MAKE-MAILBOX}
97
99NOT-DOCUMENTED
101
102\paragraph{}
104\index{OBJECT-NOTIFY}
106
108NOT-DOCUMENTED
110
111\paragraph{}
113\index{GET-MUTEX}
115
117Acquires a lock on the `mutex'.
119
120\paragraph{}
122\index{MAILBOX-PEEK}
124
126Returns two values. The second returns non-NIL when the mailbox
127is empty. The first is the next item to be read from the mailbox
128if the first is NIL.
129
130Note that due to multi-threading, the first value returned upon
131peek, may be different from the one returned upon next read in the
134
135\paragraph{}
139
141Boolean predicate whether THREAD is alive.
143
144\paragraph{}
148
150Blocks on the mailbox until an item is available for reading.
151When an item is available, it is returned.
153
154\paragraph{}
156\index{SYNCHRONIZED-ON}
158
161
162\paragraph{}
166
168Interrupts THREAD and forces it to apply FUNCTION to ARGS.
169When the function returns, the thread's original computation continues. If  multiple interrupts are queued for a thread, they are all run, but the order is not guaranteed.
171
172\paragraph{}
174\index{MAKE-MUTEX}
176
178NOT-DOCUMENTED
180
181\paragraph{}
185
187NOT-DOCUMENTED
189
190\paragraph{}
194
196NOT-DOCUMENTED
198
199\paragraph{}
201\index{MAILBOX-SEND}
202--- Function: \textbf{mailbox-send} [\textbf{threads}] \textit{mailbox item}
203
205Sends an item into the mailbox, notifying 1 waiter
206to wake up for retrieval of that object.
208
209\paragraph{}
213
215NOT-DOCUMENTED
217
218\paragraph{}
222