The cl-cookie Reference Manual

Table of Contents

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

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.


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

1 Introduction

CL-Cookie

Build Status

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

Author

Copyright

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

License

Licensed under the BSD 2-Clause License.


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 cl-cookie

Author

Eitaro Fukamachi

License

BSD 2-Clause

Description

HTTP cookie manager

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

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

## License

Licensed under the BSD 2-Clause License.

Version

0.1

Dependencies
Source

cl-cookie.asd (file)

Component

src/cl-cookie.lisp (file)


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 cl-cookie.asd

Location

cl-cookie.asd

Systems

cl-cookie (system)

Packages

cl-cookie-asd


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

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

Parent

cl-cookie (system)

Location

src/cl-cookie.lisp

Packages

cl-cookie

Exported Definitions
Internal Definitions

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

4 Packages

Packages are listed by definition order.


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

4.1 cl-cookie-asd

Source

cl-cookie.asd

Use List

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

4.2 cl-cookie

Source

src/cl-cookie.lisp (file)

Nickname

cookie

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 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)


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

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)


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

5.2 Internal definitions


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

5.2.1 Special variables

Special Variable: *current-century-offset*
Package

cl-cookie

Source

src/cl-cookie.lisp (file)


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

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)


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

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


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

Appendix A Indexes


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

A.1 Concepts

Jump to:   C   F   L  
Index Entry  Section

C
cl-cookie.asd: The cl-cookie<dot>asd file
cl-cookie/src/cl-cookie.lisp: The cl-cookie/src/cl-cookie<dot>lisp file

F
File, Lisp, cl-cookie.asd: The cl-cookie<dot>asd file
File, Lisp, cl-cookie/src/cl-cookie.lisp: The cl-cookie/src/cl-cookie<dot>lisp file

L
Lisp File, cl-cookie.asd: The cl-cookie<dot>asd file
Lisp File, cl-cookie/src/cl-cookie.lisp: The cl-cookie/src/cl-cookie<dot>lisp file

Jump to:   C   F   L  

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

A.2 Functions

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

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

C
cookie-domain: Exported functions
cookie-equal: Exported functions
cookie-expires: Exported functions
cookie-httponly-p: Exported functions
cookie-jar-cookies: Exported functions
cookie-jar-host-cookies: Exported functions
cookie-jar-p: Internal functions
cookie-name: Exported functions
cookie-origin-host: Exported functions
cookie-p: Internal functions
cookie-path: Exported functions
cookie-secure-p: Exported functions
cookie-value: Exported functions
cookie=: Exported functions
copy-cookie: Internal functions
copy-cookie-jar: Internal functions

D
delete-old-cookies: Internal functions

E
expired-cookie-p: Internal functions

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

G
get-tz-offset: Internal functions

I
integer-char-p: Internal functions

M
make-cookie: Exported functions
make-cookie-jar: Exported functions
match-cookie: Internal functions
match-cookie-path: Internal functions
merge-cookies: Exported functions

P
parse-cookie-date: Internal functions
parse-set-cookie-header: Exported functions

W
write-cookie-header: Exported functions

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

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

A.3 Variables

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

*
*current-century-offset*: Internal special variables

C
cookies: Exported structures

D
domain: Exported structures

E
expires: Exported structures
expires: Internal conditions

H
header: Internal conditions
httponly-p: Exported structures

N
name: Exported structures

O
origin-host: Exported structures

P
path: Exported structures

S
secure-p: Exported structures
Slot, cookies: Exported structures
Slot, domain: Exported structures
Slot, expires: Exported structures
Slot, expires: Internal conditions
Slot, header: Internal conditions
Slot, httponly-p: Exported structures
Slot, name: Exported structures
Slot, origin-host: Exported structures
Slot, path: Exported structures
Slot, secure-p: Exported structures
Slot, value: Exported structures
Special Variable, *current-century-offset*: Internal special variables

V
value: Exported structures

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

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

A.4 Data types

Jump to:   C   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
Condition, invalid-expires-date: Internal conditions
Condition, invalid-set-cookie: Internal conditions
cookie: Exported structures
cookie-jar: Exported structures

I
invalid-expires-date: Internal conditions
invalid-set-cookie: Internal conditions

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

S
Structure, cookie: Exported structures
Structure, cookie-jar: Exported structures
System, cl-cookie: The cl-cookie system

Jump to:   C   I   P   S