The cl-fastcgi Reference Manual

This is the cl-fastcgi Reference Manual, generated automatically by Declt version 4.0 beta 2 "William Riker" on Mon Aug 15 03:37:42 2022 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.

cl-fastcgi

2.1 `cl-fastcgi`

FastCGI wrapper for Common Lisp

Author

KDr2 <zhuo.dev@gmail.com>

License

BSD License

Dependencies

usocket (system).
cffi (system).
sb-bsd-sockets (system).

Source

cl-fastcgi.asd.

Child 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.

Lisp

3.1.1 `cl-fastcgi/cl-fastcgi.asd`

Source: cl-fastcgi.asd.
Parent Component: cl-fastcgi (system).
ASDF Systems: cl-fastcgi.

3.1.2 `cl-fastcgi/package.lisp`

Source: cl-fastcgi.asd.
Parent Component: cl-fastcgi (system).
Packages: cl-fastcgi.

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

Dependency

package.lisp (file).

Source

cl-fastcgi.asd.

Parent Component

cl-fastcgi (system).

Public Interface

load-libfcgi (function).

Internals

*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).

Source

cl-fastcgi.asd.

Parent Component

cl-fastcgi (system).

Public Interface

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).

Internals

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

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

Dependency

cl-fastcgi-x.lisp (file).

Source

cl-fastcgi.asd.

Parent Component

cl-fastcgi (system).

Public Interface

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

Internals

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).
Source: cl-fastcgi.asd.
Parent Component: cl-fastcgi (system).
Public Interface: make-serve-function (function).
Internals: gen-start-response (function).

4 Packages

Packages are listed by definition order.

cl-fastcgi

4.1 `cl-fastcgi`

Source

package.lisp.

Use List

cffi.
common-lisp.

Public Interface

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).

Internals

*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.

Public Interface
Internals

5.1 Public Interface

Ordinary functions

5.1.1 Ordinary functions

Function: fcgx-accept (req) ¶

Package: cl-fastcgi.
Source: cl-fastcgi-x.lisp.

Function: fcgx-finish (req) ¶

Package: cl-fastcgi.
Source: cl-fastcgi-x.lisp.

Function: fcgx-flush (req) ¶

Package: cl-fastcgi.
Source: cl-fastcgi-x.lisp.

Function: fcgx-getenv (req) ¶

Package: cl-fastcgi.
Source: cl-fastcgi-x.lisp.

Function: fcgx-getparam (req key) ¶

Package: cl-fastcgi.
Source: cl-fastcgi-x.lisp.

Function: fcgx-init () ¶

Package: cl-fastcgi.
Source: cl-fastcgi-x.lisp.

Function: fcgx-init-request (request sock flags) ¶

Package: cl-fastcgi.
Source: cl-fastcgi-x.lisp.

Function: fcgx-puts (req content &key stream) ¶

Package: cl-fastcgi.
Source: cl-fastcgi-x.lisp.

Function: fcgx-read (req) ¶

Package: cl-fastcgi.
Source: cl-fastcgi-x.lisp.

Function: fcgx-read-all (req) ¶

Package: cl-fastcgi.
Source: cl-fastcgi-x.lisp.

Function: load-libfcgi (&optional path) ¶

Package: cl-fastcgi.
Source: cl-fastcgi.lisp.

Function: make-serve-function (app) ¶

Package: cl-fastcgi.
Source: cl-fastcgi-wsgi.lisp.

Function: simple-server (func) ¶

Package: cl-fastcgi.
Source: cl-fastcgi-server.lisp.

Function: socket-server (func &key inet-addr port) ¶

Package: cl-fastcgi.
Source: cl-fastcgi-server.lisp.

5.2 Internals

Special variables
Ordinary functions
Classes

5.2.1 Special variables

Special Variable: *libfcgi-loaded* ¶

Package: cl-fastcgi.
Source: cl-fastcgi.lisp.

Special Variable: *read-buffer-size* ¶

Package: cl-fastcgi.
Source: cl-fastcgi-x.lisp.

5.2.2 Ordinary functions

Function: default-headers () ¶

Package: cl-fastcgi.
Source: cl-fastcgi.lisp.

Function: gen-start-response () ¶

Package: cl-fastcgi.
Source: cl-fastcgi-wsgi.lisp.

Function: merge-headers (old-headers new-headers) ¶

Package: cl-fastcgi.
Source: cl-fastcgi.lisp.

Function: server-on-fd (func fd &key flags) ¶

Package: cl-fastcgi.
Source: cl-fastcgi-server.lisp.

Function: server-on-fd-threaded (func fd &key flags threads) ¶

Package: cl-fastcgi.
Source: cl-fastcgi-server.lisp.

Function: simple-server-threaded (func &key threads) ¶

Package: cl-fastcgi.
Source: cl-fastcgi-server.lisp.

Function: socket-server-threaded (func &key inet-addr port threads) ¶

Package: cl-fastcgi.
Source: cl-fastcgi-server.lisp.

Function: split-headers-to-cons (str) ¶

Package: cl-fastcgi.
Source: cl-fastcgi.lisp.

Function: usocket-to-fd (usock) ¶

Package: cl-fastcgi.
Source: cl-fastcgi.lisp.

5.2.3 Classes

Class: fcgx-request-tclass ¶

Package

cl-fastcgi.

Source

cl-fastcgi-x.lisp.

Direct superclasses

foreign-struct-type.
translatable-foreign-type.

Appendix A Indexes

Concepts
Functions
Variables
Data types

A.1 Concepts

A.2 Functions

Jump to:	D F G L M S U

	Index Entry	Section

D
	`default-headers`:	Private ordinary functions

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

G
	`gen-start-response`:	Private ordinary functions

L
	`load-libfcgi`:	Public ordinary functions

M
	`make-serve-function`:	Public ordinary functions
	`merge-headers`:	Private ordinary functions

S
	`server-on-fd`:	Private ordinary functions
	`server-on-fd-threaded`:	Private ordinary functions
	`simple-server`:	Public ordinary functions
	`simple-server-threaded`:	Private ordinary functions
	`socket-server`:	Public ordinary functions
	`socket-server-threaded`:	Private ordinary functions
	`split-headers-to-cons`:	Private ordinary functions

U
	`usocket-to-fd`:	Private ordinary functions

Jump to:	D F G L M S U

A.3 Variables

Jump to:	* S

	Index Entry	Section

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

S
	`Special Variable, libfcgi-loaded`:	Private special variables
	`Special Variable, read-buffer-size`:	Private 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
	`cl-fastcgi-server.lisp`:	The cl-fastcgi/cl-fastcgi-server․lisp file
	`cl-fastcgi-wsgi.lisp`:	The cl-fastcgi/cl-fastcgi-wsgi․lisp file
	`cl-fastcgi-x.lisp`:	The cl-fastcgi/cl-fastcgi-x․lisp file
	`cl-fastcgi.asd`:	The cl-fastcgi/cl-fastcgi․asd file
	`cl-fastcgi.lisp`:	The cl-fastcgi/cl-fastcgi․lisp file
	`Class, fcgx-request-tclass`:	Private classes

F
	`fcgx-request-tclass`:	Private classes
	`File, cl-fastcgi-server.lisp`:	The cl-fastcgi/cl-fastcgi-server․lisp file
	`File, cl-fastcgi-wsgi.lisp`:	The cl-fastcgi/cl-fastcgi-wsgi․lisp file
	`File, cl-fastcgi-x.lisp`:	The cl-fastcgi/cl-fastcgi-x․lisp file
	`File, cl-fastcgi.asd`:	The cl-fastcgi/cl-fastcgi․asd file
	`File, cl-fastcgi.lisp`:	The cl-fastcgi/cl-fastcgi․lisp file
	`File, package.lisp`:	The cl-fastcgi/package․lisp file

P
	`Package, cl-fastcgi`:	The cl-fastcgi package
	`package.lisp`:	The cl-fastcgi/package․lisp file

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

Jump to:	C F P S

The cl-fastcgi Reference Manual

The cl-fastcgi Reference Manual

Table of Contents

1 Introduction

2 Systems

2.1 cl-fastcgi

3 Files

3.1 Lisp

3.1.1 cl-fastcgi/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 Public Interface

5.1.1 Ordinary functions

5.2 Internals

5.2.1 Special variables

5.2.2 Ordinary 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/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`