Next: Introduction, Previous: (dir), Up: (dir) [Contents][Index]
This is the safe-queue Reference Manual, version 0.2, generated automatically by Declt version 4.0 beta 2 "William Riker" on Wed Jun 15 05:46:00 2022 GMT+0.
Next: Systems, Previous: The safe-queue Reference Manual, Up: The safe-queue Reference Manual [Contents][Index]
Thread-safe queues and mailboxes. Provides uniform queue/mailbox interface. On sbcl uses sb-concurrency and lparallel on others
(setf q (make-mailbox))
(mailbox-send-message q 1)
(mailbox-send-message q 2)
(mailbox-send-message q 3)
(mailbox-receive-message q)
1
(mailbox-receive-message q)
2
(mailbox-receive-message q)
3
(mailbox-receive-message-no-hang q)
NIL
NIL
(mailbox-receive-message q :timeout 5)
;; hopefuly after 5 seconds
NIL
NIL
(mailbox-receive-message q)
Thread blocked
Copyright (c) 2010-2013 3b https://github.com/3b
Copyright (c) 2013-2015 Ilya Khaprov ilya.khaprov@publitechs.com
MIT
Next: Files, Previous: Introduction, Up: The safe-queue Reference Manual [Contents][Index]
The main system appears first, followed by any subsystem dependency.
Thread-safe queue and mailbox
Ilya Khaprov <ilya.khaprov@publitechs.com>
3b
MIT
0.2
Next: Packages, Previous: Systems, Up: The safe-queue Reference Manual [Contents][Index]
Files are sorted by type and then listed depth-first from the systems components trees.
Next: safe-queue/src/package.lisp, Previous: Lisp, Up: Lisp [Contents][Index]
safe-queue (system).
Next: safe-queue/src/sb-concurrency-patch.lisp, Previous: safe-queue/safe-queue.asd, Up: Lisp [Contents][Index]
safe-queue (system).
Next: safe-queue/src/concurrency-sbcl.lisp, Previous: safe-queue/src/package.lisp, Up: Lisp [Contents][Index]
src/package.lisp (file).
safe-queue (system).
Previous: safe-queue/src/sb-concurrency-patch.lisp, Up: Lisp [Contents][Index]
src/sb-concurrency-patch.lisp (file).
safe-queue (system).
mailboxp (function).
Next: Definitions, Previous: Files, Up: The safe-queue Reference Manual [Contents][Index]
Packages are listed by definition order.
Next: safe-queue, Previous: Packages, Up: Packages [Contents][Index]
Previous: safe-queue-system, Up: Packages [Contents][Index]
common-lisp.
mailboxp (function).
Next: Indexes, Previous: Packages, Up: The safe-queue Reference Manual [Contents][Index]
Definitions are sorted by export status, category, package, and then by lexicographic order.
Next: Internals, Previous: Definitions, Up: Definitions [Contents][Index]
Next: Types, Previous: Public Interface, Up: Public Interface [Contents][Index]
Retrieves the oldest value in QUEUE and returns it as the primary value, and T as secondary value. If the queue is empty, returns NIL as both primary and secondary value.
Adds VALUE to the end of QUEUE. Returns VALUE.
Returns the number of messages currently in the MAILBOX.
Returns true if MAILBOX is currently empty, NIL otherwise.
Returns a fresh list containing all the messages in the mailbox. Does not remove messages from the mailbox.
Removes the oldest message from MAILBOX and returns it as the primary value. If MAILBOX is empty waits until a message arrives.
The non-blocking variant of RECEIVE-MESSAGE. Returns two values, the message removed from MAILBOX, and a flag specifying whether a message could be received.
Removes and returns all (or at most N) currently pending messages
from MAILBOX, or returns NIL if no messages are pending.
Note: Concurrent threads may be snarfing messages during the run of this function, so even though X,Y appear right next to each other in the result, does not necessarily mean that Y was the message sent right after X.
Adds a MESSAGE to MAILBOX. Message can be any object.
Returns a new MAILBOX with messages in INITIAL-CONTENTS enqueued.
Returns a new QUEUE with NAME and contents of the INITIAL-CONTENTS sequence enqueued.
Returns the number of messages currently in the QUEUE.
Returns true if QUEUE is currently empty, NIL otherwise.
Previous: Ordinary functions, Up: Public Interface [Contents][Index]
Previous: Public Interface, Up: Definitions [Contents][Index]
Returns true if MAILBOX is currently empty, NIL otherwise.
Previous: Definitions, Up: The safe-queue Reference Manual [Contents][Index]
| Jump to: | D E F M Q |
|---|
| Jump to: | D E F M Q |
|---|
| Jump to: | F M P Q S T |
|---|
| Jump to: | F M P Q S T |
|---|