Ignore:
Timestamp:
01/09/12 08:38:52 (10 years ago)
Author:
Mark Evenson
Message:

Backport changes to manual en masse.

File:
1 edited

Legend:

Unmodified
Added
Removed
  • branches/1.0.x/abcl/doc/manual/threads.tex

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