The carrier Reference Manual

This is the carrier Reference Manual, version 0.1.1, generated automatically by Declt version 4.0 beta 2 "William Riker" on Wed May 15 03:33:22 2024 GMT+0.

Table of Contents


1 Introduction


2 Systems

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


2.1 carrier

An async HTTP client

Author

Andrew Danger Lyon <>

License

MIT

Version

0.1.1

Dependencies
  • alexandria (system).
  • babel (system).
  • fast-io (system).
  • cl-async (system).
  • cl-async-ssl (system).
  • blackbird (system).
  • quri (system).
  • fast-http (system).
  • fast-io (system).
  • cl-cookie (system).
Source

carrier.asd.

Child Components

3 Files

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


3.1 Lisp


3.1.1 carrier/carrier.asd

Source

carrier.asd.

Parent Component

carrier (system).

ASDF Systems

carrier.


3.1.2 carrier/package.lisp

Source

carrier.asd.

Parent Component

carrier (system).

Packages

carrier.


3.1.3 carrier/util.lisp

Dependency

package.lisp (file).

Source

carrier.asd.

Parent Component

carrier (system).


3.1.4 carrier/carrier.lisp

Dependencies
Source

carrier.asd.

Parent Component

carrier (system).

Public Interface

request (function).

Internals

4 Packages

Packages are listed by definition order.


4.1 carrier

Source

package.lisp.

Use List
  • blackbird.
  • common-lisp.
Public Interface

request (function).

Internals

5 Definitions

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


5.1 Public Interface


5.1.1 Ordinary functions

Function: request (url &rest args &key method headers body cookie-jar return-body header-callback body-callback finish-callback redirect redirect-non-get timeout)

Make an HTTP request.

Package

carrier.

Source

carrier.lisp.


5.2 Internals


5.2.1 Ordinary functions

Function: build-request (parsed-uri method headers body &optional cookie-jar)

Build an HTTP request.

Package

carrier.

Source

carrier.lisp.

Function: char-up (char)

Turn a character uppercase.

Package

carrier.

Source

carrier.lisp.

Function: header-capitalize (key)

Turn :content-type into "Content-Type".

Package

carrier.

Source

carrier.lisp.


5.2.2 Conditions

Condition: http-eof

Triggered when an HTTP peer closes the connection.

Package

carrier.

Source

carrier.lisp.

Direct superclasses

event-error.

Condition: http-timeout

Triggered when an HTTP connection times out.

Package

carrier.

Source

carrier.lisp.

Direct superclasses

event-error.


Appendix A Indexes


A.1 Concepts


A.3 Variables