This is the winhttp Reference Manual, generated automatically by Declt version 4.0 beta 2 "William Riker" on Sun Dec 15 08:05:59 2024 GMT+0.
The main system appears first, followed by any subsystem dependency.
winhttpFFI wrapper to WINHTTP
Frank James <frank.a.james@gmail.com>
MIT
cffi (system).
package.lisp (file).
ffi.lisp (file).
util.lisp (file).
Files are sorted by type and then listed depth-first from the systems components trees.
winhttp/ffi.lisppackage.lisp (file).
winhttp (system).
add-request-headers (function).
close-handle (function).
crack-url (function).
http-connect (function).
http-open (function).
http-open-request (function).
query-data-available (function).
query-headers (function).
query-status-code (function).
read-data (function).
receive-response (function).
send-request (function).
set-credentials (function).
set-status-callback (function).
upgrade-to-websocket (function).
websocket-close (function).
websocket-complete-upgrade (function).
websocket-query-close-status (function).
websocket-receive (function).
websocket-send (function).
websocket-shutdown (function).
with-websocket (macro).
%add-request-headers (function).
%close-handle (function).
%crack-url (function).
%format-message (function).
%get-last-error (function).
%http-connect (function).
%http-open (function).
%http-query-headers (function).
%query-data-available (function).
%read-data (function).
%receive-response (function).
%send-request (function).
%set-credentials (function).
%set-option (function).
%set-status-callback (function).
%set-timeouts (function).
%websocket-close (function).
%websocket-complete-upgrade (function).
%websocket-query-close-status (function).
%websocket-recv (function).
%websocket-send (function).
%websocket-shutdown (function).
%win-http-open-request (function).
*info-levels* (special variable).
*winhttp-errors* (special variable).
+access-named-proxy+ (constant).
+access-no-proxy+ (constant).
+addreq-add+ (constant).
+addreq-replace+ (constant).
+flag-secure+ (constant).
+icu-decode+ (constant).
+icu-escape+ (constant).
+websocket-binary-fragment+ (constant).
+websocket-binary-message+ (constant).
+websocket-close+ (constant).
+websocket-utf8-fragment+ (constant).
+websocket-utf8-message+ (constant).
+winhttp-option-upgrade-to-web-socket+ (constant).
format-message (function).
get-buffer-type (function).
get-last-error (function).
memset (function).
query-info-level (function).
set-ignore-certificates (function).
set-secure-protocols (function).
set-timeouts (function).
url-components-tclass (class).
win-error (condition).
win-error-code (reader method).
winhttp-error-string (function).
with-buffers (macro).
with-wide-string (macro).
winhttp/util.lispffi.lisp (file).
winhttp (system).
define-status-callback (macro).
http-request (function).
with-connect (macro).
with-http (macro).
with-request (macro).
*charsets* (special variable).
*status-cb-types* (special variable).
charset-by-name (function).
get-content-charset (function).
query-content-length (function).
Packages are listed by definition order.
winhttpcffi.
common-lisp.
add-request-headers (function).
close-handle (function).
crack-url (function).
define-status-callback (macro).
http-connect (function).
http-open (function).
http-open-request (function).
http-request (function).
query-data-available (function).
query-headers (function).
query-status-code (function).
read-data (function).
receive-response (function).
send-request (function).
set-credentials (function).
set-status-callback (function).
upgrade-to-websocket (function).
websocket-close (function).
websocket-complete-upgrade (function).
websocket-query-close-status (function).
websocket-receive (function).
websocket-send (function).
websocket-shutdown (function).
with-connect (macro).
with-http (macro).
with-request (macro).
with-websocket (macro).
%add-request-headers (function).
%close-handle (function).
%crack-url (function).
%format-message (function).
%get-last-error (function).
%http-connect (function).
%http-open (function).
%http-query-headers (function).
%query-data-available (function).
%read-data (function).
%receive-response (function).
%send-request (function).
%set-credentials (function).
%set-option (function).
%set-status-callback (function).
%set-timeouts (function).
%websocket-close (function).
%websocket-complete-upgrade (function).
%websocket-query-close-status (function).
%websocket-recv (function).
%websocket-send (function).
%websocket-shutdown (function).
%win-http-open-request (function).
*charsets* (special variable).
*info-levels* (special variable).
*status-cb-types* (special variable).
*winhttp-errors* (special variable).
+access-named-proxy+ (constant).
+access-no-proxy+ (constant).
+addreq-add+ (constant).
+addreq-replace+ (constant).
+flag-secure+ (constant).
+icu-decode+ (constant).
+icu-escape+ (constant).
+websocket-binary-fragment+ (constant).
+websocket-binary-message+ (constant).
+websocket-close+ (constant).
+websocket-utf8-fragment+ (constant).
+websocket-utf8-message+ (constant).
+winhttp-option-upgrade-to-web-socket+ (constant).
charset-by-name (function).
format-message (function).
get-buffer-type (function).
get-content-charset (function).
get-last-error (function).
memset (function).
query-content-length (function).
query-info-level (function).
set-ignore-certificates (function).
set-secure-protocols (function).
set-timeouts (function).
url-components-tclass (class).
win-error (condition).
win-error-code (generic reader).
winhttp-error-string (function).
with-buffers (macro).
with-wide-string (macro).
Definitions are sorted by export status, category, package, and then by lexicographic order.
Define a foreign callback function which can be used to receive http request status updates.
See MSDN for information on WinHttpSetStatusCallback function. Use SET-STATUS-CALLBACK to register
this with a request handle.
HINTERNET ::= handle
CONTEXT ::= pointer to DWORD context
STATUS ::= symbol naming status update type
INFOP ::= pointer to info buffer
INFOLEN ::= length of info buffer
Evaluate body with VAR bound to a connection handle.
Evaluate body with VAR bound to a session handle.
Evaludate body with VAR bound to a request handle.
Bind VAR to a websocket connected to hostname:port/url.
Send HTTP request to server.
URL ::= string in format [http|https://][username:password@]hostname[:port][/url]
METHOD ::= HTTP verb e.g. :GET, :POST etc
POST-DATA ::= if specified, is an octet vector sent as post data. Uses region bounded
by POST-START and POST-END.
RAWP ::= if true returns octets otherwise return data is parsed as text.
HEADERS ::= list of (header &optional value)* extra headers to add.
TIMEOUT ::= integer milliseconds to wait for connection and receive.
IGNORE-CERTIFICATES-P ::= if true will set option flags to ignore certificate errors.
STATUSCB ::= if non-nil, is a symbol naming a callback defined using define-status-callback.
This will be invoked to inform various status messages.
RECV-BUF ::= if provided, is an octet vector that receives the reply body.
If not supplied a buffer is allocated. Uses region bounded by RECV-START and RECV-END.
PROXY ::= NAME:PORT of proxy server to use ie 127.0.0.1:8080 or localhost:8080
Returns values return-data status-code headers content-length.
Set a callback to receive status updates. This can be used to track
progress of an HTTP request.
HINTERNET ::= request handle
CALLBACK ::= foreign callback address.
Call this before the initial SEND-REQUEST call.
Close the websocket handle
Complete the upgrade to the websocket. returns the websocket handle. The request handle can now be closed.
Get the websocket close status.
Receive some data.
HWEBSOCKET ::= the websocket handke
SEQ ::= buffer that receives the data
START, END ::= buffer region to fill in
returns values count buffer-type, where
COUNT ::= number of bytes received
BUFFER-TYPE ::= type of message received
Send some data on a websocket.
HWEBSOCKET ::= websocket handle
SEQ ::= buffer
START,END ::= buffer region to send
BUFFER-TYPE ::= type of message
Shutdown a websocket
Lookup a charset identifier by name. We only support the charsets supported by babel. We do a lookup by name because we don’t want to be interning strings received from the web server.
Use FormatMessage to convert the error code into a system-defined string.
Try and get the content charset from the headers. We need this otherwise babel may not be able to decode the text.
Returns content length as specified in header.
Set the TLS protocols that can be used for a session. HINTERNET ::= session handle.
| Jump to: | %
A C D F G H M Q R S U W |
|---|
| Jump to: | %
A C D F G H M Q R S U W |
|---|
| Jump to: | *
+
C S |
|---|
| Jump to: | *
+
C S |
|---|
| Jump to: | C F P S U W |
|---|
| Jump to: | C F P S U W |
|---|