The event-emitter Reference Manual

Table of Contents

The event-emitter Reference Manual

This is the event-emitter Reference Manual, version 0.0.1, generated automatically by Declt version 3.0 "Montgomery Scott" on Tue Dec 22 13:24:28 2020 GMT+0.

1 Introduction

Event Emitter

Event Emitter provides an event mechanism like Node.js for Common Lisp objects.

Mostly ported from Node.js 'events' module.

Usage

;; Defining Event Emitter class.
(defclass person (event-emitter)
  ((name :initarg :name
         :reader name)))

(defvar *user*
  (make-instance 'person :name "Eitaro Fukamachi"))

;; Attach a event listener for an event ':say-hi'.
(on :say-hi *user*
    (lambda () (format t "Hi!")))

;; *user* says 'Hi!' when an event ':say-hi' is invoked.
(emit :say-hi *user*)
;-> Hi!

(emit :say-hi *user*)
;-> Hi!

(emit :say-hi *user*)
;-> Hi!

;; Attach an one time event listener.
(once :say-hi *user*
      (lambda ()
        (format t "How's it going?")))

;; 'Hi!' and "How's it going?" will be printed.
(emit :say-hi *user*)
;-> Hi!
;   How's it going?

;; *user* doens't say "How's it going?" anymore.
(emit :say-hi *user*)
;-> Hi!

(emit :say-hi *user*)
;-> Hi!

'event-glue'

There's already similar library named event-glue which you may like to know.

API

[Class] event-emitter

Base standard class for 'event-emitter's.

(defclass person (event-emitter)
  ((name :initarg :name)))

[Strucuture] event-emitter*

Base strucuture class for 'event-emitter's.

(defstruct (person :include event-emitter*)
  name)

[Function] (add-listener object event listener)[Function] (on event object listener)

Adds a listener to the end of the listeners array for the specified event.

(on :connection server
    (lambda (stream) ...))

NOTE: add-listener and on takes 'object' and 'event' the opposite order.

[Function] (once event object listener)

Adds a one time listener for the event. This listener is invoked only the next time the event is fired, after which it is removed.

(once :connection server
      (lambda (stream) ...))

[Function] (remove-listener object event listener)

Removes a listener from the listener array for the specified event.

(defun connection-cb (stream)
  ...)

(on :connection server #'connection-cb)
(remove-listener server :connection #'connection-cb)

[Function] (remove-all-listeners object &optional event)

Removes all listeners, or those of the specified event.

(remove-all-listeners server)
(remove-all-listeners server :connection)

[Function] (listeners object event)

Returns an array of listeners for the specified event.

[Function] (emit event object &rest args)

Executes each of the listeners in order with the supplied arguments.

Returns T if the event had listeners, NIL otherwise.

[Function] (listener-count object event)

Returns the number of listeners for a given event.

Copyright

Copyright (c) 2014 Eitaro Fukamachi (e.arrows@gmail.com)

License

Licensed under the BSD 2-Clause License.

2 Systems

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

2.1 event-emitter

Author

Eitaro Fukamachi

License

BSD 2-Clause

Description

Event mechanism for Common Lisp objects

Version

0.0.1

Source

event-emitter.asd (file)

Component

src/event-emitter.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 event-emitter.asd

Location

event-emitter.asd

Systems

event-emitter (system)

Packages

event-emitter-asd

3.1.2 event-emitter/src/event-emitter.lisp

Parent

event-emitter (system)

Location

src/event-emitter.lisp

Packages

event-emitter

Exported Definitions

• add-listener (function)
• emit (function)
• event-emitter (class)
• event-emitter* (structure)
• listener-count (function)
• listeners (function)
• on (function)
• once (function)
• remove-all-listeners (function)
• remove-listener (function)

Internal Definitions

• %add-listener (function)
• copy-event-emitter* (function)
• copy-listener (function)
• event-emitter*-p (function)
• event-emitter*-silo (function)
• (setf event-emitter*-silo) (function)
• listener (structure)
• listener-function (function)
• (setf listener-function) (function)
• listener-once (function)
• (setf listener-once) (function)
• listener-p (function)
• make-event-emitter* (function)
• make-listener (function)
• silo (function)

4 Packages

Packages are listed by definition order.

4.1 event-emitter-asd

Source

event-emitter.asd

Use List

• asdf/interface
• common-lisp

4.2 event-emitter

Source

src/event-emitter.lisp (file)

Use List

common-lisp

Exported Definitions

• add-listener (function)
• emit (function)
• event-emitter (class)
• event-emitter* (structure)
• listener-count (function)
• listeners (function)
• on (function)
• once (function)
• remove-all-listeners (function)
• remove-listener (function)

Internal Definitions

• %add-listener (function)
• copy-event-emitter* (function)
• copy-listener (function)
• event-emitter*-p (function)
• event-emitter*-silo (function)
• (setf event-emitter*-silo) (function)
• listener (structure)
• listener-function (function)
• (setf listener-function) (function)
• listener-once (function)
• (setf listener-once) (function)
• listener-p (function)
• make-event-emitter* (function)
• make-listener (function)
• silo (function)

5 Definitions

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

5.1 Exported definitions

5.1.1 Functions

Function: add-listener OBJECT EVENT LISTENER

Package

event-emitter

Source

src/event-emitter.lisp (file)

Function: emit EVENT OBJECT &rest ARGS

Package

event-emitter

Source

src/event-emitter.lisp (file)

Function: listener-count OBJECT EVENT

Package

event-emitter

Source

src/event-emitter.lisp (file)

Function: listeners OBJECT EVENT

Package

event-emitter

Source

src/event-emitter.lisp (file)

Function: on EVENT OBJECT LISTENER

Package

event-emitter

Source

src/event-emitter.lisp (file)

Function: once EVENT OBJECT LISTENER

Package

event-emitter

Source

src/event-emitter.lisp (file)

Function: remove-all-listeners OBJECT &optional EVENT

Package

event-emitter

Source

src/event-emitter.lisp (file)

Function: remove-listener OBJECT EVENT LISTENER

Package

event-emitter

Source

src/event-emitter.lisp (file)

5.1.2 Structures

Structure: event-emitter* ()

Package

event-emitter

Source

src/event-emitter.lisp (file)

Direct superclasses

structure-object (structure)

Direct slots

Slot: silo

Initform

(make-hash-table :test (quote eq))

Readers

event-emitter*-silo (function)

Writers

(setf event-emitter*-silo) (function)

5.1.3 Classes

Class: event-emitter ()

Package

event-emitter

Source

src/event-emitter.lisp (file)

Direct superclasses

standard-object (class)

Direct slots

Slot: silo

Initform

(make-hash-table :test (quote eq))

5.2 Internal definitions

5.2.1 Functions

Function: %add-listener OBJECT EVENT LISTENER

Package

event-emitter

Source

src/event-emitter.lisp (file)

Function: copy-event-emitter* INSTANCE

Package

event-emitter

Source

src/event-emitter.lisp (file)

Function: copy-listener INSTANCE

Package

event-emitter

Source

src/event-emitter.lisp (file)

Function: event-emitter*-p OBJECT

Package

event-emitter

Source

src/event-emitter.lisp (file)

Function: event-emitter*-silo INSTANCE

Function: (setf event-emitter*-silo) VALUE INSTANCE

Package

event-emitter

Source

src/event-emitter.lisp (file)

Function: listener-function INSTANCE

Function: (setf listener-function) VALUE INSTANCE

Package

event-emitter

Source

src/event-emitter.lisp (file)

Function: listener-once INSTANCE

Function: (setf listener-once) VALUE INSTANCE

Package

event-emitter

Source

src/event-emitter.lisp (file)

Function: listener-p OBJECT

Package

event-emitter

Source

src/event-emitter.lisp (file)

Function: make-event-emitter* &key (SILO SILO)

Package

event-emitter

Source

src/event-emitter.lisp (file)

Function: make-listener FUNCTION &key ONCE

Package

event-emitter

Source

src/event-emitter.lisp (file)

Function: silo OBJECT

Package

event-emitter

Source

src/event-emitter.lisp (file)

5.2.2 Structures

Structure: listener ()

Package

event-emitter

Source

src/event-emitter.lisp (file)

Direct superclasses

structure-object (structure)

Direct slots

Slot: function

Readers

listener-function (function)

Writers

(setf listener-function) (function)

Slot: once

Readers

listener-once (function)

Writers

(setf listener-once) (function)

Appendix A Indexes

A.1 Concepts

A.2 Functions

A.3 Variables

A.4 Data types