Last change on this file since 14892 was 14892, checked in by mevenson, 21 months ago

metadata: publish all artifacts for 1.4.0 simultaneously

Update the README <file:README>, CHANGES <file:CHANGES> and the User
manual <file:doc/manual/> for 1.4.0.

File size: 6.8 KB
Line
1\paragraph{}
5
7Returns a reference to invoking thread.
9
10\paragraph{}
14
16not-documented
18
19\paragraph{}
21\index{GET-MUTEX}
22--- Function: \textbf{get-mutex} [\textbf{threads}] \textit{mutex}
23
25Acquires a lock on the mutex'.
27
28\paragraph{}
32
34Interrupts THREAD and forces it to apply FUNCTION to ARGS.
35When 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.
37
38\paragraph{}
40\index{MAILBOX-EMPTY-P}
41--- Function: \textbf{mailbox-empty-p} [\textbf{threads}] \textit{mailbox}
42
44Returns non-NIL if the mailbox can be read from, NIL otherwise.
46
47\paragraph{}
49\index{MAILBOX-PEEK}
50--- Function: \textbf{mailbox-peek} [\textbf{threads}] \textit{mailbox}
51
53Returns two values. The second returns non-NIL when the mailbox
54is empty. The first is the next item to be read from the mailbox.
55
56Note that due to multi-threading, the first value returned upon
57peek, may be different from the one returned upon next read in the
60
61\paragraph{}
65
67Blocks on the mailbox until an item is available for reading.
68When an item is available, it is returned.
70
71\paragraph{}
73\index{MAILBOX-SEND}
74--- Function: \textbf{mailbox-send} [\textbf{threads}] \textit{mailbox item}
75
77Sends an item into the mailbox, notifying 1 waiter
78to wake up for retrieval of that object.
80
81\paragraph{}
83\index{MAKE-MAILBOX}
84--- Function: \textbf{make-mailbox} [\textbf{threads}] \textit{\&key ((queue g282154) NIL)}
85
87not-documented
89
90\paragraph{}
92\index{MAKE-MUTEX}
93--- Function: \textbf{make-mutex} [\textbf{threads}] \textit{\&key ((in-use g282414) NIL)}
94
96not-documented
98
99\paragraph{}
102--- Function: \textbf{make-thread} [\textbf{threads}] \textit{function \&key name}
103
105not-documented
107
108\paragraph{}
112
114Returns an object to be used with the with-thread-lock' macro.
116
117\paragraph{}
121
123not-documented
125
126\paragraph{}
128\index{OBJECT-NOTIFY}
129--- Function: \textbf{object-notify} [\textbf{threads}] \textit{object}
130
132Wakes up a single thread that is waiting on OBJECT's monitor.
133If any threads are waiting on this object, one of them is chosen to be awakened. The choice is arbitrary and occurs at the discretion of the implementation. A thread waits on an object's monitor by calling one of the wait methods.
135
136\paragraph{}
138\index{OBJECT-NOTIFY-ALL}
139--- Function: \textbf{object-notify-all} [\textbf{threads}] \textit{object}
140
142Wakes up all threads that are waiting on this OBJECT's monitor.
143A thread waits on an object's monitor by calling one of the wait methods.
145
146\paragraph{}
148\index{OBJECT-WAIT}
149--- Function: \textbf{object-wait} [\textbf{threads}] \textit{object \&optional timeout}
150
152Causes the current thread to block until object-notify or object-notify-all is called on OBJECT.
153Optionally unblock execution after TIMEOUT seconds.  A TIMEOUT of zero
154means to wait indefinitely.
155A non-zero TIMEOUT of less than a nanosecond is interpolated as a nanosecond wait.
156See the documentation of java.lang.Object.wait() for further
157information.
158
160
161\paragraph{}
163\index{RELEASE-MUTEX}
164--- Function: \textbf{release-mutex} [\textbf{threads}] \textit{mutex}
165
167Releases a lock on the `mutex'.
169
170\paragraph{}
172\index{SYNCHRONIZED-ON}
173--- Special Operator: \textbf{synchronized-on} [\textbf{threads}] \textit{}
174
176not-documented
178
179\paragraph{}
183
185not-documented
187
188\paragraph{}
192
194Boolean predicate whether THREAD is alive.
196
197\paragraph{}
201
203Waits for thread to finish.
205
206\paragraph{}
210
212not-documented
214
215\paragraph{}
219
221not-documented
223
224\paragraph{}
226\index{WITH-MUTEX}
227--- Macro: \textbf{with-mutex} [\textbf{threads}] \textit{}
228
230not-documented
232
233\paragraph{}
237
239not-documented