The thread.comm.rendezvous Reference Manual

Table of Contents

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

The thread.comm.rendezvous Reference Manual

This is the thread.comm.rendezvous Reference Manual, version 11.10.2, generated automatically by Declt version 2.4 "Will Decker" on Wed Jun 20 12:39:59 2018 GMT+0.


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

1 Introduction

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) 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

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.


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 thread.comm.rendezvous

Author

Kazuo Koga

License

MIT

Description

Rendezvous thread synchronization

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
Source

thread.comm.rendezvous.asd (file)

Component

src (module)


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

3 Modules

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


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

3.1 thread.comm.rendezvous/src

Parent

thread.comm.rendezvous (system)

Location

src/

Component

rendezvous.lisp (file)


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

4 Files

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


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

4.1 Lisp


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

4.1.1 thread.comm.rendezvous.asd

Location

thread.comm.rendezvous.asd

Systems

thread.comm.rendezvous (system)

Packages

cl-rendezvous-asd


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

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

Parent

src (module)

Location

src/rendezvous.lisp

Packages

thread.comm.rendezvous

Exported Definitions
Internal Definitions

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

5 Packages

Packages are listed by definition order.


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

5.1 cl-rendezvous-asd

Source

thread.comm.rendezvous.asd

Use List

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

5.2 thread.comm.rendezvous

Source

rendezvous.lisp (file)

Use List

common-lisp

Exported Definitions
Internal Definitions

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

6 Definitions

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


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

6.1 Exported definitions


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

6.1.1 Functions

Function: make-rendezvous &optional NAME
Package

thread.comm.rendezvous

Source

rendezvous.lisp (file)


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

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 (file)

Generic Function: call-rendezvous RENDEZVOUS VALUE
Package

thread.comm.rendezvous

Methods
Method: call-rendezvous (RENDEZVOUS rendezvous) VALUE
Source

rendezvous.lisp (file)

Generic Function: rendezvous-name RENDEZVOUS
Package

thread.comm.rendezvous

Methods
Method: rendezvous-name (RENDEZVOUS rendezvous)
Source

rendezvous.lisp (file)


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

6.2 Internal definitions


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

6.2.1 Functions

Function: make-tconc ()
Package

thread.comm.rendezvous

Source

rendezvous.lisp (file)

Function: nickname-package &optional NICKNAME

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

Package

thread.comm.rendezvous

Source

rendezvous.lisp (file)

Function: pop-tconc TCONC
Package

thread.comm.rendezvous

Source

rendezvous.lisp (file)

Function: push-tconc TCONC ITEM
Package

thread.comm.rendezvous

Source

rendezvous.lisp (file)

Function: tconc-empty-p TCONC
Package

thread.comm.rendezvous

Source

rendezvous.lisp (file)

Function: tconc-list TCONC
Package

thread.comm.rendezvous

Source

rendezvous.lisp (file)


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

6.2.2 Classes

Class: rendezvous ()
Package

thread.comm.rendezvous

Source

rendezvous.lisp (file)

Direct superclasses

standard-object (class)

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


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

Appendix A Indexes


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

A.1 Concepts

Jump to:   F   L   M   T  
Index Entry  Section

F
File, Lisp, thread.comm.rendezvous.asd: The thread<dot>comm<dot>rendezvous<dot>asd file
File, Lisp, thread.comm.rendezvous/src/rendezvous.lisp: The thread<dot>comm<dot>rendezvous/src/rendezvous<dot>lisp file

L
Lisp File, thread.comm.rendezvous.asd: The thread<dot>comm<dot>rendezvous<dot>asd file
Lisp File, thread.comm.rendezvous/src/rendezvous.lisp: The thread<dot>comm<dot>rendezvous/src/rendezvous<dot>lisp file

M
Module, thread.comm.rendezvous/src: The thread<dot>comm<dot>rendezvous/src module

T
thread.comm.rendezvous.asd: The thread<dot>comm<dot>rendezvous<dot>asd file
thread.comm.rendezvous/src: The thread<dot>comm<dot>rendezvous/src module
thread.comm.rendezvous/src/rendezvous.lisp: The thread<dot>comm<dot>rendezvous/src/rendezvous<dot>lisp file

Jump to:   F   L   M   T  

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

A.2 Functions

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

A
accept-rendezvous: Exported generic functions
accept-rendezvous: Exported generic functions

C
call-rendezvous: Exported generic functions
call-rendezvous: Exported generic functions

F
Function, make-rendezvous: Exported functions
Function, make-tconc: Internal functions
Function, nickname-package: Internal functions
Function, pop-tconc: Internal functions
Function, push-tconc: Internal functions
Function, tconc-empty-p: Internal functions
Function, tconc-list: Internal functions

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

M
make-rendezvous: Exported functions
make-tconc: Internal functions
Method, accept-rendezvous: Exported generic functions
Method, call-rendezvous: Exported generic functions
Method, rendezvous-name: Exported generic functions

N
nickname-package: Internal functions

P
pop-tconc: Internal functions
push-tconc: Internal functions

R
rendezvous-name: Exported generic functions
rendezvous-name: Exported generic functions

T
tconc-empty-p: Internal functions
tconc-list: Internal functions

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

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

A.3 Variables

Jump to:   C   L   N   Q   R   S  
Index Entry  Section

C
condvar: Internal classes

L
lock: Internal classes

N
name: Internal classes

Q
queue: Internal classes

R
reader-count: Internal classes

S
Slot, condvar: Internal classes
Slot, lock: Internal classes
Slot, name: Internal classes
Slot, queue: Internal classes
Slot, reader-count: Internal classes

Jump to:   C   L   N   Q   R   S  

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

A.4 Data types

Jump to:   C   P   R   S   T  
Index Entry  Section

C
cl-rendezvous-asd: The cl-rendezvous-asd package
Class, rendezvous: Internal classes

P
Package, cl-rendezvous-asd: The cl-rendezvous-asd package
Package, thread.comm.rendezvous: The thread<dot>comm<dot>rendezvous package

R
rendezvous: Internal classes

S
System, thread.comm.rendezvous: The thread<dot>comm<dot>rendezvous system

T
thread.comm.rendezvous: The thread<dot>comm<dot>rendezvous system
thread.comm.rendezvous: The thread<dot>comm<dot>rendezvous package

Jump to:   C   P   R   S   T