The mailbox Reference Manual

Table of Contents

The mailbox Reference Manual

This is the mailbox Reference Manual, generated automatically by Declt version 3.0 "Montgomery Scott" on Tue Dec 22 14:21:06 2020 GMT+0.

1 Introduction

* mailbox
Simple multithreading mailboxes for Common Lisp.

** API
(*make-mailbox*)---Create a new mailbox object.

(*mailboxp* /object/)---Return T iff /object/ is a mailbox object.  The object must obey the
following interface.

(*post-mail* /object/ /mailbox/)---Add /object/ to /mailbox/.  /object/ is returned.

(*read-mail* /mailbox/)---Return multiple values the oldest object in /mailbox/ and T if the
mailbox is not empty, otherwise NIL and NIL.

** Dependencies
This library uses the [[http://common-lisp.net/project/bordeaux-threads/][Bordeaux Threads]] library for working with locks.

** License
*mailbox* is licensed under the MIT license.  That basically means you can do anything with it.

2 Systems

The main system appears first, followed by any subsystem dependency.

2.1 mailbox

Author

Lucien Pullen <drurowin@gmail.com>

License

MIT

Description

Simple multithreading mailboxes.

Dependency

bordeaux-threads

Source

mailbox.asd (file)

Component

mailbox.lisp (file)

3 Files

Files are sorted by type and then listed depth-first from the systems components trees.

3.1 Lisp

3.1.1 mailbox.asd

Location

mailbox.asd

Systems

mailbox (system)

3.1.2 mailbox/mailbox.lisp

Parent

mailbox (system)

Location

mailbox.lisp

Packages

mailbox

Exported Definitions

• mailboxp (generic function)
• mailboxp (method)
• mailboxp (method)
• make-mailbox (function)
• post-mail (generic function)
• post-mail (method)
• read-mail (generic function)
• read-mail (method)

Internal Definitions

mailbox (class)

4 Packages

Packages are listed by definition order.

4.1 mailbox

Source

mailbox.lisp (file)

Use List

common-lisp

Exported Definitions

• mailboxp (generic function)
• mailboxp (method)
• mailboxp (method)
• make-mailbox (function)
• post-mail (generic function)
• post-mail (method)
• read-mail (generic function)
• read-mail (method)

Internal Definitions

mailbox (class)

5 Definitions

Definitions are sorted by export status, category, package, and then by lexicographic order.

5.1 Exported definitions

5.1.1 Functions

Function: make-mailbox ()

Package

mailbox

Source

mailbox.lisp (file)

5.1.2 Generic functions

Generic Function: mailboxp OBJECT

Return T if OBJECT is a mailbox.

Package

mailbox

Source

mailbox.lisp (file)

Methods

Method: mailboxp OBJECT

Method: mailboxp (OBJECT mailbox)

Generic Function: post-mail OBJECT MAILBOX

Add OBJECT to MAILBOX.

Package

mailbox

Source

mailbox.lisp (file)

Methods

Method: post-mail OBJECT (MAILBOX mailbox)

Generic Function: read-mail MAILBOX

Retrieve oldest object from MAILBOX.

If the mailbox is not empty return multiple values the object and T, otherwise NIL and NIL.

Package

mailbox

Source

mailbox.lisp (file)

Methods

Method: read-mail (MAILBOX mailbox)

5.2 Internal definitions

5.2.1 Classes

Class: mailbox ()

Package

mailbox

Source

mailbox.lisp (file)

Direct superclasses

standard-object (class)

Direct methods

• read-mail (method)
• post-mail (method)
• mailboxp (method)
• initialize-instance (method)

Direct slots

Slot: mailbox

Initform

(cons nil nil)

Slot: tail

Slot: lock

Initform

(bordeaux-threads:make-lock)

Slot: emptyp

Initform

t

Appendix A Indexes

A.1 Concepts

A.2 Functions

A.3 Variables

A.4 Data types