Function

Summary

Reads the next object in a mailbox.

Package

mp

Signature

mailbox-read mailbox &optional wait-reason => object

Arguments

mailbox

A mailbox.

wait-reason

A string.

Values

object

Any object.

Description

The mailbox-read function returns the next object from the mailbox. If the mailbox is empty, this function blocks until an object is placed in the mailbox. The wait-reason is used as the first argument to process-wait .

See also

mailbox-empty-p
mailbox-peek
mailbox-send
make-mailbox