Next: Introduction, Previous: (dir), Up: (dir) [Contents][Index]
The fast-http Reference Manual
This is the fast-http Reference Manual, version 0.2.0, generated automatically by Declt version 4.0 beta 2 "William Riker" on Mon Aug 15 04:32:01 2022 GMT+0.
Table of Contents
Next: Systems, Previous: The fast-http Reference Manual, Up: The fast-http Reference Manual [Contents][Index]
1 Introduction
fast-http
This is a fast HTTP request/response protocol parser for Common Lisp.
Features
- Parses both HTTP requests and responses.
- Handles persistent streams (keep-alive).
- Decodes chunked encoding.
- Exports low-level APIs which don't any memory allocations during parsing.
API differences from http-parse
The API is quite similar to http-parse, although there's some differences.
http,http-requestandhttp-responseare structure classes, not standard classes.httpdoesn't have:force-streamoption. (always streaming)httpdoesn't have:store-bodyoption because it can consume much memory.body-callbackformake-parserdoesn't take a flagbody-complete-p.- Use
finish-callbackto know if the parsing is finished.
- Use
body-callbackformake-parsertakes pointersstartandend.multipart-callbackformake-parserhas been deleted.- Use
make-multipart-parserandbody-callbackby yourself.
- Use
:callbackofmake-multipart-parsertakes a stream, not a body octet vector at the 4th argument.- Raises errors aggressively while parsing.
- Handle
fast-http-erroras you needed.
- Handle
- Doesn't use a property list as a representation of HTTP headers. (See issue #1)
APIs
[Structure] http
Base structure class extended by http-request and http-response.
NOTE: Don't use this class directly unless you're intended to use low-level APIs of fast-http.
(make-http)
;=> #S(FAST-HTTP.HTTP:HTTP
; :METHOD NIL
; :MAJOR-VERSION 0
; :MINOR-VERSION 9
; :STATUS 0
; :CONTENT-LENGTH NIL
; :CHUNKED-P NIL
; :UPGRADE-P NIL
; :HEADERS NIL
; :HEADER-READ 0
; :MARK -1
; :STATE 0)
Methods
http-method: Returns a HTTP request method in a keyword (such like:GET,:POSTor:HEAD).http-major-version: Returns a HTTP protocol major version in an integer (such like1or0).http-minor-version: Returns a HTTP protocol minor version in an integer (such like1or0).http-version: Returns a HTTP protocol version in a float (such like1.0or1.1).http-status: Returns a HTTP response status code in an integer (such like200or302).http-content-length: Returns a value ofContent-Lengthheader in an integer. If the header doesn't exist, it returnsNIL.http-chunked-p: ReturnsTif the value ofTransfer-Encodingheader ischunked. If the header doesn't exist, it returnsNIL.http-upgrade-p: ReturnsTifUpgradeheader exists.http-headers: Returns a hash-table which represents HTTP headers. Note all hash keys are lower-cased and all values are string exceptSet-Cookieheader, whose value is a list of strings. (Content-Length->"content-length").
[Structure] http-request (extends http)
Structure class holds values specific to an HTTP request.
(make-http-request)
;=> #S(FAST-HTTP.HTTP:HTTP-REQUEST
; :METHOD NIL
; :MAJOR-VERSION 0
; :MINOR-VERSION 9
; :STATUS 0
; :CONTENT-LENGTH NIL
; :CHUNKED-P NIL
; :UPGRADE-P NIL
; :HEADERS NIL
; :HEADER-READ 0
; :MARK -1
; :STATE 0
; :RESOURCE NIL)
Methods
http-resource: Returns an URI string.
[Structure] http-response (extends http)
Structure class holds values specific to an HTTP response.
(make-http-response)
;=> #S(FAST-HTTP.HTTP:HTTP-RESPONSE
; :METHOD NIL
; :MAJOR-VERSION 0
; :MINOR-VERSION 9
; :STATUS 0
; :CONTENT-LENGTH NIL
; :CHUNKED-P NIL
; :UPGRADE-P NIL
; :HEADERS NIL
; :HEADER-READ 0
; :MARK -1
; :STATE 0
; :STATUS-TEXT NIL)
Methods
http-status-text: Returns an response status text (such likeContinue,OKorBad Request).
[Function] make-parser (http &key first-line-callback header-callback body-callback finish-callback)
Makes a parser closure and returns it.
(let ((http (make-http-request)))
(make-parser http
:body-callback
(lambda (data start end)
(write-to-buffer data start end))
:finish-callback
(lambda ()
(handle-response http))))
;=> #<CLOSURE (LAMBDA (DATA &KEY (START 0) END)
; :IN
; FAST-HTTP.PARSER:MAKE-PARSER) {10090BDD0B}>
The closure takes one required argument data, that is a simple byte vector and two keyword arguments start and end.
Callbacks
first-line-callback(): This callback function will be called when the first line is parsed.header-callback(headers-hash-table): This callback function will be called when the header lines are parsed. This function is the same object to thehttpobject holds.body-callback(data-byte-vector): This callback function will be called whenever it gets a chunk of HTTP body. Which means this can be called multiple times.finish-callback(): This callback function will be called when the HTTP message ends.
NOTE: If the HTTP request/response has multiple messages (like HTTP/1.1 pipelining), all these functions can be called multiple times.
[Function] make-multipart-parser (content-type callback)
Makes a multipart/form-data parser closure and returns it.
This takes 2 arguments, content-type (such like "multipart/form-data; boundary=--AsB03x") and callback. The callback is a function which takes exact 4 arguments -- a field name, field headers, field meta data and body bytes.
Low-level APIs
The following functions are intended to be used for internally. These APIs are likely to change in the future.
Most of functions are declared as (optimize (speed 3) (safety 0)) which means it won't check the type of arguments.
[Structure] callbacks
Structure class holds callback functions. The callbacks are similar to make-parser's, but don't correspond to them directly.
Slots
message-begin(http): This will be called when a new HTTP message begins.url(http data start end): This will be called when an URL part of the HTTP request parsed.first-line(http): This will be called when the first line of the HTTP request/response parsed.status(http data start end): This will be called when the status text (not code) of the HTTP response parsed.header-field(http data start end): This will be called when a header field parsed.header-value(http data start end): This will be called when a header value parsed. This function can be called multiple times when the header value is folded onto multiple lines.headers-complete(http): This will be called when all headers parsed.body(http data start end): This will be called whenever the parser gets a chunk of HTTP body.message-complete(http): This will be called when the HTTP message ends.
[Function] parse-request (http callbacks data &key (start 0) end)
Parses data as an HTTP request, sets values to http and invokes callbacks in callbacks.
This takes a http object, a callbacks object, and a simple byte vector data and two pointers -- start and end. If end is nil, the length of data will be used.
[Function] parse-response (http callbacks data &key (start 0) end)
Parses data as an HTTP response, sets values to http and invokes callbacks in callbacks.
Takes a http object, a callbacks object, and a simple byte vector data and two pointers -- start and end. If end is nil, the length of data will be used.
[Condition] eof
Will be raised when the data ends in the middle of parsing.
Installation
(ql:quickload :fast-http)
Running tests
(asdf:test-system :fast-http)
Benchmark
- Parsing an HTTP request header 100000 times.
In this benchmark, fast-http is 1.25 times faster than http-parser, a C equivalent.
| http-parser (C) | fast-http | | ---------------:| ---------:| | 0.108s | 0.086s |
Environment
- Travis CI
- SBCL 1.2.6
You can see the latest result at Travis CI.
fast-http (Common Lisp)
(ql:quickload :fast-http-test)
(fast-http-test.benchmark:run-ll-benchmark)
Evaluation took:
0.086 seconds of real time
0.085897 seconds of total run time (0.084763 user, 0.001134 system)
100.00% CPU
257,140,751 processor cycles
0 bytes consed
http-parser (C)
#include "http_parser.h"
#include <stdio.h>
#include <stdlib.h>
#include <string.h>
#include <assert.h>
#include <time.h>
static http_parser *parser;
static http_parser_settings settings_null =
{.on_message_begin = 0
,.on_header_field = 0
,.on_header_value = 0
,.on_url = 0
,.on_status = 0
,.on_body = 0
,.on_headers_complete = 0
,.on_message_complete = 0
};
int
main (void)
{
const char *buf;
int i;
float start, end;
size_t parsed;
parser = malloc(sizeof(http_parser));
buf = "GET /cookies HTTP/1.1\r\nHost: 127.0.0.1:8090\r\nConnection: keep-alive\r\nCache-Control: max-age=0\r\nAccept: text/html,application/xhtml+xml,application/xml;q=0.9,*/*;q=0.8\r\nUser-Agent: Mozilla/5.0 (Windows NT 6.1; WOW64) AppleWebKit/537.17 (KHTML, like Gecko) Chrome/24.0.1312.56 Safari/537.17\r\nAccept-Encoding: gzip,deflate,sdch\r\nAccept-Language: en-US,en;q=0.8\r\nAccept-Charset: ISO-8859-1,utf-8;q=0.7,*;q=0.3\r\nCookie: name=wookie\r\n\r\n";
start = (float)clock()/CLOCKS_PER_SEC;
for (i = 0; i < 100000; i++) {
http_parser_init(parser, HTTP_REQUEST);
parsed = http_parser_execute(parser, &settings_null, buf, strlen(buf));
}
end = (float)clock()/CLOCKS_PER_SEC;
free(parser);
parser = NULL;
printf("Elapsed %f seconds.\n", (end - start));
return 0;
}
$ make http_parser.o
$ gcc -Wall -Wextra -Werror -Wno-error=unused-but-set-variable -O3 http_parser.o mybench.c -o mybench
$ mybench
Elapsed 0.108815 seconds.
Author
- Eitaro Fukamachi (e.arrows@gmail.com)
Copyright
Copyright (c) 2014 Eitaro Fukamachi
License
Licensed under the MIT License.
Next: Modules, Previous: Introduction, Up: The fast-http Reference Manual [Contents][Index]
2 Systems
The main system appears first, followed by any subsystem dependency.
2.1 fast-http
A fast HTTP protocol parser in Common Lisp
- Author
Eitaro Fukamachi
- License
MIT
- Long Description
# fast-http
[](https://travis-ci.org/fukamachi/fast-http)
This is a fast HTTP request/response protocol parser for Common Lisp.
## Features
* Parses both HTTP requests and responses.
* Handles persistent streams (keep-alive).
* Decodes chunked encoding.
* Exports low-level APIs which don’t any memory allocations during parsing.
## API differences from http-parse
The API is quite similar to [http-parse](https://github.com/orthecreedence/http-parse), although there’s some differences.
* ‘http‘, ‘http-request‘ and ‘http-response‘ are structure classes, not standard classes.
* ‘http‘ doesn’t have ‘:force-stream‘ option. (always streaming)
* ‘http‘ doesn’t have ‘:store-body‘ option because it can consume much memory.
* ‘body-callback‘ for ‘make-parser‘ doesn’t take a flag ‘body-complete-p‘.
* Use ‘finish-callback‘ to know if the parsing is finished.
* ‘body-callback‘ for ‘make-parser‘ takes pointers ‘start‘ and ‘end‘.
* ‘multipart-callback‘ for ‘make-parser‘ has been deleted.
* Use ‘make-multipart-parser‘ and ‘body-callback‘ by yourself.
* ‘:callback‘ of ‘make-multipart-parser‘ takes a stream, not a body octet vector at the 4th argument.
* Raises errors aggressively while parsing.
* Handle ‘fast-http-error‘ as you needed.
* Doesn’t use a property list as a representation of HTTP headers. (See [issue #1](https://github.com/fukamachi/fast-http/issues/1))
## APIs
### \[Structure] http
Base structure class extended by ‘http-request‘ and ‘http-response‘.
**NOTE**: Don’t use this class directly unless you’re intended to use low-level APIs of fast-http.
“‘common-lisp
(make-http)
;=> #S(FAST-HTTP.HTTP:HTTP
; :METHOD NIL
; :MAJOR-VERSION 0
; :MINOR-VERSION 9
; :STATUS 0
; :CONTENT-LENGTH NIL
; :CHUNKED-P NIL
; :UPGRADE-P NIL
; :HEADERS NIL
; :HEADER-READ 0
; :MARK -1
; :STATE 0)
“‘
#### Methods
- ‘http-method‘: Returns a HTTP request method in a keyword (such like ‘:GET‘, ‘:POST‘ or ‘:HEAD‘).
- ‘http-major-version‘: Returns a HTTP protocol major version in an integer (such like ‘1‘ or ‘0‘).
- ‘http-minor-version‘: Returns a HTTP protocol minor version in an integer (such like ‘1‘ or ‘0‘).
- ‘http-version‘: Returns a HTTP protocol version in a float (such like ‘1.0‘ or ‘1.1‘).
- ‘http-status‘: Returns a HTTP response status code in an integer (such like ‘200‘ or ‘302‘).
- ‘http-content-length‘: Returns a value of ‘Content-Length‘ header in an integer. If the header doesn’t exist, it returns ‘NIL‘.
- ‘http-chunked-p‘: Returns ‘T‘ if the value of ‘Transfer-Encoding‘ header is ‘chunked‘. If the header doesn’t exist, it returns ‘NIL‘.
- ‘http-upgrade-p‘: Returns ‘T‘ if ‘Upgrade‘ header exists.
- ‘http-headers‘: Returns a hash-table which represents HTTP headers. Note all hash keys are lower-cased and all values are string except ‘Set-Cookie‘ header, whose value is a list of strings. (‘Content-Length‘ -> ‘"content-length"‘).
### \[Structure] http-request (extends http)
Structure class holds values specific to an HTTP request.
“‘common-lisp
(make-http-request)
;=> #S(FAST-HTTP.HTTP:HTTP-REQUEST
; :METHOD NIL
; :MAJOR-VERSION 0
; :MINOR-VERSION 9
; :STATUS 0
; :CONTENT-LENGTH NIL
; :CHUNKED-P NIL
; :UPGRADE-P NIL
; :HEADERS NIL
; :HEADER-READ 0
; :MARK -1
; :STATE 0
; :RESOURCE NIL)
“‘
#### Methods
- ‘http-resource‘: Returns an URI string.
### \[Structure] http-response (extends http)
Structure class holds values specific to an HTTP response.
“‘common-lisp
(make-http-response)
;=> #S(FAST-HTTP.HTTP:HTTP-RESPONSE
; :METHOD NIL
; :MAJOR-VERSION 0
; :MINOR-VERSION 9
; :STATUS 0
; :CONTENT-LENGTH NIL
; :CHUNKED-P NIL
; :UPGRADE-P NIL
; :HEADERS NIL
; :HEADER-READ 0
; :MARK -1
; :STATE 0
; :STATUS-TEXT NIL)
“‘
#### Methods
- ‘http-status-text‘: Returns an response status text (such like ‘Continue‘, ‘OK‘ or ‘Bad Request‘).
### \[Function] make-parser (http &key first-line-callback header-callback body-callback finish-callback)
Makes a parser closure and returns it.
“‘common-lisp
(let ((http (make-http-request)))
(make-parser http
:body-callback
(lambda (data start end)
(write-to-buffer data start end))
:finish-callback
(lambda ()
(handle-response http))))
;=> #<CLOSURE (LAMBDA (DATA &KEY (START 0) END)
; :IN
; FAST-HTTP.PARSER:MAKE-PARSER) {10090BDD0B}>
“‘
The closure takes one required argument ‘data‘, that is a simple byte vector and two keyword arguments ‘start‘ and ‘end‘.
#### Callbacks
- ‘first-line-callback‘ (): This callback function will be called when the first line is parsed.
- ‘header-callback‘ (headers-hash-table): This callback function will be called when the header lines are parsed. This function is the same object to the ‘http‘ object holds.
- ‘body-callback‘ (data-byte-vector): This callback function will be called whenever it gets a chunk of HTTP body. Which means this can be called multiple times.
- ‘finish-callback‘ (): This callback function will be called when the HTTP message ends.
NOTE: If the HTTP request/response has multiple messages (like HTTP/1.1 pipelining), all these functions can be called multiple times.
### \[Function] make-multipart-parser (content-type callback)
Makes a multipart/form-data parser closure and returns it.
This takes 2 arguments, ‘content-type‘ (such like ‘"multipart/form-data; boundary=–AsB03x"‘) and ‘callback‘. The ‘callback‘ is a function which takes exact 4 arguments – a field name, field headers, field meta data and body bytes.
## Low-level APIs
The following functions are intended to be used for internally. These APIs are likely to change in the future.
Most of functions are declared as ‘(optimize (speed 3) (safety 0))‘ which means it won’t check the type of arguments.
### \[Structure] callbacks
Structure class holds callback functions. The callbacks are similar to ‘make-parser‘’s, but don’t correspond to them directly.
#### Slots
- ‘message-begin‘ (http): This will be called when a new HTTP message begins.
- ‘url‘ (http data start end): This will be called when an URL part of the HTTP request parsed.
- ‘first-line‘ (http): This will be called when the first line of the HTTP request/response parsed.
- ‘status‘ (http data start end): This will be called when the status text (not code) of the HTTP response parsed.
- ‘header-field‘ (http data start end): This will be called when a header field parsed.
- ‘header-value‘ (http data start end): This will be called when a header value parsed. This function can be called multiple times when the header value is folded onto multiple lines.
- ‘headers-complete‘ (http): This will be called when all headers parsed.
- ‘body‘ (http data start end): This will be called whenever the parser gets a chunk of HTTP body.
- ‘message-complete‘ (http): This will be called when the HTTP message ends.
### \[Function] parse-request (http callbacks data &key (start 0) end)
Parses ‘data‘ as an HTTP request, sets values to ‘http‘ and invokes callbacks in ‘callbacks‘.
This takes a ‘http‘ object, a ‘callbacks‘ object, and a simple byte vector ‘data‘ and two pointers – ‘start‘ and ‘end‘. If ‘end‘ is ‘nil‘, the length of ‘data‘ will be used.
### \[Function] parse-response (http callbacks data &key (start 0) end)
Parses ‘data‘ as an HTTP response, sets values to ‘http‘ and invokes callbacks in ‘callbacks‘.
Takes a ‘http‘ object, a ‘callbacks‘ object, and a simple byte vector ‘data‘ and two pointers – ‘start‘ and ‘end‘. If ‘end‘ is ‘nil‘, the length of ‘data‘ will be used.
### \[Condition] eof
Will be raised when the ‘data‘ ends in the middle of parsing.
## Installation
“‘common-lisp
(ql:quickload :fast-http)
“‘
## Running tests
“‘common-lisp
(asdf:test-system :fast-http)
“‘
## Benchmark
- Parsing an HTTP request header 100000 times.
In this benchmark, fast-http is **1.25 times faster** than [http-parser](https://github.com/joyent/http-parser), a C equivalent.
| http-parser (C) | fast-http |
| —————:| ———:|
| 0.108s | 0.086s |
### Environment
* Travis CI
* SBCL 1.2.6
You can see the latest result at [Travis CI](https://travis-ci.org/fukamachi/fast-http).
### fast-http (Common Lisp)
“‘common-lisp
(ql:quickload :fast-http-test)
(fast-http-test.benchmark:run-ll-benchmark)
“‘
“‘
Evaluation took:
0.086 seconds of real time
0.085897 seconds of total run time (0.084763 user, 0.001134 system)
100.00% CPU
257,140,751 processor cycles
0 bytes consed
“‘
### http-parser (C)
“‘c
#include "http_parser.h"
#include <stdio.h>
#include <stdlib.h>
#include <string.h>
#include <assert.h>
#include <time.h>
static http_parser *parser;
static http_parser_settings settings_null =
{.on_message_begin = 0
,.on_header_field = 0
,.on_header_value = 0
,.on_url = 0
,.on_status = 0
,.on_body = 0
,.on_headers_complete = 0
,.on_message_complete = 0
};
int
main (void)
{
const char *buf;
int i;
float start, end;
size_t parsed;
parser = malloc(sizeof(http_parser));
buf = "GET /cookies HTTP/1.1\r\nHost: 127.0.0.1:8090\r\nConnection: keep-alive\r\nCache-Control: max-age=0\r\nAccept: text/html,application/xhtml+xml,application/xml;q=0.9,*/*;q=0.8\r\nUser-Agent: Mozilla/5.0 (Windows NT 6.1; WOW64) AppleWebKit/537.17 (KHTML, like Gecko) Chrome/24.0.1312.56 Safari/537.17\r\nAccept-Encoding: gzip,deflate,sdch\r\nAccept-Language: en-US,en;q=0.8\r\nAccept-Charset: ISO-8859-1,utf-8;q=0.7,*;q=0.3\r\nCookie: name=wookie\r\n\r\n";
start = (float)clock()/CLOCKS_PER_SEC;
for (i = 0; i < 100000; i++) {
http_parser_init(parser, HTTP_REQUEST);
parsed = http_parser_execute(parser, &settings_null, buf, strlen(buf));
}
end = (float)clock()/CLOCKS_PER_SEC;
free(parser);
parser = NULL;
printf("Elapsed %f seconds.\n", (end - start));
return 0;
}
“‘
“‘
$ make http_parser.o
$ gcc -Wall -Wextra -Werror -Wno-error=unused-but-set-variable -O3 http_parser.o mybench.c -o mybench
$ mybench
Elapsed 0.108815 seconds.
“‘
## Author
* Eitaro Fukamachi (e.arrows@gmail.com)
## Copyright
Copyright (c) 2014 Eitaro Fukamachi
## License
Licensed under the MIT License.
- Version
0.2.0
- Dependencies
- alexandria (system).
- cl-utilities (system).
- proc-parse (system).
- babel (system).
- xsubseq (system).
- smart-buffer (system).
- Source
- Child Component
src (module).
Next: Files, Previous: Systems, Up: The fast-http Reference Manual [Contents][Index]
3 Modules
Modules are listed depth-first from the system components tree.
3.1 fast-http/src
- Source
- Parent Component
fast-http (system).
- Child Components
- fast-http.lisp (file).
- http.lisp (file).
- parser.lisp (file).
- multipart-parser.lisp (file).
- byte-vector.lisp (file).
- error.lisp (file).
- util.lisp (file).
Next: Packages, Previous: Modules, Up: The fast-http Reference Manual [Contents][Index]
4 Files
Files are sorted by type and then listed depth-first from the systems components trees.
4.1 Lisp
- fast-http/fast-http.asd
- fast-http/src/fast-http.lisp
- fast-http/src/http.lisp
- fast-http/src/parser.lisp
- fast-http/src/multipart-parser.lisp
- fast-http/src/byte-vector.lisp
- fast-http/src/error.lisp
- fast-http/src/util.lisp
Next: fast-http/src/fast-http.lisp, Previous: Lisp, Up: Lisp [Contents][Index]
4.1.1 fast-http/fast-http.asd
- Source
- Parent Component
fast-http (system).
- ASDF Systems
- Packages
Next: fast-http/src/http.lisp, Previous: fast-http/fast-http.asd, Up: Lisp [Contents][Index]
4.1.2 fast-http/src/fast-http.lisp
- Dependencies
- http.lisp (file).
- parser.lisp (file).
- multipart-parser.lisp (file).
- byte-vector.lisp (file).
- error.lisp (file).
- Source
- Parent Component
src (module).
- Packages
- Public Interface
- make-multipart-parser (function).
- make-parser (function).
- Internals
find-boundary (function).
Next: fast-http/src/parser.lisp, Previous: fast-http/src/fast-http.lisp, Up: Lisp [Contents][Index]
4.1.3 fast-http/src/http.lisp
- Source
- Parent Component
src (module).
- Packages
- Public Interface
- +state-body+ (constant).
- +state-chunk-body-end-crlf+ (constant).
- +state-chunk-size+ (constant).
- +state-first-line+ (constant).
- +state-headers+ (constant).
- +state-trailing-headers+ (constant).
- http (structure).
- http-chunked-p (reader).
- (setf http-chunked-p) (writer).
- http-content-length (reader).
- (setf http-content-length) (writer).
- http-header-read (reader).
- (setf http-header-read) (writer).
- http-headers (reader).
- (setf http-headers) (writer).
- http-major-version (reader).
- (setf http-major-version) (writer).
- http-mark (reader).
- (setf http-mark) (writer).
- http-method (reader).
- (setf http-method) (writer).
- http-minor-version (reader).
- (setf http-minor-version) (writer).
- http-p (function).
- http-request (structure).
- http-request-p (function).
- http-resource (reader).
- (setf http-resource) (writer).
- http-response (structure).
- http-response-p (function).
- http-state (reader).
- (setf http-state) (writer).
- http-status (reader).
- (setf http-status) (writer).
- http-status-text (reader).
- (setf http-status-text) (writer).
- http-upgrade-p (reader).
- (setf http-upgrade-p) (writer).
- http-version (function).
- make-http (function).
- make-http-request (function).
- make-http-response (function).
- status-code (type).
- Internals
- copy-http (function).
- copy-http-request (function).
- copy-http-response (function).
Next: fast-http/src/multipart-parser.lisp, Previous: fast-http/src/http.lisp, Up: Lisp [Contents][Index]
4.1.4 fast-http/src/parser.lisp
- Dependencies
- http.lisp (file).
- error.lisp (file).
- byte-vector.lisp (file).
- util.lisp (file).
- Source
- Parent Component
src (module).
- Packages
- Public Interface
- callbacks (structure).
- eof (condition).
- make-callbacks (function).
- parse-request (function).
- parse-response (function).
- pointer (type).
- Internals
- +max-header-line+ (constant).
- +tokens+ (constant).
- +unhex+ (constant).
- callback-data (macro).
- callback-notify (macro).
- callbacks-body (reader).
- (setf callbacks-body) (writer).
- callbacks-first-line (reader).
- (setf callbacks-first-line) (writer).
- callbacks-header-field (reader).
- (setf callbacks-header-field) (writer).
- callbacks-header-value (reader).
- (setf callbacks-header-value) (writer).
- callbacks-headers-complete (reader).
- (setf callbacks-headers-complete) (writer).
- callbacks-message-begin (reader).
- (setf callbacks-message-begin) (writer).
- callbacks-message-complete (reader).
- (setf callbacks-message-complete) (writer).
- callbacks-p (function).
- callbacks-status (reader).
- (setf callbacks-status) (writer).
- callbacks-url (reader).
- (setf callbacks-url) (writer).
- copy-callbacks (function).
- expect-failed (condition).
- http-message-needs-eof-p (function).
- parse-body (function).
- parse-chunked-body (function).
- parse-header-field-and-value (function).
- parse-header-line (function).
- parse-header-value (function).
- parse-header-value-content-length (function).
- parse-header-value-parameters (function).
- parse-header-value-transfer-encoding (function).
- parse-headers (function).
- parse-http-version (function).
- parse-method (function).
- parse-status-code (function).
- parse-url (function).
- read-body-data (function).
- unhex-byte (function).
Next: fast-http/src/byte-vector.lisp, Previous: fast-http/src/parser.lisp, Up: Lisp [Contents][Index]
4.1.5 fast-http/src/multipart-parser.lisp
- Dependencies
- parser.lisp (file).
- byte-vector.lisp (file).
- error.lisp (file).
- Source
- Parent Component
src (module).
- Packages
- Public Interface
- http-multipart-parse (function).
- ll-multipart-parser (structure).
- ll-multipart-parser-state (reader).
- (setf ll-multipart-parser-state) (writer).
- make-ll-multipart-parser (function).
- Internals
- +body-almost-done+ (constant).
- +body-done+ (constant).
- +body-start+ (constant).
- +header-field-start+ (constant).
- +looking-for-delimiter+ (constant).
- +maybe-delimiter-first-dash+ (constant).
- +maybe-delimiter-second-dash+ (constant).
- +maybe-delimiter-start+ (constant).
- +parsing-delimiter+ (constant).
- +parsing-delimiter-almost-done+ (constant).
- +parsing-delimiter-dash+ (constant).
- +parsing-delimiter-dash-start+ (constant).
- +parsing-delimiter-done+ (constant).
- +parsing-delimiter-end+ (constant).
- copy-ll-multipart-parser (function).
- ll-multipart-parser-body-buffer (reader).
- (setf ll-multipart-parser-body-buffer) (writer).
- ll-multipart-parser-body-mark (reader).
- (setf ll-multipart-parser-body-mark) (writer).
- ll-multipart-parser-boundary (reader).
- (setf ll-multipart-parser-boundary) (writer).
- ll-multipart-parser-boundary-buffer (reader).
- (setf ll-multipart-parser-boundary-buffer) (writer).
- ll-multipart-parser-boundary-mark (reader).
- (setf ll-multipart-parser-boundary-mark) (writer).
- ll-multipart-parser-header-parser (reader).
- (setf ll-multipart-parser-header-parser) (writer).
- ll-multipart-parser-p (function).
Next: fast-http/src/error.lisp, Previous: fast-http/src/multipart-parser.lisp, Up: Lisp [Contents][Index]
4.1.6 fast-http/src/byte-vector.lisp
- Source
- Parent Component
src (module).
- Packages
- Public Interface
- +cr+ (constant).
- +crlf+ (constant).
- +dash+ (constant).
- +lf+ (constant).
- +page+ (constant).
- +space+ (constant).
- +tab+ (constant).
- alpha-byte-char-p (function).
- alpha-byte-char-to-lower-char (function).
- alphanumeric-byte-char-p (function).
- append-byte-vectors (function).
- ascii-octets-to-lower-string (function).
- ascii-octets-to-string (function).
- digit-byte-char-p (function).
- digit-byte-char-to-integer (function).
- mark-byte-char-p (function).
- simple-byte-vector (type).
- Internals
byte-to-ascii-lower (function).
Next: fast-http/src/util.lisp, Previous: fast-http/src/byte-vector.lisp, Up: Lisp [Contents][Index]
4.1.7 fast-http/src/error.lisp
- Source
- Parent Component
src (module).
- Packages
- Public Interface
- callback-error (condition).
- cb-body (condition).
- cb-first-line (condition).
- cb-header-field (condition).
- cb-header-value (condition).
- cb-headers-complete (condition).
- cb-message-begin (condition).
- cb-message-complete (condition).
- cb-status (condition).
- cb-url (condition).
- closed-connection (condition).
- fast-http-error (condition).
- header-overflow (condition).
- header-value-parsing-error (condition).
- invalid-boundary (condition).
- invalid-chunk-size (condition).
- invalid-constant (condition).
- invalid-content-length (condition).
- invalid-eof-state (condition).
- invalid-fragment (condition).
- invalid-header-token (condition).
- invalid-header-value (condition).
- invalid-host (condition).
- invalid-internal-state (condition).
- invalid-method (condition).
- invalid-multipart-body (condition).
- invalid-parameter-key (condition).
- invalid-parameter-value (condition).
- invalid-path (condition).
- invalid-port (condition).
- invalid-query-string (condition).
- invalid-status (condition).
- invalid-url (condition).
- invalid-version (condition).
- lf-expected (condition).
- multipart-parsing-error (condition).
- parsing-error (condition).
- paused-error (condition).
- strict-error (condition).
- unknown-error (condition).
Previous: fast-http/src/error.lisp, Up: Lisp [Contents][Index]
4.1.8 fast-http/src/util.lisp
- Dependency
error.lisp (file).
- Source
- Parent Component
src (module).
- Packages
- Public Interface
- case-byte (macro).
- casev (macro).
- casev= (macro).
- defun-careful (macro).
- defun-insane (macro).
- defun-speedy (macro).
- make-collector (function).
- number-string-p (function).
- tagcase (macro).
- tagcasev (macro).
- tagcasev= (macro).
- Internals
- %whitespacep (function).
- *careful-declaration* (special variable).
- *insane-declaration* (special variable).
- *speedy-declaration* (special variable).
- position-not-whitespace (function).
Next: Definitions, Previous: Files, Up: The fast-http Reference Manual [Contents][Index]
5 Packages
Packages are listed by definition order.
- fast-http
- fast-http.byte-vector
- fast-http.parser
- fast-http-asd
- fast-http.error
- fast-http.util
- fast-http.http
- fast-http.multipart-parser
Next: fast-http.byte-vector, Previous: Packages, Up: Packages [Contents][Index]
5.1 fast-http
- Source
- Use List
- common-lisp.
- fast-http.byte-vector.
- fast-http.error.
- fast-http.http.
- fast-http.multipart-parser.
- fast-http.parser.
- xsubseq.
- Public Interface
- make-multipart-parser (function).
- make-parser (function).
- Internals
find-boundary (function).
Next: fast-http.parser, Previous: fast-http, Up: Packages [Contents][Index]
5.2 fast-http.byte-vector
- Source
- Use List
common-lisp.
- Used By List
- Public Interface
- +cr+ (constant).
- +crlf+ (constant).
- +dash+ (constant).
- +lf+ (constant).
- +page+ (constant).
- +space+ (constant).
- +tab+ (constant).
- alpha-byte-char-p (function).
- alpha-byte-char-to-lower-char (function).
- alphanumeric-byte-char-p (function).
- append-byte-vectors (function).
- ascii-octets-to-lower-string (function).
- ascii-octets-to-string (function).
- digit-byte-char-p (function).
- digit-byte-char-to-integer (function).
- mark-byte-char-p (function).
- simple-byte-vector (type).
- Internals
byte-to-ascii-lower (function).
Next: fast-http-asd, Previous: fast-http.byte-vector, Up: Packages [Contents][Index]
5.3 fast-http.parser
- Source
- Use List
- common-lisp.
- fast-http.error.
- fast-http.http.
- proc-parse.
- Used By List
- Public Interface
- callbacks (structure).
- eof (condition).
- make-callbacks (function).
- parse-request (function).
- parse-response (function).
- pointer (type).
- Internals
- +max-header-line+ (constant).
- +tokens+ (constant).
- +unhex+ (constant).
- callback-data (macro).
- callback-notify (macro).
- callbacks-body (reader).
- (setf callbacks-body) (writer).
- callbacks-first-line (reader).
- (setf callbacks-first-line) (writer).
- callbacks-header-field (reader).
- (setf callbacks-header-field) (writer).
- callbacks-header-value (reader).
- (setf callbacks-header-value) (writer).
- callbacks-headers-complete (reader).
- (setf callbacks-headers-complete) (writer).
- callbacks-message-begin (reader).
- (setf callbacks-message-begin) (writer).
- callbacks-message-complete (reader).
- (setf callbacks-message-complete) (writer).
- callbacks-p (function).
- callbacks-status (reader).
- (setf callbacks-status) (writer).
- callbacks-url (reader).
- (setf callbacks-url) (writer).
- copy-callbacks (function).
- expect-failed (condition).
- http-message-needs-eof-p (function).
- parse-body (function).
- parse-chunked-body (function).
- parse-header-field-and-value (function).
- parse-header-line (function).
- parse-header-value (function).
- parse-header-value-content-length (function).
- parse-header-value-parameters (function).
- parse-header-value-transfer-encoding (function).
- parse-headers (function).
- parse-http-version (function).
- parse-method (function).
- parse-status-code (function).
- parse-url (function).
- read-body-data (function).
- unhex-byte (function).
Next: fast-http.error, Previous: fast-http.parser, Up: Packages [Contents][Index]
5.4 fast-http-asd
- Source
- Use List
- asdf/interface.
- common-lisp.
Next: fast-http.util, Previous: fast-http-asd, Up: Packages [Contents][Index]
5.5 fast-http.error
- Source
- Use List
common-lisp.
- Used By List
- Public Interface
- callback-error (condition).
- cb-body (condition).
- cb-first-line (condition).
- cb-header-field (condition).
- cb-header-value (condition).
- cb-headers-complete (condition).
- cb-message-begin (condition).
- cb-message-complete (condition).
- cb-status (condition).
- cb-url (condition).
- closed-connection (condition).
- fast-http-error (condition).
- header-overflow (condition).
- header-value-parsing-error (condition).
- invalid-boundary (condition).
- invalid-chunk-size (condition).
- invalid-constant (condition).
- invalid-content-length (condition).
- invalid-eof-state (condition).
- invalid-fragment (condition).
- invalid-header-token (condition).
- invalid-header-value (condition).
- invalid-host (condition).
- invalid-internal-state (condition).
- invalid-method (condition).
- invalid-multipart-body (condition).
- invalid-parameter-key (condition).
- invalid-parameter-value (condition).
- invalid-path (condition).
- invalid-port (condition).
- invalid-query-string (condition).
- invalid-status (condition).
- invalid-url (condition).
- invalid-version (condition).
- lf-expected (condition).
- multipart-parsing-error (condition).
- parsing-error (condition).
- paused-error (condition).
- strict-error (condition).
- unknown-error (condition).
- Internals
description (slot).
Next: fast-http.http, Previous: fast-http.error, Up: Packages [Contents][Index]
5.6 fast-http.util
- Source
- Use List
common-lisp.
- Public Interface
- case-byte (macro).
- casev (macro).
- casev= (macro).
- defun-careful (macro).
- defun-insane (macro).
- defun-speedy (macro).
- make-collector (function).
- number-string-p (function).
- tagcase (macro).
- tagcasev (macro).
- tagcasev= (macro).
- Internals
- %whitespacep (function).
- *careful-declaration* (special variable).
- *insane-declaration* (special variable).
- *speedy-declaration* (special variable).
- position-not-whitespace (function).
Next: fast-http.multipart-parser, Previous: fast-http.util, Up: Packages [Contents][Index]
5.7 fast-http.http
- Source
- Use List
common-lisp.
- Used By List
- Public Interface
- +state-body+ (constant).
- +state-chunk-body-end-crlf+ (constant).
- +state-chunk-size+ (constant).
- +state-first-line+ (constant).
- +state-headers+ (constant).
- +state-trailing-headers+ (constant).
- http (structure).
- http-chunked-p (reader).
- (setf http-chunked-p) (writer).
- http-content-length (reader).
- (setf http-content-length) (writer).
- http-header-read (reader).
- (setf http-header-read) (writer).
- http-headers (reader).
- (setf http-headers) (writer).
- http-major-version (reader).
- (setf http-major-version) (writer).
- http-mark (reader).
- (setf http-mark) (writer).
- http-method (reader).
- (setf http-method) (writer).
- http-minor-version (reader).
- (setf http-minor-version) (writer).
- http-p (function).
- http-request (structure).
- http-request-p (function).
- http-resource (reader).
- (setf http-resource) (writer).
- http-response (structure).
- http-response-p (function).
- http-state (reader).
- (setf http-state) (writer).
- http-status (reader).
- (setf http-status) (writer).
- http-status-text (reader).
- (setf http-status-text) (writer).
- http-upgrade-p (reader).
- (setf http-upgrade-p) (writer).
- http-version (function).
- make-http (function).
- make-http-request (function).
- make-http-response (function).
- status-code (type).
- Internals
- copy-http (function).
- copy-http-request (function).
- copy-http-response (function).
Previous: fast-http.http, Up: Packages [Contents][Index]
5.8 fast-http.multipart-parser
- Source
- Use List
- common-lisp.
- fast-http.byte-vector.
- fast-http.error.
- Used By List
- Public Interface
- http-multipart-parse (function).
- ll-multipart-parser (structure).
- ll-multipart-parser-state (reader).
- (setf ll-multipart-parser-state) (writer).
- make-ll-multipart-parser (function).
- Internals
- +body-almost-done+ (constant).
- +body-done+ (constant).
- +body-start+ (constant).
- +header-field-start+ (constant).
- +looking-for-delimiter+ (constant).
- +maybe-delimiter-first-dash+ (constant).
- +maybe-delimiter-second-dash+ (constant).
- +maybe-delimiter-start+ (constant).
- +parsing-delimiter+ (constant).
- +parsing-delimiter-almost-done+ (constant).
- +parsing-delimiter-dash+ (constant).
- +parsing-delimiter-dash-start+ (constant).
- +parsing-delimiter-done+ (constant).
- +parsing-delimiter-end+ (constant).
- copy-ll-multipart-parser (function).
- ll-multipart-parser-body-buffer (reader).
- (setf ll-multipart-parser-body-buffer) (writer).
- ll-multipart-parser-body-mark (reader).
- (setf ll-multipart-parser-body-mark) (writer).
- ll-multipart-parser-boundary (reader).
- (setf ll-multipart-parser-boundary) (writer).
- ll-multipart-parser-boundary-buffer (reader).
- (setf ll-multipart-parser-boundary-buffer) (writer).
- ll-multipart-parser-boundary-mark (reader).
- (setf ll-multipart-parser-boundary-mark) (writer).
- ll-multipart-parser-header-parser (reader).
- (setf ll-multipart-parser-header-parser) (writer).
- ll-multipart-parser-p (function).
Next: Indexes, Previous: Packages, Up: The fast-http Reference Manual [Contents][Index]
6 Definitions
Definitions are sorted by export status, category, package, and then by lexicographic order.
Next: Internals, Previous: Definitions, Up: Definitions [Contents][Index]
6.1 Public Interface
Next: Macros, Previous: Public Interface, Up: Public Interface [Contents][Index]
6.1.1 Constants
- Constant: +cr+ ¶
-
- Package
- Source
- Constant: +crlf+ ¶
-
- Package
- Source
- Constant: +dash+ ¶
-
- Package
- Source
- Constant: +lf+ ¶
-
- Package
- Source
- Constant: +page+ ¶
-
- Package
- Source
- Constant: +space+ ¶
-
- Package
- Source
- Constant: +state-body+ ¶
-
- Package
- Source
- Constant: +state-chunk-body-end-crlf+ ¶
-
- Package
- Source
- Constant: +state-chunk-size+ ¶
-
- Package
- Source
- Constant: +state-first-line+ ¶
-
- Package
- Source
- Constant: +state-headers+ ¶
-
- Package
- Source
- Constant: +state-trailing-headers+ ¶
-
- Package
- Source
- Constant: +tab+ ¶
-
- Package
- Source
Next: Ordinary functions, Previous: Constants, Up: Public Interface [Contents][Index]
6.1.2 Macros
- Macro: case-byte (byte &body cases) ¶
-
- Package
- Source
- Macro: casev (keyform &body clauses) ¶
-
- Package
- Source
- Macro: casev= (keyform &body clauses) ¶
-
- Package
- Source
- Macro: defun-careful (name lambda-list &body body) ¶
-
- Package
- Source
- Macro: defun-insane (name lambda-list &body body) ¶
-
- Package
- Source
- Macro: defun-speedy (name lambda-list &body body) ¶
-
- Package
- Source
- Macro: tagcase (keyform &body blocks) ¶
-
- Package
- Source
- Macro: tagcasev (keyform &body blocks) ¶
-
- Package
- Source
- Macro: tagcasev= (keyform &body blocks) ¶
-
- Package
- Source
Next: Conditions, Previous: Macros, Up: Public Interface [Contents][Index]
6.1.3 Ordinary functions
- Function: alpha-byte-char-p (byte) ¶
-
- Package
- Source
- Function: alpha-byte-char-to-lower-char (byte) ¶
-
- Package
- Source
- Function: alphanumeric-byte-char-p (byte) ¶
-
- Package
- Source
- Function: append-byte-vectors (vec1 vec2) ¶
-
- Package
- Source
- Function: ascii-octets-to-lower-string (octets &key start end) ¶
-
- Package
- Source
- Function: ascii-octets-to-string (octets &key start end) ¶
-
- Package
- Source
- Function: digit-byte-char-p (byte) ¶
-
- Package
- Source
- Function: digit-byte-char-to-integer (byte) ¶
-
- Package
- Source
- Reader: http-chunked-p (instance) ¶
- Writer: (setf http-chunked-p) (instance) ¶
-
- Package
- Source
- Target Slot
- Reader: http-content-length (instance) ¶
- Writer: (setf http-content-length) (instance) ¶
-
- Package
- Source
- Target Slot
- Reader: http-header-read (instance) ¶
- Writer: (setf http-header-read) (instance) ¶
-
- Package
- Source
- Target Slot
- Reader: http-headers (instance) ¶
- Writer: (setf http-headers) (instance) ¶
-
- Package
- Source
- Target Slot
- Reader: http-major-version (instance) ¶
- Writer: (setf http-major-version) (instance) ¶
-
- Package
- Source
- Target Slot
- Reader: http-mark (instance) ¶
- Writer: (setf http-mark) (instance) ¶
-
- Package
- Source
- Target Slot
mark.
- Reader: http-minor-version (instance) ¶
- Writer: (setf http-minor-version) (instance) ¶
-
- Package
- Source
- Target Slot
- Function: http-multipart-parse (parser callbacks data &key start end) ¶
-
- Package
- Source
- Function: http-p (object) ¶
-
- Package
- Source
- Function: http-request-p (object) ¶
-
- Package
- Source
- Reader: http-resource (instance) ¶
- Writer: (setf http-resource) (instance) ¶
-
- Package
- Source
- Target Slot
- Function: http-response-p (object) ¶
-
- Package
- Source
- Reader: http-status-text (instance) ¶
- Writer: (setf http-status-text) (instance) ¶
-
- Package
- Source
- Target Slot
- Reader: http-upgrade-p (instance) ¶
- Writer: (setf http-upgrade-p) (instance) ¶
-
- Package
- Source
- Target Slot
- Function: http-version (http) ¶
-
- Package
- Source
- Reader: ll-multipart-parser-state (instance) ¶
- Writer: (setf ll-multipart-parser-state) (instance) ¶
-
- Package
- Source
- Target Slot
- Function: make-callbacks (&key message-begin url first-line status header-field header-value headers-complete body message-complete) ¶
-
- Package
- Source
- Function: make-collector () ¶
-
- Package
- Source
- Function: make-http (&key method major-version minor-version status content-length chunked-p upgrade-p headers header-read mark state) ¶
-
- Package
- Source
- Function: make-http-request (&key method major-version minor-version status content-length chunked-p upgrade-p headers header-read mark state resource) ¶
-
- Package
- Source
- Function: make-http-response (&key method major-version minor-version status content-length chunked-p upgrade-p headers header-read mark state status-text) ¶
-
- Package
- Source
- Function: make-ll-multipart-parser (&key boundary) ¶
-
- Package
- Source
- Function: make-multipart-parser (content-type callback) ¶
-
- Package
- Source
- Function: make-parser (http &key first-line-callback header-callback body-callback finish-callback) ¶
-
- Package
- Source
- Function: mark-byte-char-p (byte) ¶
-
- Package
- Source
- Function: number-string-p (string) ¶
-
- Package
- Source
- Function: parse-request (http callbacks data &key start end) ¶
-
- Package
- Source
- Function: parse-response (http callbacks data &key start end) ¶
-
- Package
- Source
Next: Structures, Previous: Ordinary functions, Up: Public Interface [Contents][Index]
6.1.4 Conditions
- Condition: callback-error ¶
-
- Package
- Source
- Direct superclasses
- Direct subclasses
- Direct slots
- Slot: error ¶
-
- Package
common-lisp.
- Initform
(quote nil)
- Initargs
:error
- Condition: cb-body ¶
-
- Package
- Source
- Direct superclasses
- Direct slots
- Slot: description ¶
-
- Initform
(quote "the body callback failed")
- Condition: cb-first-line ¶
-
- Package
- Source
- Direct superclasses
- Direct slots
- Slot: description ¶
-
- Initform
(quote "the first line callback failed")
- Condition: cb-header-field ¶
-
- Package
- Source
- Direct superclasses
- Direct slots
- Slot: description ¶
-
- Initform
(quote "the header-field callback failed")
- Condition: cb-header-value ¶
-
- Package
- Source
- Direct superclasses
- Direct slots
- Slot: description ¶
-
- Initform
(quote "the header-value callback failed")
- Condition: cb-headers-complete ¶
-
- Package
- Source
- Direct superclasses
- Direct slots
- Slot: description ¶
-
- Initform
(quote "the headers-complete callback failed")
- Condition: cb-message-begin ¶
-
- Package
- Source
- Direct superclasses
- Direct slots
- Slot: description ¶
-
- Initform
(quote "the message-begin callback failed")
- Condition: cb-message-complete ¶
-
- Package
- Source
- Direct superclasses
- Direct slots
- Slot: description ¶
-
- Initform
(quote "the message-complete callback failed")
- Condition: cb-status ¶
-
- Package
- Source
- Direct superclasses
- Direct slots
- Slot: description ¶
-
- Initform
(quote "the status callback failed")
- Condition: cb-url ¶
-
- Package
- Source
- Direct superclasses
- Direct slots
- Slot: description ¶
-
- Initform
(quote "the url callback failed")
- Condition: closed-connection ¶
-
- Package
- Source
- Direct superclasses
- Direct slots
- Slot: description ¶
-
- Initform
(quote "data received after completed connection: close message")
- Condition: eof ¶
-
- Package
- Source
- Direct superclasses
condition.
- Condition: fast-http-error ¶
-
- Package
- Source
- Direct superclasses
simple-error.
- Direct subclasses
- Direct slots
- Slot: description ¶
- Condition: header-overflow ¶
-
- Package
- Source
- Direct superclasses
- Direct slots
- Slot: description ¶
-
- Initform
(quote "too many header bytes seen; overflow detected")
- Condition: header-value-parsing-error ¶
-
- Package
- Source
- Direct superclasses
- Direct subclasses
- Condition: invalid-boundary ¶
-
- Package
- Source
- Direct superclasses
- Direct slots
- Slot: description ¶
-
- Initform
(quote "invalid boundary")
- Condition: invalid-chunk-size ¶
-
- Package
- Source
- Direct superclasses
- Direct slots
- Slot: description ¶
-
- Initform
(quote "invalid character in chunk size header")
- Condition: invalid-constant ¶
-
- Package
- Source
- Direct superclasses
- Direct slots
- Slot: description ¶
-
- Initform
(quote "invalid constant string")
- Condition: invalid-content-length ¶
-
- Package
- Source
- Direct superclasses
- Direct slots
- Slot: description ¶
-
- Initform
(quote "invalid character in content-length header")
- Condition: invalid-eof-state ¶
-
- Package
- Source
- Direct superclasses
- Direct slots
- Slot: description ¶
-
- Initform
(quote "stream ended at an unexpected time")
- Condition: invalid-fragment ¶
-
- Package
- Source
- Direct superclasses
- Direct slots
- Slot: description ¶
-
- Initform
(quote "invalid fragment")
- Condition: invalid-header-token ¶
-
- Package
- Source
- Direct superclasses
- Direct slots
- Slot: description ¶
-
- Initform
(quote "invalid character in header")
- Condition: invalid-header-value ¶
-
- Package
- Source
- Direct superclasses
- Direct slots
- Slot: description ¶
-
- Initform
(quote "invalid header value")
- Condition: invalid-host ¶
-
- Package
- Source
- Direct superclasses
- Direct slots
- Slot: description ¶
-
- Initform
(quote "invalid host")
- Condition: invalid-internal-state ¶
- Condition: invalid-method ¶
-
- Package
- Source
- Direct superclasses
- Direct slots
- Slot: description ¶
-
- Initform
(quote "invalid http method")
- Condition: invalid-multipart-body ¶
-
- Package
- Source
- Direct superclasses
- Direct slots
- Slot: description ¶
-
- Initform
(quote "invalid multipart body")
- Condition: invalid-parameter-key ¶
-
- Package
- Source
- Direct superclasses
- Direct slots
- Slot: description ¶
-
- Initform
(quote "invalid parameter key")
- Condition: invalid-parameter-value ¶
-
- Package
- Source
- Direct superclasses
- Direct slots
- Slot: description ¶
-
- Initform
(quote "invalid parameter value")
- Condition: invalid-path ¶
-
- Package
- Source
- Direct superclasses
- Direct slots
- Slot: description ¶
-
- Initform
(quote "invalid path")
- Condition: invalid-port ¶
-
- Package
- Source
- Direct superclasses
- Direct slots
- Slot: description ¶
-
- Initform
(quote "invalid port")
- Condition: invalid-query-string ¶
-
- Package
- Source
- Direct superclasses
- Direct slots
- Slot: description ¶
-
- Initform
(quote "invalid query string")
- Condition: invalid-status ¶
- Condition: invalid-url ¶
-
- Package
- Source
- Direct superclasses
- Direct slots
- Slot: description ¶
-
- Initform
(quote "invalid url")
- Condition: invalid-version ¶
-
- Package
- Source
- Direct superclasses
- Direct slots
- Slot: description ¶
-
- Initform
(quote "invalid http version")
- Condition: lf-expected ¶
-
- Package
- Source
- Direct superclasses
- Direct slots
- Slot: description ¶
-
- Initform
(quote "lf character expected")
- Condition: multipart-parsing-error ¶
-
- Package
- Source
- Direct superclasses
- Direct subclasses
- Condition: parsing-error ¶
-
- Package
- Source
- Direct superclasses
- Direct subclasses
- closed-connection.
- expect-failed.
- header-overflow.
- invalid-chunk-size.
- invalid-constant.
- invalid-content-length.
- invalid-eof-state.
- invalid-fragment.
- invalid-header-token.
- invalid-host.
- invalid-internal-state.
- invalid-method.
- invalid-path.
- invalid-port.
- invalid-query-string.
- invalid-status.
- invalid-url.
- invalid-version.
- lf-expected.
- paused-error.
- strict-error.
- unknown-error.
- Condition: paused-error ¶
-
- Package
- Source
- Direct superclasses
- Direct slots
- Slot: description ¶
-
- Initform
(quote "parser is paused")
- Condition: strict-error ¶
- Condition: unknown-error ¶
-
- Package
- Source
- Direct superclasses
- Direct slots
- Slot: description ¶
-
- Initform
(quote "an unknown error occured")
Next: Types, Previous: Conditions, Up: Public Interface [Contents][Index]
6.1.5 Structures
- Structure: callbacks ¶
-
- Package
- Source
- Direct superclasses
structure-object.
- Direct slots
- Slot: message-begin ¶
-
- Type
(or null function)
- Readers
- Writers
- Slot: url ¶
-
- Type
(or null function)
- Readers
- Writers
- Slot: first-line ¶
-
- Type
(or null function)
- Readers
- Writers
- Slot: status ¶
-
- Type
(or null function)
- Readers
- Writers
- Slot: header-field ¶
-
- Type
(or null function)
- Readers
- Writers
- Slot: header-value ¶
-
- Type
(or null function)
- Readers
- Writers
- Slot: headers-complete ¶
-
- Type
(or null function)
- Readers
- Writers
- Slot: body ¶
-
- Type
(or null function)
- Readers
- Writers
- Slot: message-complete ¶
-
- Type
(or null function)
- Readers
- Writers
- Structure: http ¶
-
- Package
- Source
- Direct superclasses
structure-object.
- Direct subclasses
- Direct slots
- Slot: method ¶
-
- Package
common-lisp.
- Type
symbol
- Readers
- Writers
- Slot: major-version ¶
-
- Type
fixnum
- Initform
0
- Readers
- Writers
- Slot: minor-version ¶
-
- Type
fixnum
- Initform
9
- Readers
- Writers
- Slot: status ¶
-
- Type
fast-http.http:status-code
- Initform
0
- Readers
- Writers
- Slot: content-length ¶
-
- Type
(or null integer)
- Readers
- Writers
- Slot: chunked-p ¶
-
- Type
boolean
- Readers
- Writers
- Slot: upgrade-p ¶
-
- Type
boolean
- Readers
- Writers
- Slot: headers ¶
-
- Readers
- Writers
- Slot: header-read ¶
-
- Type
fixnum
- Initform
0
- Readers
- Writers
- Slot: mark ¶
-
- Type
fixnum
- Initform
-1
- Readers
- Writers
- Slot: state ¶
-
- Type
fixnum
- Initform
fast-http.http:+state-first-line+
- Readers
- Writers
- Structure: http-request ¶
- Structure: http-response ¶
- Structure: ll-multipart-parser ¶
-
- Package
- Source
- Direct superclasses
structure-object.
- Direct slots
- Slot: state ¶
-
- Type
fixnum
- Initform
0
- Readers
- Writers
- Slot: header-parser ¶
-
- Readers
- Writers
- Slot: boundary ¶
-
- Readers
- Writers
- Slot: body-mark ¶
-
- Readers
- Writers
- Slot: body-buffer ¶
-
- Readers
- Writers
- Slot: boundary-mark ¶
-
- Readers
- Writers
- Slot: boundary-buffer ¶
Previous: Structures, Up: Public Interface [Contents][Index]
6.1.6 Types
- Type: pointer () ¶
-
- Package
- Source
- Type: simple-byte-vector (&optional len) ¶
-
- Package
- Source
- Type: status-code () ¶
-
- Package
- Source
Previous: Public Interface, Up: Definitions [Contents][Index]
6.2 Internals
Next: Special variables, Previous: Internals, Up: Internals [Contents][Index]
6.2.1 Constants
- Constant: +body-almost-done+ ¶
-
- Package
- Source
- Constant: +body-done+ ¶
-
- Package
- Source
- Constant: +body-start+ ¶
-
- Package
- Source
- Constant: +header-field-start+ ¶
-
- Package
- Source
- Constant: +looking-for-delimiter+ ¶
-
- Package
- Source
- Constant: +max-header-line+ ¶
-
Maximum number of header lines allowed.
This restriction is for protecting users’ application against denial-of-service attacks where the attacker feeds us a never-ending header that the application keeps buffering.
- Package
- Source
- Constant: +maybe-delimiter-first-dash+ ¶
-
- Package
- Source
- Constant: +maybe-delimiter-second-dash+ ¶
-
- Package
- Source
- Constant: +maybe-delimiter-start+ ¶
-
- Package
- Source
- Constant: +parsing-delimiter+ ¶
-
- Package
- Source
- Constant: +parsing-delimiter-almost-done+ ¶
-
- Package
- Source
- Constant: +parsing-delimiter-dash+ ¶
-
- Package
- Source
- Constant: +parsing-delimiter-dash-start+ ¶
-
- Package
- Source
- Constant: +parsing-delimiter-done+ ¶
-
- Package
- Source
- Constant: +parsing-delimiter-end+ ¶
-
- Package
- Source
- Constant: +tokens+ ¶
-
- Package
- Source
- Constant: +unhex+ ¶
-
- Package
- Source
6.2.2 Special variables
- Special Variable: *careful-declaration* ¶
-
- Package
- Source
- Special Variable: *insane-declaration* ¶
-
- Package
- Source
- Special Variable: *speedy-declaration* ¶
-
- Package
- Source
Next: Ordinary functions, Previous: Special variables, Up: Internals [Contents][Index]
6.2.3 Macros
- Macro: callback-data (name http callbacks data start end) ¶
-
- Package
- Source
- Macro: callback-notify (name http callbacks) ¶
-
- Package
- Source
Next: Conditions, Previous: Macros, Up: Internals [Contents][Index]
6.2.4 Ordinary functions
- Function: %whitespacep (char) ¶
-
- Package
- Source
- Function: byte-to-ascii-lower (x) ¶
-
- Package
- Source
- Reader: callbacks-body (instance) ¶
- Writer: (setf callbacks-body) (instance) ¶
-
- Package
- Source
- Target Slot
body.
- Reader: callbacks-first-line (instance) ¶
- Writer: (setf callbacks-first-line) (instance) ¶
-
- Package
- Source
- Target Slot
- Reader: callbacks-header-field (instance) ¶
- Writer: (setf callbacks-header-field) (instance) ¶
-
- Package
- Source
- Target Slot
- Reader: callbacks-header-value (instance) ¶
- Writer: (setf callbacks-header-value) (instance) ¶
-
- Package
- Source
- Target Slot
- Reader: callbacks-headers-complete (instance) ¶
- Writer: (setf callbacks-headers-complete) (instance) ¶
-
- Package
- Source
- Target Slot
- Reader: callbacks-message-begin (instance) ¶
- Writer: (setf callbacks-message-begin) (instance) ¶
-
- Package
- Source
- Target Slot
- Reader: callbacks-message-complete (instance) ¶
- Writer: (setf callbacks-message-complete) (instance) ¶
-
- Package
- Source
- Target Slot
- Function: callbacks-p (object) ¶
-
- Package
- Source
- Reader: callbacks-status (instance) ¶
- Writer: (setf callbacks-status) (instance) ¶
-
- Package
- Source
- Target Slot
- Reader: callbacks-url (instance) ¶
- Writer: (setf callbacks-url) (instance) ¶
-
- Package
- Source
- Target Slot
url.
- Function: copy-callbacks (instance) ¶
-
- Package
- Source
- Function: copy-http (instance) ¶
-
- Package
- Source
- Function: copy-http-request (instance) ¶
-
- Package
- Source
- Function: copy-http-response (instance) ¶
-
- Package
- Source
- Function: copy-ll-multipart-parser (instance) ¶
-
- Package
- Source
- Function: find-boundary (content-type) ¶
-
- Package
- Source
- Function: http-message-needs-eof-p (http) ¶
-
- Package
- Source
- Reader: ll-multipart-parser-body-buffer (instance) ¶
- Writer: (setf ll-multipart-parser-body-buffer) (instance) ¶
-
- Package
- Source
- Target Slot
- Reader: ll-multipart-parser-body-mark (instance) ¶
- Writer: (setf ll-multipart-parser-body-mark) (instance) ¶
-
- Package
- Source
- Target Slot
- Reader: ll-multipart-parser-boundary (instance) ¶
- Writer: (setf ll-multipart-parser-boundary) (instance) ¶
-
- Package
- Source
- Target Slot
- Reader: ll-multipart-parser-boundary-buffer (instance) ¶
- Writer: (setf ll-multipart-parser-boundary-buffer) (instance) ¶
-
- Package
- Source
- Target Slot
- Reader: ll-multipart-parser-boundary-mark (instance) ¶
- Writer: (setf ll-multipart-parser-boundary-mark) (instance) ¶
-
- Package
- Source
- Target Slot
- Reader: ll-multipart-parser-header-parser (instance) ¶
- Writer: (setf ll-multipart-parser-header-parser) (instance) ¶
-
- Package
- Source
- Target Slot
- Function: ll-multipart-parser-p (object) ¶
-
- Package
- Source
- Function: parse-body (http callbacks data start end requestp) ¶
-
- Package
- Source
- Function: parse-chunked-body (http callbacks data start end) ¶
-
- Package
- Source
- Function: parse-header-field-and-value (http callbacks data start end) ¶
-
- Package
- Source
- Function: parse-header-line (http callbacks data start end) ¶
-
- Package
- Source
- Function: parse-header-value (http callbacks data start end &optional field-start field-end) ¶
-
- Package
- Source
- Function: parse-header-value-content-length (data start end) ¶
-
- Package
- Source
- Function: parse-header-value-parameters (data &key header-value-callback header-parameter-key-callback header-parameter-value-callback) ¶
-
- Package
- Source
- Function: parse-header-value-transfer-encoding (data start end) ¶
-
- Package
- Source
- Function: parse-headers (http callbacks data start end) ¶
-
- Package
- Source
- Function: parse-http-version (data start end) ¶
-
- Package
- Source
- Function: parse-method (data start end) ¶
-
- Package
- Source
- Function: parse-status-code (http callbacks data start end) ¶
-
- Package
- Source
- Function: parse-url (data start end) ¶
-
- Package
- Source
- Function: position-not-whitespace (string &key from-end) ¶
-
- Package
- Source
- Function: read-body-data (http callbacks data start end) ¶
-
- Package
- Source
- Function: unhex-byte (byte) ¶
-
- Package
- Source
Previous: Definitions, Up: The fast-http Reference Manual [Contents][Index]
Appendix A Indexes
A.2 Functions
| Jump to: | %
(
A B C D F H L M N P R T U |
|---|
| Jump to: | %
(
A B C D F H L M N P R T U |
|---|
Next: Data types, Previous: Functions, Up: Indexes [Contents][Index]
A.3 Variables
| Jump to: | *
+
B C D E F H M R S U |
|---|
| Jump to: | *
+
B C D E F H M R S U |
|---|
A.4 Data types
| Jump to: | B C E F H I L M P S T U |
|---|
| Jump to: | B C E F H I L M P S T U |
|---|