The async-process Reference Manual

Table of Contents

Next: , Previous: , 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 2.4 patchlevel 1 "Will Decker" on Mon Apr 08 12:57:08 2019 GMT+0.


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

1 Introduction

async-process

CL-USER> (ql:quickload :async-process)
To load "async-process":
  Load 1 ASDF system:
    async-process
; Loading "async-process"
..................................................
[package async-process].
(:ASYNC-PROCESS)
CL-USER> (in-package async-process)
#<PACKAGE "ASYNC-PROCESS">
ASYNC-PROCESS> (create-process "python")
#.(SB-SYS:INT-SAP #X7FFFEC002830)
ASYNC-PROCESS> (defparameter p *)
#.(SB-SYS:INT-SAP #X7FFFEC002830)
ASYNC-PROCESS> (process-receive-output p)
"Python 2.7.13 (default, Nov 24 2017, 17:33:09) 
[GCC 6.3.0 20170516] on linux2
Type \"help\", \"copyright\", \"credits\" or \"license\" for more information.
>>> "
ASYNC-PROCESS> (process-send-input p "1+1
")
; No value
ASYNC-PROCESS> (process-receive-output p)
"1+1
2
>>> "

LICENSE

MIT


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 async-process

Author

cxxxr <g23tlm@gmail.com>

License

MIT

Description

asynchronous process execution for common lisp

Version

0.0.1

Dependency

cffi

Source

async-process.asd (file)

Component

async-process.lisp (file)


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 async-process.asd

Location

async-process.asd

Systems

async-process (system)


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

3.1.2 async-process/async-process.lisp

Parent

async-process (system)

Location

async-process.lisp

Packages

async-process

Exported Definitions
Internal Definitions

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

4 Packages

Packages are listed by definition order.


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

4.1 async-process

Source

async-process.lisp (file)

Use List

common-lisp

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


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

5.1.1 Functions

Function: create-process COMMAND &key NONBLOCK ENCODE
Package

async-process

Source

async-process.lisp (file)

Function: delete-process PROCESS
Package

async-process

Source

async-process.lisp (file)

Function: process-alive-p PROCESS
Package

async-process

Source

async-process.lisp (file)

Function: process-receive-output PROCESS
Package

async-process

Source

async-process.lisp (file)

Function: process-send-input PROCESS STRING
Package

async-process

Source

async-process.lisp (file)


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

5.2 Internal definitions


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

5.2.1 Functions

Function: %create-process COMMAND NONBLOCK
Package

async-process

Source

async-process.lisp (file)

Function: %delete-process PROCESS
Package

async-process

Source

async-process.lisp (file)

Function: %process-alive-p PROCESS
Package

async-process

Source

async-process.lisp (file)

Function: %process-pid PROCESS
Package

async-process

Source

async-process.lisp (file)

Function: %process-receive-output PROCESS
Package

async-process

Source

async-process.lisp (file)

Function: %process-send-input PROCESS STRING
Package

async-process

Source

async-process.lisp (file)

Function: process-pid PROCESS
Package

async-process

Source

async-process.lisp (file)

Function: system CMD
Package

async-process

Source

async-process.lisp (file)


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

5.2.2 Generic functions

Generic Function: process-encode OBJECT
Generic Function: (setf process-encode) NEW-VALUE OBJECT
Package

async-process

Methods
Method: process-encode (PROCESS process)

automatically generated reader method

Source

async-process.lisp (file)

Method: (setf process-encode) NEW-VALUE (PROCESS process)

automatically generated writer method

Source

async-process.lisp (file)

Generic Function: process-process OBJECT
Package

async-process

Methods
Method: process-process (PROCESS process)

automatically generated reader method

Source

async-process.lisp (file)


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

5.2.3 Classes

Class: process ()
Package

async-process

Source

async-process.lisp (file)

Direct superclasses

standard-object (class)

Direct methods
Direct slots
Slot: process
Initargs

:process

Readers

process-process (generic function)

Slot: encode
Initargs

:encode

Readers

process-encode (generic function)

Writers

(setf process-encode) (generic function)


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

Appendix A Indexes


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

A.1 Concepts

Jump to:   A   F   L  
Index Entry  Section

A
async-process.asd: The async-process<dot>asd file
async-process/async-process.lisp: The async-process/async-process<dot>lisp file

F
File, Lisp, async-process.asd: The async-process<dot>asd file
File, Lisp, async-process/async-process.lisp: The async-process/async-process<dot>lisp file

L
Lisp File, async-process.asd: The async-process<dot>asd file
Lisp File, async-process/async-process.lisp: The async-process/async-process<dot>lisp file

Jump to:   A   F   L  

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

A.2 Functions

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

%
%create-process: Internal functions
%delete-process: Internal functions
%process-alive-p: Internal functions
%process-pid: Internal functions
%process-receive-output: Internal functions
%process-send-input: Internal functions

(
(setf process-encode): Internal generic functions
(setf process-encode): Internal generic functions

C
create-process: Exported functions

D
delete-process: Exported functions

F
Function, %create-process: Internal functions
Function, %delete-process: Internal functions
Function, %process-alive-p: Internal functions
Function, %process-pid: Internal functions
Function, %process-receive-output: Internal functions
Function, %process-send-input: Internal functions
Function, create-process: Exported functions
Function, delete-process: Exported functions
Function, process-alive-p: Exported functions
Function, process-pid: Internal functions
Function, process-receive-output: Exported functions
Function, process-send-input: Exported functions
Function, system: Internal functions

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

M
Method, (setf process-encode): Internal generic functions
Method, process-encode: Internal generic functions
Method, process-process: Internal generic functions

P
process-alive-p: Exported functions
process-encode: Internal generic functions
process-encode: Internal generic functions
process-pid: Internal functions
process-process: Internal generic functions
process-process: Internal generic functions
process-receive-output: Exported functions
process-send-input: Exported functions

S
system: Internal functions

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

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

A.3 Variables

Jump to:   E   P   S  
Index Entry  Section

E
encode: Internal classes

P
process: Internal classes

S
Slot, encode: Internal classes
Slot, process: Internal classes

Jump to:   E   P   S  

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

A.4 Data types

Jump to:   A   C   P   S  
Index Entry  Section

A
async-process: The async-process system
async-process: The async-process package

C
Class, process: Internal classes

P
Package, async-process: The async-process package
process: Internal classes

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

Jump to:   A   C   P   S