The mailbox Reference Manual

Table of Contents

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

The mailbox Reference Manual

This is the mailbox Reference Manual, generated automatically by Declt version 2.3 "Robert April" on Tue Feb 20 09:02:48 2018 GMT+0.


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

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.


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

2 Systems

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


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

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)


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

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 files   [Contents][Index]

3.1.1 mailbox.asd

Location

mailbox.asd

Systems

mailbox (system)


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

3.1.2 mailbox/mailbox.lisp

Parent

mailbox (system)

Location

mailbox.lisp

Packages

mailbox

Exported Definitions
Internal Definitions

mailbox (class)


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

4 Packages

Packages are listed by definition order.


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

4.1 mailbox

Source

mailbox.lisp (file)

Use List

common-lisp

Exported Definitions
Internal Definitions

mailbox (class)


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

5 Definitions

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


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

5.1 Exported definitions


Next: , Previous: , Up: Exported definitions   [Contents][Index]

5.1.1 Functions

Function: make-mailbox ()
Package

mailbox

Source

mailbox.lisp (file)


Previous: , Up: Exported definitions   [Contents][Index]

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)

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

5.2 Internal definitions


Previous: , Up: Internal definitions   [Contents][Index]

5.2.1 Classes

Class: mailbox ()
Package

mailbox

Source

mailbox.lisp (file)

Direct superclasses

standard-object (class)

Direct methods
Direct slots
Slot: mailbox
Initform

(cons nil nil)

Slot: tail
Slot: lock
Initform

(bordeaux-threads:make-lock)

Slot: emptyp
Initform

t


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

Appendix A Indexes


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

A.1 Concepts

Jump to:   F   L   M  
Index Entry  Section

F
File, Lisp, mailbox.asd: The mailbox<dot>asd file
File, Lisp, mailbox/mailbox.lisp: The mailbox/mailbox<dot>lisp file

L
Lisp File, mailbox.asd: The mailbox<dot>asd file
Lisp File, mailbox/mailbox.lisp: The mailbox/mailbox<dot>lisp file

M
mailbox.asd: The mailbox<dot>asd file
mailbox/mailbox.lisp: The mailbox/mailbox<dot>lisp file

Jump to:   F   L   M  

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

A.2 Functions

Jump to:   F   G   M   P   R  
Index Entry  Section

F
Function, make-mailbox: Exported functions

G
Generic Function, mailboxp: Exported generic functions
Generic Function, post-mail: Exported generic functions
Generic Function, read-mail: Exported generic functions

M
mailboxp: Exported generic functions
mailboxp: Exported generic functions
mailboxp: Exported generic functions
make-mailbox: Exported functions
Method, mailboxp: Exported generic functions
Method, mailboxp: Exported generic functions
Method, post-mail: Exported generic functions
Method, read-mail: Exported generic functions

P
post-mail: Exported generic functions
post-mail: Exported generic functions

R
read-mail: Exported generic functions
read-mail: Exported generic functions

Jump to:   F   G   M   P   R  

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

A.3 Variables

Jump to:   E   L   M   S   T  
Index Entry  Section

E
emptyp: Internal classes

L
lock: Internal classes

M
mailbox: Internal classes

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

T
tail: Internal classes

Jump to:   E   L   M   S   T  

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

A.4 Data types

Jump to:   C   M   P   S  
Index Entry  Section

C
Class, mailbox: Internal classes

M
mailbox: The mailbox system
mailbox: The mailbox package
mailbox: Internal classes

P
Package, mailbox: The mailbox package

S
System, mailbox: The mailbox system

Jump to:   C   M   P   S