The cl-cookie Reference Manual

Table of Contents

The cl-cookie Reference Manual

This is the cl-cookie Reference Manual, version 0.1, generated automatically by Declt version 2.4 "Will Decker" on Wed Jun 20 11:02:28 2018 GMT+0.

1 Introduction

CL-Cookie

HTTP cookie manager for Common Lisp.

Usage

(let ((cookie-jar (make-cookie-jar)))
  (merge-cookies cookie-jar
                 (list (parse-set-cookie-string "SID=31d4d96e407aad42; Path=/; Domain=example.com")))
  (cookie-jar-host-cookies cookie-jar "example.com"))

See also

• RFC 6265

Author

• Eitaro Fukamachi (e.arrows@gmail.com)

Copyright

Copyright (c) 2015 Eitaro Fukamachi (e.arrows@gmail.com)

License

Licensed under the BSD 2-Clause License.

2 Systems

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

2.1 cl-cookie

Author

Eitaro Fukamachi

License

BSD 2-Clause

Description

HTTP cookie manager

Long Description

# CL-Cookie

[](https://travis-ci.org/fukamachi/cl-cookie)

HTTP cookie manager for Common Lisp.

## Usage

“‘common-lisp
(let ((cookie-jar (make-cookie-jar)))
(merge-cookies cookie-jar
(list (parse-set-cookie-string "SID=31d4d96e407aad42; Path=/; Domain=example.com"))) (cookie-jar-host-cookies cookie-jar "example.com"))
“‘

## See also

- [RFC 6265](http://tools.ietf.org/html/rfc6265)

## Author

* Eitaro Fukamachi (e.arrows@gmail.com)

## Copyright

Copyright (c) 2015 Eitaro Fukamachi (e.arrows@gmail.com)

## License

Licensed under the BSD 2-Clause License.

Version

0.1

Dependencies

• proc-parse
• cl-ppcre
• quri
• local-time
• alexandria

Source

cl-cookie.asd (file)

Component

src/cl-cookie.lisp (file)

3 Files

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

3.1 Lisp

3.1.1 cl-cookie.asd

Location

cl-cookie.asd

Systems

cl-cookie (system)

Packages

cl-cookie-asd

3.1.2 cl-cookie/src/cl-cookie.lisp

Parent

cl-cookie (system)

Location

src/cl-cookie.lisp

Packages

cl-cookie

Exported Definitions

• cookie (structure)
• cookie-domain (function)
• (setf cookie-domain) (function)
• cookie-equal (function)
• cookie-expires (function)
• (setf cookie-expires) (function)
• cookie-httponly-p (function)
• (setf cookie-httponly-p) (function)
• cookie-jar (structure)
• cookie-jar-cookies (function)
• (setf cookie-jar-cookies) (function)
• cookie-jar-host-cookies (function)
• cookie-name (function)
• (setf cookie-name) (function)
• cookie-origin-host (function)
• (setf cookie-origin-host) (function)
• cookie-path (function)
• (setf cookie-path) (function)
• cookie-secure-p (function)
• (setf cookie-secure-p) (function)
• cookie-value (function)
• (setf cookie-value) (function)
• cookie= (function)
• make-cookie (function)
• make-cookie-jar (function)
• merge-cookies (function)
• parse-set-cookie-header (function)
• write-cookie-header (function)

Internal Definitions

• *current-century-offset* (special variable)
• cookie-jar-p (function)
• cookie-p (function)
• copy-cookie (function)
• copy-cookie-jar (function)
• delete-old-cookies (function)
• expired-cookie-p (function)
• get-tz-offset (function)
• integer-char-p (function)
• invalid-expires-date (condition)
• invalid-set-cookie (condition)
• match-cookie (function)
• match-cookie-path (function)
• parse-cookie-date (function)

4 Packages

Packages are listed by definition order.

4.1 cl-cookie-asd

Source

cl-cookie.asd

Use List

• asdf/interface
• common-lisp

4.2 cl-cookie

Source

src/cl-cookie.lisp (file)

Nickname

cookie

Use List

• proc-parse
• common-lisp

Exported Definitions

• cookie (structure)
• cookie-domain (function)
• (setf cookie-domain) (function)
• cookie-equal (function)
• cookie-expires (function)
• (setf cookie-expires) (function)
• cookie-httponly-p (function)
• (setf cookie-httponly-p) (function)
• cookie-jar (structure)
• cookie-jar-cookies (function)
• (setf cookie-jar-cookies) (function)
• cookie-jar-host-cookies (function)
• cookie-name (function)
• (setf cookie-name) (function)
• cookie-origin-host (function)
• (setf cookie-origin-host) (function)
• cookie-path (function)
• (setf cookie-path) (function)
• cookie-secure-p (function)
• (setf cookie-secure-p) (function)
• cookie-value (function)
• (setf cookie-value) (function)
• cookie= (function)
• make-cookie (function)
• make-cookie-jar (function)
• merge-cookies (function)
• parse-set-cookie-header (function)
• write-cookie-header (function)

Internal Definitions

• *current-century-offset* (special variable)
• cookie-jar-p (function)
• cookie-p (function)
• copy-cookie (function)
• copy-cookie-jar (function)
• delete-old-cookies (function)
• expired-cookie-p (function)
• get-tz-offset (function)
• integer-char-p (function)
• invalid-expires-date (condition)
• invalid-set-cookie (condition)
• match-cookie (function)
• match-cookie-path (function)
• parse-cookie-date (function)

5 Definitions

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

5.1 Exported definitions

5.1.1 Functions

Function: cookie-domain INSTANCE

Function: (setf cookie-domain) VALUE INSTANCE

Package

cl-cookie

Source

src/cl-cookie.lisp (file)

Function: cookie-equal COOKIE1 COOKIE2

Package

cl-cookie

Source

src/cl-cookie.lisp (file)

Function: cookie-expires INSTANCE

Function: (setf cookie-expires) VALUE INSTANCE

Package

cl-cookie

Source

src/cl-cookie.lisp (file)

Function: cookie-httponly-p INSTANCE

Function: (setf cookie-httponly-p) VALUE INSTANCE

Package

cl-cookie

Source

src/cl-cookie.lisp (file)

Function: cookie-jar-cookies INSTANCE

Function: (setf cookie-jar-cookies) VALUE INSTANCE

Package

cl-cookie

Source

src/cl-cookie.lisp (file)

Function: cookie-jar-host-cookies COOKIE-JAR HOST PATH &key SECUREP

Package

cl-cookie

Source

src/cl-cookie.lisp (file)

Function: cookie-name INSTANCE

Function: (setf cookie-name) VALUE INSTANCE

Package

cl-cookie

Source

src/cl-cookie.lisp (file)

Function: cookie-origin-host INSTANCE

Function: (setf cookie-origin-host) VALUE INSTANCE

Package

cl-cookie

Source

src/cl-cookie.lisp (file)

Function: cookie-path INSTANCE

Function: (setf cookie-path) VALUE INSTANCE

Package

cl-cookie

Source

src/cl-cookie.lisp (file)

Function: cookie-secure-p INSTANCE

Function: (setf cookie-secure-p) VALUE INSTANCE

Package

cl-cookie

Source

src/cl-cookie.lisp (file)

Function: cookie-value INSTANCE

Function: (setf cookie-value) VALUE INSTANCE

Package

cl-cookie

Source

src/cl-cookie.lisp (file)

Function: cookie= COOKIE1 COOKIE2

Package

cl-cookie

Source

src/cl-cookie.lisp (file)

Function: make-cookie &key (NAME NAME) (VALUE VALUE) (EXPIRES EXPIRES) (PATH PATH) (DOMAIN DOMAIN) (SECURE-P SECURE-P) (HTTPONLY-P HTTPONLY-P) (ORIGIN-HOST ORIGIN-HOST)

Package

cl-cookie

Source

src/cl-cookie.lisp (file)

Function: make-cookie-jar &key (COOKIES COOKIES)

Package

cl-cookie

Source

src/cl-cookie.lisp (file)

Function: merge-cookies COOKIE-JAR COOKIES

Package

cl-cookie

Source

src/cl-cookie.lisp (file)

Function: parse-set-cookie-header SET-COOKIE-STRING ORIGIN-HOST ORIGIN-PATH

Package

cl-cookie

Source

src/cl-cookie.lisp (file)

Function: write-cookie-header COOKIES &optional STREAM

Package

cl-cookie

Source

src/cl-cookie.lisp (file)

5.1.2 Structures

Structure: cookie ()

Package

cl-cookie

Source

src/cl-cookie.lisp (file)

Direct superclasses

structure-object (structure)

Direct slots

Slot: name

Readers

cookie-name (function)

Writers

(setf cookie-name) (function)

Slot: value

Readers

cookie-value (function)

Writers

(setf cookie-value) (function)

Slot: expires

Readers

cookie-expires (function)

Writers

(setf cookie-expires) (function)

Slot: path

Readers

cookie-path (function)

Writers

(setf cookie-path) (function)

Slot: domain

Readers

cookie-domain (function)

Writers

(setf cookie-domain) (function)

Slot: secure-p

Readers

cookie-secure-p (function)

Writers

(setf cookie-secure-p) (function)

Slot: httponly-p

Readers

cookie-httponly-p (function)

Writers

(setf cookie-httponly-p) (function)

Slot: origin-host

Readers

cookie-origin-host (function)

Writers

(setf cookie-origin-host) (function)

Structure: cookie-jar ()

Package

cl-cookie

Source

src/cl-cookie.lisp (file)

Direct superclasses

structure-object (structure)

Direct slots

Slot: cookies

Readers

cookie-jar-cookies (function)

Writers

(setf cookie-jar-cookies) (function)

5.2 Internal definitions

5.2.1 Special variables

Special Variable: *current-century-offset*

Package

cl-cookie

Source

src/cl-cookie.lisp (file)

5.2.2 Functions

Function: cookie-jar-p OBJECT

Package

cl-cookie

Source

src/cl-cookie.lisp (file)

Function: cookie-p OBJECT

Package

cl-cookie

Source

src/cl-cookie.lisp (file)

Function: copy-cookie INSTANCE

Package

cl-cookie

Source

src/cl-cookie.lisp (file)

Function: copy-cookie-jar INSTANCE

Package

cl-cookie

Source

src/cl-cookie.lisp (file)

Function: delete-old-cookies COOKIE-JAR

Package

cl-cookie

Source

src/cl-cookie.lisp (file)

Function: expired-cookie-p COOKIE

Package

cl-cookie

Source

src/cl-cookie.lisp (file)

Function: get-tz-offset TZ-ABBREV

Package

cl-cookie

Source

src/cl-cookie.lisp (file)

Function: integer-char-p CHAR

Package

cl-cookie

Source

src/cl-cookie.lisp (file)

Function: match-cookie COOKIE HOST PATH &key SECUREP

Package

cl-cookie

Source

src/cl-cookie.lisp (file)

Function: match-cookie-path REQUEST-PATH COOKIE-PATH

Package

cl-cookie

Source

src/cl-cookie.lisp (file)

Function: parse-cookie-date COOKIE-DATE

Package

cl-cookie

Source

src/cl-cookie.lisp (file)

5.2.3 Conditions

Condition: invalid-expires-date ()

Package

cl-cookie

Source

src/cl-cookie.lisp (file)

Direct superclasses

error (condition)

Direct slots

Slot: expires

Initargs

:expires

Condition: invalid-set-cookie ()

Package

cl-cookie

Source

src/cl-cookie.lisp (file)

Direct superclasses

error (condition)

Direct slots

Slot: header

Initargs

:header

Appendix A Indexes

A.1 Concepts

A.2 Functions

A.3 Variables

A.4 Data types