This is the trivial-http Reference Manual, version 1.3.0, generated automatically by Declt version 4.0 beta 2 "William Riker" on Mon Feb 26 18:07:41 2024 GMT+0.
The main system appears first, followed by any subsystem dependency.
trivial-httpSimple support for HTTP GET, POST and more.
Brian Mastenbrook and Gary King
MIT
1.3.0
usocket (system).
dev (module).
Modules are listed depth-first from the system components tree.
trivial-http/devtrivial-http (system).
package.lisp (file).
variables.lisp (file).
trivial-http.lisp (file).
base64.lisp (file).
notes.text (file).
Files are sorted by type and then listed depth-first from the systems components trees.
trivial-http/trivial-http.asdtrivial-http/dev/package.lisptrivial-http/dev/variables.lisptrivial-http/dev/trivial-http.lisptrivial-http/dev/base64.lisptrivial-http/trivial-http.asdtrivial-http (system).
trivial-http/dev/variables.lisppackage.lisp (file).
dev (module).
*http-debug* (special variable).
*user-agent* (special variable).
*proxy-password* (special variable).
*proxy-user* (special variable).
trivial-http/dev/trivial-http.lispvariables.lisp (file).
dev (module).
download-command (reader method).
download-error (condition).
download-length-claimed (reader method).
download-length-downloaded (reader method).
download-response (reader method).
download-url (reader method).
escape-url-query (function).
header-pair (function).
header-value (function).
http-download (function).
http-get (function).
http-head (function).
http-post (function).
http-resolve (function).
incompatible-stream-error (condition).
mismatched-download-size-error (condition).
stream-from (reader method).
stream-to (reader method).
*stream-buffer-size* (special variable).
+crlf+ (constant).
copy-stream (function).
download-stream (function).
open-file-arguments (function).
response-read-code (function).
response-read-headers (function).
trivial-http-error (condition).
url-host (function).
url-path (function).
url-port (function).
url-reserved-character-p (function).
write-additional-headers (function).
write-crlf (function).
write-standard-headers (function).
trivial-http/dev/base64.lispvariables.lisp (file).
dev (module).
*encode-table* (special variable).
base64-encode (function).
Packages are listed by definition order.
trivial-httptrivial-http is a simple networking library for doing HTTP POST
and GET over a socket interface. It establishes a package trivial-http,
also called SHTTP, from which the following functions are exported:
http-get, http-post, escape-url-query and http-head.
shttp
common-lisp.
usocket.
*http-debug* (special variable).
*user-agent* (special variable).
download-command (generic reader).
download-error (condition).
download-length-claimed (generic reader).
download-length-downloaded (generic reader).
download-response (generic reader).
download-url (generic reader).
escape-url-query (function).
header-pair (function).
header-value (function).
http-download (function).
http-get (function).
http-head (function).
http-post (function).
http-resolve (function).
incompatible-stream-error (condition).
mismatched-download-size-error (condition).
stream-from (generic reader).
stream-to (generic reader).
*encode-table* (special variable).
*proxy-password* (special variable).
*proxy-user* (special variable).
*stream-buffer-size* (special variable).
+crlf+ (constant).
base64-encode (function).
copy-stream (function).
download-stream (function).
open-file-arguments (function).
response-read-code (function).
response-read-headers (function).
trivial-http-error (condition).
url-host (function).
url-path (function).
url-port (function).
url-reserved-character-p (function).
write-additional-headers (function).
write-crlf (function).
write-standard-headers (function).
Definitions are sorted by export status, category, package, and then by lexicographic order.
Escapes a query string in accordance with the HTTP specification.
Searches headers for name _without_ case sensitivity. Headers should be an alist mapping symbols to values; name a symbol. Returns the (name value) pair if name is found or nil if it is not.
Searchers headers for name _without_ case sensitivity. Headers should be an alist mapping symbols to values; name a symbol. Returns the value if name is found or nil if it is not.
Resolves ‘url‘ using http-resolve and downloads the contents of the stream it to ‘destination‘. Destination is assumed to be a file. Returns (as multiple values) the number of elements downloaded (e.g., bytes) and the actual URL.
returns a list of three elements: a response code as integer, an association list of headers returned from the server, and a stream from which the response can be read.
Returns a list of two elements: a response code as an integer and an association list of headers returned from the server.
given a URL, a MIME content type, and the content as a character stream, POST to the URL and return the list of three elements as described for [http-get][].
Similar to [http-get][], ‘http-resolve‘ returns a list of four
elements: the HTTP response code, the headers, the stream
and the resolved URL. HTTP-response resolves 301 and 302
responses, and signals an error on responses greater
than 400. If there is not an error, then the caller is responsible
for closing the HTTP stream.
download-error)) ¶mismatched-download-size-error)) ¶mismatched-download-size-error)) ¶download-error)) ¶download-error)) ¶url.
incompatible-stream-error)) ¶from.
incompatible-stream-error)) ¶to.
(quote "?")
:url
This slot is read-only.
(quote "?")
:command
This slot is read-only.
(quote "?")
:response
This slot is read-only.
:from
This slot is read-only.
Copy into TO from FROM until end of the input stream, in blocks of *stream-buffer-size*. The streams should have the same element type. Returns the total number of ’elements’ read and written.
error.
| Jump to: | B C D E F G H M O R S U W |
|---|
| Jump to: | B C D E F G H M O R S U W |
|---|
| Jump to: | *
+
C F L R S T U |
|---|
| Jump to: | *
+
C F L R S T U |
|---|
| Jump to: | B C D F I M N P S T V |
|---|
| Jump to: | B C D F I M N P S T V |
|---|