This is the s-http-client Reference Manual, version 1, generated automatically by Declt version 4.0 beta 2 "William Riker" on Mon Feb 26 17:49:34 2024 GMT+0.
The main system appears first, followed by any subsystem dependency.
s-http-clientA Basic HTTP Client
Sven Van Caekenberghe <svc@mac.com>
Sven Van Caekenberghe <svc@mac.com>
Lesser Lisp General Public License (LLGPL)
A Basic HTTP Client
1
s-utils (system).
s-sysdeps (system).
s-base64 (system).
puri (system).
chipz (system).
src (module).
Modules are listed depth-first from the system components tree.
s-http-client/srcs-http-client (system).
package.lisp (file).
http-client.lisp (file).
Files are sorted by type and then listed depth-first from the systems components trees.
s-http-client/src/http-client.lisppackage.lisp (file).
src (module).
*default-http-client-state* (special variable).
*http-client-accept* (special variable).
*http-client-accept-encoding* (special variable).
*http-client-agent* (special variable).
close-all-connections (function).
do-http-request (function).
http-client-state (class).
make-http-client-state (function).
print-object (method).
uri-decode-for-query (function).
uri-encode-for-query (function).
*connection-keep-alive-timeout* (special variable).
*endpoint* (special variable).
+common-response-headers+ (special variable).
+uri-encode-char-map+ (special variable).
cleanup-old-connections (method).
close-all-connections-internal (method).
close-connection (function).
concatenate-chunks (function).
do-http-request-internal (function).
do-one-request-response (function).
encode-basic-authorization (function).
format-http-request-line (function).
get-buffer (reader method).
(setf get-buffer) (writer method).
get-endpoint (reader method).
(setf get-endpoint) (writer method).
get-http-server-state (method).
get-in-use-p (reader method).
(setf get-in-use-p) (writer method).
get-kept-alive-age (method).
get-lock (reader method).
get-open-connection (function).
get-scheme-host-port (reader method).
(setf get-scheme-host-port) (writer method).
get-socket (reader method).
(setf get-socket) (writer method).
get-timeout (reader method).
(setf get-timeout) (writer method).
get-timestamp (reader method).
(setf get-timestamp) (writer method).
gunzip (function).
header-field-name->keyword (function).
header-field-value->string (function).
http-client-connection-error (condition).
http-client-error (condition).
http-client-read-error (condition).
http-client-write-error (condition).
http-server-state (class).
open-socket-stream (function).
read-crlf-line (function).
read-response (function).
release-connection (function).
response-read-body (function).
response-read-chunked-body (function).
response-read-code (function).
response-read-headers (function).
response-read-undefined-body (function).
write-http-request-line (function).
write-request (function).
Packages are listed by definition order.
s-http-clientA Basic HTTP Client
common-lisp.
*default-http-client-state* (special variable).
*http-client-accept* (special variable).
*http-client-accept-encoding* (special variable).
*http-client-agent* (special variable).
close-all-connections (function).
do-http-request (function).
http-client-state (class).
make-http-client-state (function).
uri-decode-for-query (function).
uri-encode-for-query (function).
*connection-keep-alive-timeout* (special variable).
*endpoint* (special variable).
+common-response-headers+ (special variable).
+uri-encode-char-map+ (special variable).
cleanup-old-connections (generic function).
close-all-connections-internal (generic function).
close-connection (function).
concatenate-chunks (function).
do-http-request-internal (function).
do-one-request-response (function).
encode-basic-authorization (function).
format-http-request-line (function).
get-buffer (generic reader).
(setf get-buffer) (generic writer).
get-endpoint (generic reader).
(setf get-endpoint) (generic writer).
get-http-server-state (generic function).
get-in-use-p (generic reader).
(setf get-in-use-p) (generic writer).
get-kept-alive-age (generic function).
get-lock (generic reader).
get-open-connection (function).
get-scheme-host-port (generic reader).
(setf get-scheme-host-port) (generic writer).
get-socket (generic reader).
(setf get-socket) (generic writer).
get-timeout (generic reader).
(setf get-timeout) (generic writer).
get-timestamp (generic reader).
(setf get-timestamp) (generic writer).
gunzip (function).
header-field-name->keyword (function).
header-field-value->string (function).
http-client-connection-error (condition).
http-client-error (condition).
http-client-read-error (condition).
http-client-write-error (condition).
http-server-state (class).
open-socket-stream (function).
read-crlf-line (function).
read-response (function).
release-connection (function).
response-read-body (function).
response-read-chunked-body (function).
response-read-code (function).
response-read-headers (function).
response-read-undefined-body (function).
write-http-request-line (function).
write-request (function).
Definitions are sorted by export status, category, package, and then by lexicographic order.
The default, globally shared HTTP client state
The value to use for the ’Accept’ request header
The value to use for the ’Accept-Encoding’ request header
The value to use for the ’User-Agent’ request header
Close all open connections in http-client-state, optionaly aborting them
Execute an HTTP request, returns (VALUES body code headers uri kept-alive-state)
Make a new HTTP client state object to hold open (keepalive) connections
URI decode string from a query parameter value
URI encode string for use as a query parameter value
Keep-Alive connections not used for this amount of time will be force closed, eventually
Close a socket connection stream, optionally aborting
Do one HTTP request and response on stream
Get an open connection to scheme://host:port reusing one from state unless force-new is t. Release after use
Read a CRLF termintated line from a character input stream into buffer. Return length excluding CRLF.
Read an HTTP response, headers and content, from stream
Release a connection obtained through get-open-connection (either stored in state for reuse or not)
Write an HTTP request, full header and body, to stream
http-client-state)) ¶Force close all kept-alive connections that are too old
http-client-state) &key abort) ¶http-server-state)) ¶automatically generated reader method
http-server-state)) ¶automatically generated writer method
http-client-error)) ¶http-client-error)) ¶http-client-state) scheme-host-port) ¶http-server-state)) ¶automatically generated reader method
http-server-state)) ¶automatically generated writer method
http-server-state)) ¶http-client-state)) ¶automatically generated reader method
lock.
http-server-state)) ¶automatically generated reader method
http-server-state)) ¶automatically generated writer method
http-server-state)) ¶automatically generated reader method
http-server-state)) ¶automatically generated writer method
http-client-error)) ¶http-client-error)) ¶http-server-state)) ¶automatically generated reader method
http-server-state)) ¶automatically generated writer method
Object holding a reusable open connection to a scheme://host:port
:scheme-host-port
:socket
(make-string 4096)
(get-universal-time)
| Jump to: | (
C D E F G H M O P R U W |
|---|
| Jump to: | (
C D E F G H M O P R U W |
|---|
| Jump to: | *
+
B D E I L S T |
|---|
| Jump to: | *
+
B D E I L S T |
|---|
| Jump to: | C F H M P S |
|---|
| Jump to: | C F H M P S |
|---|