The cl-plumbing Reference Manual

Table of Contents

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

The cl-plumbing Reference Manual

This is the cl-plumbing Reference Manual, generated automatically by Declt version 2.3 "Robert April" on Tue Jan 09 13:55:50 2018 GMT+0.


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

1 Introduction


* CL-Plumbing

This library adds a few stream manipulation facilities that I haven't been able
to figure out using CL's stream facilities.  These include:

=make-pipe=: Make a two way stream (though not of type two-way-stream) that
accepts data (via writing to it) and that data can then be read from it.  This
is similar to the piping mechanism in the shell.

=connect-streams=: Take an input stream and an output stream and feed all data
from the input stream to the output stream.  Again, similar to the way shell
pipes act, but this is for two existing streams and the other creates two new
streams (well, one new two way stream).

** Future work

Just now it occurred to me that it would be cool to have this provide a CL
(gray) stream interface for ZeroMQ.  Most of the work is already done, I
believe...


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 cl-plumbing

Author

Zachary Smith <zachkostsmith@gmail.com>

License

LLGPL

Description

A few (at least seemingly) missing stream operations in Common Lisp.

Dependencies
Source

cl-plumbing.asd (file)

Components

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 cl-plumbing.asd

Location

cl-plumbing.asd

Systems

cl-plumbing (system)


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

3.1.2 cl-plumbing/package.lisp

Parent

cl-plumbing (system)

Location

package.lisp

Packages

cl-plumbing


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

3.1.3 cl-plumbing/gray-streams-pipe.lisp

Dependency

package.lisp (file)

Parent

cl-plumbing (system)

Location

gray-streams-pipe.lisp

Exported Definitions

make-pipe (function)

Internal Definitions

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

3.1.4 cl-plumbing/cl-plumbing.lisp

Dependency

gray-streams-pipe.lisp (file)

Parent

cl-plumbing (system)

Location

cl-plumbing.lisp

Exported Definitions
Internal Definitions

dump-stream (function)


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

4 Packages

Packages are listed by definition order.


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

4.1 cl-plumbing

Source

package.lisp (file)

Use List
Exported Definitions
Internal Definitions

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 Special variables

Special Variable: *warn-on-foreground-connect-stream*
Package

cl-plumbing

Source

cl-plumbing.lisp (file)


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

5.1.2 Functions

Function: connect-streams INPUT OUTPUT &key BACKGROUND FN

This reads from input and writes output until the end of input is found.

Package

cl-plumbing

Source

cl-plumbing.lisp (file)

Function: make-pipe ()

This makes a stream where you can write your output, then read it out elsewhere.

Package

cl-plumbing

Source

gray-streams-pipe.lisp (file)


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

5.2 Internal definitions


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

5.2.1 Special variables

Special Variable: *block-size*
Package

cl-plumbing

Source

gray-streams-pipe.lisp (file)


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

5.2.2 Functions

Function: dump-stream INPUT OUTPUT &optional FN
Package

cl-plumbing

Source

cl-plumbing.lisp (file)

Function: flush-in-to-out PIPE
Package

cl-plumbing

Source

gray-streams-pipe.lisp (file)


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

5.2.3 Generic functions

Generic Function: input-of OBJECT
Generic Function: (setf input-of) NEW-VALUE OBJECT
Package

cl-plumbing

Methods
Method: input-of (PIPE pipe)

automatically generated reader method

Source

gray-streams-pipe.lisp (file)

Method: (setf input-of) NEW-VALUE (PIPE pipe)

automatically generated writer method

Source

gray-streams-pipe.lisp (file)

Generic Function: lock-of OBJECT
Generic Function: (setf lock-of) NEW-VALUE OBJECT
Package

cl-plumbing

Methods
Method: lock-of (PIPE pipe)

automatically generated reader method

Source

gray-streams-pipe.lisp (file)

Method: (setf lock-of) NEW-VALUE (PIPE pipe)

automatically generated writer method

Source

gray-streams-pipe.lisp (file)

Generic Function: output-of OBJECT
Generic Function: (setf output-of) NEW-VALUE OBJECT
Package

cl-plumbing

Methods
Method: output-of (PIPE pipe)

automatically generated reader method

Source

gray-streams-pipe.lisp (file)

Method: (setf output-of) NEW-VALUE (PIPE pipe)

automatically generated writer method

Source

gray-streams-pipe.lisp (file)


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

5.2.4 Classes

Class: pipe ()
Package

cl-plumbing

Source

gray-streams-pipe.lisp (file)

Direct superclasses
  • trivial-gray-stream-mixin (class)
  • fundamental-stream (class)
Direct methods
  • close (method)
  • stream-line-column (method)
  • stream-write-sequence (method)
  • stream-read-sequence (method)
  • stream-read-line (method)
  • stream-unread-char (method)
  • stream-read-char (method)
  • stream-write-char (method)
  • output-of (method)
  • output-of (method)
  • input-of (method)
  • input-of (method)
  • lock-of (method)
  • lock-of (method)
Direct slots
Slot: lock
Initform

(bordeaux-threads:make-lock)

Readers

lock-of (generic function)

Writers

(setf lock-of) (generic function)

Slot: input
Initargs

:input

Readers

input-of (generic function)

Writers

(setf input-of) (generic function)

Slot: output
Initargs

:output

Readers

output-of (generic function)

Writers

(setf output-of) (generic function)


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

Appendix A Indexes


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

A.1 Concepts

Jump to:   C   F   L  
Index Entry  Section

C
cl-plumbing.asd: The cl-plumbing<dot>asd file
cl-plumbing/cl-plumbing.lisp: The cl-plumbing/cl-plumbing<dot>lisp file
cl-plumbing/gray-streams-pipe.lisp: The cl-plumbing/gray-streams-pipe<dot>lisp file
cl-plumbing/package.lisp: The cl-plumbing/package<dot>lisp file

F
File, Lisp, cl-plumbing.asd: The cl-plumbing<dot>asd file
File, Lisp, cl-plumbing/cl-plumbing.lisp: The cl-plumbing/cl-plumbing<dot>lisp file
File, Lisp, cl-plumbing/gray-streams-pipe.lisp: The cl-plumbing/gray-streams-pipe<dot>lisp file
File, Lisp, cl-plumbing/package.lisp: The cl-plumbing/package<dot>lisp file

L
Lisp File, cl-plumbing.asd: The cl-plumbing<dot>asd file
Lisp File, cl-plumbing/cl-plumbing.lisp: The cl-plumbing/cl-plumbing<dot>lisp file
Lisp File, cl-plumbing/gray-streams-pipe.lisp: The cl-plumbing/gray-streams-pipe<dot>lisp file
Lisp File, cl-plumbing/package.lisp: The cl-plumbing/package<dot>lisp file

Jump to:   C   F   L  

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

A.2 Functions

Jump to:   (  
C   D   F   G   I   L   M   O  
Index Entry  Section

(
(setf input-of): Internal generic functions
(setf input-of): Internal generic functions
(setf lock-of): Internal generic functions
(setf lock-of): Internal generic functions
(setf output-of): Internal generic functions
(setf output-of): Internal generic functions

C
connect-streams: Exported functions

D
dump-stream: Internal functions

F
flush-in-to-out: Internal functions
Function, connect-streams: Exported functions
Function, dump-stream: Internal functions
Function, flush-in-to-out: Internal functions
Function, make-pipe: Exported functions

G
Generic Function, (setf input-of): Internal generic functions
Generic Function, (setf lock-of): Internal generic functions
Generic Function, (setf output-of): Internal generic functions
Generic Function, input-of: Internal generic functions
Generic Function, lock-of: Internal generic functions
Generic Function, output-of: Internal generic functions

I
input-of: Internal generic functions
input-of: Internal generic functions

L
lock-of: Internal generic functions
lock-of: Internal generic functions

M
make-pipe: Exported functions
Method, (setf input-of): Internal generic functions
Method, (setf lock-of): Internal generic functions
Method, (setf output-of): Internal generic functions
Method, input-of: Internal generic functions
Method, lock-of: Internal generic functions
Method, output-of: Internal generic functions

O
output-of: Internal generic functions
output-of: Internal generic functions

Jump to:   (  
C   D   F   G   I   L   M   O  

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

A.3 Variables

Jump to:   *  
I   L   O   S  
Index Entry  Section

*
*block-size*: Internal special variables
*warn-on-foreground-connect-stream*: Exported special variables

I
input: Internal classes

L
lock: Internal classes

O
output: Internal classes

S
Slot, input: Internal classes
Slot, lock: Internal classes
Slot, output: Internal classes
Special Variable, *block-size*: Internal special variables
Special Variable, *warn-on-foreground-connect-stream*: Exported special variables

Jump to:   *  
I   L   O   S  

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

A.4 Data types

Jump to:   C   P   S  
Index Entry  Section

C
cl-plumbing: The cl-plumbing system
cl-plumbing: The cl-plumbing package
Class, pipe: Internal classes

P
Package, cl-plumbing: The cl-plumbing package
pipe: Internal classes

S
System, cl-plumbing: The cl-plumbing system

Jump to:   C   P   S