The sb-fastcgi Reference Manual

Table of Contents

The sb-fastcgi Reference Manual

This is the sb-fastcgi Reference Manual, generated automatically by Declt version 3.0 "Montgomery Scott" on Mon Apr 19 17:42:27 2021 GMT+0.

1 Introduction

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

 - HOMEPAGE : https://kdr2.com/project/sb-fastcgi.html
 - Author : KDr2   https://kdr2.com
 - License : BSD License
 - Curren-Version :    0.9
 - Docs :              https://kdr2.com/project/sb-fastcgi.html
 - Examples :          test.lisp
 - A Generic Version : https://kdr2.com/project/cl-fastcgi.html

2 Systems

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

2.1 sb-fastcgi

Author

KDr2 <zhuo.dev@gmail.com>

License

BSD License

Description

FastCGI wrapper for SBCL

Dependency

sb-bsd-sockets

Source

sb-fastcgi.asd (file)

Components

• package.lisp (file)
• sb-fastcgi.lisp (file)
• sb-fastcgi-x.lisp (file)
• sb-fastcgi-server.lisp (file)
• sb-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 sb-fastcgi.asd

Location

sb-fastcgi.asd

Systems

sb-fastcgi (system)

3.1.2 sb-fastcgi/package.lisp

Parent

sb-fastcgi (system)

Location

package.lisp

Packages

sb-fastcgi

3.1.3 sb-fastcgi/sb-fastcgi.lisp

Dependency

package.lisp (file)

Parent

sb-fastcgi (system)

Location

sb-fastcgi.lisp

Exported Definitions

load-libfcgi (function)

Internal Definitions

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

3.1.4 sb-fastcgi/sb-fastcgi-x.lisp

Dependency

sb-fastcgi.lisp (file)

Parent

sb-fastcgi (system)

Location

sb-fastcgi-x.lisp

Exported Definitions

• fcgx-accept (function)
• fcgx-finish (function)
• fcgx-getenv (function)
• fcgx-getparam (function)
• fcgx-init (function)
• fcgx-init-request (function)
• fcgx-puts (function)
• fcgx-puts-utf-8 (function)
• fcgx-read (function)
• fcgx-read-all (function)

Internal Definitions

*read-buffer-size* (special variable)

3.1.5 sb-fastcgi/sb-fastcgi-server.lisp

Dependency

sb-fastcgi-x.lisp (file)

Parent

sb-fastcgi (system)

Location

sb-fastcgi-server.lisp

Exported Definitions

• simple-server (function)
• simple-server-threaded (function)
• socket-server (function)
• socket-server-threaded (function)

Internal Definitions

• server-on-fd (function)
• server-on-fd-threaded (function)

3.1.6 sb-fastcgi/sb-fastcgi-wsgi.lisp

Dependency

sb-fastcgi-server.lisp (file)

Parent

sb-fastcgi (system)

Location

sb-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 sb-fastcgi

Source

package.lisp (file)

Nickname

cl-fastcgi

Use List

• sb-alien
• common-lisp

Exported Definitions

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

Internal Definitions

• *libfcgi-loaded* (special variable)
• *read-buffer-size* (special variable)
• default-headers (function)
• gen-start-response (function)
• merge-headers (function)
• server-on-fd (function)
• server-on-fd-threaded (function)
• split-headers-to-cons (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

sb-fastcgi

Source

sb-fastcgi-x.lisp (file)

Function: fcgx-finish REQ

Package

sb-fastcgi

Source

sb-fastcgi-x.lisp (file)

Function: fcgx-getenv REQ

Package

sb-fastcgi

Source

sb-fastcgi-x.lisp (file)

Function: fcgx-getparam REQ KEY

Package

sb-fastcgi

Source

sb-fastcgi-x.lisp (file)

Function: fcgx-init ()

Package

sb-fastcgi

Source

sb-fastcgi-x.lisp (file)

Function: fcgx-init-request REQUEST SOCK FLAGS

Package

sb-fastcgi

Source

sb-fastcgi-x.lisp (file)

Function: fcgx-puts REQ CONTENT &key STREAM

Package

sb-fastcgi

Source

sb-fastcgi-x.lisp (file)

Function: fcgx-puts-utf-8 REQ CONTENT &key STREAM

Package

sb-fastcgi

Source

sb-fastcgi-x.lisp (file)

Function: fcgx-read REQ

Package

sb-fastcgi

Source

sb-fastcgi-x.lisp (file)

Function: fcgx-read-all REQ

Package

sb-fastcgi

Source

sb-fastcgi-x.lisp (file)

Function: load-libfcgi &optional PATH

Package

sb-fastcgi

Source

sb-fastcgi.lisp (file)

Function: make-serve-function APP

Package

sb-fastcgi

Source

sb-fastcgi-wsgi.lisp (file)

Function: simple-server FUNC

Package

sb-fastcgi

Source

sb-fastcgi-server.lisp (file)

Function: simple-server-threaded FUNC &key THREADS

Package

sb-fastcgi

Source

sb-fastcgi-server.lisp (file)

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

Package

sb-fastcgi

Source

sb-fastcgi-server.lisp (file)

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

Package

sb-fastcgi

Source

sb-fastcgi-server.lisp (file)

5.2 Internal definitions

5.2.1 Special variables

Special Variable: *libfcgi-loaded*

Package

sb-fastcgi

Source

sb-fastcgi.lisp (file)

Special Variable: *read-buffer-size*

Package

sb-fastcgi

Source

sb-fastcgi-x.lisp (file)

5.2.2 Functions

Function: default-headers ()

Package

sb-fastcgi

Source

sb-fastcgi.lisp (file)

Function: gen-start-response ()

Package

sb-fastcgi

Source

sb-fastcgi-wsgi.lisp (file)

Function: merge-headers OLD-HEADERS NEW-HEADERS

Package

sb-fastcgi

Source

sb-fastcgi.lisp (file)

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

Package

sb-fastcgi

Source

sb-fastcgi-server.lisp (file)

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

Package

sb-fastcgi

Source

sb-fastcgi-server.lisp (file)

Function: split-headers-to-cons STR

Package

sb-fastcgi

Source

sb-fastcgi.lisp (file)

Appendix A Indexes

A.1 Concepts

A.2 Functions

A.3 Variables

A.4 Data types