The cl-growl Reference Manual
Table of Contents
The cl-growl Reference Manual
This is the cl-growl Reference Manual, version 1.2.20161206,
generated automatically by Declt version 3.0 "Montgomery Scott"
on Tue Dec 22 12:22:20 2020 GMT+0.
1 Introduction
CL-Growl Client Library
Growl is a notification system originally written for Mac OS
X, but now supported on Windows and Linux. Growl
supports a small network protocol over UDP called GNTP. This
is a Common Lisp client library for registering an application with
Growl and sending Growl notifications on behalf of the registered
application.
Obtaining the code
Usage
Before your application can start sending messages to Growl, it needs
to register the notification types it intends to send. On the
receiving end, the message display can be customized based on the
notification type. Here is a simple example showing some of the many
options to the register
function for an application called Lambda
Fun with four types of messages: debug, info, warn, and error
where debug messages are not displayed unless you tweak your Growl
preferences to display them:
(growl:register
:app "Lambda Fun"
:app-icon "http://nklein.com/favicon.ico"
:enabled '( "info" "warn" "error" )
:disabled '( "debug" )
:host "localhost"
:port 23053
:password "growl-password"
:checksum-mode :sha256)
See (documentation #'growl:register t)
for a description of the
other parameters available when calling register
.
After an application has been registered once (from anywhere, in any
process), you can send a message Cannot connect to database! with
the title Critical Error of type Error with priority 2 that will
stay showing on the receiving desktop with:
(growl:notify "Cannot cannoect to database!"
:title "Critical Error"
:priority 2
:sticky t)
See (documentation #'growl:notify t)
for a description of the
other parameters available when calling notify
.
Almost all of the parameters to both register
and notify
take
their default values from special variables which can be rebound by
your application. Here are the available variables. You can use
(documentation <variable-name> 'variable)
to see documentation for
each of these variables.
*growl-default-host* ; initially "localhost"
*growl-default-port* ; initially 23053
*growl-default-app*
*growl-default-app-icon*
*growl-default-salt*
*growl-default-iv*
*growl-default-notification*
*growl-default-title*
*growl-default-priority*
*growl-default-icon*
*growl-default-callback-context*
*growl-default-callback-context-type*
*growl-default-callback-target*
*growl-default-origin-fields*
*growl-default-custom-fields*
*growl-default-application-fields*
*growl-default-checksum-mode*
*growl-default-encryption-mode*
*growl-default-password*
Compatibility
This library does not currently implement the subscribe
protocol
method of GNTP.
Currently, the Mac OS X Growl server does not support any of the
encryption modes that Growl for Windows supports.
2 Systems
The main system appears first, followed by any subsystem dependency.
2.1 cl-growl
- Maintainer
Patrick Stein <pat@nklein.com>
- Author
Patrick Stein <pat@nklein.com>
- License
Public Domain
- Description
Utilities for sending messages to Growl on Mac OS X.
- Version
1.2.20161206
- Dependencies
- trivial-utf-8
- usocket
- flexi-streams
- ironclad
- Source
cl-growl.asd (file)
- Component
src (module)
3 Modules
Modules are listed depth-first from the system components tree.
3.1 cl-growl/src
- Parent
cl-growl (system)
- Location
src/
- Components
-
4 Files
Files are sorted by type and then listed depth-first from the systems
components trees.
4.1 Lisp
4.1.1 cl-growl.asd
- Location
cl-growl.asd
- Systems
cl-growl (system)
4.1.2 cl-growl/src/package.lisp
- Parent
src (module)
- Location
src/package.lisp
- Packages
cl-growl
4.1.3 cl-growl/src/constants.lisp
- Dependency
package.lisp (file)
- Parent
src (module)
- Location
src/constants.lisp
- Internal Definitions
-
4.1.4 cl-growl/src/types.lisp
- Dependency
package.lisp (file)
- Parent
src (module)
- Location
src/types.lisp
- Internal Definitions
-
4.1.5 cl-growl/src/utils.lisp
- Dependency
package.lisp (file)
- Parent
src (module)
- Location
src/utils.lisp
- Internal Definitions
-
4.1.6 cl-growl/src/specials.lisp
- Dependencies
-
- Parent
src (module)
- Location
src/specials.lisp
- Exported Definitions
-
- Internal Definitions
-
4.1.7 cl-growl/src/gntp.lisp
- Dependencies
-
- Parent
src (module)
- Location
src/gntp.lisp
- Internal Definitions
-
4.1.8 cl-growl/src/register.lisp
- Dependencies
-
- Parent
src (module)
- Location
src/register.lisp
- Exported Definitions
register (function)
4.1.9 cl-growl/src/notify.lisp
- Dependencies
-
- Parent
src (module)
- Location
src/notify.lisp
- Exported Definitions
notify (function)
5 Packages
Packages are listed by definition order.
5.1 cl-growl
- Source
package.lisp (file)
- Nickname
growl
- Use List
- trivial-utf-8
- common-lisp
- Exported Definitions
-
- Internal Definitions
-
6 Definitions
Definitions are sorted by export status, category, package, and then by
lexicographic order.
6.1 Exported definitions
6.1.1 Special variables
- Special Variable: *growl-default-app*
-
This is the default name by which your application will identify
itself to the Growl server.
- Package
cl-growl
- Source
specials.lisp (file)
- Special Variable: *growl-default-app-icon*
-
If not NIL, this icon will be transmitted to the Growl server.
It can be either an encoded image stored in a one-dimensional
binary array or a URL for the icon image to use.
- Package
cl-growl
- Source
specials.lisp (file)
- Special Variable: *growl-default-callback-context*
-
If not NIL, this will be the default context supplied to
a callback for the notification. Growl invokes a callback
when the user clicks the notification, when the user closes
the notification, or when the notification times out.
- Package
cl-growl
- Source
specials.lisp (file)
- Special Variable: *growl-default-callback-context-type*
-
If not NIL, this specifies the context type information
supplied to the callback for the notification.
- Package
cl-growl
- Source
specials.lisp (file)
- Special Variable: *growl-default-callback-target*
-
If not NIL, this should be a URL for a callback method.
This URL will be opened in the user’s default browser
if the user clicks the notification.
- Package
cl-growl
- Source
specials.lisp (file)
- Special Variable: *growl-default-checksum-mode*
-
Default hash algorithm to use. It must be a valid
GROWL-CHECKSUM-MODE.
- Package
cl-growl
- Source
specials.lisp (file)
- Special Variable: *growl-default-custom-fields*
-
GNTP allows custom fields in the Growl message headers.
This must be a LIST of CONS cells. The CAR of each
cell is the field name. The CDR of each cell is the
field value. The value can either be a string or
a one-dimensional binary array.
- Package
cl-growl
- Source
specials.lisp (file)
- Special Variable: *growl-default-encryption-mode*
-
Default encryption algorithm to use. It could be :AES,
:DES, :3DES, or :NONE. You need Ironclad to do anything
other than :NONE.
- Package
cl-growl
- Source
specials.lisp (file)
- Special Variable: *growl-default-host*
-
This is the default hostname of the Growl server
- Package
cl-growl
- Source
specials.lisp (file)
- Special Variable: *growl-default-icon*
-
If not NIL, this is the default notification-icon that
will be transmitted to the Growl server along with your
notification events. It can be either an encoded image
stored in a one-dimensional binary array or a URL for the
icon image to use.
- Package
cl-growl
- Source
specials.lisp (file)
- Special Variable: *growl-default-notification*
-
This is the default notification level to use when sending
notification events to the Growl server.
- Package
cl-growl
- Source
specials.lisp (file)
- Special Variable: *growl-default-origin-fields*
-
GNTP allows fields that describe the system/software
that generated the message.
This must be a LIST of CONS cells. The CAR of each
cell is the field name. The CDR of each cell is the
field value. The value can either be a string or
a one-dimensional binary array.
- Package
cl-growl
- Source
specials.lisp (file)
- Special Variable: *growl-default-password*
-
Default password to use if the hash algorithm is not :NONE
- Package
cl-growl
- Source
specials.lisp (file)
- Special Variable: *growl-default-port*
-
This is the default port number the Growl server is listening on.
This is the GNTP default port.
- Package
cl-growl
- Source
specials.lisp (file)
- Special Variable: *growl-default-priority*
-
If not NIL, this is the default priority used when sending
notification events to the Growl server.
- Package
cl-growl
- Source
specials.lisp (file)
- Special Variable: *growl-default-salt*
-
This can be either a function of no arguments used to generate
a binary array or string as a salt, a fixed binary array,
or a fixed string.
- Package
cl-growl
- Source
specials.lisp (file)
- Special Variable: *growl-default-title*
-
This is the default message title to use when sending
notification events to the Growl server.
- Package
cl-growl
- Source
specials.lisp (file)
6.1.2 Functions
- Function: notify BODY &key APP NOTIFICATION ID TITLE STICKY PRIORITY ICON COALESCE CALLBACK-CONTEXT CALLBACK-CONTEXT-TYPE CALLBACK-TARGET HOST PORT CHECKSUM-MODE ENCRYPTION-MODE PASSWORD SALT IV
-
Send a notification with TITLE as its title and BODY as its text
body. The notificiation is from the APP and with notification name
NOTIFICATION. It has an ID that is hopefully unique to this
notification. And, it has an advisory PRIORITY on the range
[-2,2] (unless PRIORITY is nil). The app can request that the
notification be STICKY.
This notice can specify its own ICON either by URL or by sending
along the binary data.
If a COALESCE is given, it should contain the ID of a previously
sent notification that should be updated or replaced by this one.
If a CALLBACK-CONTEXT string is given, it specifies that GROWL
should send a message back on this notification’s socket when the
user click the message, closes the message, or when the message
times out. If CALLBACK-CONTEXT is non-nil (and non-empty), then
CALLBACK-CONTEXT-TYPE must also be non-nil (and non-empty). The
CALLBACK-CONTEXT and CALLBACK-CONTEXT-TYPE are returned in the
callback.
If a CALLBACK-TARGET is specified, it must be a URL. If the user
clicks on a notification with a CALLBACK-TARGET, the user’s default
browser is opened to the CALLBACK-TARGET URL.
If SALT is an array of unsigned bytes, it will be used directly.
If SALT is a string, it will be converted to an array of unsigned
bytes using a UTF-8 encoding. If SALT is a function, it will be
invoked with zero arguments and can either return an array of
unsigned bytes or a string.
This function returns (VALUES STREAM ID). STREAM will be NIL if
there is no CALLBACK-CONTEXT. It will be a stream for the socket
on which the callback will arrive if a CALLBACK-CONTEXT was
given. ID will be the notification ID used for this message.
- Package
cl-growl
- Source
notify.lisp (file)
- Function: register &key APP APP-ICON ENABLED DISABLED ORIGIN-FIELDS CUSTOM-FIELDS APPLICATION-FIELDS HOST PORT CHECKSUM-MODE ENCRYPTION-MODE PASSWORD SALT IV
-
Register as the application named APP with the ENABLED
notifications turned on and the DISABLED notifications turned off
by default.
The ENABLED and DISABLED parameters are lists. The list elements
of the ENABLED and DISABLED parameters can be either a string or a
list. If it is a string, it is the name of a notification. If it
is a list, it can have either one, two, or three members. The
first member is the notification name, the second member (if
present) is the human-readable notification name, and the third
member (if present) is the notification icon. The third item can
be either a URL to the notification icon or a one-dimensional
binary vector containing the encoded icon image.
- Package
cl-growl
- Source
register.lisp (file)
6.2 Internal definitions
6.2.1 Constants
- Constant: +growl-notify-message-type+
-
Message type for notify messages.
- Package
cl-growl
- Source
constants.lisp (file)
- Constant: +growl-protocol-version+
-
GNTP Protocol Version
- Package
cl-growl
- Source
constants.lisp (file)
- Constant: +growl-register-message-type+
-
Message type for register messages.
- Package
cl-growl
- Source
constants.lisp (file)
- Constant: +growl-subscribe-message-type+
-
Message type for subscribe messages.
- Package
cl-growl
- Source
constants.lisp (file)
6.2.2 Special variables
- Special Variable: *growl-default-application-fields*
-
GNTP allows app-specific field in the Growl message headers.
This must be a LIST of CONS cells. The CAR of each
cell is the field name. The CDR of each cell is the
field value. The value can either be a string or
a one-dimensional binary array.
- Package
cl-growl
- Source
specials.lisp (file)
- Special Variable: *growl-default-iv*
-
This can be either a function that takes the encryption
mode and returns a binary array or string as a salt, a
fixed binary array, or a fixed string.
- Package
cl-growl
- Source
specials.lisp (file)
6.2.3 Macros
- Macro: define-constant NAME VALUE &optional DOC
-
- Package
cl-growl
- Source
constants.lisp (file)
- Macro: with-output-to-binary-string &body BODY
-
- Package
cl-growl
- Source
utils.lisp (file)
- Macro: with-utf-8-strings (&rest NAMES) &body BODY
-
- Package
cl-growl
- Source
utils.lisp (file)
6.2.4 Functions
- Function: 3des PAYLOAD KEY IV
-
- Package
cl-growl
- Source
utils.lisp (file)
- Function: aes PAYLOAD KEY IV
-
- Package
cl-growl
- Source
utils.lisp (file)
- Function: app-hdr-line HDR DATA-HASH
-
- Package
cl-growl
- Source
gntp.lisp (file)
- Function: checksum PAYLOAD PASSWORD CHECKSUM-MODE
-
- Package
cl-growl
- Source
utils.lisp (file)
- Function: compose MESSAGE-TYPE &key HEADER BINARY-DATA CHECKSUM-MODE ENCRYPTION-MODE PASSWORD SALT IV
-
- Package
cl-growl
- Source
gntp.lisp (file)
- Function: custom-hdr-line HDR DATA-HASH
-
- Package
cl-growl
- Source
gntp.lisp (file)
- Function: des PAYLOAD KEY IV
-
- Package
cl-growl
- Source
utils.lisp (file)
- Function: echo-all-bytes STREAM &optional BUFFER
-
- Package
cl-growl
- Source
utils.lisp (file)
- Function: encode-binary-data ID VALUE &key ENCRYPTION-MODE KEY IV
-
- Package
cl-growl
- Source
gntp.lisp (file)
- Function: encrypt PAYLOAD ENCRYPTION-MODE KEY IV
-
- Package
cl-growl
- Source
utils.lisp (file)
- Function: generate-iv ENCRYPTION-MODE
-
- Package
cl-growl
- Source
utils.lisp (file)
- Function: generate-random-bytes BYTE-COUNT
-
- Package
cl-growl
- Source
utils.lisp (file)
- Function: generate-salt SALT-BYTE-COUNT
-
- Package
cl-growl
- Source
utils.lisp (file)
- Function: generate-unique-id ITEM
-
- Package
cl-growl
- Source
utils.lisp (file)
- Function: hdr-line KEY VALUE DATA-HASH
-
- Package
cl-growl
- Source
gntp.lisp (file)
- Function: hdr-terpri ()
-
- Package
cl-growl
- Source
gntp.lisp (file)
- Function: hex-encode BYTES
-
- Package
cl-growl
- Source
utils.lisp (file)
- Function: ironclad-encrypt NAME PAYLOAD KEY IV
-
- Package
cl-growl
- Source
utils.lisp (file)
- Function: make-encryption-hdr ENCRYPTION-MODE IV
-
- Package
cl-growl
- Source
gntp.lisp (file)
- Function: make-key CHECKSUM-MODE PASSWORD SALT
-
- Package
cl-growl
- Source
gntp.lisp (file)
- Function: make-password-hash-hdr KEY CHECKSUM-MODE SALT
-
- Package
cl-growl
- Source
gntp.lisp (file)
- Function: md5 BUFFER PASSWORD
-
- Package
cl-growl
- Source
utils.lisp (file)
- Function: noauth BUFFER PASSWORD
-
- Package
cl-growl
- Source
utils.lisp (file)
- Function: notice-decl NN ENABLED DATA-HASH
-
- Package
cl-growl
- Source
gntp.lisp (file)
- Function: optional-icon II
-
- Package
cl-growl
- Source
gntp.lisp (file)
- Function: optional-id ID
-
- Package
cl-growl
- Source
gntp.lisp (file)
- Function: optional-string SS
-
- Package
cl-growl
- Source
gntp.lisp (file)
- Function: origin-hdr-line HDR DATA-HASH
-
- Package
cl-growl
- Source
gntp.lisp (file)
- Function: pkcs7-pad PAYLOAD BLOCK-LEN
-
- Package
cl-growl
- Source
utils.lisp (file)
- Function: report-incompatible-encryption-and-checksum-error ERR STREAM
-
- Package
cl-growl
- Source
types.lisp (file)
- Function: report-unavailable-checksum-error ERR STREAM
-
- Package
cl-growl
- Source
types.lisp (file)
- Function: report-unavailable-encryption-error ERR STREAM
-
- Package
cl-growl
- Source
types.lisp (file)
- Function: report-unsupported-iv-type-error ERR STREAM
-
- Package
cl-growl
- Source
types.lisp (file)
- Function: report-unsupported-salt-type-error ERR STREAM
-
- Package
cl-growl
- Source
types.lisp (file)
- Function: require-iv IV ENCRYPTION-MODE
-
- Package
cl-growl
- Source
gntp.lisp (file)
- Function: require-salt SALT
-
- Package
cl-growl
- Source
gntp.lisp (file)
- Function: required-id ID
-
- Package
cl-growl
- Source
gntp.lisp (file)
- Function: required-string SS
-
- Package
cl-growl
- Source
gntp.lisp (file)
- Function: required-value VV
-
- Package
cl-growl
- Source
gntp.lisp (file)
- Function: sha1 BUFFER PASSWORD
-
- Package
cl-growl
- Source
utils.lisp (file)
- Function: sha256 BUFFER PASSWORD
-
- Package
cl-growl
- Source
utils.lisp (file)
- Function: valid-encryption-checksum-combo ENCRYPTION-MODE CHECKSUM-MODE
-
- Package
cl-growl
- Source
gntp.lisp (file)
- Function: valid-field FF
-
- Package
cl-growl
- Source
gntp.lisp (file)
- Function: valid-notice-decl NN
-
- Package
cl-growl
- Source
gntp.lisp (file)
- Function: valid-origin-field FF
-
- Package
cl-growl
- Source
gntp.lisp (file)
- Function: valid-port PP
-
- Package
cl-growl
- Source
gntp.lisp (file)
- Function: valid-priority PP
-
- Package
cl-growl
- Source
gntp.lisp (file)
- Function: write-short SS STREAM
-
- Package
cl-growl
- Source
utils.lisp (file)
6.2.5 Generic functions
- Generic Function: incompatible-checksum-requested-mode CONDITION
-
- Package
cl-growl
- Methods
- Method: incompatible-checksum-requested-mode (CONDITION incompatible-encryption-and-checksum-error)
-
- Source
types.lisp (file)
- Generic Function: incompatible-encryption-requested-mode CONDITION
-
- Package
cl-growl
- Methods
- Method: incompatible-encryption-requested-mode (CONDITION incompatible-encryption-and-checksum-error)
-
- Source
types.lisp (file)
- Generic Function: unavailable-checksum-requested-mode CONDITION
-
- Package
cl-growl
- Methods
- Method: unavailable-checksum-requested-mode (CONDITION unavailable-checksum-error)
-
- Source
types.lisp (file)
- Generic Function: unavailable-encryption-requested-mode CONDITION
-
- Package
cl-growl
- Methods
- Method: unavailable-encryption-requested-mode (CONDITION unavailable-encryption-error)
-
- Source
types.lisp (file)
- Generic Function: unsupported-iv-type-encryption-mode CONDITION
-
- Package
cl-growl
- Methods
- Method: unsupported-iv-type-encryption-mode (CONDITION unsupported-iv-type-error)
-
- Source
types.lisp (file)
- Generic Function: unsupported-iv-type-iv CONDITION
-
- Package
cl-growl
- Methods
- Method: unsupported-iv-type-iv (CONDITION unsupported-iv-type-error)
-
- Source
types.lisp (file)
- Generic Function: unsupported-salt-type-salt CONDITION
-
- Package
cl-growl
- Methods
- Method: unsupported-salt-type-salt (CONDITION unsupported-salt-type-error)
-
- Source
types.lisp (file)
6.2.6 Conditions
- Condition: incompatible-encryption-and-checksum-error ()
-
- Package
cl-growl
- Source
types.lisp (file)
- Direct superclasses
error (condition)
- Direct methods
-
- Direct slots
- Slot: requested-encryption-mode
-
- Initargs
:requested-encryption-mode
- Readers
incompatible-encryption-requested-mode (generic function)
- Slot: requested-checksum-mode
-
- Initargs
:requested-checksum-mode
- Readers
incompatible-checksum-requested-mode (generic function)
- Condition: unavailable-checksum-error ()
-
- Package
cl-growl
- Source
types.lisp (file)
- Direct superclasses
error (condition)
- Direct methods
unavailable-checksum-requested-mode (method)
- Direct slots
- Slot: requested-mode
-
- Initargs
:requested-mode
- Readers
unavailable-checksum-requested-mode (generic function)
- Condition: unavailable-encryption-error ()
-
- Package
cl-growl
- Source
types.lisp (file)
- Direct superclasses
error (condition)
- Direct methods
unavailable-encryption-requested-mode (method)
- Direct slots
- Slot: requested-mode
-
- Initargs
:requested-mode
- Readers
unavailable-encryption-requested-mode (generic function)
- Condition: unsupported-iv-type-error ()
-
- Package
cl-growl
- Source
types.lisp (file)
- Direct superclasses
error (condition)
- Direct methods
-
- Direct slots
- Slot: iv
-
- Initargs
:iv
- Readers
unsupported-iv-type-iv (generic function)
- Slot: encryption-mode
-
- Initargs
:encryption-mode
- Readers
unsupported-iv-type-encryption-mode (generic function)
- Condition: unsupported-salt-type-error ()
-
- Package
cl-growl
- Source
types.lisp (file)
- Direct superclasses
error (condition)
- Direct methods
unsupported-salt-type-salt (method)
- Direct slots
- Slot: salt
-
- Initargs
:salt
- Readers
unsupported-salt-type-salt (generic function)
6.2.7 Types
- Type: growl-binary-data-type ()
-
- Package
cl-growl
- Source
types.lisp (file)
- Type: growl-checksum-mode ()
-
If you have Ironclad, you can do :SHA256, :SHA1, :MD5, or :NONE.
If you have the MD5 package, you can do :MD5 or :NONE.
If you have neither Ironclad nor MD5, you can only do :NONE.
With :NONE, you will not be able to do authenticated Growl
transactions.
- Package
cl-growl
- Source
types.lisp (file)
- Type: growl-encryption-mode ()
-
If you have Ironclad, then you can encrypt with mode :AES,
:DES, :3DES, or :NONE. If you do not have Ironclad, you
can only use the :NONE mode. You can still do authenticated
Growl transactions with encryption mode :NONE, but the
contents of the transaction will go over the network in
plain text so an eavesdropper could potentially read the
contents of the Growl.
- Package
cl-growl
- Source
types.lisp (file)
Appendix A Indexes
A.1 Concepts
| Index Entry | | Section |
|
C | | |
| cl-growl.asd: | | The cl-growl․asd file |
| cl-growl/src: | | The cl-growl/src module |
| cl-growl/src/constants.lisp: | | The cl-growl/src/constants․lisp file |
| cl-growl/src/gntp.lisp: | | The cl-growl/src/gntp․lisp file |
| cl-growl/src/notify.lisp: | | The cl-growl/src/notify․lisp file |
| cl-growl/src/package.lisp: | | The cl-growl/src/package․lisp file |
| cl-growl/src/register.lisp: | | The cl-growl/src/register․lisp file |
| cl-growl/src/specials.lisp: | | The cl-growl/src/specials․lisp file |
| cl-growl/src/types.lisp: | | The cl-growl/src/types․lisp file |
| cl-growl/src/utils.lisp: | | The cl-growl/src/utils․lisp file |
|
F | | |
| File, Lisp, cl-growl.asd: | | The cl-growl․asd file |
| File, Lisp, cl-growl/src/constants.lisp: | | The cl-growl/src/constants․lisp file |
| File, Lisp, cl-growl/src/gntp.lisp: | | The cl-growl/src/gntp․lisp file |
| File, Lisp, cl-growl/src/notify.lisp: | | The cl-growl/src/notify․lisp file |
| File, Lisp, cl-growl/src/package.lisp: | | The cl-growl/src/package․lisp file |
| File, Lisp, cl-growl/src/register.lisp: | | The cl-growl/src/register․lisp file |
| File, Lisp, cl-growl/src/specials.lisp: | | The cl-growl/src/specials․lisp file |
| File, Lisp, cl-growl/src/types.lisp: | | The cl-growl/src/types․lisp file |
| File, Lisp, cl-growl/src/utils.lisp: | | The cl-growl/src/utils․lisp file |
|
L | | |
| Lisp File, cl-growl.asd: | | The cl-growl․asd file |
| Lisp File, cl-growl/src/constants.lisp: | | The cl-growl/src/constants․lisp file |
| Lisp File, cl-growl/src/gntp.lisp: | | The cl-growl/src/gntp․lisp file |
| Lisp File, cl-growl/src/notify.lisp: | | The cl-growl/src/notify․lisp file |
| Lisp File, cl-growl/src/package.lisp: | | The cl-growl/src/package․lisp file |
| Lisp File, cl-growl/src/register.lisp: | | The cl-growl/src/register․lisp file |
| Lisp File, cl-growl/src/specials.lisp: | | The cl-growl/src/specials․lisp file |
| Lisp File, cl-growl/src/types.lisp: | | The cl-growl/src/types․lisp file |
| Lisp File, cl-growl/src/utils.lisp: | | The cl-growl/src/utils․lisp file |
|
M | | |
| Module, cl-growl/src: | | The cl-growl/src module |
|
A.2 Functions
| Index Entry | | Section |
|
3 | | |
| 3des : | | Internal functions |
|
A | | |
| aes : | | Internal functions |
| app-hdr-line : | | Internal functions |
|
C | | |
| checksum : | | Internal functions |
| compose : | | Internal functions |
| custom-hdr-line : | | Internal functions |
|
D | | |
| define-constant : | | Internal macros |
| des : | | Internal functions |
|
E | | |
| echo-all-bytes : | | Internal functions |
| encode-binary-data : | | Internal functions |
| encrypt : | | Internal functions |
|
F | | |
| Function, 3des : | | Internal functions |
| Function, aes : | | Internal functions |
| Function, app-hdr-line : | | Internal functions |
| Function, checksum : | | Internal functions |
| Function, compose : | | Internal functions |
| Function, custom-hdr-line : | | Internal functions |
| Function, des : | | Internal functions |
| Function, echo-all-bytes : | | Internal functions |
| Function, encode-binary-data : | | Internal functions |
| Function, encrypt : | | Internal functions |
| Function, generate-iv : | | Internal functions |
| Function, generate-random-bytes : | | Internal functions |
| Function, generate-salt : | | Internal functions |
| Function, generate-unique-id : | | Internal functions |
| Function, hdr-line : | | Internal functions |
| Function, hdr-terpri : | | Internal functions |
| Function, hex-encode : | | Internal functions |
| Function, ironclad-encrypt : | | Internal functions |
| Function, make-encryption-hdr : | | Internal functions |
| Function, make-key : | | Internal functions |
| Function, make-password-hash-hdr : | | Internal functions |
| Function, md5 : | | Internal functions |
| Function, noauth : | | Internal functions |
| Function, notice-decl : | | Internal functions |
| Function, notify : | | Exported functions |
| Function, optional-icon : | | Internal functions |
| Function, optional-id : | | Internal functions |
| Function, optional-string : | | Internal functions |
| Function, origin-hdr-line : | | Internal functions |
| Function, pkcs7-pad : | | Internal functions |
| Function, register : | | Exported functions |
| Function, report-incompatible-encryption-and-checksum-error : | | Internal functions |
| Function, report-unavailable-checksum-error : | | Internal functions |
| Function, report-unavailable-encryption-error : | | Internal functions |
| Function, report-unsupported-iv-type-error : | | Internal functions |
| Function, report-unsupported-salt-type-error : | | Internal functions |
| Function, require-iv : | | Internal functions |
| Function, require-salt : | | Internal functions |
| Function, required-id : | | Internal functions |
| Function, required-string : | | Internal functions |
| Function, required-value : | | Internal functions |
| Function, sha1 : | | Internal functions |
| Function, sha256 : | | Internal functions |
| Function, valid-encryption-checksum-combo : | | Internal functions |
| Function, valid-field : | | Internal functions |
| Function, valid-notice-decl : | | Internal functions |
| Function, valid-origin-field : | | Internal functions |
| Function, valid-port : | | Internal functions |
| Function, valid-priority : | | Internal functions |
| Function, write-short : | | Internal functions |
|
G | | |
| generate-iv : | | Internal functions |
| generate-random-bytes : | | Internal functions |
| generate-salt : | | Internal functions |
| generate-unique-id : | | Internal functions |
| Generic Function, incompatible-checksum-requested-mode : | | Internal generic functions |
| Generic Function, incompatible-encryption-requested-mode : | | Internal generic functions |
| Generic Function, unavailable-checksum-requested-mode : | | Internal generic functions |
| Generic Function, unavailable-encryption-requested-mode : | | Internal generic functions |
| Generic Function, unsupported-iv-type-encryption-mode : | | Internal generic functions |
| Generic Function, unsupported-iv-type-iv : | | Internal generic functions |
| Generic Function, unsupported-salt-type-salt : | | Internal generic functions |
|
H | | |
| hdr-line : | | Internal functions |
| hdr-terpri : | | Internal functions |
| hex-encode : | | Internal functions |
|
I | | |
| incompatible-checksum-requested-mode : | | Internal generic functions |
| incompatible-checksum-requested-mode : | | Internal generic functions |
| incompatible-encryption-requested-mode : | | Internal generic functions |
| incompatible-encryption-requested-mode : | | Internal generic functions |
| ironclad-encrypt : | | Internal functions |
|
M | | |
| Macro, define-constant : | | Internal macros |
| Macro, with-output-to-binary-string : | | Internal macros |
| Macro, with-utf-8-strings : | | Internal macros |
| make-encryption-hdr : | | Internal functions |
| make-key : | | Internal functions |
| make-password-hash-hdr : | | Internal functions |
| md5 : | | Internal functions |
| Method, incompatible-checksum-requested-mode : | | Internal generic functions |
| Method, incompatible-encryption-requested-mode : | | Internal generic functions |
| Method, unavailable-checksum-requested-mode : | | Internal generic functions |
| Method, unavailable-encryption-requested-mode : | | Internal generic functions |
| Method, unsupported-iv-type-encryption-mode : | | Internal generic functions |
| Method, unsupported-iv-type-iv : | | Internal generic functions |
| Method, unsupported-salt-type-salt : | | Internal generic functions |
|
N | | |
| noauth : | | Internal functions |
| notice-decl : | | Internal functions |
| notify : | | Exported functions |
|
O | | |
| optional-icon : | | Internal functions |
| optional-id : | | Internal functions |
| optional-string : | | Internal functions |
| origin-hdr-line : | | Internal functions |
|
P | | |
| pkcs7-pad : | | Internal functions |
|
R | | |
| register : | | Exported functions |
| report-incompatible-encryption-and-checksum-error : | | Internal functions |
| report-unavailable-checksum-error : | | Internal functions |
| report-unavailable-encryption-error : | | Internal functions |
| report-unsupported-iv-type-error : | | Internal functions |
| report-unsupported-salt-type-error : | | Internal functions |
| require-iv : | | Internal functions |
| require-salt : | | Internal functions |
| required-id : | | Internal functions |
| required-string : | | Internal functions |
| required-value : | | Internal functions |
|
S | | |
| sha1 : | | Internal functions |
| sha256 : | | Internal functions |
|
U | | |
| unavailable-checksum-requested-mode : | | Internal generic functions |
| unavailable-checksum-requested-mode : | | Internal generic functions |
| unavailable-encryption-requested-mode : | | Internal generic functions |
| unavailable-encryption-requested-mode : | | Internal generic functions |
| unsupported-iv-type-encryption-mode : | | Internal generic functions |
| unsupported-iv-type-encryption-mode : | | Internal generic functions |
| unsupported-iv-type-iv : | | Internal generic functions |
| unsupported-iv-type-iv : | | Internal generic functions |
| unsupported-salt-type-salt : | | Internal generic functions |
| unsupported-salt-type-salt : | | Internal generic functions |
|
V | | |
| valid-encryption-checksum-combo : | | Internal functions |
| valid-field : | | Internal functions |
| valid-notice-decl : | | Internal functions |
| valid-origin-field : | | Internal functions |
| valid-port : | | Internal functions |
| valid-priority : | | Internal functions |
|
W | | |
| with-output-to-binary-string : | | Internal macros |
| with-utf-8-strings : | | Internal macros |
| write-short : | | Internal functions |
|
A.3 Variables
| Index Entry | | Section |
|
* | | |
| *growl-default-app* : | | Exported special variables |
| *growl-default-app-icon* : | | Exported special variables |
| *growl-default-application-fields* : | | Internal special variables |
| *growl-default-callback-context* : | | Exported special variables |
| *growl-default-callback-context-type* : | | Exported special variables |
| *growl-default-callback-target* : | | Exported special variables |
| *growl-default-checksum-mode* : | | Exported special variables |
| *growl-default-custom-fields* : | | Exported special variables |
| *growl-default-encryption-mode* : | | Exported special variables |
| *growl-default-host* : | | Exported special variables |
| *growl-default-icon* : | | Exported special variables |
| *growl-default-iv* : | | Internal special variables |
| *growl-default-notification* : | | Exported special variables |
| *growl-default-origin-fields* : | | Exported special variables |
| *growl-default-password* : | | Exported special variables |
| *growl-default-port* : | | Exported special variables |
| *growl-default-priority* : | | Exported special variables |
| *growl-default-salt* : | | Exported special variables |
| *growl-default-title* : | | Exported special variables |
|
+ | | |
| +growl-notify-message-type+ : | | Internal constants |
| +growl-protocol-version+ : | | Internal constants |
| +growl-register-message-type+ : | | Internal constants |
| +growl-subscribe-message-type+ : | | Internal constants |
|
C | | |
| Constant, +growl-notify-message-type+ : | | Internal constants |
| Constant, +growl-protocol-version+ : | | Internal constants |
| Constant, +growl-register-message-type+ : | | Internal constants |
| Constant, +growl-subscribe-message-type+ : | | Internal constants |
|
E | | |
| encryption-mode : | | Internal conditions |
|
I | | |
| iv : | | Internal conditions |
|
R | | |
| requested-checksum-mode : | | Internal conditions |
| requested-encryption-mode : | | Internal conditions |
| requested-mode : | | Internal conditions |
| requested-mode : | | Internal conditions |
|
S | | |
| salt : | | Internal conditions |
| Slot, encryption-mode : | | Internal conditions |
| Slot, iv : | | Internal conditions |
| Slot, requested-checksum-mode : | | Internal conditions |
| Slot, requested-encryption-mode : | | Internal conditions |
| Slot, requested-mode : | | Internal conditions |
| Slot, requested-mode : | | Internal conditions |
| Slot, salt : | | Internal conditions |
| Special Variable, *growl-default-app* : | | Exported special variables |
| Special Variable, *growl-default-app-icon* : | | Exported special variables |
| Special Variable, *growl-default-application-fields* : | | Internal special variables |
| Special Variable, *growl-default-callback-context* : | | Exported special variables |
| Special Variable, *growl-default-callback-context-type* : | | Exported special variables |
| Special Variable, *growl-default-callback-target* : | | Exported special variables |
| Special Variable, *growl-default-checksum-mode* : | | Exported special variables |
| Special Variable, *growl-default-custom-fields* : | | Exported special variables |
| Special Variable, *growl-default-encryption-mode* : | | Exported special variables |
| Special Variable, *growl-default-host* : | | Exported special variables |
| Special Variable, *growl-default-icon* : | | Exported special variables |
| Special Variable, *growl-default-iv* : | | Internal special variables |
| Special Variable, *growl-default-notification* : | | Exported special variables |
| Special Variable, *growl-default-origin-fields* : | | Exported special variables |
| Special Variable, *growl-default-password* : | | Exported special variables |
| Special Variable, *growl-default-port* : | | Exported special variables |
| Special Variable, *growl-default-priority* : | | Exported special variables |
| Special Variable, *growl-default-salt* : | | Exported special variables |
| Special Variable, *growl-default-title* : | | Exported special variables |
|
A.4 Data types
| Index Entry | | Section |
|
C | | |
| cl-growl : | | The cl-growl system |
| cl-growl : | | The cl-growl package |
| Condition, incompatible-encryption-and-checksum-error : | | Internal conditions |
| Condition, unavailable-checksum-error : | | Internal conditions |
| Condition, unavailable-encryption-error : | | Internal conditions |
| Condition, unsupported-iv-type-error : | | Internal conditions |
| Condition, unsupported-salt-type-error : | | Internal conditions |
|
G | | |
| growl-binary-data-type : | | Internal types |
| growl-checksum-mode : | | Internal types |
| growl-encryption-mode : | | Internal types |
|
I | | |
| incompatible-encryption-and-checksum-error : | | Internal conditions |
|
P | | |
| Package, cl-growl : | | The cl-growl package |
|
S | | |
| System, cl-growl : | | The cl-growl system |
|
T | | |
| Type, growl-binary-data-type : | | Internal types |
| Type, growl-checksum-mode : | | Internal types |
| Type, growl-encryption-mode : | | Internal types |
|
U | | |
| unavailable-checksum-error : | | Internal conditions |
| unavailable-encryption-error : | | Internal conditions |
| unsupported-iv-type-error : | | Internal conditions |
| unsupported-salt-type-error : | | Internal conditions |
|