The cl-cookie Reference Manual

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 4.0 beta 2 "William Riker" on Wed Jun 15 03:36:04 2022 GMT+0.

Table of Contents


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.


2 Systems

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


Previous: , 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

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

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


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   [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.


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

Source

cl-cookie.asd.

Parent Component

cl-cookie (system).

Packages

cl-cookie.

Public Interface
Internals

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
  • asdf/interface.
  • common-lisp.

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

4.2 cl-cookie

Source

src/cl-cookie.lisp.

Nickname

cookie

Use List
  • common-lisp.
  • proc-parse.
Public Interface
Internals

5 Definitions

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


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

5.1 Public Interface


5.1.1 Ordinary functions

Package

cl-cookie.

Source

src/cl-cookie.lisp.

Target Slot

domain.

Package

cl-cookie.

Source

src/cl-cookie.lisp.

Package

cl-cookie.

Source

src/cl-cookie.lisp.

Target Slot

expires.

Package

cl-cookie.

Source

src/cl-cookie.lisp.

Target Slot

httponly-p.

Package

cl-cookie.

Source

src/cl-cookie.lisp.

Target Slot

cookies.

Package

cl-cookie.

Source

src/cl-cookie.lisp.

Package

cl-cookie.

Source

src/cl-cookie.lisp.

Target Slot

name.

Package

cl-cookie.

Source

src/cl-cookie.lisp.

Target Slot

origin-host.

Package

cl-cookie.

Source

src/cl-cookie.lisp.

Target Slot

path.

Package

cl-cookie.

Source

src/cl-cookie.lisp.

Target Slot

secure-p.

Package

cl-cookie.

Source

src/cl-cookie.lisp.

Target Slot

value.

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.


5.1.2 Structures

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

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


5.2 Internals


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

5.2.1 Special variables

Special Variable: *current-century-offset*
Package

cl-cookie.

Source

src/cl-cookie.lisp.


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

5.2.2 Ordinary functions

Package

cl-cookie.

Source

src/cl-cookie.lisp.

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.


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


Appendix A Indexes


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

A.1 Concepts


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

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

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