mailbox

  1. mailbox
  2. Documentation
    1. mailbox-timeout-exception?
    2. make-mailbox
    3. mailbox?
    4. mailbox-name
    5. mailbox-empty?
    6. mailbox-count
    7. mailbox-waiting?
    8. mailbox-waiters
    9. mailbox-send!
    10. mailbox-receive!
    11. mailbox-wait!
    12. mailbox-push-back!
    13. mailbox-push-back-list!
    14. make-mailbox-cursor
    15. mailbox-cursor?
    16. mailbox-cursor-mailbox
    17. mailbox-cursor-next
    18. mailbox-cursor-rewind
    19. mailbox-cursor-extract-and-rewind
    20. mailbox-cursor-rewound?
    21. mailbox-cursor-more?
  3. Usage
  4. Examples
  5. Notes
  6. Author
  7. Requirements
  8. Version history
  9. License

Documentation

Thread-safe queues with timeout.

mailbox-timeout-exception?

[procedure] (mailbox-timeout-exception? *) => boolean

Is the * a mailbox timeout exception?

A mailbox timeout exception is a composite condition of 'exn, 'mailbox, and 'timeout, with properties of 'location and 'arguments.

make-mailbox

[procedure] (make-mailbox [NAME]) => mailbox

Returns a new mailbox object. NAME is an optional object to identify this mailbox and defaults to some gensym'd symbol.

mailbox?

[procedure] (mailbox? *) => boolean

Is the * a mailbox?

mailbox-name

[procedure] (mailbox-name MAILBOX) => *

Returns the name of the MAILBOX.

mailbox-empty?

[procedure] (mailbox-empty? MAILBOX) => boolean

If there are no queued objects in the MAILBOX, then this procedure returns #t, otherwise it returns #f.

mailbox-count

[procedure] (mailbox-count MAILBOX) => integer

Returns the number of queued objects for the MAILBOX.

mailbox-waiting?

[procedure] (mailbox-waiting? MAILBOX) => boolean

Is any thread waiting for the MAILBOX?

mailbox-waiters

[procedure] (mailbox-waiters MAILBOX) => list

Returns a list of the threads waiting for the MAILBOX.

mailbox-send!

[procedure] (mailbox-send! MAILBOX X)

Queues the data object X. If any threads exist that are waiting for input on MAILBOX, the execution of the first one will be resumed. The data will be read out of a mailbox in the same order in which is written in (in FIFO manner).

mailbox-receive!

[procedure] (mailbox-receive! MAILBOX [TIMEOUT [DEFAULT]]) => *

If there is any data in the MAILBOX, then the first object will be removed and returned as the result. If the mailbox is currently empty, the current thread will suspended until data is available.

TIMEOUT is a SRFI-18 time object or the real number of seconds.

Should TIMEOUT be specified and occur the DEFAULT, if supplied, will be returned. Otherwise a mailbox timeout exception will be signaled for the calling thread. The DEFAULT value cannot be (void).

mailbox-wait!

[procedure] (mailbox-wait! MAILBOX [TIMEOUT])

Similar to mailbox-receive!, but does not remove the received result from the queue of pending data.

TIMEOUT is a SRFI-18 time object or the real number of seconds.

Should TIMEOUT be specified and occur a mailbox timeout exception will be signaled for the calling thread.

mailbox-push-back!

[procedure] (mailbox-push-back! MAILBOX X)

Pushes the data object X into the first position of a mailbox.

mailbox-push-back-list!

[procedure] (mailbox-push-back-list! MAILBOX XS)

Pushes the list of objects XS back into the mailbox, so that (car XS) becomes the next receivable item.

make-mailbox-cursor

[procedure] (make-mailbox-cursor MAILBOX) => mailbox-cursor

Returns an object which can enumerate a mailbox.

Multiple cursors can scan, and mutate, the same mailbox.

mailbox-cursor?

[procedure] (mailbox-cursor? *) => boolean

Is the * a mailbox-cursor?

mailbox-cursor-mailbox

[procedure] (mailbox-cursor-mailbox MAILBOX-CURSOR) => mailbox

Returns the mailbox object associated with the mailbox cursor.

mailbox-cursor-next

[procedure] (mailbox-cursor-next MAILBOX-CURSOR [TIMEOUT [DEFAULT]]) => *

Returns the next object in the mailbox queue, waiting if necessary.

The mailbox queue is scanned from oldest to newest.

TIMEOUT is a SRFI-18 time object or the real number of seconds.

Should TIMEOUT be specified and occur the DEFAULT, if supplied, will be returned. Otherwise a mailbox timeout exception will be signaled for the calling thread. The DEFAULT value cannot be (void).

mailbox-cursor-rewind

[procedure] (mailbox-cursor-rewind MAILBOX-CURSOR)

Position the cursor at the oldest message in the mailbox.

mailbox-cursor-extract-and-rewind

[procedure] (mailbox-cursor-extract-and-rewind MAILBOX-CURSOR)

Remove from the associated mailbox queue the last object returned by mailbox-cursor-next and position the cursor at the oldest message in the mailbox.

The extraction is not performed without a previous call to mailbox-cursor-next.

mailbox-cursor-rewound?

[procedure] (mailbox-cursor-rewound? MAILBOX-CURSOR) => boolean

Is the MAILBOX-CURSOR positioned at the start of the mailbox queue?

mailbox-cursor-more?

[procedure] (mailbox-cursor-unwound? MAILBOX-CURSOR) => boolean

Is the MAILBOX-CURSOR positioned at the end of the mailbox queue?

Usage

(require-extension mailbox)

or

(require-library mailbox)
...
(import mailbox)

Examples

(define (consumer ch)
  (make-thread
    (lambda ()
      (let loop () 
        (print (current-thread) ": reading " (mailbox-receive! ch))
        (loop) ) ) ) )

(define ch (make-mailbox))
(thread-start! (consumer ch))
(for-each
  (lambda (x)
    (print (current-thread) ": writing " x)
    (mailbox-send! ch x) )
  '(33 44 55 hello) )

Notes

Using a timeout will allow the calling thread to unblock eventually.

Author

felix winkelmann

Kon Lovett

Requirements

check-errors

Version history

2.1.3
Fix for resuming a thread when mailbox empty; reported by Jeronimo Pellegrini. Added mailbox-cursor-unwound?. mailbox-name can be arbitrary Scheme object.
2.1.2
2.1.1
2.1.0
Needs "check-errors" extension.
2.0.0
Port to hygienic Chicken.

License

Copyright (c) 2003, Felix L. Winkelmann All rights reserved.

Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:

 Redistributions of source code must retain the above copyright notice, this list of conditions and the following
   disclaimer. 
 Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following
   disclaimer in the documentation and/or other materials provided with the distribution. 
 Neither the name of the author nor the names of its contributors may be used to endorse or promote
   products derived from this software without specific prior written permission. 

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDERS OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.