mirror of
https://gitlab.com/embeddable-common-lisp/ecl.git
synced 2026-01-24 05:21:20 -08:00
newdoc: mp: improve documentation (cv)
This commit is contained in:
Daniel Kochmański
parent
cb8d454fae
commit
bf3e59c2a3
9 changed files with 492 additions and 482 deletions
|
|
@ -42,4 +42,14 @@ both for flexibility and a greater risk. In order to control access to
|
|||
different resources, ECL provides the user with locks, as explained in
|
||||
the next section.
|
||||
|
||||
@include extensions/mp_ref.txi
|
||||
@node Native threads reference
|
||||
@subsection Native threads reference
|
||||
|
||||
@include extensions/mp_ref_process.txi
|
||||
@include extensions/mp_ref_mutex.txi
|
||||
@include extensions/mp_ref_rwlock.txi
|
||||
@include extensions/mp_ref_cv.txi
|
||||
@include extensions/mp_ref_sem.txi
|
||||
@include extensions/mp_ref_barrier.txi
|
||||
@include extensions/mp_ref_mailbox.txi
|
||||
@include extensions/mp_ref_atomic.txi
|
||||
|
|
|
|||
|
|
@ -1,481 +0,0 @@
|
|||
@node Native threads reference
|
||||
@subsection Native threads reference
|
||||
|
||||
@include extensions/mp_ref_process.txi
|
||||
|
||||
|
||||
@c condition variables
|
||||
@node Condition variables
|
||||
@subsubsection Condition variables
|
||||
|
||||
|
||||
@cppindex mp_make_condition_variable
|
||||
@lspindex mp:make-condition-variable
|
||||
|
||||
@deftypefun cl_object mp_make_condition_variable ()
|
||||
@end deftypefun
|
||||
|
||||
@defun mp:make-condition-variable
|
||||
|
||||
@end defun
|
||||
|
||||
@lspindex mp:condition_variable_wait
|
||||
@cppindex mp_condition_variable_wait
|
||||
@defun mp:condition_variable_wait
|
||||
@table @var
|
||||
@item returns
|
||||
???
|
||||
@item C/C++ signature
|
||||
cl_object mp_condition_variable_wait(cl_object cv, cl_object lock);
|
||||
@end table
|
||||
@end defun
|
||||
|
||||
@lspindex mp:condition_variable_timedwait
|
||||
@cppindex mp_condition_variable_timedwait
|
||||
@defun mp:condition_variable_timedwait
|
||||
@table @var
|
||||
@item returns
|
||||
???
|
||||
@item C/C++ signature
|
||||
cl_object mp_condition_variable_timedwait(cl_object cv, cl_object lock, cl_object seconds);
|
||||
@end table
|
||||
@end defun
|
||||
|
||||
@lspindex mp:condition_variable_signal
|
||||
@cppindex mp_condition_variable_signal
|
||||
@defun mp:condition_variable_signal
|
||||
@table @var
|
||||
@item returns
|
||||
???
|
||||
@item C/C++ signature
|
||||
cl_object mp_condition_variable_signal(cl_object cv);
|
||||
@end table
|
||||
@end defun
|
||||
|
||||
@lspindex mp:condition_variable_broadcast
|
||||
@cppindex mp_condition_variable_broadcast
|
||||
@defun mp:condition_variable_broadcast
|
||||
@table @var
|
||||
@item returns
|
||||
???
|
||||
@item C/C++ signature
|
||||
cl_object mp_condition_variable_broadcast(cl_object cv);
|
||||
@end table
|
||||
@end defun
|
||||
|
||||
|
||||
@node Locks
|
||||
@subsubsection Locks (mutexes)
|
||||
/* threads/process.d */
|
||||
|
||||
@lspindex mp:make_lock
|
||||
@cppindex mp_make_lock
|
||||
@defun mp:make_lock
|
||||
@table @var
|
||||
@item returns
|
||||
???
|
||||
@item C/C++ signature
|
||||
cl_object mp_make_lock _ECL_ARGS((cl_narg narg, ...));
|
||||
@end table
|
||||
@end defun
|
||||
|
||||
@lspindex mp:recursive_lock_p
|
||||
@lspindex mp_recursive_lock_p
|
||||
@defun mp:recursive_lock_p
|
||||
@table @var
|
||||
@item returns
|
||||
???
|
||||
@item C/C++ signature
|
||||
cl_object mp_recursive_lock_p(cl_object lock);
|
||||
@end table
|
||||
@end defun
|
||||
|
||||
@lspindex mp:holding_lock_p
|
||||
@lspindex mp_holding_lock_p
|
||||
@defun mp:holding_lock_p
|
||||
@table @var
|
||||
@item returns
|
||||
???
|
||||
@item C/C++ signature
|
||||
cl_object mp_holding_lock_p(cl_object lock);
|
||||
@end table
|
||||
@end defun
|
||||
|
||||
@lspindex mp:lock_name
|
||||
@lspindex mp_lock_name
|
||||
@defun mp:lock_name
|
||||
@table @var
|
||||
@item returns
|
||||
???
|
||||
@item C/C++ signature
|
||||
cl_object mp_lock_name(cl_object lock);
|
||||
@end table
|
||||
@end defun
|
||||
|
||||
@lspindex mp:lock_owner
|
||||
@lspindex mp_lock_owner
|
||||
@defun mp:lock_owner
|
||||
@table @var
|
||||
@item returns
|
||||
???
|
||||
@item C/C++ signature
|
||||
cl_object mp_lock_owner(cl_object lock);
|
||||
@end table
|
||||
@end defun
|
||||
|
||||
@lspindex mp:lock_count
|
||||
@lspindex mp_lock_count
|
||||
@defun mp:lock_count
|
||||
@table @var
|
||||
@item returns
|
||||
???
|
||||
@item C/C++ signature
|
||||
cl_object mp_lock_count(cl_object lock);
|
||||
@end table
|
||||
@end defun
|
||||
|
||||
@lspindex mp:get_lock
|
||||
@lspindex mp_get_lock
|
||||
@defun mp:get_lock
|
||||
@table @var
|
||||
@item returns
|
||||
???
|
||||
@item C/C++ signature
|
||||
cl_object mp_get_lock _ECL_ARGS((cl_narg narg, cl_object lock, ...));
|
||||
@end table
|
||||
@end defun
|
||||
|
||||
@lspindex mp:get_lock_wait
|
||||
@lspindex mp_get_lock_wait
|
||||
@defun mp:get_lock_wait
|
||||
@table @var
|
||||
@item returns
|
||||
???
|
||||
@item C/C++ signature
|
||||
cl_object mp_get_lock_wait(cl_object lock);
|
||||
@end table
|
||||
@end defun
|
||||
|
||||
@lspindex mp:get_lock_nowait
|
||||
@lspindex mp_get_lock_nowait
|
||||
@defun mp:get_lock_nowait
|
||||
@table @var
|
||||
@item returns
|
||||
???
|
||||
@item C/C++ signature
|
||||
cl_object mp_get_lock_nowait(cl_object lock);
|
||||
@end table
|
||||
@end defun
|
||||
|
||||
@lspindex mp:giveup_lock
|
||||
@lspindex mp_giveup_lock
|
||||
@defun mp:giveup_lock
|
||||
@table @var
|
||||
@item returns
|
||||
???
|
||||
@item C/C++ signature
|
||||
cl_object mp_giveup_lock(cl_object lock);
|
||||
@end table
|
||||
@end defun
|
||||
|
||||
cl_object ecl_make_lock(cl_object lock, bool recursive);
|
||||
|
||||
@node Read-Write locks
|
||||
@subsubsection Read-Write locks
|
||||
/* threads/rwlock.d */
|
||||
|
||||
@lspindex mp:make_rwlock
|
||||
@lspindex mp_make_rwlock
|
||||
@defun mp:make_rwlock
|
||||
@table @var
|
||||
@item returns
|
||||
???
|
||||
@item C/C++ signature
|
||||
cl_object mp_make_rwlock _ECL_ARGS((cl_narg narg, ...));
|
||||
@end table
|
||||
@end defun
|
||||
|
||||
@lspindex mp:rwlock_name
|
||||
@lspindex mp_rwlock_name
|
||||
@defun mp:rwlock_name
|
||||
@table @var
|
||||
@item returns
|
||||
???
|
||||
@item C/C++ signature
|
||||
cl_object mp_rwlock_name(cl_object lock);
|
||||
@end table
|
||||
@end defun
|
||||
|
||||
@lspindex mp:get_rwlock_read
|
||||
@lspindex mp_get_rwlock_read
|
||||
@defun mp:get_rwlock_read
|
||||
@table @var
|
||||
@item returns
|
||||
???
|
||||
@item C/C++ signature
|
||||
cl_object mp_get_rwlock_read _ECL_ARGS((cl_narg narg, cl_object lock, ...));
|
||||
@end table
|
||||
@end defun
|
||||
|
||||
@lspindex mp:get_rwlock_write
|
||||
@lspindex mp_get_rwlock_write
|
||||
@defun mp:get_rwlock_write
|
||||
@table @var
|
||||
@item returns
|
||||
???
|
||||
@item C/C++ signature
|
||||
cl_object mp_get_rwlock_write _ECL_ARGS((cl_narg narg, cl_object lock, ...));
|
||||
@end table
|
||||
@end defun
|
||||
|
||||
@lspindex mp:giveup_rwlock_read
|
||||
@lspindex mp_giveup_rwlock_read
|
||||
@defun mp:giveup_rwlock_read
|
||||
@table @var
|
||||
@item returns
|
||||
???
|
||||
@item C/C++ signature
|
||||
cl_object mp_giveup_rwlock_read(cl_object lock);
|
||||
@end table
|
||||
@end defun
|
||||
|
||||
@lspindex mp:giveup_rwlock_write
|
||||
@lspindex mp_giveup_rwlock_write
|
||||
@defun mp:giveup_rwlock_write
|
||||
@table @var
|
||||
@item returns
|
||||
???
|
||||
@item C/C++ signature
|
||||
cl_object mp_giveup_rwlock_write(cl_object lock);
|
||||
@end table
|
||||
@end defun
|
||||
|
||||
cl_object ecl_make_rwlock(cl_object lock);
|
||||
|
||||
@node Semaphores
|
||||
@subsubsection Semaphores
|
||||
/* threads/semaphore.d */
|
||||
|
||||
@lspindex mp:make_semaphore
|
||||
@lspindex mp_make_semaphore
|
||||
@defun mp:make_semaphore
|
||||
@table @var
|
||||
@item returns
|
||||
???
|
||||
@item C/C++ signature
|
||||
cl_object mp_make_semaphore _ECL_ARGS((cl_narg, ...));
|
||||
@end table
|
||||
@end defun
|
||||
|
||||
@lspindex mp:semaphore_count
|
||||
@lspindex mp_semaphore_count
|
||||
@defun mp:semaphore_count
|
||||
@table @var
|
||||
@item returns
|
||||
???
|
||||
@item C/C++ signature
|
||||
cl_object mp_semaphore_count(cl_object);
|
||||
@end table
|
||||
@end defun
|
||||
|
||||
@lspindex mp:semaphore_name
|
||||
@lspindex mp_semaphore_name
|
||||
@defun mp:semaphore_name
|
||||
@table @var
|
||||
@item returns
|
||||
???
|
||||
@item C/C++ signature
|
||||
cl_object mp_semaphore_name(cl_object);
|
||||
@end table
|
||||
@end defun
|
||||
|
||||
@lspindex mp:semaphore_wait_count
|
||||
@lspindex mp_semaphore_wait_count
|
||||
@defun mp:semaphore_wait_count
|
||||
@table @var
|
||||
@item returns
|
||||
???
|
||||
@item C/C++ signature
|
||||
cl_object mp_semaphore_wait_count(cl_object);
|
||||
@end table
|
||||
@end defun
|
||||
|
||||
@lspindex mp:wait_on_semaphore
|
||||
@lspindex mp_wait_on_semaphore
|
||||
@defun mp:wait_on_semaphore
|
||||
@table @var
|
||||
@item returns
|
||||
???
|
||||
@item C/C++ signature
|
||||
cl_object mp_wait_on_semaphore(cl_object);
|
||||
@end table
|
||||
@end defun
|
||||
|
||||
@lspindex mp:try_get_semaphore
|
||||
@lspindex mp_try_get_semaphore
|
||||
@defun mp:try_get_semaphore
|
||||
@table @var
|
||||
@item returns
|
||||
???
|
||||
@item C/C++ signature
|
||||
cl_object mp_try_get_semaphore(cl_object);
|
||||
@end table
|
||||
@end defun
|
||||
|
||||
@lspindex mp:signal_semaphore
|
||||
@lspindex mp_signal_semaphore
|
||||
@defun mp:signal_semaphore
|
||||
@table @var
|
||||
@item returns
|
||||
???
|
||||
@item C/C++ signature
|
||||
cl_object mp_signal_semaphore _ECL_ARGS((cl_narg, cl_object, ...));
|
||||
@end table
|
||||
@end defun
|
||||
|
||||
cl_object ecl_make_semaphore(cl_object name, cl_fixnum count);
|
||||
|
||||
@node Barriers
|
||||
@subsubsection Barriers
|
||||
/* threads/barrier.d */
|
||||
|
||||
@lspindex ecl_make_barrier
|
||||
cl_object ecl_make_barrier(cl_object name, cl_index count);
|
||||
cl_object mp:make_barrier _ECL_ARGS((cl_narg, cl_object, ...));
|
||||
cl_object mp_make_barrier _ECL_ARGS((cl_narg, cl_object, ...));
|
||||
@defun mp:make_barrier _ECL_ARGS((cl_narg, cl_object, ...));
|
||||
@table @var
|
||||
@item returns
|
||||
???
|
||||
@item C/C++ signature
|
||||
cl_object mp_barrier_count(cl_object);
|
||||
@end table
|
||||
@end defun
|
||||
|
||||
@lspindex mp:barrier_name
|
||||
@lspindex mp_barrier_name
|
||||
@defun mp:barrier_name
|
||||
@table @var
|
||||
@item returns
|
||||
???
|
||||
@item C/C++ signature
|
||||
cl_object mp_barrier_name(cl_object);
|
||||
@end table
|
||||
@end defun
|
||||
|
||||
@lspindex mp:barrier_arrivers_count
|
||||
@lspindex mp_barrier_arrivers_count
|
||||
@defun mp:barrier_arrivers_count
|
||||
@table @var
|
||||
@item returns
|
||||
???
|
||||
@item C/C++ signature
|
||||
cl_object mp_barrier_arrivers_count(cl_object);
|
||||
@end table
|
||||
@end defun
|
||||
|
||||
@lspindex mp:barrier_wait
|
||||
@lspindex mp_barrier_wait
|
||||
@defun mp:barrier_wait
|
||||
@table @var
|
||||
@item returns
|
||||
???
|
||||
@item C/C++ signature
|
||||
cl_object mp_barrier_wait _ECL_ARGS((cl_narg, cl_object, ...));
|
||||
@end table
|
||||
@end defun
|
||||
|
||||
cl_object mp_barrier_unblock _ECL_ARGS((cl_narg, cl_object, ...));
|
||||
|
||||
@node Mailboxes
|
||||
@subsubsection Mailboxes
|
||||
/* threads/mailbox.d */
|
||||
|
||||
@lspindex mp:make_mailbox
|
||||
@lspindex mp_make_mailbox
|
||||
@defun mp:make_mailbox
|
||||
@table @var
|
||||
@item returns
|
||||
???
|
||||
@item C/C++ signature
|
||||
cl_object mp_make_mailbox _ECL_ARGS((cl_narg, ...));
|
||||
@end table
|
||||
@end defun
|
||||
|
||||
@lspindex mp:mailbox_name
|
||||
@lspindex mp_mailbox_name
|
||||
@defun mp:mailbox_name
|
||||
@table @var
|
||||
@item returns
|
||||
???
|
||||
@item C/C++ signature
|
||||
cl_object mp_mailbox_name(cl_object mailbox);
|
||||
@end table
|
||||
@end defun
|
||||
|
||||
@lspindex mp:mailbox_count
|
||||
@lspindex mp_mailbox_count
|
||||
@defun mp:mailbox_count
|
||||
@table @var
|
||||
@item returns
|
||||
???
|
||||
@item C/C++ signature
|
||||
cl_object mp_mailbox_count(cl_object mailbox);
|
||||
@end table
|
||||
@end defun
|
||||
|
||||
@lspindex mp:mailbox_empty_p
|
||||
@lspindex mp_mailbox_empty_p
|
||||
@defun mp:mailbox_empty_p
|
||||
@table @var
|
||||
@item returns
|
||||
???
|
||||
@item C/C++ signature
|
||||
cl_object mp_mailbox_empty_p(cl_object);
|
||||
@end table
|
||||
@end defun
|
||||
|
||||
@lspindex mp:mailbox_read
|
||||
@lspindex mp_mailbox_read
|
||||
@defun mp:mailbox_read
|
||||
@table @var
|
||||
@item returns
|
||||
???
|
||||
@item C/C++ signature
|
||||
cl_object mp_mailbox_read(cl_object mailbox);
|
||||
@end table
|
||||
@end defun
|
||||
|
||||
@lspindex mp:mailbox_try_read
|
||||
@lspindex mp_mailbox_try_read
|
||||
@defun mp:mailbox_try_read
|
||||
@table @var
|
||||
@item returns
|
||||
???
|
||||
@item C/C++ signature
|
||||
cl_object mp_mailbox_try_read(cl_object mailbox);
|
||||
@end table
|
||||
@end defun
|
||||
|
||||
@lspindex mp:mailbox_send
|
||||
@lspindex mp_mailbox_send
|
||||
@defun mp:mailbox_send
|
||||
@table @var
|
||||
@item returns
|
||||
???
|
||||
@item C/C++ signature
|
||||
cl_object mp_mailbox_send(cl_object mailbox, cl_object msg);
|
||||
@end table
|
||||
@end defun
|
||||
|
||||
cl_object mp_mailbox_try_send(cl_object mailbox, cl_object msg);
|
||||
|
||||
@node Atomic operations
|
||||
@subsubsection Atomic operations
|
||||
/* threads/atomic.c */
|
||||
|
||||
cl_object ecl_atomic_get(cl_object *slot);
|
||||
void ecl_atomic_push(cl_object *slot, cl_object o);
|
||||
void ecl_atomic_nconc(cl_object l, cl_object *slot);
|
||||
cl_object ecl_atomic_pop(cl_object *slot);
|
||||
cl_index ecl_atomic_index_incf(cl_index *slot);
|
||||
9
src/doc/new-doc/extensions/mp_ref_atomic.txi
Normal file
9
src/doc/new-doc/extensions/mp_ref_atomic.txi
Normal file
|
|
@ -0,0 +1,9 @@
|
|||
@node Atomic operations
|
||||
@subsubsection Atomic operations
|
||||
/* threads/atomic.c */
|
||||
|
||||
cl_object ecl_atomic_get(cl_object *slot);
|
||||
void ecl_atomic_push(cl_object *slot, cl_object o);
|
||||
void ecl_atomic_nconc(cl_object l, cl_object *slot);
|
||||
cl_object ecl_atomic_pop(cl_object *slot);
|
||||
cl_index ecl_atomic_index_incf(cl_index *slot);
|
||||
51
src/doc/new-doc/extensions/mp_ref_barrier.txi
Normal file
51
src/doc/new-doc/extensions/mp_ref_barrier.txi
Normal file
|
|
@ -0,0 +1,51 @@
|
|||
@node Barriers
|
||||
@subsubsection Barriers
|
||||
/* threads/barrier.d */
|
||||
|
||||
@lspindex ecl_make_barrier
|
||||
cl_object ecl_make_barrier(cl_object name, cl_index count);
|
||||
cl_object mp:make_barrier _ECL_ARGS((cl_narg, cl_object, ...));
|
||||
cl_object mp_make_barrier _ECL_ARGS((cl_narg, cl_object, ...));
|
||||
@defun mp:make_barrier _ECL_ARGS((cl_narg, cl_object, ...));
|
||||
@table @var
|
||||
@item returns
|
||||
???
|
||||
@item C/C++ signature
|
||||
cl_object mp_barrier_count(cl_object);
|
||||
@end table
|
||||
@end defun
|
||||
|
||||
@lspindex mp:barrier_name
|
||||
@lspindex mp_barrier_name
|
||||
@defun mp:barrier_name
|
||||
@table @var
|
||||
@item returns
|
||||
???
|
||||
@item C/C++ signature
|
||||
cl_object mp_barrier_name(cl_object);
|
||||
@end table
|
||||
@end defun
|
||||
|
||||
@lspindex mp:barrier_arrivers_count
|
||||
@lspindex mp_barrier_arrivers_count
|
||||
@defun mp:barrier_arrivers_count
|
||||
@table @var
|
||||
@item returns
|
||||
???
|
||||
@item C/C++ signature
|
||||
cl_object mp_barrier_arrivers_count(cl_object);
|
||||
@end table
|
||||
@end defun
|
||||
|
||||
@lspindex mp:barrier_wait
|
||||
@lspindex mp_barrier_wait
|
||||
@defun mp:barrier_wait
|
||||
@table @var
|
||||
@item returns
|
||||
???
|
||||
@item C/C++ signature
|
||||
cl_object mp_barrier_wait _ECL_ARGS((cl_narg, cl_object, ...));
|
||||
@end table
|
||||
@end defun
|
||||
|
||||
cl_object mp_barrier_unblock _ECL_ARGS((cl_narg, cl_object, ...));
|
||||
65
src/doc/new-doc/extensions/mp_ref_cv.txi
Normal file
65
src/doc/new-doc/extensions/mp_ref_cv.txi
Normal file
|
|
@ -0,0 +1,65 @@
|
|||
@node Condition variables
|
||||
@subsubsection Condition variables
|
||||
|
||||
|
||||
@cppindex mp_make_condition_variable
|
||||
@lspindex mp:make-condition-variable
|
||||
|
||||
@deftypefun cl_object mp_make_condition_variable ()
|
||||
@end deftypefun
|
||||
|
||||
@defun mp:make-condition-variable
|
||||
Creates a condition variable.
|
||||
@end defun
|
||||
|
||||
|
||||
@cppindex mp_condition_variable_wait
|
||||
@lspindex mp:condition-variable-wait
|
||||
|
||||
@deftypefun cl_object mp_condition_variable_wait (cl_object cv, cl_object lock)
|
||||
@end deftypefun
|
||||
|
||||
@defun mp:condition-variable-wait cv lock
|
||||
Release @code{lock} and suspend thread until condition
|
||||
@code{mp:condition-variable-signal} is called on @code{cv}. When thread
|
||||
resumes re-aquire @code{lock}.
|
||||
@end defun
|
||||
|
||||
|
||||
@cppindex mp_condition_variable_timedwait
|
||||
@lspindex mp:condition-variable-timedwait
|
||||
|
||||
@deftypefun cl_object mp_condition_variable_timedwait (cl_object cv, cl_object lock, cl_object seconds)
|
||||
@end deftypefun
|
||||
|
||||
@defun mp:condition-variable-timedwait cv lock seconds
|
||||
@code{mp:condition-variable-wait} which timeouts after @code{seconds}
|
||||
seconds.
|
||||
@end defun
|
||||
|
||||
|
||||
@cppindex mp_condition_variable_signal
|
||||
@lspindex mp:condition-variable-signal
|
||||
|
||||
@deftypefun cl_object mp_condition_variable_signal (cl_object cv)
|
||||
@end deftypefun
|
||||
|
||||
@defun mp:condition-variable-signal cv
|
||||
Signal @code{cv} (wakes up only one waiter). After signal, signaling
|
||||
thread keeps lock, waking thread goes on the queue waiting for the lock.
|
||||
|
||||
See @code{mp:condition-variable-wait}.
|
||||
@end defun
|
||||
|
||||
|
||||
@cppindex mp_condition_variable-broadcast
|
||||
@lspindex mp:condition-variable-broadcast
|
||||
|
||||
@deftypefun cl_object mp_condition_variable_broadcast (cl_object cv)
|
||||
@end deftypefun
|
||||
|
||||
@defun mp:condition-variable-broadcast cv
|
||||
Signal @code{cv} (wakes up all waiters).
|
||||
|
||||
See @code{mp:condition-variable-wait}.
|
||||
@end defun
|
||||
82
src/doc/new-doc/extensions/mp_ref_mailbox.txi
Normal file
82
src/doc/new-doc/extensions/mp_ref_mailbox.txi
Normal file
|
|
@ -0,0 +1,82 @@
|
|||
@node Mailboxes
|
||||
@subsubsection Mailboxes
|
||||
/* threads/mailbox.d */
|
||||
|
||||
@lspindex mp:make_mailbox
|
||||
@lspindex mp_make_mailbox
|
||||
@defun mp:make_mailbox
|
||||
@table @var
|
||||
@item returns
|
||||
???
|
||||
@item C/C++ signature
|
||||
cl_object mp_make_mailbox _ECL_ARGS((cl_narg, ...));
|
||||
@end table
|
||||
@end defun
|
||||
|
||||
@lspindex mp:mailbox_name
|
||||
@lspindex mp_mailbox_name
|
||||
@defun mp:mailbox_name
|
||||
@table @var
|
||||
@item returns
|
||||
???
|
||||
@item C/C++ signature
|
||||
cl_object mp_mailbox_name(cl_object mailbox);
|
||||
@end table
|
||||
@end defun
|
||||
|
||||
@lspindex mp:mailbox_count
|
||||
@lspindex mp_mailbox_count
|
||||
@defun mp:mailbox_count
|
||||
@table @var
|
||||
@item returns
|
||||
???
|
||||
@item C/C++ signature
|
||||
cl_object mp_mailbox_count(cl_object mailbox);
|
||||
@end table
|
||||
@end defun
|
||||
|
||||
@lspindex mp:mailbox_empty_p
|
||||
@lspindex mp_mailbox_empty_p
|
||||
@defun mp:mailbox_empty_p
|
||||
@table @var
|
||||
@item returns
|
||||
???
|
||||
@item C/C++ signature
|
||||
cl_object mp_mailbox_empty_p(cl_object);
|
||||
@end table
|
||||
@end defun
|
||||
|
||||
@lspindex mp:mailbox_read
|
||||
@lspindex mp_mailbox_read
|
||||
@defun mp:mailbox_read
|
||||
@table @var
|
||||
@item returns
|
||||
???
|
||||
@item C/C++ signature
|
||||
cl_object mp_mailbox_read(cl_object mailbox);
|
||||
@end table
|
||||
@end defun
|
||||
|
||||
@lspindex mp:mailbox_try_read
|
||||
@lspindex mp_mailbox_try_read
|
||||
@defun mp:mailbox_try_read
|
||||
@table @var
|
||||
@item returns
|
||||
???
|
||||
@item C/C++ signature
|
||||
cl_object mp_mailbox_try_read(cl_object mailbox);
|
||||
@end table
|
||||
@end defun
|
||||
|
||||
@lspindex mp:mailbox_send
|
||||
@lspindex mp_mailbox_send
|
||||
@defun mp:mailbox_send
|
||||
@table @var
|
||||
@item returns
|
||||
???
|
||||
@item C/C++ signature
|
||||
cl_object mp_mailbox_send(cl_object mailbox, cl_object msg);
|
||||
@end table
|
||||
@end defun
|
||||
|
||||
cl_object mp_mailbox_try_send(cl_object mailbox, cl_object msg);
|
||||
118
src/doc/new-doc/extensions/mp_ref_mutex.txi
Normal file
118
src/doc/new-doc/extensions/mp_ref_mutex.txi
Normal file
|
|
@ -0,0 +1,118 @@
|
|||
|
||||
@node Locks
|
||||
@subsubsection Locks (mutexes)
|
||||
/* threads/process.d */
|
||||
|
||||
@lspindex mp:make_lock
|
||||
@cppindex mp_make_lock
|
||||
@defun mp:make_lock
|
||||
@table @var
|
||||
@item returns
|
||||
???
|
||||
@item C/C++ signature
|
||||
cl_object mp_make_lock _ECL_ARGS((cl_narg narg, ...));
|
||||
@end table
|
||||
@end defun
|
||||
|
||||
@lspindex mp:recursive_lock_p
|
||||
@lspindex mp_recursive_lock_p
|
||||
@defun mp:recursive_lock_p
|
||||
@table @var
|
||||
@item returns
|
||||
???
|
||||
@item C/C++ signature
|
||||
cl_object mp_recursive_lock_p(cl_object lock);
|
||||
@end table
|
||||
@end defun
|
||||
|
||||
@lspindex mp:holding_lock_p
|
||||
@lspindex mp_holding_lock_p
|
||||
@defun mp:holding_lock_p
|
||||
@table @var
|
||||
@item returns
|
||||
???
|
||||
@item C/C++ signature
|
||||
cl_object mp_holding_lock_p(cl_object lock);
|
||||
@end table
|
||||
@end defun
|
||||
|
||||
@lspindex mp:lock_name
|
||||
@lspindex mp_lock_name
|
||||
@defun mp:lock_name
|
||||
@table @var
|
||||
@item returns
|
||||
???
|
||||
@item C/C++ signature
|
||||
cl_object mp_lock_name(cl_object lock);
|
||||
@end table
|
||||
@end defun
|
||||
|
||||
@lspindex mp:lock_owner
|
||||
@lspindex mp_lock_owner
|
||||
@defun mp:lock_owner
|
||||
@table @var
|
||||
@item returns
|
||||
???
|
||||
@item C/C++ signature
|
||||
cl_object mp_lock_owner(cl_object lock);
|
||||
@end table
|
||||
@end defun
|
||||
|
||||
@lspindex mp:lock_count
|
||||
@lspindex mp_lock_count
|
||||
@defun mp:lock_count
|
||||
@table @var
|
||||
@item returns
|
||||
???
|
||||
@item C/C++ signature
|
||||
cl_object mp_lock_count(cl_object lock);
|
||||
@end table
|
||||
@end defun
|
||||
|
||||
@lspindex mp:get_lock
|
||||
@lspindex mp_get_lock
|
||||
@defun mp:get_lock
|
||||
@table @var
|
||||
@item returns
|
||||
???
|
||||
@item C/C++ signature
|
||||
cl_object mp_get_lock _ECL_ARGS((cl_narg narg, cl_object lock, ...));
|
||||
@end table
|
||||
@end defun
|
||||
|
||||
@lspindex mp:get_lock_wait
|
||||
@lspindex mp_get_lock_wait
|
||||
@defun mp:get_lock_wait
|
||||
@table @var
|
||||
@item returns
|
||||
???
|
||||
@item C/C++ signature
|
||||
cl_object mp_get_lock_wait(cl_object lock);
|
||||
@end table
|
||||
@end defun
|
||||
|
||||
@lspindex mp:get_lock_nowait
|
||||
@lspindex mp_get_lock_nowait
|
||||
@defun mp:get_lock_nowait
|
||||
@table @var
|
||||
@item returns
|
||||
???
|
||||
@item C/C++ signature
|
||||
cl_object mp_get_lock_nowait(cl_object lock);
|
||||
@end table
|
||||
@end defun
|
||||
|
||||
@lspindex mp:giveup_lock
|
||||
@lspindex mp_giveup_lock
|
||||
@defun mp:giveup_lock
|
||||
@table @var
|
||||
@item returns
|
||||
???
|
||||
@item C/C++ signature
|
||||
cl_object mp_giveup_lock(cl_object lock);
|
||||
@end table
|
||||
@end defun
|
||||
|
||||
@lspindex mp:with-lock
|
||||
@defmac mp:with-lock
|
||||
@end defmac
|
||||
74
src/doc/new-doc/extensions/mp_ref_rwlock.txi
Normal file
74
src/doc/new-doc/extensions/mp_ref_rwlock.txi
Normal file
|
|
@ -0,0 +1,74 @@
|
|||
@node Read-Write locks
|
||||
@subsubsection Read-Write locks
|
||||
/* threads/rwlock.d */
|
||||
|
||||
@lspindex mp:make_rwlock
|
||||
@lspindex mp_make_rwlock
|
||||
@defun mp:make_rwlock
|
||||
@table @var
|
||||
@item returns
|
||||
???
|
||||
@item C/C++ signature
|
||||
cl_object mp_make_rwlock _ECL_ARGS((cl_narg narg, ...));
|
||||
@end table
|
||||
@end defun
|
||||
|
||||
@lspindex mp:rwlock_name
|
||||
@lspindex mp_rwlock_name
|
||||
@defun mp:rwlock_name
|
||||
@table @var
|
||||
@item returns
|
||||
???
|
||||
@item C/C++ signature
|
||||
cl_object mp_rwlock_name(cl_object lock);
|
||||
@end table
|
||||
@end defun
|
||||
|
||||
@lspindex mp:get_rwlock_read
|
||||
@lspindex mp_get_rwlock_read
|
||||
@defun mp:get_rwlock_read
|
||||
@table @var
|
||||
@item returns
|
||||
???
|
||||
@item C/C++ signature
|
||||
cl_object mp_get_rwlock_read _ECL_ARGS((cl_narg narg, cl_object lock, ...));
|
||||
@end table
|
||||
@end defun
|
||||
|
||||
@lspindex mp:get_rwlock_write
|
||||
@lspindex mp_get_rwlock_write
|
||||
@defun mp:get_rwlock_write
|
||||
@table @var
|
||||
@item returns
|
||||
???
|
||||
@item C/C++ signature
|
||||
cl_object mp_get_rwlock_write _ECL_ARGS((cl_narg narg, cl_object lock, ...));
|
||||
@end table
|
||||
@end defun
|
||||
|
||||
@lspindex mp:giveup_rwlock_read
|
||||
@lspindex mp_giveup_rwlock_read
|
||||
@defun mp:giveup_rwlock_read
|
||||
@table @var
|
||||
@item returns
|
||||
???
|
||||
@item C/C++ signature
|
||||
cl_object mp_giveup_rwlock_read(cl_object lock);
|
||||
@end table
|
||||
@end defun
|
||||
|
||||
@lspindex mp:giveup_rwlock_write
|
||||
@lspindex mp_giveup_rwlock_write
|
||||
@defun mp:giveup_rwlock_write
|
||||
@table @var
|
||||
@item returns
|
||||
???
|
||||
@item C/C++ signature
|
||||
cl_object mp_giveup_rwlock_write(cl_object lock);
|
||||
@end table
|
||||
@end defun
|
||||
|
||||
|
||||
@lspindex mp:with-rwlock
|
||||
@defmac mp:with-rwlock
|
||||
@end defmac
|
||||
82
src/doc/new-doc/extensions/mp_ref_sem.txi
Normal file
82
src/doc/new-doc/extensions/mp_ref_sem.txi
Normal file
|
|
@ -0,0 +1,82 @@
|
|||
@node Semaphores
|
||||
@subsubsection Semaphores
|
||||
/* threads/semaphore.d */
|
||||
|
||||
@lspindex mp:make_semaphore
|
||||
@lspindex mp_make_semaphore
|
||||
@defun mp:make_semaphore
|
||||
@table @var
|
||||
@item returns
|
||||
???
|
||||
@item C/C++ signature
|
||||
cl_object mp_make_semaphore _ECL_ARGS((cl_narg, ...));
|
||||
@end table
|
||||
@end defun
|
||||
|
||||
@lspindex mp:semaphore_count
|
||||
@lspindex mp_semaphore_count
|
||||
@defun mp:semaphore_count
|
||||
@table @var
|
||||
@item returns
|
||||
???
|
||||
@item C/C++ signature
|
||||
cl_object mp_semaphore_count(cl_object);
|
||||
@end table
|
||||
@end defun
|
||||
|
||||
@lspindex mp:semaphore_name
|
||||
@lspindex mp_semaphore_name
|
||||
@defun mp:semaphore_name
|
||||
@table @var
|
||||
@item returns
|
||||
???
|
||||
@item C/C++ signature
|
||||
cl_object mp_semaphore_name(cl_object);
|
||||
@end table
|
||||
@end defun
|
||||
|
||||
@lspindex mp:semaphore_wait_count
|
||||
@lspindex mp_semaphore_wait_count
|
||||
@defun mp:semaphore_wait_count
|
||||
@table @var
|
||||
@item returns
|
||||
???
|
||||
@item C/C++ signature
|
||||
cl_object mp_semaphore_wait_count(cl_object);
|
||||
@end table
|
||||
@end defun
|
||||
|
||||
@lspindex mp:wait_on_semaphore
|
||||
@lspindex mp_wait_on_semaphore
|
||||
@defun mp:wait_on_semaphore
|
||||
@table @var
|
||||
@item returns
|
||||
???
|
||||
@item C/C++ signature
|
||||
cl_object mp_wait_on_semaphore(cl_object);
|
||||
@end table
|
||||
@end defun
|
||||
|
||||
@lspindex mp:try_get_semaphore
|
||||
@lspindex mp_try_get_semaphore
|
||||
@defun mp:try_get_semaphore
|
||||
@table @var
|
||||
@item returns
|
||||
???
|
||||
@item C/C++ signature
|
||||
cl_object mp_try_get_semaphore(cl_object);
|
||||
@end table
|
||||
@end defun
|
||||
|
||||
@lspindex mp:signal_semaphore
|
||||
@lspindex mp_signal_semaphore
|
||||
@defun mp:signal_semaphore
|
||||
@table @var
|
||||
@item returns
|
||||
???
|
||||
@item C/C++ signature
|
||||
cl_object mp_signal_semaphore _ECL_ARGS((cl_narg, cl_object, ...));
|
||||
@end table
|
||||
@end defun
|
||||
|
||||
cl_object ecl_make_semaphore(cl_object name, cl_fixnum count);
|
||||
Loading…
Add table
Add a link
Reference in a new issue