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 2.4 "Will Decker" on Wed Jun 20 11:09:53 2018 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

• Quicklisp: (ql:quickload :cl-growl)
• Git repository: http://github.com/nklein/cl-growl/

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

• package.lisp (file)
• constants.lisp (file)
• types.lisp (file)
• utils.lisp (file)
• specials.lisp (file)
• gntp.lisp (file)
• register.lisp (file)
• notify.lisp (file)

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

• +growl-notify-message-type+ (constant)
• +growl-protocol-version+ (constant)
• +growl-register-message-type+ (constant)
• +growl-subscribe-message-type+ (constant)
• define-constant (macro)

4.1.4 cl-growl/src/types.lisp

Dependency

package.lisp (file)

Parent

src (module)

Location

src/types.lisp

Internal Definitions

• growl-binary-data-type (type)
• growl-checksum-mode (type)
• growl-encryption-mode (type)
• incompatible-checksum-requested-mode (method)
• incompatible-encryption-and-checksum-error (condition)
• incompatible-encryption-requested-mode (method)
• report-incompatible-encryption-and-checksum-error (function)
• report-unavailable-checksum-error (function)
• report-unavailable-encryption-error (function)
• report-unsupported-iv-type-error (function)
• report-unsupported-salt-type-error (function)
• unavailable-checksum-error (condition)
• unavailable-checksum-requested-mode (method)
• unavailable-encryption-error (condition)
• unavailable-encryption-requested-mode (method)
• unsupported-iv-type-encryption-mode (method)
• unsupported-iv-type-error (condition)
• unsupported-iv-type-iv (method)
• unsupported-salt-type-error (condition)
• unsupported-salt-type-salt (method)

4.1.5 cl-growl/src/utils.lisp

Dependency

package.lisp (file)

Parent

src (module)

Location

src/utils.lisp

Internal Definitions

• 3des (function)
• aes (function)
• checksum (function)
• des (function)
• echo-all-bytes (function)
• encrypt (function)
• generate-iv (function)
• generate-random-bytes (function)
• generate-salt (function)
• generate-unique-id (function)
• hex-encode (function)
• ironclad-encrypt (function)
• md5 (function)
• noauth (function)
• pkcs7-pad (function)
• sha1 (function)
• sha256 (function)
• with-output-to-binary-string (macro)
• with-utf-8-strings (macro)
• write-short (function)

4.1.6 cl-growl/src/specials.lisp

Dependencies

• package.lisp (file)
• types.lisp (file)
• utils.lisp (file)

Parent

src (module)

Location

src/specials.lisp

Exported Definitions

• *growl-default-app* (special variable)
• *growl-default-app-icon* (special variable)
• *growl-default-callback-context* (special variable)
• *growl-default-callback-context-type* (special variable)
• *growl-default-callback-target* (special variable)
• *growl-default-checksum-mode* (special variable)
• *growl-default-custom-fields* (special variable)
• *growl-default-encryption-mode* (special variable)
• *growl-default-host* (special variable)
• *growl-default-icon* (special variable)
• *growl-default-notification* (special variable)
• *growl-default-origin-fields* (special variable)
• *growl-default-password* (special variable)
• *growl-default-port* (special variable)
• *growl-default-priority* (special variable)
• *growl-default-salt* (special variable)
• *growl-default-title* (special variable)

Internal Definitions

• *growl-default-application-fields* (special variable)
• *growl-default-iv* (special variable)

4.1.7 cl-growl/src/gntp.lisp

Dependencies

• package.lisp (file)
• constants.lisp (file)
• types.lisp (file)
• utils.lisp (file)

Parent

src (module)

Location

src/gntp.lisp

Internal Definitions

• app-hdr-line (function)
• compose (function)
• custom-hdr-line (function)
• encode-binary-data (function)
• hdr-line (function)
• hdr-terpri (function)
• make-encryption-hdr (function)
• make-key (function)
• make-password-hash-hdr (function)
• notice-decl (function)
• optional-icon (function)
• optional-id (function)
• optional-string (function)
• origin-hdr-line (function)
• require-iv (function)
• require-salt (function)
• required-id (function)
• required-string (function)
• required-value (function)
• valid-encryption-checksum-combo (function)
• valid-field (function)
• valid-notice-decl (function)
• valid-origin-field (function)
• valid-port (function)
• valid-priority (function)

4.1.8 cl-growl/src/register.lisp

Dependencies

• package.lisp (file)
• constants.lisp (file)
• types.lisp (file)
• specials.lisp (file)
• utils.lisp (file)
• gntp.lisp (file)

Parent

src (module)

Location

src/register.lisp

Exported Definitions

register (function)

4.1.9 cl-growl/src/notify.lisp

Dependencies

• package.lisp (file)
• constants.lisp (file)
• types.lisp (file)
• specials.lisp (file)
• utils.lisp (file)

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

• *growl-default-app* (special variable)
• *growl-default-app-icon* (special variable)
• *growl-default-callback-context* (special variable)
• *growl-default-callback-context-type* (special variable)
• *growl-default-callback-target* (special variable)
• *growl-default-checksum-mode* (special variable)
• *growl-default-custom-fields* (special variable)
• *growl-default-encryption-mode* (special variable)
• *growl-default-host* (special variable)
• *growl-default-icon* (special variable)
• *growl-default-notification* (special variable)
• *growl-default-origin-fields* (special variable)
• *growl-default-password* (special variable)
• *growl-default-port* (special variable)
• *growl-default-priority* (special variable)
• *growl-default-salt* (special variable)
• *growl-default-title* (special variable)
• notify (function)
• register (function)

Internal Definitions

• *growl-default-application-fields* (special variable)
• *growl-default-iv* (special variable)
• +growl-notify-message-type+ (constant)
• +growl-protocol-version+ (constant)
• +growl-register-message-type+ (constant)
• +growl-subscribe-message-type+ (constant)
• 3des (function)
• aes (function)
• app-hdr-line (function)
• checksum (function)
• compose (function)
• custom-hdr-line (function)
• define-constant (macro)
• des (function)
• echo-all-bytes (function)
• encode-binary-data (function)
• encrypt (function)
• generate-iv (function)
• generate-random-bytes (function)
• generate-salt (function)
• generate-unique-id (function)
• growl-binary-data-type (type)
• growl-checksum-mode (type)
• growl-encryption-mode (type)
• hdr-line (function)
• hdr-terpri (function)
• hex-encode (function)
• incompatible-checksum-requested-mode (generic function)
• incompatible-checksum-requested-mode (method)
• incompatible-encryption-and-checksum-error (condition)
• incompatible-encryption-requested-mode (generic function)
• incompatible-encryption-requested-mode (method)
• ironclad-encrypt (function)
• make-encryption-hdr (function)
• make-key (function)
• make-password-hash-hdr (function)
• md5 (function)
• noauth (function)
• notice-decl (function)
• optional-icon (function)
• optional-id (function)
• optional-string (function)
• origin-hdr-line (function)
• pkcs7-pad (function)
• report-incompatible-encryption-and-checksum-error (function)
• report-unavailable-checksum-error (function)
• report-unavailable-encryption-error (function)
• report-unsupported-iv-type-error (function)
• report-unsupported-salt-type-error (function)
• require-iv (function)
• require-salt (function)
• required-id (function)
• required-string (function)
• required-value (function)
• sha1 (function)
• sha256 (function)
• unavailable-checksum-error (condition)
• unavailable-checksum-requested-mode (generic function)
• unavailable-checksum-requested-mode (method)
• unavailable-encryption-error (condition)
• unavailable-encryption-requested-mode (generic function)
• unavailable-encryption-requested-mode (method)
• unsupported-iv-type-encryption-mode (generic function)
• unsupported-iv-type-encryption-mode (method)
• unsupported-iv-type-error (condition)
• unsupported-iv-type-iv (generic function)
• unsupported-iv-type-iv (method)
• unsupported-salt-type-error (condition)
• unsupported-salt-type-salt (generic function)
• unsupported-salt-type-salt (method)
• valid-encryption-checksum-combo (function)
• valid-field (function)
• valid-notice-decl (function)
• valid-origin-field (function)
• valid-port (function)
• valid-priority (function)
• with-output-to-binary-string (macro)
• with-utf-8-strings (macro)
• write-short (function)

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

• incompatible-checksum-requested-mode (method)
• incompatible-encryption-requested-mode (method)

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

• unsupported-iv-type-encryption-mode (method)
• unsupported-iv-type-iv (method)

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

A.2 Functions

A.3 Variables

A.4 Data types