source: tags/1.3.1/doc/manual/threads.tex

Last change on this file was 13866, checked in by Mark Evenson, 12 years ago

Promote JAVA:JARRAY-FROM-LIST to the public API.

Re-run grovel on the docstrings.
File size: 5.7 KB
Line 
1\paragraph{}
2\label{THREADS:MAILBOX-EMPTY-P}
3\index{MAILBOX-EMPTY-P}
4--- Function: \textbf{mailbox-empty-p} [\textbf{threads}] \textit{mailbox}
5
6\begin{adjustwidth}{5em}{5em}
7Returns non-NIL if the mailbox can be read from, NIL otherwise.
8\end{adjustwidth}
9
10\paragraph{}
11\label{THREADS:THREADP}
12\index{THREADP}
13--- Function: \textbf{threadp} [\textbf{threads}] \textit{}
14
15\begin{adjustwidth}{5em}{5em}
16not-documented
17\end{adjustwidth}
18
19\paragraph{}
20\label{THREADS:DESTROY-THREAD}
21\index{DESTROY-THREAD}
22--- Function: \textbf{destroy-thread} [\textbf{threads}] \textit{}
23
24\begin{adjustwidth}{5em}{5em}
25not-documented
26\end{adjustwidth}
27
28\paragraph{}
29\label{THREADS:WITH-MUTEX}
30\index{WITH-MUTEX}
31--- Macro: \textbf{with-mutex} [\textbf{threads}] \textit{}
32
33\begin{adjustwidth}{5em}{5em}
34not-documented
35\end{adjustwidth}
36
37\paragraph{}
38\label{THREADS:THREAD-JOIN}
39\index{THREAD-JOIN}
40--- Function: \textbf{thread-join} [\textbf{threads}] \textit{thread}
41
42\begin{adjustwidth}{5em}{5em}
43Waits for thread to finish.
44\end{adjustwidth}
45
46\paragraph{}
47\label{THREADS:RELEASE-MUTEX}
48\index{RELEASE-MUTEX}
49--- Function: \textbf{release-mutex} [\textbf{threads}] \textit{mutex}
50
51\begin{adjustwidth}{5em}{5em}
52Releases a lock on the `mutex'.
53\end{adjustwidth}
54
55\paragraph{}
56\label{THREADS:OBJECT-WAIT}
57\index{OBJECT-WAIT}
58--- Function: \textbf{object-wait} [\textbf{threads}] \textit{}
59
60\begin{adjustwidth}{5em}{5em}
61not-documented
62\end{adjustwidth}
63
64\paragraph{}
65\label{THREADS:MAKE-THREAD}
66\index{MAKE-THREAD}
67--- Function: \textbf{make-thread} [\textbf{threads}] \textit{function \&key name}
68
69\begin{adjustwidth}{5em}{5em}
70not-documented
71\end{adjustwidth}
72
73\paragraph{}
74\label{THREADS:MAKE-THREAD-LOCK}
75\index{MAKE-THREAD-LOCK}
76--- Function: \textbf{make-thread-lock} [\textbf{threads}] \textit{}
77
78\begin{adjustwidth}{5em}{5em}
79Returns an object to be used with the `with-thread-lock' macro.
80\end{adjustwidth}
81
82\paragraph{}
83\label{THREADS:OBJECT-NOTIFY-ALL}
84\index{OBJECT-NOTIFY-ALL}
85--- Function: \textbf{object-notify-all} [\textbf{threads}] \textit{}
86
87\begin{adjustwidth}{5em}{5em}
88not-documented
89\end{adjustwidth}
90
91\paragraph{}
92\label{THREADS:MAKE-MAILBOX}
93\index{MAKE-MAILBOX}
94--- Function: \textbf{make-mailbox} [\textbf{threads}] \textit{\&key ((queue g2304220) NIL)}
95
96\begin{adjustwidth}{5em}{5em}
97not-documented
98\end{adjustwidth}
99
100\paragraph{}
101\label{THREADS:OBJECT-NOTIFY}
102\index{OBJECT-NOTIFY}
103--- Function: \textbf{object-notify} [\textbf{threads}] \textit{object}
104
105\begin{adjustwidth}{5em}{5em}
106not-documented
107\end{adjustwidth}
108
109\paragraph{}
110\label{THREADS:GET-MUTEX}
111\index{GET-MUTEX}
112--- Function: \textbf{get-mutex} [\textbf{threads}] \textit{mutex}
113
114\begin{adjustwidth}{5em}{5em}
115Acquires a lock on the `mutex'.
116\end{adjustwidth}
117
118\paragraph{}
119\label{THREADS:MAILBOX-PEEK}
120\index{MAILBOX-PEEK}
121--- Function: \textbf{mailbox-peek} [\textbf{threads}] \textit{mailbox}
122
123\begin{adjustwidth}{5em}{5em}
124Returns two values. The second returns non-NIL when the mailbox
125is empty. The first is the next item to be read from the mailbox
126if the first is NIL.
127
128Note that due to multi-threading, the first value returned upon
129peek, may be different from the one returned upon next read in the
130calling thread.
131\end{adjustwidth}
132
133\paragraph{}
134\label{THREADS:THREAD-ALIVE-P}
135\index{THREAD-ALIVE-P}
136--- Function: \textbf{thread-alive-p} [\textbf{threads}] \textit{thread}
137
138\begin{adjustwidth}{5em}{5em}
139Boolean predicate whether THREAD is alive.
140\end{adjustwidth}
141
142\paragraph{}
143\label{THREADS:MAILBOX-READ}
144\index{MAILBOX-READ}
145--- Function: \textbf{mailbox-read} [\textbf{threads}] \textit{mailbox}
146
147\begin{adjustwidth}{5em}{5em}
148Blocks on the mailbox until an item is available for reading.
149When an item is available, it is returned.
150\end{adjustwidth}
151
152\paragraph{}
153\label{THREADS:SYNCHRONIZED-ON}
154\index{SYNCHRONIZED-ON}
155--- Special Operator: \textbf{synchronized-on} [\textbf{threads}] \textit{}
156
157\begin{adjustwidth}{5em}{5em}
158not-documented
159\end{adjustwidth}
160
161\paragraph{}
162\label{THREADS:INTERRUPT-THREAD}
163\index{INTERRUPT-THREAD}
164--- Function: \textbf{interrupt-thread} [\textbf{threads}] \textit{thread function \&rest args}
165
166\begin{adjustwidth}{5em}{5em}
167Interrupts THREAD and forces it to apply FUNCTION to ARGS.
168When 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.
169\end{adjustwidth}
170
171\paragraph{}
172\label{THREADS:MAKE-MUTEX}
173\index{MAKE-MUTEX}
174--- Function: \textbf{make-mutex} [\textbf{threads}] \textit{\&key ((in-use g2304421) NIL)}
175
176\begin{adjustwidth}{5em}{5em}
177not-documented
178\end{adjustwidth}
179
180\paragraph{}
181\label{THREADS:THREAD}
182\index{THREAD}
183--- Class: \textbf{thread} [\textbf{threads}] \textit{}
184
185\begin{adjustwidth}{5em}{5em}
186not-documented
187\end{adjustwidth}
188
189\paragraph{}
190\label{THREADS:WITH-THREAD-LOCK}
191\index{WITH-THREAD-LOCK}
192--- Macro: \textbf{with-thread-lock} [\textbf{threads}] \textit{}
193
194\begin{adjustwidth}{5em}{5em}
195not-documented
196\end{adjustwidth}
197
198\paragraph{}
199\label{THREADS:MAILBOX-SEND}
200\index{MAILBOX-SEND}
201--- Function: \textbf{mailbox-send} [\textbf{threads}] \textit{mailbox item}
202
203\begin{adjustwidth}{5em}{5em}
204Sends an item into the mailbox, notifying 1 waiter
205to wake up for retrieval of that object.
206\end{adjustwidth}
207
208\paragraph{}
209\label{THREADS:THREAD-NAME}
210\index{THREAD-NAME}
211--- Function: \textbf{thread-name} [\textbf{threads}] \textit{}
212
213\begin{adjustwidth}{5em}{5em}
214not-documented
215\end{adjustwidth}
216
217\paragraph{}
218\label{THREADS:CURRENT-THREAD}
219\index{CURRENT-THREAD}
220--- Function: \textbf{current-thread} [\textbf{threads}] \textit{}
221
222\begin{adjustwidth}{5em}{5em}
223not-documented
224\end{adjustwidth}
225
226\paragraph{}
227\label{THREADS:MAPCAR-THREADS}
228\index{MAPCAR-THREADS}
229--- Function: \textbf{mapcar-threads} [\textbf{threads}] \textit{}
230
231\begin{adjustwidth}{5em}{5em}
232not-documented
233\end{adjustwidth}
234
Note: See TracBrowser for help on using the repository browser.