The shellpool Reference Manual

3.1.1 shellpool/shellpool.asd

Source

shellpool.asd.

Parent Component

shellpool (system).

ASDF Systems

shellpool.

---

3.1.2 shellpool/src/packages.lisp

Source

shellpool.asd.

Parent Component

shellpool (system).

Packages

shellpool.

---

3.1.3 shellpool/src/main.lisp

Dependency

src/packages.lisp (file).

Source

shellpool.asd.

Parent Component

shellpool (system).

Public Interface

• *debug* (special variable).
• *max-shells* (special variable).
• ensure (function).
• run (function).
• run& (function).
• start (function).

Internals

• *state* (special variable).
• +allkids+ (constant).
• +death-line+ (constant).
• +exit-line+ (constant).
• +pid-line+ (constant).
• +status-line+ (constant).
• add-runners (function).
• bash-alive-p (function).
• bash-err (function).
• bash-in (function).
• bash-out (function).
• copy-runner (function).
• copy-state (function).
• debug-msg (macro).
• default-each-line (function).
• define-constant (macro).
• kill (function).
• make-bash (function).
• make-run-command-string (function).
• make-runner (function).
• make-state (function).
• nl (constant).
• parse-pid-line (function).
• runner (structure).
• runner-err (reader).
• (setf runner-err) (writer).
• runner-p (function).
• runner-sh (reader).
• (setf runner-sh) (writer).
• state (structure).
• state-aux (reader).
• (setf state-aux) (writer).
• state-lock (reader).
• (setf state-lock) (writer).
• state-p (function).
• state-runners (reader).
• (setf state-runners) (writer).
• state-sem (reader).
• (setf state-sem) (writer).
• state-total (reader).
• (setf state-total) (writer).
• strpos (function).
• strpos-fast (function).
• strprefixp (function).
• strprefixp-impl (function).
• strsuffixp (function).
• with-file-to-be-deleted (macro).
• with-runner (macro).
• with-state-lock (macro).

---

5.1.1 Special variables

Special Variable: *debug* ¶

Change to T for verbose debugging messages.

Package

shellpool.

Source

src/main.lisp.

Special Variable: *max-shells* ¶

Purely a safety valve. We’ll cause an error if you try to start more than this many shells at once, since that would probably cause problems on your system. We make this a parameter so you can reconfigure it if you really need to create so many shells.

Package

shellpool.

Source

src/main.lisp.

---

5.1.2 Ordinary functions

Function: ensure (&optional n) ¶

Ensure that at least n shells are running, starting up shells if needed.

Package

shellpool.

Source

src/main.lisp.

Function: run (script &key each-line) ¶

Package

shellpool.

Source

src/main.lisp.

Function: run& (script) ¶

Package

shellpool.

Source

src/main.lisp.

Function: start (&optional n) ¶

Start some number of shells and ensure that the aux shell is running.

Package

shellpool.

Source

src/main.lisp.

---

5.2.1 Constants

Constant: +allkids+ ¶

Package

shellpool.

Source

src/main.lisp.

Constant: +death-line+ ¶

Package

shellpool.

Source

src/main.lisp.

Constant: +exit-line+ ¶

Package

shellpool.

Source

src/main.lisp.

Constant: +pid-line+ ¶

Package

shellpool.

Source

src/main.lisp.

Constant: +status-line+ ¶

Package

shellpool.

Source

src/main.lisp.

Constant: nl ¶

Newline as a string. Convenient in string concatenations as a way to insert newlines without having to ruin your indenting.

Package

shellpool.

Source

src/main.lisp.

---

5.2.2 Special variables

Special Variable: *state* ¶

Package

shellpool.

Source

src/main.lisp.

---

5.2.3 Macros

Macro: debug-msg (&rest args) ¶

Like (format t ...) but only prints if debugging is enabled.

Package

shellpool.

Source

src/main.lisp.

Macro: define-constant (name value &optional doc) ¶

Package

shellpool.

Source

src/main.lisp.

Macro: with-file-to-be-deleted (filename &rest forms) ¶

Package

shellpool.

Source

src/main.lisp.

Macro: with-runner (name &rest forms) ¶

Package

shellpool.

Source

src/main.lisp.

Macro: with-state-lock (&rest forms) ¶

Package

shellpool.

Source

src/main.lisp.

---

5.2.4 Ordinary functions

Function: add-runners (n) ¶

Package

shellpool.

Source

src/main.lisp.

Function: bash-alive-p (sh) ¶

Package

shellpool.

Source

src/main.lisp.

Function: bash-err (sh) ¶

Package

shellpool.

Source

src/main.lisp.

Function: bash-in (sh) ¶

Package

shellpool.

Source

src/main.lisp.

Function: bash-out (sh) ¶

Package

shellpool.

Source

src/main.lisp.

Function: copy-runner (instance) ¶

Package

shellpool.

Source

src/main.lisp.

Function: copy-state (instance) ¶

Package

shellpool.

Source

src/main.lisp.

Function: default-each-line (line type) ¶

Package

shellpool.

Source

src/main.lisp.

Function: kill (pid) ¶

Package

shellpool.

Source

src/main.lisp.

Function: make-bash () ¶

Package

shellpool.

Source

src/main.lisp.

Function: make-run-command-string (filename) ¶

Package

shellpool.

Source

src/main.lisp.

Function: make-runner (&key err sh) ¶

Package

shellpool.

Source

src/main.lisp.

Function: make-state (&key lock aux sem runners total) ¶

Package

shellpool.

Source

src/main.lisp.

Function: parse-pid-line (line) ¶

Package

shellpool.

Source

src/main.lisp.

Reader: runner-err (instance) ¶

Writer: (setf runner-err) (instance) ¶

Package

shellpool.

Source

src/main.lisp.

Target Slot

err.

Function: runner-p (object) ¶

Package

shellpool.

Source

src/main.lisp.

Reader: runner-sh (instance) ¶

Writer: (setf runner-sh) (instance) ¶

Package

shellpool.

Source

src/main.lisp.

Target Slot

sh.

Reader: state-aux (instance) ¶

Writer: (setf state-aux) (instance) ¶

Package

shellpool.

Source

src/main.lisp.

Target Slot

aux.

Reader: state-lock (instance) ¶

Writer: (setf state-lock) (instance) ¶

Package

shellpool.

Source

src/main.lisp.

Target Slot

lock.

Function: state-p (object) ¶

Package

shellpool.

Source

src/main.lisp.

Reader: state-runners (instance) ¶

Writer: (setf state-runners) (instance) ¶

Package

shellpool.

Source

src/main.lisp.

Target Slot

runners.

Reader: state-sem (instance) ¶

Writer: (setf state-sem) (instance) ¶

Package

shellpool.

Source

src/main.lisp.

Target Slot

sem.

Reader: state-total (instance) ¶

Writer: (setf state-total) (instance) ¶

Package

shellpool.

Source

src/main.lisp.

Target Slot

total.

Function: strpos (x y) ¶

Determines the position of the first occurrence of the substring X in the string Y, or returns NIL if there is no such occurrence.

Package

shellpool.

Source

src/main.lisp.

Function: strpos-fast (x y n xlen ylen) ¶

Package

shellpool.

Source

src/main.lisp.

Function: strprefixp (x y) ¶

Determines if the string X comes at the start of the string Y. Example: (strprefixp "foo" "foobar") is true.

Package

shellpool.

Source

src/main.lisp.

Function: strprefixp-impl (x y xn yn xlen ylen) ¶

Package

shellpool.

Source

src/main.lisp.

Function: strsuffixp (x y) ¶

Determines if the string X comes at the end of the string Y. Example: (strsuffixp "bar" "foobar") is true.

Package

shellpool.

Source

src/main.lisp.

---

5.2.5 Structures

Structure: runner ¶

Package

shellpool.

Source

src/main.lisp.

Direct superclasses

structure-object.

Direct slots

Slot: err ¶

Readers

runner-err.

Writers

(setf runner-err).

Slot: sh ¶

Readers

runner-sh.

Writers

(setf runner-sh).

Structure: state ¶

Package

shellpool.

Source

src/main.lisp.

Direct superclasses

structure-object.

Direct slots

Slot: lock ¶

Readers

state-lock.

Writers

(setf state-lock).

Slot: aux ¶

Readers

state-aux.

Writers

(setf state-aux).

Slot: sem ¶

Readers

state-sem.

Writers

(setf state-sem).

Slot: runners ¶

Readers

state-runners.

Writers

(setf state-runners).

Slot: total ¶

Readers

state-total.

Writers

(setf state-total).

---