The cl-fastcgi Reference Manual

This is the cl-fastcgi Reference Manual, generated automatically by Declt version 3.0 "Montgomery Scott" on Fri Jun 26 10:11:11 2020 GMT+0.

1 Introduction

#+TITLE: CL-FastCGI
# -*- mode: org; mode: auto-fill -*-

* Introduction
  CL-FastCGI is a generic version of SB-FastCGI, targeting
  to run on mostly Common Lisp implementation.

  - Curren-Version : 0.2
  - Docs : https://kdr2.com/project/cl-fastcgi.html
  - Examples : test.lisp

2 Systems

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

2.1 `cl-fastcgi`

Author

KDr2 <zhuo.dev@gmail.com>

License

BSD License

Description

FastCGI wrapper for Common Lisp

Dependencies

usocket
cffi
sb-bsd-sockets

Source

cl-fastcgi.asd (file)

Components

package.lisp (file)
cl-fastcgi.lisp (file)
cl-fastcgi-x.lisp (file)
cl-fastcgi-server.lisp (file)
cl-fastcgi-wsgi.lisp (file)

3 Files

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

3.1 Lisp

3.1.1 `cl-fastcgi.asd`

Location: cl-fastcgi.asd
Systems: cl-fastcgi (system)

3.1.2 `cl-fastcgi/package.lisp`

Parent: cl-fastcgi (system)
Location: package.lisp
Packages: cl-fastcgi

3.1.3 `cl-fastcgi/cl-fastcgi.lisp`

Dependency

package.lisp (file)

Parent

cl-fastcgi (system)

Location

cl-fastcgi.lisp

Exported Definitions

load-libfcgi (function)

Internal Definitions

*libfcgi-loaded* (special variable)
default-headers (function)
merge-headers (function)
split-headers-to-cons (function)
usocket-to-fd (function)

3.1.4 `cl-fastcgi/cl-fastcgi-x.lisp`

Dependency

cl-fastcgi.lisp (file)

Parent

cl-fastcgi (system)

Location

cl-fastcgi-x.lisp

Exported Definitions

fcgx-accept (function)
fcgx-finish (function)
fcgx-flush (function)
fcgx-getenv (function)
fcgx-getparam (function)
fcgx-init (function)
fcgx-init-request (function)
fcgx-puts (function)
fcgx-read (function)
fcgx-read-all (function)

Internal Definitions

*read-buffer-size* (special variable)
fcgx-request-tclass (class)

3.1.5 `cl-fastcgi/cl-fastcgi-server.lisp`

Dependency

cl-fastcgi-x.lisp (file)

Parent

cl-fastcgi (system)

Location

cl-fastcgi-server.lisp

Exported Definitions

simple-server (function)
socket-server (function)

Internal Definitions

server-on-fd (function)
server-on-fd-threaded (function)
simple-server-threaded (function)
socket-server-threaded (function)

3.1.6 `cl-fastcgi/cl-fastcgi-wsgi.lisp`

Dependency: cl-fastcgi-server.lisp (file)
Parent: cl-fastcgi (system)
Location: cl-fastcgi-wsgi.lisp
Exported Definitions: make-serve-function (function)
Internal Definitions: gen-start-response (function)

4 Packages

Packages are listed by definition order.

4.1 `cl-fastcgi`

Source

package.lisp (file)

Use List

cffi
common-lisp

Exported Definitions

fcgx-accept (function)
fcgx-finish (function)
fcgx-flush (function)
fcgx-getenv (function)
fcgx-getparam (function)
fcgx-init (function)
fcgx-init-request (function)
fcgx-puts (function)
fcgx-read (function)
fcgx-read-all (function)
load-libfcgi (function)
make-serve-function (function)
simple-server (function)
socket-server (function)

Internal Definitions

*libfcgi-loaded* (special variable)
*read-buffer-size* (special variable)
default-headers (function)
fcgx-request-tclass (class)
gen-start-response (function)
merge-headers (function)
server-on-fd (function)
server-on-fd-threaded (function)
simple-server-threaded (function)
socket-server-threaded (function)
split-headers-to-cons (function)
usocket-to-fd (function)

5 Definitions

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

5.1 Exported definitions

5.1.1 Functions

Function: fcgx-accept REQ

Package: cl-fastcgi
Source: cl-fastcgi-x.lisp (file)

Function: fcgx-finish REQ

Package: cl-fastcgi
Source: cl-fastcgi-x.lisp (file)

Function: fcgx-flush REQ

Package: cl-fastcgi
Source: cl-fastcgi-x.lisp (file)

Function: fcgx-getenv REQ

Package: cl-fastcgi
Source: cl-fastcgi-x.lisp (file)

Function: fcgx-getparam REQ KEY

Package: cl-fastcgi
Source: cl-fastcgi-x.lisp (file)

Function: fcgx-init ()

Package: cl-fastcgi
Source: cl-fastcgi-x.lisp (file)

Function: fcgx-init-request REQUEST SOCK FLAGS

Package: cl-fastcgi
Source: cl-fastcgi-x.lisp (file)

Function: fcgx-puts REQ CONTENT &key STREAM

Package: cl-fastcgi
Source: cl-fastcgi-x.lisp (file)

Function: fcgx-read REQ

Package: cl-fastcgi
Source: cl-fastcgi-x.lisp (file)

Function: fcgx-read-all REQ

Package: cl-fastcgi
Source: cl-fastcgi-x.lisp (file)

Function: load-libfcgi &optional PATH

Package: cl-fastcgi
Source: cl-fastcgi.lisp (file)

Function: make-serve-function APP

Package: cl-fastcgi
Source: cl-fastcgi-wsgi.lisp (file)

Function: simple-server FUNC

Package: cl-fastcgi
Source: cl-fastcgi-server.lisp (file)

Function: socket-server FUNC &key INET-ADDR PORT

Package: cl-fastcgi
Source: cl-fastcgi-server.lisp (file)

5.2 Internal definitions

5.2.1 Special variables

Special Variable: *libfcgi-loaded*

Package: cl-fastcgi
Source: cl-fastcgi.lisp (file)

Special Variable: *read-buffer-size*

Package: cl-fastcgi
Source: cl-fastcgi-x.lisp (file)

5.2.2 Functions

Function: default-headers ()

Package: cl-fastcgi
Source: cl-fastcgi.lisp (file)

Function: gen-start-response ()

Package: cl-fastcgi
Source: cl-fastcgi-wsgi.lisp (file)

Function: merge-headers OLD-HEADERS NEW-HEADERS

Package: cl-fastcgi
Source: cl-fastcgi.lisp (file)

Function: server-on-fd FUNC FD &key FLAGS

Package: cl-fastcgi
Source: cl-fastcgi-server.lisp (file)

Function: server-on-fd-threaded FUNC FD &key FLAGS THREADS

Package: cl-fastcgi
Source: cl-fastcgi-server.lisp (file)

Function: simple-server-threaded FUNC &key THREADS

Package: cl-fastcgi
Source: cl-fastcgi-server.lisp (file)

Function: socket-server-threaded FUNC &key INET-ADDR PORT THREADS

Package: cl-fastcgi
Source: cl-fastcgi-server.lisp (file)

Function: split-headers-to-cons STR

Package: cl-fastcgi
Source: cl-fastcgi.lisp (file)

Function: usocket-to-fd USOCK

Package: cl-fastcgi
Source: cl-fastcgi.lisp (file)

5.2.3 Classes

Class: fcgx-request-tclass ()

Package

cl-fastcgi

Source

cl-fastcgi-x.lisp (file)

Direct superclasses

translatable-foreign-type (class)
foreign-struct-type (class)

Appendix A Indexes

A.1 Concepts

Jump to:	C F L

	Index Entry	Section

C
	`cl-fastcgi.asd`:	The cl-fastcgi․asd file
	`cl-fastcgi/cl-fastcgi-server.lisp`:	The cl-fastcgi/cl-fastcgi-server․lisp file
	`cl-fastcgi/cl-fastcgi-wsgi.lisp`:	The cl-fastcgi/cl-fastcgi-wsgi․lisp file
	`cl-fastcgi/cl-fastcgi-x.lisp`:	The cl-fastcgi/cl-fastcgi-x․lisp file
	`cl-fastcgi/cl-fastcgi.lisp`:	The cl-fastcgi/cl-fastcgi․lisp file
	`cl-fastcgi/package.lisp`:	The cl-fastcgi/package․lisp file

F
	File, Lisp, `cl-fastcgi.asd`:	The cl-fastcgi․asd file
	File, Lisp, `cl-fastcgi/cl-fastcgi-server.lisp`:	The cl-fastcgi/cl-fastcgi-server․lisp file
	File, Lisp, `cl-fastcgi/cl-fastcgi-wsgi.lisp`:	The cl-fastcgi/cl-fastcgi-wsgi․lisp file
	File, Lisp, `cl-fastcgi/cl-fastcgi-x.lisp`:	The cl-fastcgi/cl-fastcgi-x․lisp file
	File, Lisp, `cl-fastcgi/cl-fastcgi.lisp`:	The cl-fastcgi/cl-fastcgi․lisp file
	File, Lisp, `cl-fastcgi/package.lisp`:	The cl-fastcgi/package․lisp file

L
	Lisp File, `cl-fastcgi.asd`:	The cl-fastcgi․asd file
	Lisp File, `cl-fastcgi/cl-fastcgi-server.lisp`:	The cl-fastcgi/cl-fastcgi-server․lisp file
	Lisp File, `cl-fastcgi/cl-fastcgi-wsgi.lisp`:	The cl-fastcgi/cl-fastcgi-wsgi․lisp file
	Lisp File, `cl-fastcgi/cl-fastcgi-x.lisp`:	The cl-fastcgi/cl-fastcgi-x․lisp file
	Lisp File, `cl-fastcgi/cl-fastcgi.lisp`:	The cl-fastcgi/cl-fastcgi․lisp file
	Lisp File, `cl-fastcgi/package.lisp`:	The cl-fastcgi/package․lisp file

Jump to:	C F L

A.2 Functions

Jump to:	D F G L M S U

	Index Entry	Section

D
	`default-headers`:	Internal functions

F
	`fcgx-accept`:	Exported functions
	`fcgx-finish`:	Exported functions
	`fcgx-flush`:	Exported functions
	`fcgx-getenv`:	Exported functions
	`fcgx-getparam`:	Exported functions
	`fcgx-init`:	Exported functions
	`fcgx-init-request`:	Exported functions
	`fcgx-puts`:	Exported functions
	`fcgx-read`:	Exported functions
	`fcgx-read-all`:	Exported functions
	`Function, default-headers`:	Internal functions
	`Function, fcgx-accept`:	Exported functions
	`Function, fcgx-finish`:	Exported functions
	`Function, fcgx-flush`:	Exported functions
	`Function, fcgx-getenv`:	Exported functions
	`Function, fcgx-getparam`:	Exported functions
	`Function, fcgx-init`:	Exported functions
	`Function, fcgx-init-request`:	Exported functions
	`Function, fcgx-puts`:	Exported functions
	`Function, fcgx-read`:	Exported functions
	`Function, fcgx-read-all`:	Exported functions
	`Function, gen-start-response`:	Internal functions
	`Function, load-libfcgi`:	Exported functions
	`Function, make-serve-function`:	Exported functions
	`Function, merge-headers`:	Internal functions
	`Function, server-on-fd`:	Internal functions
	`Function, server-on-fd-threaded`:	Internal functions
	`Function, simple-server`:	Exported functions
	`Function, simple-server-threaded`:	Internal functions
	`Function, socket-server`:	Exported functions
	`Function, socket-server-threaded`:	Internal functions
	`Function, split-headers-to-cons`:	Internal functions
	`Function, usocket-to-fd`:	Internal functions

G
	`gen-start-response`:	Internal functions

L
	`load-libfcgi`:	Exported functions

M
	`make-serve-function`:	Exported functions
	`merge-headers`:	Internal functions

S
	`server-on-fd`:	Internal functions
	`server-on-fd-threaded`:	Internal functions
	`simple-server`:	Exported functions
	`simple-server-threaded`:	Internal functions
	`socket-server`:	Exported functions
	`socket-server-threaded`:	Internal functions
	`split-headers-to-cons`:	Internal functions

U
	`usocket-to-fd`:	Internal functions

Jump to:	D F G L M S U

A.3 Variables

Jump to:	* S

	Index Entry	Section

*
	`libfcgi-loaded`:	Internal special variables
	`read-buffer-size`:	Internal special variables

S
	`Special Variable, libfcgi-loaded`:	Internal special variables
	`Special Variable, read-buffer-size`:	Internal special variables

Jump to:	* S

A.4 Data types

Jump to:	C F P S

	Index Entry	Section

C
	`cl-fastcgi`:	The cl-fastcgi system
	`cl-fastcgi`:	The cl-fastcgi package
	`Class, fcgx-request-tclass`:	Internal classes

F
	`fcgx-request-tclass`:	Internal classes

P
	`Package, cl-fastcgi`:	The cl-fastcgi package

S
	`System, cl-fastcgi`:	The cl-fastcgi system

Jump to:	C F P S

• Introduction		What cl-fastcgi is all about
• Systems		The systems documentation
• Files		The files documentation
• Packages		The packages documentation
• Definitions		The symbols documentation
• Indexes		Concepts, functions, variables and data types

• The cl-fastcgi.asd file
• The cl-fastcgi/package.lisp file
• The cl-fastcgi/cl-fastcgi.lisp file
• The cl-fastcgi/cl-fastcgi-x.lisp file
• The cl-fastcgi/cl-fastcgi-server.lisp file
• The cl-fastcgi/cl-fastcgi-wsgi.lisp file

• Concept index
• Function index
• Variable index
• Data type index

• Internal special variables
• Internal functions
• Internal classes

The cl-fastcgi Reference Manual

Table of Contents

The cl-fastcgi Reference Manual

1 Introduction

2 Systems

2.1 cl-fastcgi

3 Files

3.1 Lisp

3.1.1 cl-fastcgi.asd

3.1.2 cl-fastcgi/package.lisp

3.1.3 cl-fastcgi/cl-fastcgi.lisp

3.1.4 cl-fastcgi/cl-fastcgi-x.lisp

3.1.5 cl-fastcgi/cl-fastcgi-server.lisp

3.1.6 cl-fastcgi/cl-fastcgi-wsgi.lisp

4 Packages

4.1 cl-fastcgi

5 Definitions

5.1 Exported definitions

5.1.1 Functions

5.2 Internal definitions

5.2.1 Special variables

5.2.2 Functions

5.2.3 Classes

Appendix A Indexes

A.1 Concepts

A.2 Functions

A.3 Variables

A.4 Data types

2.1 `cl-fastcgi`

3.1.1 `cl-fastcgi.asd`

3.1.2 `cl-fastcgi/package.lisp`

3.1.3 `cl-fastcgi/cl-fastcgi.lisp`

3.1.4 `cl-fastcgi/cl-fastcgi-x.lisp`

3.1.5 `cl-fastcgi/cl-fastcgi-server.lisp`

3.1.6 `cl-fastcgi/cl-fastcgi-wsgi.lisp`

4.1 `cl-fastcgi`