The drakma Reference Manual

Table of Contents

Next: , Previous: , Up: (dir)   [Contents][Index]

The drakma Reference Manual

This is the drakma Reference Manual, version 2.0.4, generated automatically by Declt version 2.3 "Robert April" on Wed Mar 14 03:49:38 2018 GMT+0.


Next: , Previous: , Up: Top   [Contents][Index]

1 Introduction

DRAKMA - http client written in Common Lisp

DRAKMA is a http client written in Common Lisp. Please visit the documentation site for more information.

Gitter


Next: , Previous: , Up: Top   [Contents][Index]

2 Systems

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


Previous: , Up: Systems   [Contents][Index]

2.1 drakma

Description

Full-featured http/https client based on usocket

Version

2.0.4

Dependencies
Source

drakma.asd (file)

Components

Next: , Previous: , Up: Top   [Contents][Index]

3 Files

Files are sorted by type and then listed depth-first from the systems components trees.


Previous: , Up: Files   [Contents][Index]

3.1 Lisp


Next: , Previous: , Up: Lisp files   [Contents][Index]

3.1.1 drakma.asd

Location

drakma.asd

Systems

drakma (system)

Packages

drakma-asd


Next: , Previous: , Up: Lisp files   [Contents][Index]

3.1.2 drakma/packages.lisp

Parent

drakma (system)

Location

packages.lisp

Packages

drakma


Next: , Previous: , Up: Lisp files   [Contents][Index]

3.1.3 drakma/specials.lisp

Dependency

packages.lisp (file)

Parent

drakma (system)

Location

specials.lisp

Exported Definitions
Internal Definitions

Next: , Previous: , Up: Lisp files   [Contents][Index]

3.1.4 drakma/conditions.lisp

Dependency

specials.lisp (file)

Parent

drakma (system)

Location

conditions.lisp

Exported Definitions
Internal Definitions

Next: , Previous: , Up: Lisp files   [Contents][Index]

3.1.5 drakma/util.lisp

Dependency

conditions.lisp (file)

Parent

drakma (system)

Location

util.lisp

Exported Definitions
Internal Definitions

Next: , Previous: , Up: Lisp files   [Contents][Index]

3.1.6 drakma/read.lisp

Dependency

util.lisp (file)

Parent

drakma (system)

Location

read.lisp

Exported Definitions
Internal Definitions

Next: , Previous: , Up: Lisp files   [Contents][Index]

3.1.7 drakma/cookies.lisp

Dependency

read.lisp (file)

Parent

drakma (system)

Location

cookies.lisp

Exported Definitions
Internal Definitions

Next: , Previous: , Up: Lisp files   [Contents][Index]

3.1.8 drakma/encoding.lisp

Dependency

cookies.lisp (file)

Parent

drakma (system)

Location

encoding.lisp

Exported Definitions
Internal Definitions

Previous: , Up: Lisp files   [Contents][Index]

3.1.9 drakma/request.lisp

Dependency

encoding.lisp (file)

Parent

drakma (system)

Location

request.lisp

Exported Definitions

http-request (function)

Internal Definitions

Next: , Previous: , Up: Top   [Contents][Index]

4 Packages

Packages are listed by definition order.


Next: , Previous: , Up: Packages   [Contents][Index]

4.1 drakma-asd

Source

drakma.asd

Use List

Previous: , Up: Packages   [Contents][Index]

4.2 drakma

Source

packages.lisp (file)

Use List
Exported Definitions
Internal Definitions

Next: , Previous: , Up: Top   [Contents][Index]

5 Definitions

Definitions are sorted by export status, category, package, and then by lexicographic order.


Next: , Previous: , Up: Definitions   [Contents][Index]

5.1 Exported definitions


Next: , Previous: , Up: Exported definitions   [Contents][Index]

5.1.1 Special variables

Special Variable: *allow-dotless-cookie-domains-p*

When this variable is not NIL, cookie domains containing no dots are considered valid. The default is NIL, meaning to disallow such domains except for "localhost".

Package

drakma

Source

specials.lisp (file)

Special Variable: *body-format-function*

A function which determines whether the content body returned by the server is text and should be treated as such or not. The function is called after the request headers have been read and it must accept two arguments, headers and external-format-in, where headers is like the third return value of HTTP-REQUEST while external-format-in is the HTTP-REQUEST argument of the same name. It should return NIL if the body should be regarded as binary content, or a FLEXI-STREAMS external format (which will be used to read the body) otherwise.

This function will only be called if the force-binary argument to HTTP-REQUEST is NIL.

The initial value of this variable is a function which uses *TEXT-CONTENT-TYPES* to determine whether the body is text and then proceeds as described in the HTTP-REQUEST documentation entry.

Package

drakma

Source

specials.lisp (file)

Special Variable: *default-http-proxy*

HTTP proxy to be used as default. If not NIL, it should be a string denoting a proxy server through which the request should be sent. Or it can be a list of two values - a string denoting the proxy server and an integer denoting the port to use (which will default to 80 otherwise).

Package

drakma

Source

specials.lisp (file)

Special Variable: *drakma-default-external-format*

The default value for the external format keyword arguments of HTTP-REQUEST. The value of this variable will be interpreted by FLEXI-STREAMS. The initial value is the keyword :LATIN-1. (Note that Drakma binds *DEFAULT-EOL-STYLE* to :LF).

Package

drakma

Source

specials.lisp (file)

Special Variable: *drakma-version*

Drakma’s version number as a string.

Package

drakma

Source

specials.lisp (file)

Special Variable: *header-stream*

If this variable is not NIL, it should be bound to a stream to which incoming and outgoing headers will be written for debugging purposes.

Package

drakma

Source

specials.lisp (file)

Special Variable: *ignore-unparseable-cookie-dates-p*

Whether Drakma is allowed to treat ‘Expires’ dates in cookie headers as non-existent if it can’t parse them. If the value of this variable is NIL (which is the default), an error will be signalled instead.

Package

drakma

Source

specials.lisp (file)

Special Variable: *no-proxy-domains*

A list of domains for which a proxy should not be used.

Package

drakma

Source

specials.lisp (file)

Special Variable: *remove-duplicate-cookies-p*

Determines how duplicate cookies in the response are handled,
defaults to T. Cookies are considered duplicate using COOKIE=. Valid
values are:

NIL - duplicates will not be removed,
T or :KEEP-LAST - for duplicates, only the last cookie value will be kept, based on the
order of the response header,
:KEEP-FIRST - for duplicates, only the first cookie value will be kept, based on the order of the response header.

Misbehaving servers may send duplicate cookies back in the
same Set-Cookie header:

HTTP/1.1 200 OK
Server: My-hand-rolled-server
Date: Wed, 07 Apr 2010 15:12:30 GMT
Connection: Close
Content-Type: text/html
Content-Length: 82
Set-Cookie: a=1; Path=/; Secure, a=2; Path=/; Secure

In this case Drakma has to choose whether cookie ’a’ has the value ’1’
or ’2’. By default, Drakma will choose the last value specified, in
this case ’2’. By default, Drakma conforms to RFC2109 HTTP State
Management Mechanism, section 4.3.3 Cookie Management:

If a user agent receives a Set-Cookie response header whose NAME
is the same as a pre-existing cookie, and whose Domain and Path
attribute values exactly (string) match those of a pre-existing
cookie, the new cookie supersedes the old.

Package

drakma

Source

specials.lisp (file)

Special Variable: *text-content-types*

A list of conses which are used by the default value of *BODY-FORMAT-FUNCTION* to decide whether a ’Content-Type’ header denotes text content. The car and cdr of each cons should each be a string or NIL. A content type matches one of these
entries (and thus denotes text) if the type part is STRING-EQUAL to the car or if the car is NIL and if the subtype part
is STRING-EQUAL
to the cdr or if the cdr is NIL.

The initial value of this variable is the list

(("text" . nil))

which means that every content type that starts with "text/" is regarded as text, no matter what the subtype is.

Package

drakma

Source

specials.lisp (file)


Next: , Previous: , Up: Exported definitions   [Contents][Index]

5.1.2 Functions

Function: cookie-date-parse-error FORMAT-CONTROL &rest FORMAT-ARGUMENTS

Signals an error of type COOKIE-DATE-PARSE-ERROR with the provided format control and arguments.

Package

drakma

Source

conditions.lisp (file)

Function: cookie-error COOKIE FORMAT-CONTROL &rest FORMAT-ARGUMENTS

Signals an error of type COOKIE-ERROR with the provided cookie (can be NIL), format control and arguments.

Package

drakma

Source

conditions.lisp (file)

Function: cookie= COOKIE1 COOKIE2

Returns true if the cookies COOKIE1 and COOKIE2 are equal. Two cookies are considered to be equal if name and path are equal.

Package

drakma

Source

cookies.lisp (file)

Function: delete-old-cookies COOKIE-JAR

Removes all cookies from COOKIE-JAR which have either expired or which don’t have an expiry date.

Package

drakma

Source

cookies.lisp (file)

Function: get-content-type HEADERS

Reads and parses a ‘Content-Type’ header and returns it as three values - the type, the subtype, and an alist (possibly empty) of name/value pairs for the optional parameters. HEADERS is supposed to be an alist of headers as returned by HTTP-REQUEST. Returns NIL if there is no such header amongst HEADERS.

Package

drakma

Source

read.lisp (file)

Function: header-value NAME HEADERS

If HEADERS is an alist of headers as returned by HTTP-REQUEST and NAME is a keyword naming a header, this function returns the corresponding value of this header (or NIL if it’s not in HEADERS).

Package

drakma

Source

util.lisp (file)

Function: http-request URI &rest ARGS &key PROTOCOL METHOD FORCE-SSL CERTIFICATE KEY CERTIFICATE-PASSWORD VERIFY MAX-DEPTH CA-FILE CA-DIRECTORY PARAMETERS URL-ENCODER CONTENT CONTENT-TYPE CONTENT-LENGTH FORM-DATA COOKIE-JAR BASIC-AUTHORIZATION USER-AGENT ACCEPT RANGE PROXY NO-PROXY-DOMAINS PROXY-BASIC-AUTHORIZATION REAL-HOST ADDITIONAL-HEADERS REDIRECT AUTO-REFERER KEEP-ALIVE CLOSE EXTERNAL-FORMAT-OUT EXTERNAL-FORMAT-IN FORCE-BINARY WANT-STREAM STREAM PRESERVE-URI DECODE-CONTENT CONNECTION-TIMEOUT &aux UNPARSED-URI

Sends a HTTP request to a web server and returns its reply. URI
is where the request is sent to, and it is either a string denoting a uniform resource identifier or a PURI:URI object. The scheme of URI must be ‘http’ or ‘https’. The function returns SEVEN values - the body of the reply (but see below), the status code as an integer, an alist of the headers sent by the server where for each element the car (the name of the header) is a keyword and the cdr (the value of the header) is a string, the URI the reply comes from (which might be different from the URI the request was sent to in case of redirects), the stream the reply was read from, a generalized boolean which
denotes whether the stream should be closed (and which you can
usually ignore), and finally the reason phrase from the status line as a string.

PROTOCOL is the HTTP protocol which is going to be used in the
request line, it must be one of the keywords :HTTP/1.0 or
:HTTP/1.1. METHOD is the method used in the request line, a
keyword (like :GET or :HEAD) denoting a valid HTTP/1.1 or WebDAV request method, or :REPORT, as described in the Versioning
Extensions to WebDAV. Additionally, you can also use the pseudo
method :OPTIONS* which is like :OPTIONS but means that an
"OPTIONS *" request line will be sent, i.e. the URI’s path and
query parts will be ignored.

If FORCE-SSL is true, SSL will be attached to the socket stream
which connects Drakma with the web server. Usually, you don’t
have to provide this argument, as SSL will be attached anyway if
the scheme of URI is ‘https’.

CERTIFICATE is the file name of the PEM encoded client certificate to present to the server when making a SSL connection. KEY specifies the file name of the PEM encoded private key matching the certificate. CERTIFICATE-PASSWORD specifies the pass phrase to use to decrypt the private key.

VERIFY can be specified to force verification of the certificate that is presented by the server in an SSL connection. It can be specified either as NIL if no check should be performed, :OPTIONAL to verify the server’s certificate if it presented one or :REQUIRED to verify the server’s certificate and fail if an invalid or no certificate was presented.

MAX-DEPTH can be specified to change the maximum allowed certificate signing depth that is accepted. The default is 10.

CA-FILE and CA-DIRECTORY can be specified to set the certificate authority bundle file or directory to use for certificate validation.

The CERTIFICATE, KEY, CERTIFICATE-PASSWORD, VERIFY, MAX-DEPTH, CA-FILE and CA-DIRECTORY parameters are ignored for non-SSL requests. They
are also ignored on LispWorks.

PARAMETERS is an alist of name/value pairs (the car and the cdr each being a string) which denotes the parameters which are added to the query part of the URL or (in the case of a POST request) comprise the body of the request. (But see CONTENT below.) The values can also be NIL in which case only the name (without an equal sign) is used in
the query string. The name/value pairs are URL-encoded using the FLEXI-STREAMS external format EXTERNAL-FORMAT-OUT before they are sent to the server unless FORM-DATA is true in which case the POST request body is sent as ‘multipart/form-data’ using EXTERNAL-FORMAT-OUT. The values of the PARAMETERS alist can also be pathnames, open binary
input streams, unary functions, or lists where the first element is of one of the former types. These values denote files which should be sent as part of the request body. If files are present in PARAMETERS, the content type of the request is always ‘multipart/form-data’. If the value is a list, the part of the list behind the first element is treated as a plist which can be used to specify a content type and/or
a filename for the file, i.e. such a value could look like, e.g., (#p"/tmp/my_file.doc" :content-type "application/msword"
:filename "upload.doc").

URL-ENCODER specifies a custom URL encoder function which will be used by drakma to URL-encode parameter names and values. It needs to be a function of one argument. The argument is the string to encode, the return value must be the URL-encoded string. This can be used if specific encoding rules are required.

CONTENT, if not NIL, is used as the request body - PARAMETERS is ignored in this case. CONTENT can be a string, a sequence of
octets, a pathname, an open binary input stream, or a function designator. If CONTENT is a sequence, it will be directly sent
to the server (using EXTERNAL-FORMAT-OUT in the case of
strings). If CONTENT is a pathname, the binary contents of the corresponding file will be sent to the server. If CONTENT is a
stream, everything that can be read from the stream until EOF
will be sent to the server. If CONTENT is a function designator,
the corresponding function will be called with one argument, the
stream to the server, to which it should send data.

Finally, CONTENT can also be the keyword :CONTINUATION in which case HTTP-REQUEST returns only one value - a ‘continuation’ function. This function has one required argument and one optional argument. The first argument will be interpreted like CONTENT above (but it cannot
be a keyword), i.e. it will be sent to the server according to its type. If the second argument is true, the continuation function can
be called again to send more content, if it is NIL the continuation function returns what HTTP-REQUEST would have returned.

If CONTENT is a sequence, Drakma will use LENGTH to determine its length and will use the result for the ‘Content-Length’ header sent to the server. You can overwrite this with the CONTENT-LENGTH parameter (a non-negative integer) which you can also use for the cases where Drakma can’t or won’t determine the content length itself. You can also explicitly provide a CONTENT-LENGTH argument of NIL which will imply that no ‘Content-Length’ header will be sent in any case. If no ‘Content-Length’ header is sent, Drakma will use chunked encoding to send the content body. Note that this will not work with older web servers.

Providing a true CONTENT-LENGTH argument which is not a non-negative integer means that Drakma /must/ build the request body in RAM and compute the content length even if it would have otherwise used
chunked encoding, for example in the case of file uploads.

CONTENT-TYPE is the corresponding ‘Content-Type’ header to be sent and will be ignored unless CONTENT is provided as well.

Note that a query already contained in URI will always be sent with
the request line anyway in addition to other parameters sent by
Drakma.

COOKIE-JAR is a cookie jar containing cookies which will
potentially be sent to the server (if the domain matches, if
they haven’t expired, etc.) - this cookie jar will be modified according to the ‘Set-Cookie’ header(s) sent back by the server.

BASIC-AUTHORIZATION, if not NIL, should be a list of two strings (username and password) which will be sent to the server for
basic authorization. USER-AGENT, if not NIL, denotes which ‘User-Agent’ header will be sent with the request. It can be one
of the keywords :DRAKMA, :FIREFOX, :EXPLORER, :OPERA, or :SAFARI
which denote the current version of Drakma or, in the latter four cases, a fixed string corresponding to a more or less recent (as
of August 2006) version of the corresponding browser. Or it can
be a string which is used directly.

ACCEPT, if not NIL, specifies the contents of the ‘Accept’ header
sent.

RANGE optionally specifies a subrange of the resource to be requested. It must be specified as a list of two integers which indicate the
start and (inclusive) end offset of the requested range, in bytes
(i.e. octets).

If PROXY is not NIL, it should be a string denoting a proxy
server through which the request should be sent. Or it can be a
list of two values - a string denoting the proxy server and an
integer denoting the port to use (which will default to 80
otherwise). Defaults to *default-http-proxy*. PROXY-BASIC-AUTHORIZATION is used like
BASIC-AUTHORIZATION, but for the proxy, and only if PROXY is
true. If the host portion of the uri is present in the *no-proxy-domains* or the NO-PROXY-DOMAINS list then the proxy
setting will be ignored for this request.

If NO-PROXY-DOMAINS is set then it will supersede the *no-proxy-domains* variable. Inserting domains into this list will allow them to ignore the proxy setting.

If REAL-HOST is not NIL, request is sent to the denoted host instead
of the URI host. When specified, REAL-HOST supersedes PROXY.

ADDITIONAL-HEADERS is a name/value alist of additional HTTP headers which should be sent with the request. Unlike in PARAMETERS, the cdrs can not only be strings but also designators for unary functions
(which should in turn return a string) in which case the function is called each time the header is written.

If REDIRECT is not NIL, it must be a non-negative integer or T.
If REDIRECT is true, Drakma will follow redirects (return codes
301, 302, 303, or 307) unless REDIRECT is 0. If REDIRECT is an integer, it will be decreased by 1 with each redirect.
Furthermore, if AUTO-REFERER is true when following redirects,
Drakma will populate the ‘Referer’ header with the URI that
triggered the redirection, overwriting an existing ‘Referer’
header (in ADDITIONAL-HEADERS) if necessary.

If KEEP-ALIVE is T, the server will be asked to keep the
connection alive, i.e. not to close it after the reply has been
sent. (Note that this not necessary if both the client and the
server use HTTP 1.1.) If CLOSE is T, the server is explicitly
asked to close the connection after the reply has been sent.
KEEP-ALIVE and CLOSE are obviously mutually exclusive.

If the message body sent by the server has a text content type, Drakma will try to return it as a Lisp string. It’ll first check if the ‘Content-Type’ header denotes an encoding to be used, or otherwise it will use the EXTERNAL-FORMAT-IN argument. The body is decoded using FLEXI-STREAMS. If FLEXI-STREAMS doesn’t know the external format, the body is returned as an array of octets. If the body is empty, Drakma will return NIL.

If the message body doesn’t have a text content type or if
FORCE-BINARY is true, the body is always returned as an array of octets.

If WANT-STREAM is true, the message body is NOT read and instead the (open) socket stream is returned as the first return value. If the sixth value of HTTP-REQUEST is true, the stream should be closed (and not be re-used) after the body has been read. The stream returned is
a flexi stream (see http://weitz.de/flexi-streams/) with a chunked stream (see http://weitz.de/chunga/) as its underlying stream. If
you want to read binary data from this stream, read from the
underlying stream which you can get with FLEXI-STREAM-STREAM.

Drakma will usually create a new socket connection for each HTTP request. However, you can use the STREAM argument to provide an
open socket stream which should be re-used. STREAM MUST be a
stream returned by a previous invocation of HTTP-REQUEST where
the sixth return value wasn’t true. Obviously, it must also be connected to the correct server and at the right position
(i.e. the message body, if any, must have been read). Drakma
will NEVER attach SSL to a stream provided as the STREAM
argument.

CONNECTION-TIMEOUT is the time (in seconds) Drakma will wait until it considers an attempt to connect to a server as a failure. It is supported only on some platforms (currently abcl, clisp, LispWorks, mcl, openmcl and sbcl). READ-TIMEOUT and WRITE-TIMEOUT are the read
and write timeouts (in seconds) for the socket stream to the server. All three timeout arguments can also be NIL (meaning no timeout), and they don’t apply if an existing stream is re-used. READ-TIMEOUT argument is only available for LispWorks, WRITE-TIMEOUT is only available for LispWorks 5.0 or higher.

DEADLINE, a time in the future, specifies the time until which the request should be finished. The deadline is specified in internal
time units. If the server fails to respond until that time, a COMMUNICATION-DEADLINE-EXPIRED condition is signalled. DEADLINE is only available on CCL 1.2 and later.

If PRESERVE-URI is not NIL, the given URI will not be processed. This means that the URI will be sent as-is to the remote server and it is the responsibility of the client to make sure that all parameters are encoded properly. Note that if this parameter is given, and the
request is not a POST with a content-type of ‘multipart/form-data’, PARAMETERS will not be used.

If DECODE-CONTENT is not NIL, then the content will automatically be decoded according to any encodings specified in the Content-Encoding header. The actual decoding is done by the DECODE-STREAM generic function, and you can implement new methods to support additional encodings.
Any encodings in Transfer-Encoding, such as chunking, are always performed.

Package

drakma

Source

request.lisp (file)

Function: parameter-error FORMAT-CONTROL &rest FORMAT-ARGUMENTS

Signals an error of type PARAMETER-ERROR with the provided format control and arguments.

Package

drakma

Source

conditions.lisp (file)

Function: parameter-present-p NAME PARAMETERS

If PARAMETERS is an alist of parameters as returned by, for example, READ-TOKENS-AND-PARAMETERS and NAME is a string naming a parameter, this function returns the full parameter (name and value) - or NIL if it’s not in PARAMETERS.

Package

drakma

Source

util.lisp (file)

Function: parameter-value NAME PARAMETERS

If PARAMETERS is an alist of parameters as returned by, for example, READ-TOKENS-AND-PARAMETERS and NAME is a string naming a parameter, this function returns the value of this parameter - or NIL if it’s not in PARAMETERS.

Package

drakma

Source

util.lisp (file)

Function: parse-cookie-date STRING

Parses a cookie expiry date and returns it as a Lisp universal time. Currently understands the following formats:

"Wed, 06-Feb-2008 21:01:38 GMT"
"Wed, 06-Feb-08 21:01:38 GMT"
"Tue Feb 13 08:00:00 2007 GMT"
"Wednesday, 07-February-2027 08:55:23 GMT"
"Wed, 07-02-2017 10:34:45 GMT"

Instead of "GMT" time zone abbreviations like "CEST" and UTC offsets like "GMT-01:30" are also allowed.

While this function has "cookie" in its name, it might come in handy in other situations as well and it is thus exported as a convenience function.

Package

drakma

Source

cookies.lisp (file)

Function: read-tokens-and-parameters STRING &key VALUE-REQUIRED-P

Reads a comma-separated list of tokens from the string STRING. Each token can be followed by an optional, semicolon-separated list of attribute/value pairs where the attributes are tokens followed by a #\= character and a token or a quoted string. Returned is a list where each element is either a string (for a simple token) or a cons of a string (the token) and an alist (the attribute/value pairs). If VALUE-REQUIRED-P is NIL, the value part (including the #\= character) of each attribute/value pair is optional.

Package

drakma

Source

read.lisp (file)

Function: split-tokens STRING

Splits the string STRING into a list of substrings separated by commas and optional whitespace. Empty substrings are ignored.

Package

drakma

Source

read.lisp (file)

Function: syntax-error FORMAT-CONTROL &rest FORMAT-ARGUMENTS

Signals an error of type SYNTAX-ERROR with the provided format control and arguments.

Package

drakma

Source

conditions.lisp (file)

Function: url-encode STRING EXTERNAL-FORMAT

Returns a URL-encoded version of the string STRING using the external format EXTERNAL-FORMAT.

Package

drakma

Source

util.lisp (file)


Next: , Previous: , Up: Exported definitions   [Contents][Index]

5.1.3 Generic functions

Generic Function: cookie-domain OBJECT
Generic Function: (setf cookie-domain) NEW-VALUE OBJECT
Package

drakma

Methods
Method: cookie-domain (COOKIE cookie)
Method: (setf cookie-domain) NEW-VALUE (COOKIE cookie)

The domain the cookie is valid for.

Source

cookies.lisp (file)

Method: (setf cookie-domain) NEW-VALUE (COOKIE cookie) after

Check cookie validity after domain change.

Source

cookies.lisp (file)

Generic Function: cookie-error-cookie CONDITION
Package

drakma

Methods
Method: cookie-error-cookie (CONDITION cookie-error)
Source

conditions.lisp (file)

Generic Function: cookie-expires OBJECT
Generic Function: (setf cookie-expires) NEW-VALUE OBJECT
Package

drakma

Methods
Method: cookie-expires (COOKIE cookie)
Method: (setf cookie-expires) NEW-VALUE (COOKIE cookie)

When the cookie expires. A Lisp universal time or NIL.

Source

cookies.lisp (file)

Method: (setf cookie-expires) NEW-VALUE (COOKIE cookie) after

Check cookie validity after expiry change.

Source

cookies.lisp (file)

Generic Function: cookie-http-only-p OBJECT
Generic Function: (setf cookie-http-only-p) NEW-VALUE OBJECT
Package

drakma

Methods
Method: cookie-http-only-p (COOKIE cookie)
Method: (setf cookie-http-only-p) NEW-VALUE (COOKIE cookie)

Whether the cookie should not be
accessible from Javascript.

This is a Microsoft extension that has been implemented in Firefox as well. See <http://msdn2.microsoft.com/en-us/library/ms533046.aspx>.

Source

cookies.lisp (file)

Generic Function: cookie-jar-cookies OBJECT
Generic Function: (setf cookie-jar-cookies) NEW-VALUE OBJECT
Package

drakma

Methods
Method: cookie-jar-cookies (COOKIE-JAR cookie-jar)
Method: (setf cookie-jar-cookies) NEW-VALUE (COOKIE-JAR cookie-jar)

A list of the cookies in this cookie jar.

Source

cookies.lisp (file)

Generic Function: cookie-name OBJECT
Generic Function: (setf cookie-name) NEW-VALUE OBJECT
Package

drakma

Methods
Method: cookie-name (COOKIE cookie)
Method: (setf cookie-name) NEW-VALUE (COOKIE cookie)

The name of the cookie.

Source

cookies.lisp (file)

Method: (setf cookie-name) NEW-VALUE (COOKIE cookie) after

Check cookie validity after name change.

Source

cookies.lisp (file)

Generic Function: cookie-path OBJECT
Generic Function: (setf cookie-path) NEW-VALUE OBJECT
Package

drakma

Methods
Method: cookie-path (COOKIE cookie)
Method: (setf cookie-path) NEW-VALUE (COOKIE cookie)

The path prefix the cookie is valid for.

Source

cookies.lisp (file)

Method: (setf cookie-path) NEW-VALUE (COOKIE cookie) after

Check cookie validity after path change.

Source

cookies.lisp (file)

Generic Function: cookie-securep OBJECT
Generic Function: (setf cookie-securep) NEW-VALUE OBJECT
Package

drakma

Methods
Method: cookie-securep (COOKIE cookie)
Method: (setf cookie-securep) NEW-VALUE (COOKIE cookie)

Whether the cookie must only be transmitted over secure connections.

Source

cookies.lisp (file)

Generic Function: cookie-value OBJECT
Generic Function: (setf cookie-value) NEW-VALUE OBJECT
Package

drakma

Methods
Method: cookie-value (COOKIE cookie)
Method: (setf cookie-value) NEW-VALUE (COOKIE cookie)

The cookie’s value.

Source

cookies.lisp (file)

Method: (setf cookie-value) NEW-VALUE (COOKIE cookie) after

Check cookie validity after value change.

Source

cookies.lisp (file)

Generic Function: decode-stream ENCODING-TYPE STREAM

Generic function to decode a stream.
This is a generic function which decodes the stream based on the encoding-type.
If a response contains one or more transfer or content encodings, then decode-stream
is called for each encoding type in the correct order to properly decode the stream to its original content.

ENCODING-TYPE will be a keyword created by upcasing and interning the encoding type from the header. STREAM will be the stream that needs to be decoded. decode-stream returns a new stream from which you can read the decoded data.

Package

drakma

Source

encoding.lisp (file)

Methods
Method: decode-stream (ENCODING-TYPE (eql chunked)) STREAM

General decode method for chunked stream. Creates new chunked-stream.

Method: decode-stream (ENCODING-TYPE (eql chunked)) (STREAM chunked-input-stream)

Decode a chunked stream.
Special method for chunked-input-stream that just turns chunking on.

Method: decode-stream (ENCODING-TYPE (eql deflate)) STREAM

Decode stream using deflate compression in zlib container.

Method: decode-stream (ENCODING-TYPE (eql gzip)) STREAM

Decode stream using gzip compression.

Method: decode-stream ENCODING-TYPE STREAM

Default handler, just return the stream.


Next: , Previous: , Up: Exported definitions   [Contents][Index]

5.1.4 Conditions

Condition: cookie-date-parse-error ()

Signalled if Drakma tries to parse the date of an incoming cookie header and can’t interpret it.

Package

drakma

Source

conditions.lisp (file)

Direct superclasses

cookie-error (condition)

Condition: cookie-error ()

Signalled if someone tries to create a COOKIE object that’s not valid.

Package

drakma

Source

conditions.lisp (file)

Direct superclasses

drakma-simple-error (condition)

Direct subclasses

cookie-date-parse-error (condition)

Direct methods

cookie-error-cookie (method)

Direct slots
Slot: cookie

The COOKIE object that caused this error.
Can be NIL in case such an object couldn’t be initialized.

Initargs

:cookie

Initform

(quote nil)

Readers

cookie-error-cookie (generic function)

Condition: drakma-condition ()

Superclass for all conditions related to Drakma.

Package

drakma

Source

conditions.lisp (file)

Direct superclasses

condition (condition)

Direct subclasses
Condition: drakma-error ()

Superclass for all errors related to Drakma.

Package

drakma

Source

conditions.lisp (file)

Direct superclasses
Direct subclasses

drakma-simple-error (condition)

Condition: drakma-warning ()

Superclass for all warnings related to Drakma.

Package

drakma

Source

conditions.lisp (file)

Direct superclasses
Direct subclasses

drakma-simple-warning (condition)

Condition: parameter-error ()

Signalled if a function was called with inconsistent or illegal parameters.

Package

drakma

Source

conditions.lisp (file)

Direct superclasses

drakma-simple-error (condition)

Condition: syntax-error ()

Signalled if Drakma encounters wrong or unknown syntax when reading the reply from the server.

Package

drakma

Source

conditions.lisp (file)

Direct superclasses

drakma-simple-error (condition)


Previous: , Up: Exported definitions   [Contents][Index]

5.1.5 Classes

Class: cookie ()

Instances of this class represent HTTP cookies. If
you need to create your own cookies, you should use MAKE-INSTANCE with the initargs :NAME, :DOMAIN, :VALUE, :PATH, :EXPIRES,
:SECUREP, and :HTTP-ONLY-P all of which are optional except for the first two. The meaning of these initargs and the corresponding accessors should be pretty clear if one looks at the original cookie specification <http://wp.netscape.com/newsref/std/cookie_spec.html> (and at this page <http://msdn2.microsoft.com/en-us/library/ms533046.aspx> for the HttpOnly extension).

Package

drakma

Source

cookies.lisp (file)

Direct superclasses

standard-object (class)

Direct methods
Direct slots
Slot: name

The name of the cookie.

Initargs

:name

Initform

(drakma:cookie-error nil "a cookie must have a name.")

Readers

cookie-name (generic function)

Writers

(setf cookie-name) (generic function)

Slot: value

The cookie’s value.

Initargs

:value

Initform

""

Readers

cookie-value (generic function)

Writers

(setf cookie-value) (generic function)

Slot: domain

The domain the cookie is valid for.

Initargs

:domain

Initform

(drakma:cookie-error nil "a cookie must have a domain.")

Readers

cookie-domain (generic function)

Writers

(setf cookie-domain) (generic function)

Slot: path

The path prefix the cookie is valid for.

Initargs

:path

Initform

"/"

Readers

cookie-path (generic function)

Writers

(setf cookie-path) (generic function)

Slot: expires

When the cookie expires. A Lisp universal time or NIL.

Initargs

:expires

Readers

cookie-expires (generic function)

Writers

(setf cookie-expires) (generic function)

Slot: securep

Whether the cookie must only be transmitted over secure connections.

Initargs

:securep

Readers

cookie-securep (generic function)

Writers

(setf cookie-securep) (generic function)

Slot: http-only-p

Whether the cookie should not be
accessible from Javascript.

This is a Microsoft extension that has been implemented in Firefox as well. See <http://msdn2.microsoft.com/en-us/library/ms533046.aspx>.

Initargs

:http-only-p

Readers

cookie-http-only-p (generic function)

Writers

(setf cookie-http-only-p) (generic function)

Class: cookie-jar ()

An object of this class encapsulates a
collection (a list, actually) of COOKIE objects. You create a new cookie jar with (MAKE-INSTANCE ’COOKIE-JAR) where you can optionally provide a list of COOKIE objects with the :COOKIES initarg. The cookies in a cookie jar are accessed with COOKIE-JAR-COOKIES.

Package

drakma

Source

cookies.lisp (file)

Direct superclasses

standard-object (class)

Direct methods
Direct slots
Slot: cookies

A list of the cookies in this cookie jar.

Initargs

:cookies

Readers

cookie-jar-cookies (generic function)

Writers

(setf cookie-jar-cookies) (generic function)


Previous: , Up: Definitions   [Contents][Index]

5.2 Internal definitions


Next: , Previous: , Up: Internal definitions   [Contents][Index]

5.2.1 Constants

Constant: +buffer-size+
Package

drakma

Source

specials.lisp (file)

Constant: +known-methods+

The HTTP methods (including WebDAV methods) Drakma knows.

Package

drakma

Source

specials.lisp (file)

Constant: +latin-1+

Default external format when reading headers.

Package

drakma

Source

specials.lisp (file)

Constant: +redirect-codes+

A list of all HTTP return codes that redirect us to another URI.

Package

drakma

Source

specials.lisp (file)

Constant: +redirect-to-get-codes+

A list of HTTP return codes that redirect using a GET method (see http://en.wikipedia.org/wiki/Post/Redirect/Get).

Package

drakma

Source

specials.lisp (file)

Constant: +redirect-to-get-methods+

A list of HTTP methods that should be changed to GET in case of redirect (see http://en.wikipedia.org/wiki/Post/Redirect/Get).

Package

drakma

Source

specials.lisp (file)


Next: , Previous: , Up: Internal definitions   [Contents][Index]

5.2.2 Special variables

Special Variable: *hyperdoc-base-uri*
Package

drakma

Source

specials.lisp (file)

Special Variable: *time-zone-map*

An alist which maps time zone abbreviations to Common Lisp timezones.

Package

drakma

Source

specials.lisp (file)


Next: , Previous: , Up: Internal definitions   [Contents][Index]

5.2.3 Macros

Macro: define-constant NAME VALUE &optional DOC

A version of DEFCONSTANT for, cough, /strict/ CL implementations.

Package

drakma

Source

specials.lisp (file)

Macro: when-let (VAR EXPR) &body BODY

Evaluates EXPR, binds it to VAR, and executes BODY if VAR has a true value.

Package

drakma

Source

util.lisp (file)

Macro: with-sequence-from-string (STREAM STRING) &body BODY

Kludge to make Chunga tokenizing functionality usable. Works like WITH-INPUT-FROM-STRING, but creates a sequence of octets that works with CHUNGA::PEEK-CHAR* and friends.

Package

drakma

Source

util.lisp (file)

Macro: with-unique-names (&rest BINDINGS) &body BODY

Syntax: WITH-UNIQUE-NAMES ( { var | (var x) }* ) declaration* form*

Executes a series of forms with each VAR bound to a fresh, uninterned symbol. The uninterned symbol is as if returned by a call to GENSYM with the string denoted by X - or, if X is not supplied, the string denoted by VAR - as argument.

The variable bindings created are lexical unless special declarations are specified. The scopes of the name bindings and declarations do not include the Xs.

The forms are evaluated in order, and the values of all but the last are discarded (that is, the body is an implicit PROGN).

Package

drakma

Source

util.lisp (file)


Next: , Previous: , Up: Internal definitions   [Contents][Index]

5.2.4 Functions

Function: %read-body STREAM ELEMENT-TYPE

Helper function to read from stream into a buffer of element-type, which is returned.

Package

drakma

Source

request.lisp (file)

Function: alist-to-url-encoded-string ALIST EXTERNAL-FORMAT URL-ENCODER

ALIST is supposed to be an alist of name/value pairs where both names and values are strings (or, for values, NIL). This function returns a string where this list is represented as for the content type ‘application/x-www-form-urlencoded’, i.e. the values are URL-encoded using the external format EXTERNAL-FORMAT, the pairs are joined with a #\& character, and each name is separated from its value with a #\= character. If the value is NIL, no #\= is used.

Package

drakma

Source

util.lisp (file)

Function: check-cookie COOKIE

Checks if the slots of the COOKIE object COOKIE have valid values and raises a corresponding error of type COOKIE-ERROR otherwise.

Package

drakma

Source

cookies.lisp (file)

Function: cookie-domain-matches DOMAIN URI

Checks if the domain DOMAIN (a string) matches the (PURI) URI URI.

Package

drakma

Source

cookies.lisp (file)

Function: decode-flexi-stream HEADERS STREAM &key DECODE-CONTENT

Perform all necessary decodings on the internal stream of a flexi-stream. Wrapper around decode-response-stream which preserverves the external format of the flexi-stream.

If DECODE-CONTENT is nil, the Content-Encoding header will not be used to determine which decoding mechanisms to use. Most servers use Content-Encoding to identify compression.

Package

drakma

Source

encoding.lisp (file)

Function: decode-response-stream HEADERS STREAM &key DECODE-CONTENT

Perform all necessary decodings on stream, from the Transfer-Encoding and Content-Encoding headers.

If DECODE-CONTENT is nil, only the Transfer-Encoding headers will be used.

Package

drakma

Source

encoding.lisp (file)

Function: default-port URI

Returns the default port number for the (PURI) URI URI. Works only with the http and https schemes.

Package

drakma

Source

util.lisp (file)

Function: determine-body-format HEADERS EXTERNAL-FORMAT-IN

The default function used by Drakma to determine how the content body is to be read. See the docstring of *BODY-FORMAT-FUNCTION* for more info.

Package

drakma

Source

request.lisp (file)

Function: dissect-query QUERY-STRING

Accepts a query string as in PURI:URI-QUERY and returns a corresponding alist of name/value pairs.

Package

drakma

Source

util.lisp (file)

Function: drakma-warn FORMAT-CONTROL &rest FORMAT-ARGUMENTS

Signals a warning of type DRAKMA-SIMPLE-WARNING with the provided format control and arguments.

Package

drakma

Source

conditions.lisp (file)

Function: ends-with-p SEQ SUFFIX &key TEST

Returns true if the sequence SEQ ends with the sequence SUFFIX. Individual elements are compared with TEST.

Package

drakma

Source

util.lisp (file)

Function: get-cookies HEADERS URI

Returns a list of COOKIE objects corresponding to the ‘Set-Cookie’ header as found in HEADERS (an alist as returned by HTTP-REQUEST). Collects only cookies which match the domain of the (PURI) URI URI.

Package

drakma

Source

cookies.lisp (file)

Function: hyperdoc-lookup SYMBOL TYPE
Package

drakma

Source

specials.lisp (file)

Function: interpret-as-month STRING

Tries to interpret STRING as a string denoting a month and returns the corresponding number of the month. Accepts three-letter abbreviations like "Feb" and full month names likes "February". Finally, the function also accepts strings representing integers from one to twelve.

Package

drakma

Source

util.lisp (file)

Function: interpret-as-time-zone STRING

Tries to interpret STRING as a time zone abbreviation which can either be something like "PST" or "GMT" with an offset like "GMT-02:00".

Package

drakma

Source

util.lisp (file)

Function: make-form-data-function PARAMETERS BOUNDARY EXTERNAL-FORMAT-OUT

Creates and returns a closure which can be used as an argument for SEND-CONTENT to send PARAMETERS as a ‘multipart/form-data’ request body using the boundary BOUNDARY.

Package

drakma

Source

request.lisp (file)

Function: make-random-string &optional LENGTH

Generates and returns a random string length LENGTH. The string will consist solely of decimal digits and ASCII letters.

Package

drakma

Source

util.lisp (file)

Function: make-ssl-stream HTTP-STREAM &key CERTIFICATE KEY CERTIFICATE-PASSWORD VERIFY MAX-DEPTH CA-FILE CA-DIRECTORY HOSTNAME

Attaches SSL to the stream HTTP-STREAM and returns the SSL stream (which will not be equal to HTTP-STREAM).

Package

drakma

Source

util.lisp (file)

Function: non-default-port URI

If the (PURI) URI specifies an explicit port number which is different from the default port its scheme, this port number is returned, otherwise NIL.

Package

drakma

Source

util.lisp (file)

Function: normalize-cookie-domain DOMAIN

Adds a dot at the beginning of the string DOMAIN unless there is already one.

Package

drakma

Source

cookies.lisp (file)

Function: parse-set-cookie STRING

Parses the ‘Set-Cookie’ header line STRING and returns a list of three-element lists where each one contains the name of the cookie, the value of the cookie, and an attribute/value list for the optional cookie parameters.

Package

drakma

Source

cookies.lisp (file)

Function: read-body STREAM HEADERS TEXTP &key DECODE-CONTENT

Reads the message body from the HTTP stream STREAM using the information contained in HEADERS (as produced by HTTP-REQUEST). If TEXTP is true, the body is assumed to be of content type ‘text’ and will be returned as a string. Otherwise an array of octets (or NIL for an empty body) is returned. Returns the optional ‘trailer’ HTTP headers of the chunked stream (if any) as a second value.

Package

drakma

Source

request.lisp (file)

Function: read-status-line STREAM &optional LOG-STREAM

Reads one line from STREAM (using Chunga’s READ-LINE*) and interprets it as a HTTP status line. Returns a list of two or three values - the protocol (HTTP version) as a keyword, the status code as an integer, and optionally the reason phrase.

Package

drakma

Source

read.lisp (file)

Function: read-token-and-parameters STREAM

Reads and returns (as a two-element list) from STREAM a token and an optional list of parameters (attribute/value pairs) following the token.

Package

drakma

Source

read.lisp (file)

Function: render-cookie-date TIME

Returns a string representation of the universal time TIME which can be used for cookie headers.

Package

drakma

Source

cookies.lisp (file)

Function: safe-parse-integer STRING

Like PARSE-INTEGER, but returns NIL instead of signalling an error.

Package

drakma

Source

util.lisp (file)

Function: send-content CONTENT STREAM &optional EXTERNAL-FORMAT-OUT

Sends CONTENT to the stream STREAM as part of the request body depending on the type of CONTENT.

Package

drakma

Source

request.lisp (file)

Function: send-cookie-p COOKIE URI FORCE-SSL

Checks if the cookie COOKIE should be sent to the server depending on the (PURI) URI URI and the value of FORCE-SSL (as in HTTP-REQUEST).

Package

drakma

Source

cookies.lisp (file)

Function: set-referer REFERER-URI &optional ALIST

Returns a fresh copy of the HTTP header list ALIST with the ‘Referer’ header set to REFERER-URI. If REFERER-URI is NIL, the result will be a list of headers without a ‘Referer’ header.

Package

drakma

Source

util.lisp (file)

Function: skip-more-commas STREAM

Reads and consumes from STREAM any number of commas and whitespace. Returns the following character or NIL in case of END-OF-FILE.

Package

drakma

Source

read.lisp (file)

Function: split-set-cookie-string STRING

Splits the string STRING which is assumed to be the value of a ‘Set-Cookie’ into parts corresponding to individual cookies and returns a list of these parts (substrings).

The string /should/ be split at commas, but heuristical approach is used instead which doesn’t split at commas which are followed by what cannot be recognized as the start of the next cookie. This is necessary because servers send headers containing unquoted commas which are not meant as separators.

Package

drakma

Source

util.lisp (file)

Function: starts-with-p SEQ PREFIX &key TEST

Returns true if the sequence SEQ starts with the sequence PREFIX whereby the elements are compared using TEST.

Package

drakma

Source

util.lisp (file)

Function: text-content-type-p TYPE SUBTYPE

Returns a true value iff the combination of TYPE and SUBTYPE matches an entry of *TEXT-CONTENT-TYPES*. See docstring of *TEXT-CONTENT-TYPES* for more info.

Package

drakma

Source

util.lisp (file)

Function: trivial-uri-path URI-STRING

If the PRESERVE-URI argument is used, the URI needs to be passed to the server in unmodified form. This function returns just the path component of the URI with no URL encoding or other modifications done.

Package

drakma

Source

request.lisp (file)

Function: update-cookies NEW-COOKIES COOKIE-JAR

Updates the cookies in COOKIE-JAR by replacing those which are equal to a cookie in (the list) NEW-COOKIES with the corresponding ‘new’ cookie and adding those which are really new.

Package

drakma

Source

cookies.lisp (file)

Function: user-agent-string TOKEN

Returns a corresponding user agent string if TOKEN is one of the keywords :DRAKMA, :FIREFOX, :EXPLORER, :OPERA, or :SAFARI. Returns TOKEN itself otherwise.

Package

drakma

Source

util.lisp (file)

Function: valid-cookie-domain-p DOMAIN

Checks if the string DOMAIN contains enough dots to be acceptable. If *ALLOW-DOTLESS-COOKIE-DOMAINS-P* is non-NIL, every domain name is considered acceptable.

Package

drakma

Source

cookies.lisp (file)


Previous: , Up: Internal definitions   [Contents][Index]

5.2.5 Conditions

Condition: drakma-simple-error ()

Like DRAKMA-ERROR but with formatting capabilities.

Package

drakma

Source

conditions.lisp (file)

Direct superclasses
Direct subclasses
Condition: drakma-simple-warning ()

Like DRAKMA-WARNING but with formatting capabilities.

Package

drakma

Source

conditions.lisp (file)

Direct superclasses

Previous: , Up: Top   [Contents][Index]

Appendix A Indexes


Next: , Previous: , Up: Indexes   [Contents][Index]

A.1 Concepts

Jump to:   D   F   L  
Index Entry  Section

D
drakma.asd: The drakma<dot>asd file
drakma/conditions.lisp: The drakma/conditions<dot>lisp file
drakma/cookies.lisp: The drakma/cookies<dot>lisp file
drakma/encoding.lisp: The drakma/encoding<dot>lisp file
drakma/packages.lisp: The drakma/packages<dot>lisp file
drakma/read.lisp: The drakma/read<dot>lisp file
drakma/request.lisp: The drakma/request<dot>lisp file
drakma/specials.lisp: The drakma/specials<dot>lisp file
drakma/util.lisp: The drakma/util<dot>lisp file

F
File, Lisp, drakma.asd: The drakma<dot>asd file
File, Lisp, drakma/conditions.lisp: The drakma/conditions<dot>lisp file
File, Lisp, drakma/cookies.lisp: The drakma/cookies<dot>lisp file
File, Lisp, drakma/encoding.lisp: The drakma/encoding<dot>lisp file
File, Lisp, drakma/packages.lisp: The drakma/packages<dot>lisp file
File, Lisp, drakma/read.lisp: The drakma/read<dot>lisp file
File, Lisp, drakma/request.lisp: The drakma/request<dot>lisp file
File, Lisp, drakma/specials.lisp: The drakma/specials<dot>lisp file
File, Lisp, drakma/util.lisp: The drakma/util<dot>lisp file

L
Lisp File, drakma.asd: The drakma<dot>asd file
Lisp File, drakma/conditions.lisp: The drakma/conditions<dot>lisp file
Lisp File, drakma/cookies.lisp: The drakma/cookies<dot>lisp file
Lisp File, drakma/encoding.lisp: The drakma/encoding<dot>lisp file
Lisp File, drakma/packages.lisp: The drakma/packages<dot>lisp file
Lisp File, drakma/read.lisp: The drakma/read<dot>lisp file
Lisp File, drakma/request.lisp: The drakma/request<dot>lisp file
Lisp File, drakma/specials.lisp: The drakma/specials<dot>lisp file
Lisp File, drakma/util.lisp: The drakma/util<dot>lisp file

Jump to:   D   F   L  

Next: , Previous: , Up: Indexes   [Contents][Index]

A.2 Functions

Jump to:   %   (  
A   C   D   E   F   G   H   I   M   N   P   R   S   T   U   V   W  
Index Entry  Section

%
%read-body: Internal functions

(
(setf cookie-domain): Exported generic functions
(setf cookie-domain): Exported generic functions
(setf cookie-domain): Exported generic functions
(setf cookie-expires): Exported generic functions
(setf cookie-expires): Exported generic functions
(setf cookie-expires): Exported generic functions
(setf cookie-http-only-p): Exported generic functions
(setf cookie-http-only-p): Exported generic functions
(setf cookie-jar-cookies): Exported generic functions
(setf cookie-jar-cookies): Exported generic functions
(setf cookie-name): Exported generic functions
(setf cookie-name): Exported generic functions
(setf cookie-name): Exported generic functions
(setf cookie-path): Exported generic functions
(setf cookie-path): Exported generic functions
(setf cookie-path): Exported generic functions
(setf cookie-securep): Exported generic functions
(setf cookie-securep): Exported generic functions
(setf cookie-value): Exported generic functions
(setf cookie-value): Exported generic functions
(setf cookie-value): Exported generic functions

A
alist-to-url-encoded-string: Internal functions

C
check-cookie: Internal functions
cookie-date-parse-error: Exported functions
cookie-domain: Exported generic functions
cookie-domain: Exported generic functions
cookie-domain-matches: Internal functions
cookie-error: Exported functions
cookie-error-cookie: Exported generic functions
cookie-error-cookie: Exported generic functions
cookie-expires: Exported generic functions
cookie-expires: Exported generic functions
cookie-http-only-p: Exported generic functions
cookie-http-only-p: Exported generic functions
cookie-jar-cookies: Exported generic functions
cookie-jar-cookies: Exported generic functions
cookie-name: Exported generic functions
cookie-name: Exported generic functions
cookie-path: Exported generic functions
cookie-path: Exported generic functions
cookie-securep: Exported generic functions
cookie-securep: Exported generic functions
cookie-value: Exported generic functions
cookie-value: Exported generic functions
cookie=: Exported functions

D
decode-flexi-stream: Internal functions
decode-response-stream: Internal functions
decode-stream: Exported generic functions
decode-stream: Exported generic functions
decode-stream: Exported generic functions
decode-stream: Exported generic functions
decode-stream: Exported generic functions
decode-stream: Exported generic functions
default-port: Internal functions
define-constant: Internal macros
delete-old-cookies: Exported functions
determine-body-format: Internal functions
dissect-query: Internal functions
drakma-warn: Internal functions

E
ends-with-p: Internal functions

F
Function, %read-body: Internal functions
Function, alist-to-url-encoded-string: Internal functions
Function, check-cookie: Internal functions
Function, cookie-date-parse-error: Exported functions
Function, cookie-domain-matches: Internal functions
Function, cookie-error: Exported functions
Function, cookie=: Exported functions
Function, decode-flexi-stream: Internal functions
Function, decode-response-stream: Internal functions
Function, default-port: Internal functions
Function, delete-old-cookies: Exported functions
Function, determine-body-format: Internal functions
Function, dissect-query: Internal functions
Function, drakma-warn: Internal functions
Function, ends-with-p: Internal functions
Function, get-content-type: Exported functions
Function, get-cookies: Internal functions
Function, header-value: Exported functions
Function, http-request: Exported functions
Function, hyperdoc-lookup: Internal functions
Function, interpret-as-month: Internal functions
Function, interpret-as-time-zone: Internal functions
Function, make-form-data-function: Internal functions
Function, make-random-string: Internal functions
Function, make-ssl-stream: Internal functions
Function, non-default-port: Internal functions
Function, normalize-cookie-domain: Internal functions
Function, parameter-error: Exported functions
Function, parameter-present-p: Exported functions
Function, parameter-value: Exported functions
Function, parse-cookie-date: Exported functions
Function, parse-set-cookie: Internal functions
Function, read-body: Internal functions
Function, read-status-line: Internal functions
Function, read-token-and-parameters: Internal functions
Function, read-tokens-and-parameters: Exported functions
Function, render-cookie-date: Internal functions
Function, safe-parse-integer: Internal functions
Function, send-content: Internal functions
Function, send-cookie-p: Internal functions
Function, set-referer: Internal functions
Function, skip-more-commas: Internal functions
Function, split-set-cookie-string: Internal functions
Function, split-tokens: Exported functions
Function, starts-with-p: Internal functions
Function, syntax-error: Exported functions
Function, text-content-type-p: Internal functions
Function, trivial-uri-path: Internal functions
Function, update-cookies: Internal functions
Function, url-encode: Exported functions
Function, user-agent-string: Internal functions
Function, valid-cookie-domain-p: Internal functions

G
Generic Function, (setf cookie-domain): Exported generic functions
Generic Function, (setf cookie-expires): Exported generic functions
Generic Function, (setf cookie-http-only-p): Exported generic functions
Generic Function, (setf cookie-jar-cookies): Exported generic functions
Generic Function, (setf cookie-name): Exported generic functions
Generic Function, (setf cookie-path): Exported generic functions
Generic Function, (setf cookie-securep): Exported generic functions
Generic Function, (setf cookie-value): Exported generic functions
Generic Function, cookie-domain: Exported generic functions
Generic Function, cookie-error-cookie: Exported generic functions
Generic Function, cookie-expires: Exported generic functions
Generic Function, cookie-http-only-p: Exported generic functions
Generic Function, cookie-jar-cookies: Exported generic functions
Generic Function, cookie-name: Exported generic functions
Generic Function, cookie-path: Exported generic functions
Generic Function, cookie-securep: Exported generic functions
Generic Function, cookie-value: Exported generic functions
Generic Function, decode-stream: Exported generic functions
get-content-type: Exported functions
get-cookies: Internal functions

H
header-value: Exported functions
http-request: Exported functions
hyperdoc-lookup: Internal functions

I
interpret-as-month: Internal functions
interpret-as-time-zone: Internal functions

M
Macro, define-constant: Internal macros
Macro, when-let: Internal macros
Macro, with-sequence-from-string: Internal macros
Macro, with-unique-names: Internal macros
make-form-data-function: Internal functions
make-random-string: Internal functions
make-ssl-stream: Internal functions
Method, (setf cookie-domain): Exported generic functions
Method, (setf cookie-domain): Exported generic functions
Method, (setf cookie-expires): Exported generic functions
Method, (setf cookie-expires): Exported generic functions
Method, (setf cookie-http-only-p): Exported generic functions
Method, (setf cookie-jar-cookies): Exported generic functions
Method, (setf cookie-name): Exported generic functions
Method, (setf cookie-name): Exported generic functions
Method, (setf cookie-path): Exported generic functions
Method, (setf cookie-path): Exported generic functions
Method, (setf cookie-securep): Exported generic functions
Method, (setf cookie-value): Exported generic functions
Method, (setf cookie-value): Exported generic functions
Method, cookie-domain: Exported generic functions
Method, cookie-error-cookie: Exported generic functions
Method, cookie-expires: Exported generic functions
Method, cookie-http-only-p: Exported generic functions
Method, cookie-jar-cookies: Exported generic functions
Method, cookie-name: Exported generic functions
Method, cookie-path: Exported generic functions
Method, cookie-securep: Exported generic functions
Method, cookie-value: Exported generic functions
Method, decode-stream: Exported generic functions
Method, decode-stream: Exported generic functions
Method, decode-stream: Exported generic functions
Method, decode-stream: Exported generic functions
Method, decode-stream: Exported generic functions

N
non-default-port: Internal functions
normalize-cookie-domain: Internal functions

P
parameter-error: Exported functions
parameter-present-p: Exported functions
parameter-value: Exported functions
parse-cookie-date: Exported functions
parse-set-cookie: Internal functions

R
read-body: Internal functions
read-status-line: Internal functions
read-token-and-parameters: Internal functions
read-tokens-and-parameters: Exported functions
render-cookie-date: Internal functions

S
safe-parse-integer: Internal functions
send-content: Internal functions
send-cookie-p: Internal functions
set-referer: Internal functions
skip-more-commas: Internal functions
split-set-cookie-string: Internal functions
split-tokens: Exported functions
starts-with-p: Internal functions
syntax-error: Exported functions

T
text-content-type-p: Internal functions
trivial-uri-path: Internal functions

U
update-cookies: Internal functions
url-encode: Exported functions
user-agent-string: Internal functions

V
valid-cookie-domain-p: Internal functions

W
when-let: Internal macros
with-sequence-from-string: Internal macros
with-unique-names: Internal macros

Jump to:   %   (  
A   C   D   E   F   G   H   I   M   N   P   R   S   T   U   V   W  

Next: , Previous: , Up: Indexes   [Contents][Index]

A.3 Variables

Jump to:   *   +  
C   D   E   H   N   P   S   V  
Index Entry  Section

*
*allow-dotless-cookie-domains-p*: Exported special variables
*body-format-function*: Exported special variables
*default-http-proxy*: Exported special variables
*drakma-default-external-format*: Exported special variables
*drakma-version*: Exported special variables
*header-stream*: Exported special variables
*hyperdoc-base-uri*: Internal special variables
*ignore-unparseable-cookie-dates-p*: Exported special variables
*no-proxy-domains*: Exported special variables
*remove-duplicate-cookies-p*: Exported special variables
*text-content-types*: Exported special variables
*time-zone-map*: Internal special variables

+
+buffer-size+: Internal constants
+known-methods+: Internal constants
+latin-1+: Internal constants
+redirect-codes+: Internal constants
+redirect-to-get-codes+: Internal constants
+redirect-to-get-methods+: Internal constants

C
Constant, +buffer-size+: Internal constants
Constant, +known-methods+: Internal constants
Constant, +latin-1+: Internal constants
Constant, +redirect-codes+: Internal constants
Constant, +redirect-to-get-codes+: Internal constants
Constant, +redirect-to-get-methods+: Internal constants
cookie: Exported conditions
cookies: Exported classes

D
domain: Exported classes

E
expires: Exported classes

H
http-only-p: Exported classes

N
name: Exported classes

P
path: Exported classes

S
securep: Exported classes
Slot, cookie: Exported conditions
Slot, cookies: Exported classes
Slot, domain: Exported classes
Slot, expires: Exported classes
Slot, http-only-p: Exported classes
Slot, name: Exported classes
Slot, path: Exported classes
Slot, securep: Exported classes
Slot, value: Exported classes
Special Variable, *allow-dotless-cookie-domains-p*: Exported special variables
Special Variable, *body-format-function*: Exported special variables
Special Variable, *default-http-proxy*: Exported special variables
Special Variable, *drakma-default-external-format*: Exported special variables
Special Variable, *drakma-version*: Exported special variables
Special Variable, *header-stream*: Exported special variables
Special Variable, *hyperdoc-base-uri*: Internal special variables
Special Variable, *ignore-unparseable-cookie-dates-p*: Exported special variables
Special Variable, *no-proxy-domains*: Exported special variables
Special Variable, *remove-duplicate-cookies-p*: Exported special variables
Special Variable, *text-content-types*: Exported special variables
Special Variable, *time-zone-map*: Internal special variables

V
value: Exported classes

Jump to:   *   +  
C   D   E   H   N   P   S   V  

Previous: , Up: Indexes   [Contents][Index]

A.4 Data types

Jump to:   C   D   P   S  
Index Entry  Section

C
Class, cookie: Exported classes
Class, cookie-jar: Exported classes
Condition, cookie-date-parse-error: Exported conditions
Condition, cookie-error: Exported conditions
Condition, drakma-condition: Exported conditions
Condition, drakma-error: Exported conditions
Condition, drakma-simple-error: Internal conditions
Condition, drakma-simple-warning: Internal conditions
Condition, drakma-warning: Exported conditions
Condition, parameter-error: Exported conditions
Condition, syntax-error: Exported conditions
cookie: Exported classes
cookie-date-parse-error: Exported conditions
cookie-error: Exported conditions
cookie-jar: Exported classes

D
drakma: The drakma system
drakma: The drakma package
drakma-asd: The drakma-asd package
drakma-condition: Exported conditions
drakma-error: Exported conditions
drakma-simple-error: Internal conditions
drakma-simple-warning: Internal conditions
drakma-warning: Exported conditions

P
Package, drakma: The drakma package
Package, drakma-asd: The drakma-asd package
parameter-error: Exported conditions

S
syntax-error: Exported conditions
System, drakma: The drakma system

Jump to:   C   D   P   S