The mailbox Reference Manual

Next: , Previous: , Up: (dir)   [Contents][Index]

The mailbox Reference Manual

This is the mailbox Reference Manual, generated automatically by Declt version 4.0 beta 2 "William Riker" on Thu Sep 15 05:34:27 2022 GMT+0.

Table of Contents


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.


Previous: , Up: Systems   [Contents][Index]

2.1 mailbox

Simple multithreading mailboxes.

Author

Lucien Pullen <drurowin@gmail.com>

License

MIT

Dependency

bordeaux-threads (system).

Source

mailbox.asd.

Child Component

mailbox.lisp (file).


3 Files

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


Previous: , Up: Files   [Contents][Index]

3.1 Lisp


Next: , Previous: , Up: Lisp   [Contents][Index]

3.1.1 mailbox/mailbox.asd

Source

mailbox.asd.

Parent Component

mailbox (system).

ASDF Systems

mailbox.


Previous: , Up: Lisp   [Contents][Index]

3.1.2 mailbox/mailbox.lisp

Source

mailbox.asd.

Parent Component

mailbox (system).

Packages

mailbox.

Public Interface
Internals

mailbox (class).


4 Packages

Packages are listed by definition order.


Previous: , Up: Packages   [Contents][Index]

4.1 mailbox

Source

mailbox.lisp.

Use List

common-lisp.

Public Interface
Internals

mailbox (class).


5 Definitions

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


Next: , Previous: , Up: Definitions   [Contents][Index]

5.1 Public Interface


5.1.1 Ordinary functions

Function: make-mailbox ()
Package

mailbox.

Source

mailbox.lisp.


5.1.2 Generic functions

Generic Function: mailboxp (object)

Return T if OBJECT is a mailbox.

Package

mailbox.

Source

mailbox.lisp.

Methods
Method: mailboxp (object)
Method: mailboxp ((object mailbox))
Generic Function: post-mail (object mailbox)

Add OBJECT to MAILBOX.

Package

mailbox.

Source

mailbox.lisp.

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.

Methods
Method: read-mail ((mailbox mailbox))

5.1.3 Standalone methods

Method: initialize-instance :after ((the mailbox) &rest initargs)
Source

mailbox.lisp.


5.2 Internals


Previous: , Up: Internals   [Contents][Index]

5.2.1 Classes

Class: mailbox
Package

mailbox.

Source

mailbox.lisp.

Direct methods
Direct slots
Slot: mailbox
Initform

(cons nil nil)

Slot: tail
Slot: lock
Initform

(bordeaux-threads:make-lock)

Slot: emptyp
Initform

t


Appendix A Indexes


Next: , Previous: , Up: Indexes   [Contents][Index]

A.1 Concepts


Next: , Previous: , Up: Indexes   [Contents][Index]

A.3 Variables

Jump to:   E   L   M   S   T  
Index Entry  Section

E
emptyp: Private classes

L
lock: Private classes

M
mailbox: Private classes

S
Slot, emptyp: Private classes
Slot, lock: Private classes
Slot, mailbox: Private classes
Slot, tail: Private classes

T
tail: Private classes

Jump to:   E   L   M   S   T