The carrier Reference Manual

Table of Contents

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

The carrier Reference Manual

This is the carrier Reference Manual, version 0.1.1, generated automatically by Declt version 2.3 "Robert April" on Tue Feb 20 07:46:23 2018 GMT+0.


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

1 Introduction

Carrier

Carrier is a lightweight, async HTTP client built on top of cl-async and fast-http.

Its goal is to allow easy and efficient streaming of data over HTTP. It is the lightweight cousin to drakma-async.

Documentation

request (function)

(defun request (url &key (method :get) headers body return-body header-callback body-callback finish-callback (redirect 5) redirect-non-get timeout))
  => promise

Perform an HTTP request. Returns a promise (to be used with cl-async-future) that is finished when the response has fully downloaded.

(lambda (headers) (gethash "content-type" headers))
(lambda (chunk start end)
  ;; here's how you'd get the actual bytes. note that most stream functions
  ;; take :start and :end functions, so we don't actually have to do a subseq
  ;; to send the chunk where we need it to go
  (subseq chunk start end))
(lambda () ...)
(lambda (redirecting-url headers) ...)

License

MIT!!


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 carrier

Author

Andrew Danger Lyon <orthecreedence@gmail.com>

License

MIT

Description

An async HTTP client

Version

0.1.1

Dependencies
Source

carrier.asd (file)

Components

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 carrier.asd

Location

carrier.asd

Systems

carrier (system)


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

3.1.2 carrier/package.lisp

Parent

carrier (system)

Location

package.lisp

Packages

carrier


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

3.1.3 carrier/util.lisp

Dependency

package.lisp (file)

Parent

carrier (system)

Location

util.lisp


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

3.1.4 carrier/carrier.lisp

Dependencies
Parent

carrier (system)

Location

carrier.lisp

Exported Definitions

request (function)

Internal Definitions

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

4 Packages

Packages are listed by definition order.


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

4.1 carrier

Source

package.lisp (file)

Use List
Exported Definitions

request (function)

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


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

5.1.1 Functions

Function: request URL &rest ARGS &key METHOD HEADERS BODY RETURN-BODY HEADER-CALLBACK BODY-CALLBACK FINISH-CALLBACK REDIRECT REDIRECT-NON-GET TIMEOUT

Make an HTTP request.

Package

carrier

Source

carrier.lisp (file)


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

5.2 Internal definitions


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

5.2.1 Functions

Function: build-request PARSED-URI METHOD HEADERS BODY

Build an HTTP request.

Package

carrier

Source

carrier.lisp (file)

Function: char-up CHAR

Turn a character uppercase.

Package

carrier

Source

carrier.lisp (file)

Function: header-capitalize KEY

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

Package

carrier

Source

carrier.lisp (file)


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

5.2.2 Conditions

Condition: http-eof ()

Triggered when an HTTP peer closes the connection.

Package

carrier

Source

carrier.lisp (file)

Direct superclasses

event-error (condition)

Condition: http-timeout ()

Triggered when an HTTP connection times out.

Package

carrier

Source

carrier.lisp (file)

Direct superclasses

event-error (condition)


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
carrier.asd: The carrier<dot>asd file
carrier/carrier.lisp: The carrier/carrier<dot>lisp file
carrier/package.lisp: The carrier/package<dot>lisp file
carrier/util.lisp: The carrier/util<dot>lisp file

F
File, Lisp, carrier.asd: The carrier<dot>asd file
File, Lisp, carrier/carrier.lisp: The carrier/carrier<dot>lisp file
File, Lisp, carrier/package.lisp: The carrier/package<dot>lisp file
File, Lisp, carrier/util.lisp: The carrier/util<dot>lisp file

L
Lisp File, carrier.asd: The carrier<dot>asd file
Lisp File, carrier/carrier.lisp: The carrier/carrier<dot>lisp file
Lisp File, carrier/package.lisp: The carrier/package<dot>lisp file
Lisp File, carrier/util.lisp: The carrier/util<dot>lisp file

Jump to:   C   F   L  

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

A.2 Functions

Jump to:   B   C   F   H   R  
Index Entry  Section

B
build-request: Internal functions

C
char-up: Internal functions

F
Function, build-request: Internal functions
Function, char-up: Internal functions
Function, header-capitalize: Internal functions
Function, request: Exported functions

H
header-capitalize: Internal functions

R
request: Exported functions

Jump to:   B   C   F   H   R  

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

A.3 Variables


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

A.4 Data types

Jump to:   C   H   P   S  
Index Entry  Section

C
carrier: The carrier system
carrier: The carrier package
Condition, http-eof: Internal conditions
Condition, http-timeout: Internal conditions

H
http-eof: Internal conditions
http-timeout: Internal conditions

P
Package, carrier: The carrier package

S
System, carrier: The carrier system

Jump to:   C   H   P   S