The cl-httpsqs Reference Manual

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 4.0 beta 2 "William Riker" on Mon Aug 15 03:43:27 2022 GMT+0.

Table of Contents


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

2 Systems

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


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

2.1 cl-httpsqs

A client lib for accessing HTTPSQS written in Common Lisp

Author

Liutos <mat.liutos@gmail.com>

License

MIT

Version

0.0.1

Dependency

drakma (system).

Source

cl-httpsqs.asd.

Child Component

src (module).


3 Modules

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


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

3.1 cl-httpsqs/src

Source

cl-httpsqs.asd.

Parent Component

cl-httpsqs (system).

Child Components

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   [Contents][Index]

4.1.1 cl-httpsqs/cl-httpsqs.asd

Source

cl-httpsqs.asd.

Parent Component

cl-httpsqs (system).

ASDF Systems

cl-httpsqs.


4.1.2 cl-httpsqs/src/package.lisp

Source

cl-httpsqs.asd.

Parent Component

src (module).

Packages

cl-httpsqs.


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

Dependency

package.lisp (file).

Source

cl-httpsqs.asd.

Parent Component

src (module).

Public Interface
Internals

5 Packages

Packages are listed by definition order.


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

5.1 cl-httpsqs

Source

package.lisp.

Use List

common-lisp.

Public Interface
Internals

6 Definitions

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


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

6.1 Public Interface


6.1.1 Ordinary 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.

Function: enqueue (data name queue &optional charset)

Append DATA into QUEUE named NAME.

Package

cl-httpsqs.

Source

cl-httpsqs.lisp.

Function: fetch-json-status (name queue)

Returns a JSON string of the QUEUE’s status.

Package

cl-httpsqs.

Source

cl-httpsqs.lisp.

Function: make-queue (host port &optional auth)
Package

cl-httpsqs.

Source

cl-httpsqs.lisp.

Function: print-status (name queue)

Display the current status of QUEUE.

Package

cl-httpsqs.

Source

cl-httpsqs.lisp.

Function: reset (name queue)

Reset the QUEUE.

Package

cl-httpsqs.

Source

cl-httpsqs.lisp.

Function: set-max (name num queue)

Set the max number of elements in QUEUE.

Package

cl-httpsqs.

Source

cl-httpsqs.lisp.

Function: set-sync-time (name queue seconds)

Set interval in seconds for auto flush of QUEUE.

Package

cl-httpsqs.

Source

cl-httpsqs.lisp.

Function: view (name pos queue)

View the element at POS in QUEUE.

Package

cl-httpsqs.

Source

cl-httpsqs.lisp.


6.2 Internals


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

6.2.1 Ordinary 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.

Function: make-queue-uri (queue)
Package

cl-httpsqs.

Source

cl-httpsqs.lisp.


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

6.2.2 Generic functions

Generic Reader: queue-auth (object)
Package

cl-httpsqs.

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

automatically generated reader method

Source

cl-httpsqs.lisp.

Target Slot

auth.

Generic Reader: queue-host (object)
Package

cl-httpsqs.

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

automatically generated reader method

Source

cl-httpsqs.lisp.

Target Slot

host.

Generic Reader: queue-port (object)
Package

cl-httpsqs.

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

automatically generated reader method

Source

cl-httpsqs.lisp.

Target Slot

port.


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

6.2.3 Conditions

Condition: httpsqs-auth-failed
Package

cl-httpsqs.

Source

cl-httpsqs.lisp.

Direct superclasses

httpsqs-error.

Condition: httpsqs-enqueue-error
Package

cl-httpsqs.

Source

cl-httpsqs.lisp.

Direct superclasses

httpsqs-error.

Condition: httpsqs-error
Package

cl-httpsqs.

Source

cl-httpsqs.lisp.

Direct superclasses

error.

Direct subclasses
Condition: httpsqs-reset-error
Package

cl-httpsqs.

Source

cl-httpsqs.lisp.

Direct superclasses

httpsqs-error.


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

6.2.4 Classes

Class: <httpsqs>
Package

cl-httpsqs.

Source

cl-httpsqs.lisp.

Direct methods
Direct slots
Slot: auth
Type

string

Initargs

:auth

Readers

queue-auth.

Writers

This slot is read-only.

Slot: host
Type

string

Initargs

:host

Readers

queue-host.

Writers

This slot is read-only.

Slot: port
Type

integer

Initargs

:port

Readers

queue-port.

Writers

This slot is read-only.


Appendix A Indexes


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

A.1 Concepts


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: Public ordinary functions

E
enqueue: Public ordinary functions

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

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

H
http-request: Private ordinary functions

M
make-queue: Public ordinary functions
make-queue-uri: Private ordinary functions
Method, queue-auth: Private generic functions
Method, queue-host: Private generic functions
Method, queue-port: Private generic functions

P
print-status: Public ordinary functions

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

R
reset: Public ordinary functions

S
set-max: Public ordinary functions
set-sync-time: Public ordinary functions

V
view: Public ordinary 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: Private classes

H
host: Private classes

P
port: Private classes

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

Jump to:   A   H   P   S