The cl-httpsqs Reference Manual

Table of Contents

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

The cl-httpsqs Reference Manual

This is the cl-httpsqs Reference Manual, version 0.0.1, generated automatically by Declt version 2.4 "Will Decker" on Wed Jun 20 11:10:46 2018 GMT+0.


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

1 Introduction

CL-HTTPSQS - A client library for accessing HTTPSQS

Overview

HTTPSQS is a HTTP-based message queue, and this lib is used to interact with it.f

Usage

Assume the HTTPSQS is started and listened on port 1218 at localhost, after loading this lib, the following functions could be used

CL-HTTPSQS:MAKE-QUEUE

This is a function and it's used to create an instance of class CL-HTTPSQS:<HTTPSQS>

(defvar *queue* (cl-httpsqs:make-queue "127.0.0.1" 1218))

CL-HTTPSQS:ENQUEUE

After creating the instance, it's able to push an item into the queue by means of the function CL-HTTPSQS:ENQUEUE

(cl-httpsqs:enqueue "Hello, world!" "test" *queue*)

CL-HTTPSQS:PRINT-STATUS

To see the current status of a queue, use the CL-HTTPSQS:PRINT-STATUS

(cl-httpsqs:print-status "test" *queue*)

CL-HTTPSQS:DEQUEUE

Now there is one item in the queue, and it's able to ask the queue to output it

(cl-httpsqs:dequeue "test" *queue*)

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

Author

Liutos <mat.liutos@gmail.com>

License

MIT

Description

A client lib for accessing HTTPSQS written in Common Lisp

Version

0.0.1

Dependency

drakma

Source

cl-httpsqs.asd (file)

Component

src (module)


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

3 Modules

Modules are listed depth-first from the system components tree.


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

3.1 cl-httpsqs/src

Parent

cl-httpsqs (system)

Location

src/

Components

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

4 Files

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


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

4.1 Lisp


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

4.1.1 cl-httpsqs.asd

Location

cl-httpsqs.asd

Systems

cl-httpsqs (system)


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

4.1.2 cl-httpsqs/src/package.lisp

Parent

src (module)

Location

src/package.lisp

Packages

cl-httpsqs


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

4.1.3 cl-httpsqs/src/cl-httpsqs.lisp

Dependency

package.lisp (file)

Parent

src (module)

Location

src/cl-httpsqs.lisp

Exported Definitions
Internal Definitions

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

5 Packages

Packages are listed by definition order.


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

5.1 cl-httpsqs

Source

package.lisp (file)

Use List

common-lisp

Exported Definitions
Internal Definitions

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

6 Definitions

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


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

6.1 Exported definitions


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

6.1.1 Functions

Function: dequeue NAME QUEUE &optional CHARSET

Returns a string dequeued from a httpsqs queue, or NIL when the queue is empty.

Package

cl-httpsqs

Source

cl-httpsqs.lisp (file)

Function: enqueue DATA NAME QUEUE &optional CHARSET

Append DATA into QUEUE named NAME.

Package

cl-httpsqs

Source

cl-httpsqs.lisp (file)

Function: fetch-json-status NAME QUEUE

Returns a JSON string of the QUEUE’s status.

Package

cl-httpsqs

Source

cl-httpsqs.lisp (file)

Function: make-queue HOST PORT &optional AUTH
Package

cl-httpsqs

Source

cl-httpsqs.lisp (file)

Function: print-status NAME QUEUE

Display the current status of QUEUE.

Package

cl-httpsqs

Source

cl-httpsqs.lisp (file)

Function: reset NAME QUEUE

Reset the QUEUE.

Package

cl-httpsqs

Source

cl-httpsqs.lisp (file)

Function: set-max NAME NUM QUEUE

Set the max number of elements in QUEUE.

Package

cl-httpsqs

Source

cl-httpsqs.lisp (file)

Function: set-sync-time NAME QUEUE SECONDS

Set interval in seconds for auto flush of QUEUE.

Package

cl-httpsqs

Source

cl-httpsqs.lisp (file)

Function: view NAME POS QUEUE

View the element at POS in QUEUE.

Package

cl-httpsqs

Source

cl-httpsqs.lisp (file)


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

6.2 Internal definitions


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

6.2.1 Functions

Function: http-request METHOD NAME PARAMETERS QUEUE &optional CONTENT

Send HTTP request to QUEUE with CONTENT and PARAMETERS.

Package

cl-httpsqs

Source

cl-httpsqs.lisp (file)

Function: make-queue-uri QUEUE
Package

cl-httpsqs

Source

cl-httpsqs.lisp (file)


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

6.2.2 Generic functions

Generic Function: queue-auth OBJECT
Package

cl-httpsqs

Methods
Method: queue-auth (<HTTPSQS> <httpsqs>)

automatically generated reader method

Source

cl-httpsqs.lisp (file)

Generic Function: queue-host OBJECT
Package

cl-httpsqs

Methods
Method: queue-host (<HTTPSQS> <httpsqs>)

automatically generated reader method

Source

cl-httpsqs.lisp (file)

Generic Function: queue-port OBJECT
Package

cl-httpsqs

Methods
Method: queue-port (<HTTPSQS> <httpsqs>)

automatically generated reader method

Source

cl-httpsqs.lisp (file)


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

6.2.3 Conditions

Condition: httpsqs-auth-failed ()
Package

cl-httpsqs

Source

cl-httpsqs.lisp (file)

Direct superclasses

httpsqs-error (condition)

Condition: httpsqs-enqueue-error ()
Package

cl-httpsqs

Source

cl-httpsqs.lisp (file)

Direct superclasses

httpsqs-error (condition)

Condition: httpsqs-error ()
Package

cl-httpsqs

Source

cl-httpsqs.lisp (file)

Direct superclasses

error (condition)

Direct subclasses
Condition: httpsqs-reset-error ()
Package

cl-httpsqs

Source

cl-httpsqs.lisp (file)

Direct superclasses

httpsqs-error (condition)


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

6.2.4 Classes

Class: <httpsqs> ()
Package

cl-httpsqs

Source

cl-httpsqs.lisp (file)

Direct superclasses

standard-object (class)

Direct methods
Direct slots
Slot: auth
Type

string

Initargs

:auth

Readers

queue-auth (generic function)

Slot: host
Type

string

Initargs

:host

Readers

queue-host (generic function)

Slot: port
Type

integer

Initargs

:port

Readers

queue-port (generic function)


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

Appendix A Indexes


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

A.1 Concepts

Jump to:   C   F   L   M  
Index Entry  Section

C
cl-httpsqs.asd: The cl-httpsqs<dot>asd file
cl-httpsqs/src: The cl-httpsqs/src module
cl-httpsqs/src/cl-httpsqs.lisp: The cl-httpsqs/src/cl-httpsqs<dot>lisp file
cl-httpsqs/src/package.lisp: The cl-httpsqs/src/package<dot>lisp file

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

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

M
Module, cl-httpsqs/src: The cl-httpsqs/src module

Jump to:   C   F   L   M  

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

A.2 Functions

Jump to:   D   E   F   G   H   M   P   Q   R   S   V  
Index Entry  Section

D
dequeue: Exported functions

E
enqueue: Exported functions

F
fetch-json-status: Exported functions
Function, dequeue: Exported functions
Function, enqueue: Exported functions
Function, fetch-json-status: Exported functions
Function, http-request: Internal functions
Function, make-queue: Exported functions
Function, make-queue-uri: Internal functions
Function, print-status: Exported functions
Function, reset: Exported functions
Function, set-max: Exported functions
Function, set-sync-time: Exported functions
Function, view: Exported functions

G
Generic Function, queue-auth: Internal generic functions
Generic Function, queue-host: Internal generic functions
Generic Function, queue-port: Internal generic functions

H
http-request: Internal functions

M
make-queue: Exported functions
make-queue-uri: Internal functions
Method, queue-auth: Internal generic functions
Method, queue-host: Internal generic functions
Method, queue-port: Internal generic functions

P
print-status: Exported functions

Q
queue-auth: Internal generic functions
queue-auth: Internal generic functions
queue-host: Internal generic functions
queue-host: Internal generic functions
queue-port: Internal generic functions
queue-port: Internal generic functions

R
reset: Exported functions

S
set-max: Exported functions
set-sync-time: Exported functions

V
view: Exported functions

Jump to:   D   E   F   G   H   M   P   Q   R   S   V  

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

A.3 Variables

Jump to:   A   H   P   S  
Index Entry  Section

A
auth: Internal classes

H
host: Internal classes

P
port: Internal classes

S
Slot, auth: Internal classes
Slot, host: Internal classes
Slot, port: Internal classes

Jump to:   A   H   P   S  

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

A.4 Data types

Jump to:   <  
C   H   P   S  
Index Entry  Section

<
<httpsqs>: Internal classes

C
cl-httpsqs: The cl-httpsqs system
cl-httpsqs: The cl-httpsqs package
Class, <httpsqs>: Internal classes
Condition, httpsqs-auth-failed: Internal conditions
Condition, httpsqs-enqueue-error: Internal conditions
Condition, httpsqs-error: Internal conditions
Condition, httpsqs-reset-error: Internal conditions

H
httpsqs-auth-failed: Internal conditions
httpsqs-enqueue-error: Internal conditions
httpsqs-error: Internal conditions
httpsqs-reset-error: Internal conditions

P
Package, cl-httpsqs: The cl-httpsqs package

S
System, cl-httpsqs: The cl-httpsqs system

Jump to:   <  
C   H   P   S