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

The async-process Reference Manual

This is the async-process Reference Manual, version 0.0.1, generated automatically by Declt version 4.0 beta 2 "William Riker" on Mon Feb 26 14:38:18 2024 GMT+0.

Next: Systems, Previous: The async-process Reference Manual, Up: The async-process Reference Manual [Contents][Index]

1 Introduction

Next: Files, Previous: Introduction, Up: The async-process Reference Manual [Contents][Index]

2 Systems

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

async-process

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

2.1 `async-process`

asynchronous process execution for common lisp

Author: cxxxr <g23tlm@gmail.com>
License: MIT
Version: 0.0.1
Dependency: cffi (system).
Source: async-process.asd.
Child Component: async-process.lisp (file).

Next: Packages, Previous: Systems, Up: The async-process Reference Manual [Contents][Index]

3 Files

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

Lisp

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

Next: async-process/async-process.lisp, Previous: Lisp, Up: Lisp [Contents][Index]

3.1.1 `async-process/async-process.asd`

Source: async-process.asd.
Parent Component: async-process (system).
ASDF Systems: async-process.

Previous: async-process/async-process.asd, Up: Lisp [Contents][Index]

3.1.2 `async-process/async-process.lisp`

Source

async-process.asd.

Parent Component

async-process (system).

Packages

async-process.

Public Interface

create-process (function).
delete-process (function).
process-alive-p (function).
process-receive-output (function).
process-send-input (function).

Internals

%create-process (function).
%delete-process (function).
%process-alive-p (function).
%process-pid (function).
%process-receive-output (function).
%process-send-input (function).
muslp (function).
process (class).
process-encode (reader method).
(setf process-encode) (writer method).
process-pid (function).
process-process (reader method).
system (function).

Next: Definitions, Previous: Files, Up: The async-process Reference Manual [Contents][Index]

4 Packages

Packages are listed by definition order.

async-process

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

4.1 `async-process`

Source

async-process.lisp.

Use List

common-lisp.

Public Interface

create-process (function).
delete-process (function).
process-alive-p (function).
process-receive-output (function).
process-send-input (function).

Internals

%create-process (function).
%delete-process (function).
%process-alive-p (function).
%process-pid (function).
%process-receive-output (function).
%process-send-input (function).
muslp (function).
process (class).
process-encode (generic reader).
(setf process-encode) (generic writer).
process-pid (function).
process-process (generic reader).
system (function).

Next: Indexes, Previous: Packages, Up: The async-process Reference Manual [Contents][Index]

5 Definitions

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

Public Interface
Internals

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

5.1 Public Interface

Ordinary functions

Previous: Public Interface, Up: Public Interface [Contents][Index]

5.1.1 Ordinary functions

Function: create-process (command &key nonblock encode directory) ¶

Package: async-process.
Source: async-process.lisp.

Function: delete-process (process) ¶

Package: async-process.
Source: async-process.lisp.

Function: process-alive-p (process) ¶

Package: async-process.
Source: async-process.lisp.

Function: process-receive-output (process) ¶

Package: async-process.
Source: async-process.lisp.

Function: process-send-input (process string) ¶

Package: async-process.
Source: async-process.lisp.

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

5.2 Internals

Ordinary functions
Generic functions
Classes

Next: Generic functions, Previous: Internals, Up: Internals [Contents][Index]

5.2.1 Ordinary functions

Function: %create-process (command nonblock path) ¶

Package: async-process.
Source: async-process.lisp.

Function: %delete-process (process) ¶

Package: async-process.
Source: async-process.lisp.

Function: %process-alive-p (process) ¶

Package: async-process.
Source: async-process.lisp.

Function: %process-pid (process) ¶

Package: async-process.
Source: async-process.lisp.

Function: %process-receive-output (process) ¶

Package: async-process.
Source: async-process.lisp.

Function: %process-send-input (process string) ¶

Package: async-process.
Source: async-process.lisp.

Function: muslp () ¶

Package: async-process.
Source: async-process.lisp.

Function: process-pid (process) ¶

Package: async-process.
Source: async-process.lisp.

Function: system (cmd) ¶

Package: async-process.
Source: async-process.lisp.

Next: Classes, Previous: Ordinary functions, Up: Internals [Contents][Index]

5.2.2 Generic functions

Generic Reader: process-encode (object) ¶

Package

async-process.

Methods

Reader Method: process-encode ((process process)) ¶

automatically generated reader method

Source: async-process.lisp.
Target Slot: encode.

Generic Writer: (setf process-encode) (object) ¶

Package

async-process.

Methods

Writer Method: (setf process-encode) ((process process)) ¶

automatically generated writer method

Source: async-process.lisp.
Target Slot: encode.

Generic Reader: process-process (object) ¶

Package

async-process.

Methods

Reader Method: process-process ((process process)) ¶

automatically generated reader method

Source: async-process.lisp.
Target Slot: process.

Previous: Generic functions, Up: Internals [Contents][Index]

5.2.3 Classes

Class: process ¶

Package

async-process.

Source

async-process.lisp.

Direct methods

(setf process-encode).
process-encode.
process-process.

Direct slots

Slot: process ¶

Initargs: :process
Readers: process-process.
Writers: This slot is read-only.

Slot: encode ¶

Initargs: :encode
Readers: process-encode.
Writers: (setf process-encode).

Previous: Definitions, Up: The async-process Reference Manual [Contents][Index]

Appendix A Indexes

Concepts
Functions
Variables
Data types

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

A.1 Concepts

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

A.2 Functions

Jump to:	% ( C D F G M P S

	Index Entry	Section

%
	`%create-process`:	Private ordinary functions
	`%delete-process`:	Private ordinary functions
	`%process-alive-p`:	Private ordinary functions
	`%process-pid`:	Private ordinary functions
	`%process-receive-output`:	Private ordinary functions
	`%process-send-input`:	Private ordinary functions

(
	`(setf process-encode)`:	Private generic functions
	`(setf process-encode)`:	Private generic functions

C
	`create-process`:	Public ordinary functions

D
	`delete-process`:	Public ordinary functions

F
	`Function, %create-process`:	Private ordinary functions
	`Function, %delete-process`:	Private ordinary functions
	`Function, %process-alive-p`:	Private ordinary functions
	`Function, %process-pid`:	Private ordinary functions
	`Function, %process-receive-output`:	Private ordinary functions
	`Function, %process-send-input`:	Private ordinary functions
	`Function, create-process`:	Public ordinary functions
	`Function, delete-process`:	Public ordinary functions
	`Function, muslp`:	Private ordinary functions
	`Function, process-alive-p`:	Public ordinary functions
	`Function, process-pid`:	Private ordinary functions
	`Function, process-receive-output`:	Public ordinary functions
	`Function, process-send-input`:	Public ordinary functions
	`Function, system`:	Private ordinary functions

G
	`Generic Function, (setf process-encode)`:	Private generic functions
	`Generic Function, process-encode`:	Private generic functions
	`Generic Function, process-process`:	Private generic functions

M
	`Method, (setf process-encode)`:	Private generic functions
	`Method, process-encode`:	Private generic functions
	`Method, process-process`:	Private generic functions
	`muslp`:	Private ordinary functions

P
	`process-alive-p`:	Public ordinary functions
	`process-encode`:	Private generic functions
	`process-encode`:	Private generic functions
	`process-pid`:	Private ordinary functions
	`process-process`:	Private generic functions
	`process-process`:	Private generic functions
	`process-receive-output`:	Public ordinary functions
	`process-send-input`:	Public ordinary functions

S
	`system`:	Private ordinary functions

Next: Data types, Previous: Functions, Up: Indexes [Contents][Index]

A.3 Variables

Jump to:	E P S

	Index Entry	Section

E
	`encode`:	Private classes

P
	`process`:	Private classes

S
	`Slot, encode`:	Private classes
	`Slot, process`:	Private classes

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

A.4 Data types

Jump to:	A C F P S

	Index Entry	Section

A
	`async-process`:	The async-process system
	`async-process`:	The async-process package
	`async-process.asd`:	The async-process/async-process․asd file
	`async-process.lisp`:	The async-process/async-process․lisp file

C
	`Class, process`:	Private classes

F
	`File, async-process.asd`:	The async-process/async-process․asd file
	`File, async-process.lisp`:	The async-process/async-process․lisp file

P
	`Package, async-process`:	The async-process package
	`process`:	Private classes

S
	`System, async-process`:	The async-process system

The async-process Reference Manual

Table of Contents

1 Introduction

2 Systems

2.1 async-process

3 Files

3.1 Lisp

3.1.1 async-process/async-process.asd

3.1.2 async-process/async-process.lisp

4 Packages

4.1 async-process

5 Definitions

5.1 Public Interface

5.1.1 Ordinary functions

5.2 Internals

5.2.1 Ordinary functions

5.2.2 Generic functions

5.2.3 Classes

Appendix A Indexes

A.1 Concepts

A.2 Functions

A.3 Variables

A.4 Data types

2.1 `async-process`

3.1.1 `async-process/async-process.asd`

3.1.2 `async-process/async-process.lisp`

4.1 `async-process`