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

The cl-cookie Reference Manual

This is the cl-cookie Reference Manual, version 0.1, generated automatically by Declt version 4.0 beta 2 "William Riker" on Fri Sep 15 03:48:32 2023 GMT+0.

Next: Systems, Previous: The cl-cookie Reference Manual, Up: The cl-cookie Reference Manual [Contents][Index]

1 Introduction

Next: Files, Previous: Introduction, Up: The cl-cookie Reference Manual [Contents][Index]

2 Systems

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

cl-cookie

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

2.1 `cl-cookie`

HTTP cookie manager

Author

Eitaro Fukamachi

License

BSD 2-Clause

Long Description

# CL-Cookie

[![Build Status](https://travis-ci.org/fukamachi/cl-cookie.svg?branch=master)](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

## License

Licensed under the BSD 2-Clause License.

Version

0.1

Dependencies

proc-parse (system).
cl-ppcre (system).
quri (system).
local-time (system).
alexandria (system).

Source

cl-cookie.asd.

Child Component

src/cl-cookie.lisp (file).

Next: Packages, Previous: Systems, Up: The cl-cookie Reference Manual [Contents][Index]

3 Files

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

Lisp

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

Next: cl-cookie/src/cl-cookie.lisp, Previous: Lisp, Up: Lisp [Contents][Index]

3.1.1 `cl-cookie/cl-cookie.asd`

Source: cl-cookie.asd.
Parent Component: cl-cookie (system).
ASDF Systems: cl-cookie.
Packages: cl-cookie-asd.

Previous: cl-cookie/cl-cookie.asd, Up: Lisp [Contents][Index]

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

Source

cl-cookie.asd.

Parent Component

cl-cookie (system).

Packages

cl-cookie.

Public Interface

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

Internals

*current-century-offset* (special variable).
+set-cookie-date-format+ (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).

Next: Definitions, Previous: Files, Up: The cl-cookie Reference Manual [Contents][Index]

4 Packages

Packages are listed by definition order.

cl-cookie-asd
cl-cookie

Next: cl-cookie, Previous: Packages, Up: Packages [Contents][Index]

4.1 `cl-cookie-asd`

Source

cl-cookie.asd.

Use List

asdf/interface.
common-lisp.

Previous: cl-cookie-asd, Up: Packages [Contents][Index]

4.2 `cl-cookie`

Source

src/cl-cookie.lisp.

Nickname

cookie

Use List

common-lisp.
proc-parse.

Public Interface

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

Internals

*current-century-offset* (special variable).
+set-cookie-date-format+ (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).

Next: Indexes, Previous: Packages, Up: The cl-cookie Reference Manual [Contents][Index]

5 Definitions

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

Public Interface
Internals

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

5.1 Public Interface

Ordinary functions
Structures

Next: Structures, Previous: Public Interface, Up: Public Interface [Contents][Index]

5.1.1 Ordinary functions

Reader: cookie-domain (instance) ¶

Writer: (setf cookie-domain) (instance) ¶

Package: cl-cookie.
Source: src/cl-cookie.lisp.
Target Slot: domain.

Function: cookie-equal (cookie1 cookie2) ¶

Package: cl-cookie.
Source: src/cl-cookie.lisp.

Reader: cookie-expires (instance) ¶

Writer: (setf cookie-expires) (instance) ¶

Package: cl-cookie.
Source: src/cl-cookie.lisp.
Target Slot: expires.

Reader: cookie-httponly-p (instance) ¶

Writer: (setf cookie-httponly-p) (instance) ¶

Package: cl-cookie.
Source: src/cl-cookie.lisp.
Target Slot: httponly-p.

Reader: cookie-jar-cookies (instance) ¶

Writer: (setf cookie-jar-cookies) (instance) ¶

Package: cl-cookie.
Source: src/cl-cookie.lisp.
Target Slot: cookies.

Function: cookie-jar-host-cookies (cookie-jar host path &key securep) ¶

Package: cl-cookie.
Source: src/cl-cookie.lisp.

Reader: cookie-name (instance) ¶

Writer: (setf cookie-name) (instance) ¶

Package: cl-cookie.
Source: src/cl-cookie.lisp.
Target Slot: name.

Reader: cookie-origin-host (instance) ¶

Writer: (setf cookie-origin-host) (instance) ¶

Package: cl-cookie.
Source: src/cl-cookie.lisp.
Target Slot: origin-host.

Reader: cookie-path (instance) ¶

Writer: (setf cookie-path) (instance) ¶

Package: cl-cookie.
Source: src/cl-cookie.lisp.
Target Slot: path.

Reader: cookie-secure-p (instance) ¶

Writer: (setf cookie-secure-p) (instance) ¶

Package: cl-cookie.
Source: src/cl-cookie.lisp.
Target Slot: secure-p.

Reader: cookie-value (instance) ¶

Writer: (setf cookie-value) (instance) ¶

Package: cl-cookie.
Source: src/cl-cookie.lisp.
Target Slot: value.

Function: cookie= (cookie1 cookie2) ¶

Package: cl-cookie.
Source: src/cl-cookie.lisp.

Function: make-cookie (&key name value expires path domain secure-p httponly-p origin-host) ¶

Package: cl-cookie.
Source: src/cl-cookie.lisp.

Function: make-cookie-jar (&key cookies) ¶

Package: cl-cookie.
Source: src/cl-cookie.lisp.

Function: merge-cookies (cookie-jar cookies) ¶

Package: cl-cookie.
Source: src/cl-cookie.lisp.

Function: parse-set-cookie-header (set-cookie-string origin-host origin-path) ¶

Package: cl-cookie.
Source: src/cl-cookie.lisp.

Function: write-cookie-header (cookies &optional stream) ¶

Package: cl-cookie.
Source: src/cl-cookie.lisp.

Function: write-set-cookie-header (cookie &optional stream) ¶

Package: cl-cookie.
Source: src/cl-cookie.lisp.

Previous: Ordinary functions, Up: Public Interface [Contents][Index]

5.1.2 Structures

Structure: cookie ¶

Package

cl-cookie.

Source

src/cl-cookie.lisp.

Direct superclasses

structure-object.

Direct slots

Slot: name ¶

Readers: cookie-name.
Writers: (setf cookie-name).

Slot: value ¶

Readers: cookie-value.
Writers: (setf cookie-value).

Slot: expires ¶

Readers: cookie-expires.
Writers: (setf cookie-expires).

Slot: path ¶

Readers: cookie-path.
Writers: (setf cookie-path).

Slot: domain ¶

Readers: cookie-domain.
Writers: (setf cookie-domain).

Slot: secure-p ¶

Readers: cookie-secure-p.
Writers: (setf cookie-secure-p).

Slot: httponly-p ¶

Readers: cookie-httponly-p.
Writers: (setf cookie-httponly-p).

Slot: origin-host ¶

Readers: cookie-origin-host.
Writers: (setf cookie-origin-host).

Structure: cookie-jar ¶

Package

cl-cookie.

Source

src/cl-cookie.lisp.

Direct superclasses

structure-object.

Direct slots

Slot: cookies ¶

Readers: cookie-jar-cookies.
Writers: (setf cookie-jar-cookies).

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

5.2 Internals

Special variables
Ordinary functions
Conditions

Next: Ordinary functions, Previous: Internals, Up: Internals [Contents][Index]

5.2.1 Special variables

Special Variable: *current-century-offset* ¶

Package: cl-cookie.
Source: src/cl-cookie.lisp.

Special Variable: +set-cookie-date-format+ ¶

The date format used in RFC 6265. For example: Wed, 09 Jun 2021 10:18:14 GMT.

Package: cl-cookie.
Source: src/cl-cookie.lisp.

Next: Conditions, Previous: Special variables, Up: Internals [Contents][Index]

5.2.2 Ordinary functions

Function: cookie-jar-p (object) ¶

Package: cl-cookie.
Source: src/cl-cookie.lisp.

Function: cookie-p (object) ¶

Package: cl-cookie.
Source: src/cl-cookie.lisp.

Function: copy-cookie (instance) ¶

Package: cl-cookie.
Source: src/cl-cookie.lisp.

Function: copy-cookie-jar (instance) ¶

Package: cl-cookie.
Source: src/cl-cookie.lisp.

Function: delete-old-cookies (cookie-jar) ¶

Package: cl-cookie.
Source: src/cl-cookie.lisp.

Function: expired-cookie-p (cookie) ¶

Package: cl-cookie.
Source: src/cl-cookie.lisp.

Function: get-tz-offset (tz-abbrev) ¶

Package: cl-cookie.
Source: src/cl-cookie.lisp.

Function: integer-char-p (char) ¶

Package: cl-cookie.
Source: src/cl-cookie.lisp.

Function: match-cookie (cookie host path &key securep) ¶

Package: cl-cookie.
Source: src/cl-cookie.lisp.

Function: match-cookie-path (request-path cookie-path) ¶

Package: cl-cookie.
Source: src/cl-cookie.lisp.

Function: parse-cookie-date (cookie-date) ¶

Package: cl-cookie.
Source: src/cl-cookie.lisp.

Previous: Ordinary functions, Up: Internals [Contents][Index]

5.2.3 Conditions

Condition: invalid-expires-date ¶

Package

cl-cookie.

Source

src/cl-cookie.lisp.

Direct superclasses

error.

Direct slots

Slot: expires ¶

Initargs: :expires

Condition: invalid-set-cookie ¶

Package

cl-cookie.

Source

src/cl-cookie.lisp.

Direct superclasses

error.

Direct slots

Slot: header ¶

Initargs: :header

Previous: Definitions, Up: The cl-cookie Reference Manual [Contents][Index]

Appendix A Indexes

Concepts
Functions
Variables
Data types

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

A.1 Concepts

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

A.2 Functions

Jump to:	( C D E F G I M P W

	Index Entry	Section

(
	`(setf cookie-domain)`:	Public ordinary functions
	`(setf cookie-expires)`:	Public ordinary functions
	`(setf cookie-httponly-p)`:	Public ordinary functions
	`(setf cookie-jar-cookies)`:	Public ordinary functions
	`(setf cookie-name)`:	Public ordinary functions
	`(setf cookie-origin-host)`:	Public ordinary functions
	`(setf cookie-path)`:	Public ordinary functions
	`(setf cookie-secure-p)`:	Public ordinary functions
	`(setf cookie-value)`:	Public ordinary functions

C
	`cookie-domain`:	Public ordinary functions
	`cookie-equal`:	Public ordinary functions
	`cookie-expires`:	Public ordinary functions
	`cookie-httponly-p`:	Public ordinary functions
	`cookie-jar-cookies`:	Public ordinary functions
	`cookie-jar-host-cookies`:	Public ordinary functions
	`cookie-jar-p`:	Private ordinary functions
	`cookie-name`:	Public ordinary functions
	`cookie-origin-host`:	Public ordinary functions
	`cookie-p`:	Private ordinary functions
	`cookie-path`:	Public ordinary functions
	`cookie-secure-p`:	Public ordinary functions
	`cookie-value`:	Public ordinary functions
	`cookie=`:	Public ordinary functions
	`copy-cookie`:	Private ordinary functions
	`copy-cookie-jar`:	Private ordinary functions

D
	`delete-old-cookies`:	Private ordinary functions

E
	`expired-cookie-p`:	Private ordinary functions

F
	`Function, (setf cookie-domain)`:	Public ordinary functions
	`Function, (setf cookie-expires)`:	Public ordinary functions
	`Function, (setf cookie-httponly-p)`:	Public ordinary functions
	`Function, (setf cookie-jar-cookies)`:	Public ordinary functions
	`Function, (setf cookie-name)`:	Public ordinary functions
	`Function, (setf cookie-origin-host)`:	Public ordinary functions
	`Function, (setf cookie-path)`:	Public ordinary functions
	`Function, (setf cookie-secure-p)`:	Public ordinary functions
	`Function, (setf cookie-value)`:	Public ordinary functions
	`Function, cookie-domain`:	Public ordinary functions
	`Function, cookie-equal`:	Public ordinary functions
	`Function, cookie-expires`:	Public ordinary functions
	`Function, cookie-httponly-p`:	Public ordinary functions
	`Function, cookie-jar-cookies`:	Public ordinary functions
	`Function, cookie-jar-host-cookies`:	Public ordinary functions
	`Function, cookie-jar-p`:	Private ordinary functions
	`Function, cookie-name`:	Public ordinary functions
	`Function, cookie-origin-host`:	Public ordinary functions
	`Function, cookie-p`:	Private ordinary functions
	`Function, cookie-path`:	Public ordinary functions
	`Function, cookie-secure-p`:	Public ordinary functions
	`Function, cookie-value`:	Public ordinary functions
	`Function, cookie=`:	Public ordinary functions
	`Function, copy-cookie`:	Private ordinary functions
	`Function, copy-cookie-jar`:	Private ordinary functions
	`Function, delete-old-cookies`:	Private ordinary functions
	`Function, expired-cookie-p`:	Private ordinary functions
	`Function, get-tz-offset`:	Private ordinary functions
	`Function, integer-char-p`:	Private ordinary functions
	`Function, make-cookie`:	Public ordinary functions
	`Function, make-cookie-jar`:	Public ordinary functions
	`Function, match-cookie`:	Private ordinary functions
	`Function, match-cookie-path`:	Private ordinary functions
	`Function, merge-cookies`:	Public ordinary functions
	`Function, parse-cookie-date`:	Private ordinary functions
	`Function, parse-set-cookie-header`:	Public ordinary functions
	`Function, write-cookie-header`:	Public ordinary functions
	`Function, write-set-cookie-header`:	Public ordinary functions

G
	`get-tz-offset`:	Private ordinary functions

I
	`integer-char-p`:	Private ordinary functions

M
	`make-cookie`:	Public ordinary functions
	`make-cookie-jar`:	Public ordinary functions
	`match-cookie`:	Private ordinary functions
	`match-cookie-path`:	Private ordinary functions
	`merge-cookies`:	Public ordinary functions

P
	`parse-cookie-date`:	Private ordinary functions
	`parse-set-cookie-header`:	Public ordinary functions

W
	`write-cookie-header`:	Public ordinary functions
	`write-set-cookie-header`:	Public ordinary functions

Next: Data types, Previous: Functions, Up: Indexes [Contents][Index]

A.3 Variables

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

	Index Entry	Section

*
	`current-century-offset`:	Private special variables

+
	`+set-cookie-date-format+`:	Private special variables

C
	`cookies`:	Public structures

D
	`domain`:	Public structures

E
	`expires`:	Public structures
	`expires`:	Private conditions

H
	`header`:	Private conditions
	`httponly-p`:	Public structures

N
	`name`:	Public structures

O
	`origin-host`:	Public structures

P
	`path`:	Public structures

S
	`secure-p`:	Public structures
	`Slot, cookies`:	Public structures
	`Slot, domain`:	Public structures
	`Slot, expires`:	Public structures
	`Slot, expires`:	Private conditions
	`Slot, header`:	Private conditions
	`Slot, httponly-p`:	Public structures
	`Slot, name`:	Public structures
	`Slot, origin-host`:	Public structures
	`Slot, path`:	Public structures
	`Slot, secure-p`:	Public structures
	`Slot, value`:	Public structures
	`Special Variable, current-century-offset`:	Private special variables
	`Special Variable, +set-cookie-date-format+`:	Private special variables

V
	`value`:	Public structures

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

A.4 Data types

Jump to:	C F I P S

	Index Entry	Section

C
	`cl-cookie`:	The cl-cookie system
	`cl-cookie`:	The cl-cookie package
	`cl-cookie-asd`:	The cl-cookie-asd package
	`cl-cookie.asd`:	The cl-cookie/cl-cookie․asd file
	`Condition, invalid-expires-date`:	Private conditions
	`Condition, invalid-set-cookie`:	Private conditions
	`cookie`:	Public structures
	`cookie-jar`:	Public structures

F
	`File, cl-cookie.asd`:	The cl-cookie/cl-cookie․asd file
	`File, src/cl-cookie.lisp`:	The cl-cookie/src/cl-cookie․lisp file

I
	`invalid-expires-date`:	Private conditions
	`invalid-set-cookie`:	Private conditions

P
	`Package, cl-cookie`:	The cl-cookie package
	`Package, cl-cookie-asd`:	The cl-cookie-asd package

S
	`src/cl-cookie.lisp`:	The cl-cookie/src/cl-cookie․lisp file
	`Structure, cookie`:	Public structures
	`Structure, cookie-jar`:	Public structures
	`System, cl-cookie`:	The cl-cookie system

The cl-cookie Reference Manual

Table of Contents

1 Introduction

2 Systems

2.1 cl-cookie

3 Files

3.1 Lisp

3.1.1 cl-cookie/cl-cookie.asd

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

4 Packages

4.1 cl-cookie-asd

4.2 cl-cookie

5 Definitions

5.1 Public Interface

5.1.1 Ordinary functions

5.1.2 Structures

5.2 Internals

5.2.1 Special variables

5.2.2 Ordinary functions

5.2.3 Conditions

Appendix A Indexes

A.1 Concepts

A.2 Functions

A.3 Variables

A.4 Data types

2.1 `cl-cookie`

3.1.1 `cl-cookie/cl-cookie.asd`

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

4.1 `cl-cookie-asd`

4.2 `cl-cookie`