The thread.comm.rendezvous Reference Manual

This is the thread.comm.rendezvous Reference Manual, version 11.10.2, generated automatically by Declt version 4.0 beta 2 "William Riker" on Sat Dec 03 23:29:35 2022 GMT+0.

Table of Contents


1 Introduction


2 Systems

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


2.1 thread.comm.rendezvous

Rendezvous thread synchronization

Author

Kazuo Koga

License

MIT

Long Description

# Thread.Comm.Rendezvous

## Usage

(let ((rdv (make-rendezvous)))
(bordeaux-threads:make-thread (lambda () (accept-rendezvous rdv)))
(call-rendezvous rdv 2))

## Installation

Use Quicklisp.

## API

Thread.Comm.Rendezvous provides [CSP(Communicating sequential processes)](http://en.wikipedia.org/wiki/Communicating_sequential_processes) style inter thread communication channel.

All API are MT-Safe.

Currently run only on SBCL and Clozure-CL.

### [Function] make-rendezvous (&optional name)

Make and return new rendezvous object.

### [Generic Function] call-rendezvous (rendezvous value)

Send _value_ to and wait until _rendezvous_ acceptor thread.

Return _value_ or acceptor thread’s reply value if acceptor has :reply keyword arg.

### [Generic Function] accept-rendezvous (rendezvous &key reply)

Return _value_ from passed by _rendezvous_ caller thread.

_:reply_ should be one argument funcallable object.
It called after accept call-rendezvous _value_ and before restart call-rendezvous thread.
It’s evaluated value becomes call-rendezvous thread’s return value.

### [Generic Function] rendezvous-name (rendezvous)

Return _rendezvous_’s name.

### [Function] nickname-package (&optional (name :rdv))

Add nickname for this package (:THREAD.COMM.RENDEZVOUS).

## Author

* Kazuo Koga

## Copyright

Copyright (c) 2011 Kazuo Koga

# License

Licensed under the MIT License.
(http://www.opensource.org/licenses/MIT)

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

Version

11.10.2

Dependencies
  • cl-annot (system).
  • bordeaux-threads (system).
Source

thread.comm.rendezvous.asd.

Child Component

src (module).


3 Modules

Modules are listed depth-first from the system components tree.


3.1 thread.comm.rendezvous/src

Source

thread.comm.rendezvous.asd.

Parent Component

thread.comm.rendezvous (system).

Child Component

rendezvous.lisp (file).


4 Files

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


4.1 Lisp


4.1.1 thread.comm.rendezvous/thread.comm.rendezvous.asd

Source

thread.comm.rendezvous.asd.

Parent Component

thread.comm.rendezvous (system).

ASDF Systems

thread.comm.rendezvous.

Packages

cl-rendezvous-asd.


4.1.2 thread.comm.rendezvous/src/rendezvous.lisp

Source

thread.comm.rendezvous.asd.

Parent Component

src (module).

Packages

thread.comm.rendezvous.

Public Interface
Internals

5 Packages

Packages are listed by definition order.


5.1 thread.comm.rendezvous

Source

rendezvous.lisp.

Use List

common-lisp.

Public Interface
Internals

5.2 cl-rendezvous-asd

Source

thread.comm.rendezvous.asd.

Use List
  • asdf/interface.
  • common-lisp.

6 Definitions

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


6.1 Public Interface


6.1.1 Ordinary functions

Function: make-rendezvous (&optional name)
Package

thread.comm.rendezvous.

Source

rendezvous.lisp.


6.1.2 Generic functions

Generic Function: accept-rendezvous (rendezvous &key reply)
Package

thread.comm.rendezvous.

Methods
Method: accept-rendezvous ((rendezvous rendezvous) &key reply)
Source

rendezvous.lisp.

Generic Function: call-rendezvous (rendezvous value)
Package

thread.comm.rendezvous.

Methods
Method: call-rendezvous ((rendezvous rendezvous) value)
Source

rendezvous.lisp.

Generic Function: rendezvous-name (rendezvous)
Package

thread.comm.rendezvous.

Methods
Method: rendezvous-name ((rendezvous rendezvous))
Source

rendezvous.lisp.


6.1.3 Standalone methods

Method: print-object ((rendezvous rendezvous) stream)
Source

rendezvous.lisp.


6.2 Internals


6.2.1 Ordinary functions

Function: make-tconc ()
Package

thread.comm.rendezvous.

Source

rendezvous.lisp.

Function: nickname-package (&optional nickname)

Add NICKNAME (:RDV by default) to the :THREAD.COMM.RENDEZVOUS package.

Package

thread.comm.rendezvous.

Source

rendezvous.lisp.

Function: pop-tconc (tconc)
Package

thread.comm.rendezvous.

Source

rendezvous.lisp.

Function: push-tconc (tconc item)
Package

thread.comm.rendezvous.

Source

rendezvous.lisp.

Function: tconc-empty-p (tconc)
Package

thread.comm.rendezvous.

Source

rendezvous.lisp.

Function: tconc-list (tconc)
Package

thread.comm.rendezvous.

Source

rendezvous.lisp.


6.2.2 Classes

Class: rendezvous
Package

thread.comm.rendezvous.

Source

rendezvous.lisp.

Direct methods
Direct slots
Slot: name
Initargs

:name

Slot: queue
Initform

(thread.comm.rendezvous::make-tconc)

Slot: lock
Initform

(bordeaux-threads:make-lock)

Slot: condvar
Initform

(bordeaux-threads:make-condition-variable)

Slot: reader-count
Initform

0


Appendix A Indexes


A.1 Concepts


A.2 Functions

Jump to:   A   C   F   G   M   N   P   R   T  
Index Entry  Section

A
accept-rendezvous: Public generic functions
accept-rendezvous: Public generic functions

C
call-rendezvous: Public generic functions
call-rendezvous: Public generic functions

F
Function, make-rendezvous: Public ordinary functions
Function, make-tconc: Private ordinary functions
Function, nickname-package: Private ordinary functions
Function, pop-tconc: Private ordinary functions
Function, push-tconc: Private ordinary functions
Function, tconc-empty-p: Private ordinary functions
Function, tconc-list: Private ordinary functions

G
Generic Function, accept-rendezvous: Public generic functions
Generic Function, call-rendezvous: Public generic functions
Generic Function, rendezvous-name: Public generic functions

M
make-rendezvous: Public ordinary functions
make-tconc: Private ordinary functions
Method, accept-rendezvous: Public generic functions
Method, call-rendezvous: Public generic functions
Method, print-object: Public standalone methods
Method, rendezvous-name: Public generic functions

N
nickname-package: Private ordinary functions

P
pop-tconc: Private ordinary functions
print-object: Public standalone methods
push-tconc: Private ordinary functions

R
rendezvous-name: Public generic functions
rendezvous-name: Public generic functions

T
tconc-empty-p: Private ordinary functions
tconc-list: Private ordinary functions