source: branches/1.1.x/doc/manual/threads.tex @ 14282

Last change on this file since 14282 was 14282, checked in by Mark Evenson, 8 years ago

manual: Updates to manual for ABCL 1.1.

Preface to the second addition. TODO TeX.

Added Appendix for SYSTEM and JSS packages. TODO Need to fix LaTex?.

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:MAKE-THREAD}
57\index{MAKE-THREAD}
58--- Function: \textbf{make-thread} [\textbf{threads}] \textit{function \&key name}
59
60\begin{adjustwidth}{5em}{5em}
61not-documented
62\end{adjustwidth}
63
64\paragraph{}
65\label{THREADS:OBJECT-WAIT}
66\index{OBJECT-WAIT}
67--- Function: \textbf{object-wait} [\textbf{threads}] \textit{}
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 g348097) 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.
126
127Note that due to multi-threading, the first value returned upon
128peek, may be different from the one returned upon next read in the
129calling thread.
130\end{adjustwidth}
131
132\paragraph{}
133\label{THREADS:THREAD-ALIVE-P}
134\index{THREAD-ALIVE-P}
135--- Function: \textbf{thread-alive-p} [\textbf{threads}] \textit{thread}
136
137\begin{adjustwidth}{5em}{5em}
138Boolean predicate whether THREAD is alive.
139\end{adjustwidth}
140
141\paragraph{}
142\label{THREADS:MAILBOX-READ}
143\index{MAILBOX-READ}
144--- Function: \textbf{mailbox-read} [\textbf{threads}] \textit{mailbox}
145
146\begin{adjustwidth}{5em}{5em}
147Blocks on the mailbox until an item is available for reading.
148When an item is available, it is returned.
149\end{adjustwidth}
150
151\paragraph{}
152\label{THREADS:SYNCHRONIZED-ON}
153\index{SYNCHRONIZED-ON}
154--- Special Operator: \textbf{synchronized-on} [\textbf{threads}] \textit{}
155
156\begin{adjustwidth}{5em}{5em}
157not-documented
158\end{adjustwidth}
159
160\paragraph{}
161\label{THREADS:INTERRUPT-THREAD}
162\index{INTERRUPT-THREAD}
163--- Function: \textbf{interrupt-thread} [\textbf{threads}] \textit{thread function \&rest args}
164
165\begin{adjustwidth}{5em}{5em}
166Interrupts THREAD and forces it to apply FUNCTION to ARGS.
167When 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.
168\end{adjustwidth}
169
170\paragraph{}
171\label{THREADS:THREAD}
172\index{THREAD}
173--- Class: \textbf{thread} [\textbf{threads}] \textit{}
174
175\begin{adjustwidth}{5em}{5em}
176not-documented
177\end{adjustwidth}
178
179\paragraph{}
180\label{THREADS:MAKE-MUTEX}
181\index{MAKE-MUTEX}
182--- Function: \textbf{make-mutex} [\textbf{threads}] \textit{\&key ((in-use g348357) NIL)}
183
184\begin{adjustwidth}{5em}{5em}
185not-documented
186\end{adjustwidth}
187
188\paragraph{}
189\label{THREADS:WITH-THREAD-LOCK}
190\index{WITH-THREAD-LOCK}
191--- Macro: \textbf{with-thread-lock} [\textbf{threads}] \textit{}
192
193\begin{adjustwidth}{5em}{5em}
194not-documented
195\end{adjustwidth}
196
197\paragraph{}
198\label{THREADS:MAILBOX-SEND}
199\index{MAILBOX-SEND}
200--- Function: \textbf{mailbox-send} [\textbf{threads}] \textit{mailbox item}
201
202\begin{adjustwidth}{5em}{5em}
203Sends an item into the mailbox, notifying 1 waiter
204to wake up for retrieval of that object.
205\end{adjustwidth}
206
207\paragraph{}
208\label{THREADS:THREAD-NAME}
209\index{THREAD-NAME}
210--- Function: \textbf{thread-name} [\textbf{threads}] \textit{}
211
212\begin{adjustwidth}{5em}{5em}
213not-documented
214\end{adjustwidth}
215
216\paragraph{}
217\label{THREADS:CURRENT-THREAD}
218\index{CURRENT-THREAD}
219--- Function: \textbf{current-thread} [\textbf{threads}] \textit{}
220
221\begin{adjustwidth}{5em}{5em}
222not-documented
223\end{adjustwidth}
224
225\paragraph{}
226\label{THREADS:MAPCAR-THREADS}
227\index{MAPCAR-THREADS}
228--- Function: \textbf{mapcar-threads} [\textbf{threads}] \textit{}
229
230\begin{adjustwidth}{5em}{5em}
231not-documented
232\end{adjustwidth}
233
Note: See TracBrowser for help on using the repository browser.