The gcm Reference Manual

This is the gcm Reference Manual, generated automatically by Declt version 4.0 beta 2 "William Riker" on Mon Feb 26 16:28:28 2024 GMT+0.

Table of Contents


1 Introduction


2 Systems

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


2.1 gcm

Google Cloud Messaging (GCM) library for Common Lisp

Author

death

License

MIT

Dependencies
  • drakma (system).
  • com.gigamonkeys.json (system).
  • babel (system).
Source

gcm.asd.

Child Component

gcm.lisp (file).


3 Files

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


3.1 Lisp


3.1.1 gcm/gcm.asd

Source

gcm.asd.

Parent Component

gcm (system).

ASDF Systems

gcm.


3.1.2 gcm/gcm.lisp

Source

gcm.asd.

Parent Component

gcm (system).

Packages

gcm.

Public Interface
Internals

4 Packages

Packages are listed by definition order.


4.1 gcm

Source

gcm.lisp.

Use List

common-lisp.

Public Interface
Internals

5 Definitions

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


5.1 Public Interface


5.1.1 Special variables

Special Variable: *config*
Package

gcm.

Source

gcm.lisp.

Special Variable: *registration-ids*
Package

gcm.

Source

gcm.lisp.


5.1.2 Ordinary functions

Function: configure (api-key &rest options)
Package

gcm.

Source

gcm.lisp.

Function: send (message &key config registration-ids)
Package

gcm.

Source

gcm.lisp.

Function: set-registration-ids (registration-ids)
Package

gcm.

Source

gcm.lisp.


5.1.3 Generic functions

Generic Reader: config-api-key (object)
Package

gcm.

Methods
Reader Method: config-api-key ((config config))

automatically generated reader method

Source

gcm.lisp.

Target Slot

api-key.

Generic Reader: config-dry-run-p (object)
Package

gcm.

Methods
Reader Method: config-dry-run-p ((config config))

automatically generated reader method

Source

gcm.lisp.

Target Slot

dry-run.

Generic Reader: config-send-endpoint (object)
Package

gcm.

Methods
Reader Method: config-send-endpoint ((config config))

automatically generated reader method

Source

gcm.lisp.

Target Slot

send-endpoint.

Generic Reader: config-timeout (object)
Package

gcm.

Methods
Reader Method: config-timeout ((config config))

automatically generated reader method

Source

gcm.lisp.

Target Slot

timeout.

Generic Reader: message-collapse-key (object)
Package

gcm.

Methods
Reader Method: message-collapse-key ((message message))

automatically generated reader method

Source

gcm.lisp.

Target Slot

collapse-key.

Generic Reader: message-delay-while-idle-p (object)
Package

gcm.

Methods
Reader Method: message-delay-while-idle-p ((message message))

automatically generated reader method

Source

gcm.lisp.

Target Slot

delay-while-idle.

Generic Reader: message-payload (object)
Package

gcm.

Methods
Reader Method: message-payload ((message message))

automatically generated reader method

Source

gcm.lisp.

Target Slot

payload.

Generic Reader: message-time-to-live (object)
Package

gcm.

Methods
Reader Method: message-time-to-live ((message message))

automatically generated reader method

Source

gcm.lisp.

Target Slot

time-to-live.

Generic Reader: raw-json (object)
Package

gcm.

Source

gcm.lisp.

Methods
Reader Method: raw-json ((result result))

automatically generated reader method

Target Slot

raw-json.

Reader Method: raw-json ((response response))

automatically generated reader method

Target Slot

raw-json.

Generic Reader: response-canonical-ids (object)
Package

gcm.

Methods
Reader Method: response-canonical-ids ((response response))

automatically generated reader method

Source

gcm.lisp.

Target Slot

canonical-ids.

Generic Reader: response-failure (object)
Package

gcm.

Methods
Reader Method: response-failure ((response response))

automatically generated reader method

Source

gcm.lisp.

Target Slot

failure.

Generic Reader: response-multicast-id (object)
Package

gcm.

Methods
Reader Method: response-multicast-id ((response response))

automatically generated reader method

Source

gcm.lisp.

Target Slot

multicast-id.

Generic Reader: response-results (object)
Package

gcm.

Methods
Reader Method: response-results ((response response))

automatically generated reader method

Source

gcm.lisp.

Target Slot

results.

Generic Reader: response-success (object)
Package

gcm.

Methods
Reader Method: response-success ((response response))

automatically generated reader method

Source

gcm.lisp.

Target Slot

success.

Generic Reader: result-error-string (object)
Package

gcm.

Methods
Reader Method: result-error-string ((result result))

automatically generated reader method

Source

gcm.lisp.

Target Slot

error-string.

Generic Reader: result-message-id (object)
Package

gcm.

Methods
Reader Method: result-message-id ((result result))

automatically generated reader method

Source

gcm.lisp.

Target Slot

message-id.

Generic Reader: send-failure-code (condition)
Package

gcm.

Methods
Reader Method: send-failure-code ((condition send-failure))
Source

gcm.lisp.

Target Slot

code.

Generic Reader: send-failure-response (condition)
Package

gcm.

Methods
Reader Method: send-failure-response ((condition send-failure))
Source

gcm.lisp.

Target Slot

response.


5.1.4 Standalone methods

Method: initialize-instance :after ((message message) &key)
Source

gcm.lisp.

Method: to-json ((message message))
Package

com.gigamonkeys.json.

Source

gcm.lisp.


5.1.5 Conditions

Condition: gcm-error
Package

gcm.

Source

gcm.lisp.

Direct superclasses

error.

Direct subclasses

send-failure.

Condition: send-failure
Package

gcm.

Source

gcm.lisp.

Direct superclasses

gcm-error.

Direct methods
Direct slots
Slot: code
Initargs

:code

Readers

send-failure-code.

Writers

This slot is read-only.

Slot: response
Initargs

:response

Readers

send-failure-response.

Writers

This slot is read-only.


5.1.6 Classes

Class: config
Package

gcm.

Source

gcm.lisp.

Direct methods
Direct Default Initargs
InitargValue
:dry-runnil
:send-endpointhttps://android.googleapis.com/gcm/send
:timeout20
:api-keynil
Direct slots
Slot: api-key
Initargs

:api-key

Readers

config-api-key.

Writers

This slot is read-only.

Slot: dry-run
Initargs

:dry-run

Readers

config-dry-run-p.

Writers

This slot is read-only.

Slot: send-endpoint
Initargs

:send-endpoint

Readers

config-send-endpoint.

Writers

This slot is read-only.

Slot: timeout
Initargs

:timeout

Readers

config-timeout.

Writers

This slot is read-only.

Class: message
Package

gcm.

Source

gcm.lisp.

Direct methods
Direct slots
Slot: payload
Initargs

:payload

Readers

message-payload.

Writers

This slot is read-only.

Slot: delay-while-idle
Initargs

:delay-while-idle

Readers

message-delay-while-idle-p.

Writers

This slot is read-only.

Slot: collapse-key
Initargs

:collapse-key

Readers

message-collapse-key.

Writers

This slot is read-only.

Slot: time-to-live
Initargs

:time-to-live

Readers

message-time-to-live.

Writers

This slot is read-only.

Class: response
Package

gcm.

Source

gcm.lisp.

Direct methods
Direct slots
Slot: multicast-id
Readers

response-multicast-id.

Writers

This slot is read-only.

Slot: success
Initform

0

Readers

response-success.

Writers

This slot is read-only.

Slot: failure
Initform

0

Readers

response-failure.

Writers

This slot is read-only.

Slot: canonical-ids
Initform

0

Readers

response-canonical-ids.

Writers

This slot is read-only.

Slot: results
Initform

#()

Readers

response-results.

Writers

This slot is read-only.

Slot: raw-json
Initargs

:raw-json

Readers

raw-json.

Writers

This slot is read-only.

Class: result
Package

gcm.

Source

gcm.lisp.

Direct methods
Direct slots
Slot: message-id
Readers

result-message-id.

Writers

This slot is read-only.

Slot: error-string
Readers

result-error-string.

Writers

This slot is read-only.

Slot: raw-json
Initargs

:raw-json

Readers

raw-json.

Writers

This slot is read-only.


5.2 Internals


5.2.1 Ordinary functions

Function: cat (&rest strings)
Package

gcm.

Source

gcm.lisp.

Function: json-bool (x)
Package

gcm.

Source

gcm.lisp.

Function: parse-response (json)
Package

gcm.

Source

gcm.lisp.

Function: parse-result (json)
Package

gcm.

Source

gcm.lisp.

Function: report-send-failure (condition stream)
Package

gcm.

Source

gcm.lisp.

Function: require-config (config)
Package

gcm.

Source

gcm.lisp.

Function: send-body (message registration-ids config)
Package

gcm.

Source

gcm.lisp.


Appendix A Indexes


A.1 Concepts


A.2 Functions

Jump to:   C   F   G   I   J   M   P   R   S   T  
Index Entry  Section

C
cat: Private ordinary functions
config-api-key: Public generic functions
config-api-key: Public generic functions
config-dry-run-p: Public generic functions
config-dry-run-p: Public generic functions
config-send-endpoint: Public generic functions
config-send-endpoint: Public generic functions
config-timeout: Public generic functions
config-timeout: Public generic functions
configure: Public ordinary functions

F
Function, cat: Private ordinary functions
Function, configure: Public ordinary functions
Function, json-bool: Private ordinary functions
Function, parse-response: Private ordinary functions
Function, parse-result: Private ordinary functions
Function, report-send-failure: Private ordinary functions
Function, require-config: Private ordinary functions
Function, send: Public ordinary functions
Function, send-body: Private ordinary functions
Function, set-registration-ids: Public ordinary functions

G
Generic Function, config-api-key: Public generic functions
Generic Function, config-dry-run-p: Public generic functions
Generic Function, config-send-endpoint: Public generic functions
Generic Function, config-timeout: Public generic functions
Generic Function, message-collapse-key: Public generic functions
Generic Function, message-delay-while-idle-p: Public generic functions
Generic Function, message-payload: Public generic functions
Generic Function, message-time-to-live: Public generic functions
Generic Function, raw-json: Public generic functions
Generic Function, response-canonical-ids: Public generic functions
Generic Function, response-failure: Public generic functions
Generic Function, response-multicast-id: Public generic functions
Generic Function, response-results: Public generic functions
Generic Function, response-success: Public generic functions
Generic Function, result-error-string: Public generic functions
Generic Function, result-message-id: Public generic functions
Generic Function, send-failure-code: Public generic functions
Generic Function, send-failure-response: Public generic functions

I
initialize-instance: Public standalone methods

J
json-bool: Private ordinary functions

M
message-collapse-key: Public generic functions
message-collapse-key: Public generic functions
message-delay-while-idle-p: Public generic functions
message-delay-while-idle-p: Public generic functions
message-payload: Public generic functions
message-payload: Public generic functions
message-time-to-live: Public generic functions
message-time-to-live: Public generic functions
Method, config-api-key: Public generic functions
Method, config-dry-run-p: Public generic functions
Method, config-send-endpoint: Public generic functions
Method, config-timeout: Public generic functions
Method, initialize-instance: Public standalone methods
Method, message-collapse-key: Public generic functions
Method, message-delay-while-idle-p: Public generic functions
Method, message-payload: Public generic functions
Method, message-time-to-live: Public generic functions
Method, raw-json: Public generic functions
Method, raw-json: Public generic functions
Method, response-canonical-ids: Public generic functions
Method, response-failure: Public generic functions
Method, response-multicast-id: Public generic functions
Method, response-results: Public generic functions
Method, response-success: Public generic functions
Method, result-error-string: Public generic functions
Method, result-message-id: Public generic functions
Method, send-failure-code: Public generic functions
Method, send-failure-response: Public generic functions
Method, to-json: Public standalone methods

P
parse-response: Private ordinary functions
parse-result: Private ordinary functions

R
raw-json: Public generic functions
raw-json: Public generic functions
raw-json: Public generic functions
report-send-failure: Private ordinary functions
require-config: Private ordinary functions
response-canonical-ids: Public generic functions
response-canonical-ids: Public generic functions
response-failure: Public generic functions
response-failure: Public generic functions
response-multicast-id: Public generic functions
response-multicast-id: Public generic functions
response-results: Public generic functions
response-results: Public generic functions
response-success: Public generic functions
response-success: Public generic functions
result-error-string: Public generic functions
result-error-string: Public generic functions
result-message-id: Public generic functions
result-message-id: Public generic functions

S
send: Public ordinary functions
send-body: Private ordinary functions
send-failure-code: Public generic functions
send-failure-code: Public generic functions
send-failure-response: Public generic functions
send-failure-response: Public generic functions
set-registration-ids: Public ordinary functions

T
to-json: Public standalone methods


A.3 Variables

Jump to:   *  
A   C   D   E   F   M   P   R   S   T  
Index Entry  Section

*
*config*: Public special variables
*registration-ids*: Public special variables

A
api-key: Public classes

C
canonical-ids: Public classes
code: Public conditions
collapse-key: Public classes

D
delay-while-idle: Public classes
dry-run: Public classes

E
error-string: Public classes

F
failure: Public classes

M
message-id: Public classes
multicast-id: Public classes

P
payload: Public classes

R
raw-json: Public classes
raw-json: Public classes
response: Public conditions
results: Public classes

S
send-endpoint: Public classes
Slot, api-key: Public classes
Slot, canonical-ids: Public classes
Slot, code: Public conditions
Slot, collapse-key: Public classes
Slot, delay-while-idle: Public classes
Slot, dry-run: Public classes
Slot, error-string: Public classes
Slot, failure: Public classes
Slot, message-id: Public classes
Slot, multicast-id: Public classes
Slot, payload: Public classes
Slot, raw-json: Public classes
Slot, raw-json: Public classes
Slot, response: Public conditions
Slot, results: Public classes
Slot, send-endpoint: Public classes
Slot, success: Public classes
Slot, time-to-live: Public classes
Slot, timeout: Public classes
Special Variable, *config*: Public special variables
Special Variable, *registration-ids*: Public special variables
success: Public classes

T
time-to-live: Public classes
timeout: Public classes