The eventbus Reference Manual

4.1.1 eventbus/eventbus.asd

Source

eventbus.asd.

Parent Component

eventbus (system).

ASDF Systems

eventbus.

4.1.2 eventbus/src/package.lisp

Source

eventbus.asd.

Parent Component

src (module).

Packages

noloop.eventbus.

4.1.3 eventbus/src/eventbus.lisp

Dependency

package.lisp (file).

Source

eventbus.asd.

Parent Component

src (module).

Public Interface

• emit (function).
• get-all-events-name (function).
• get-all-listeners-of-event (function).
• get-listener-count-of-event (function).
• make-eventbus (function).
• off (function).
• on (function).
• once (function).
• remove-all-listeners-of-event (function).

Internals

make-listener (function).

6.1.1 Ordinary functions

Function: emit (eventbus event-name &rest args) ¶

Emite an event by passing the arguments offered to the listener function. If the listener is once, then the listener is excluded from the list of listeners.

Package

noloop.eventbus.

Source

eventbus.lisp.

Function: get-all-events-name (eventbus) ¶

Return one list with all name of events of the eventbus. The list returned includes add-listener and remove-listener.

Package

noloop.eventbus.

Source

eventbus.lisp.

Function: get-all-listeners-of-event (eventbus event-name) ¶

Return two values, the value: list of listeners of the event, and present-p: list is present.

Package

noloop.eventbus.

Source

eventbus.lisp.

Function: get-listener-count-of-event (eventbus event-name) ¶

Return length listeners of event. Return nil if event nonexistent.

Package

noloop.eventbus.

Source

eventbus.lisp.

Function: make-eventbus () ¶

Return eventbus instance.

Package

noloop.eventbus.

Source

eventbus.lisp.

Function: off (eventbus event-name listener-fn) ¶

Remove the first listener from the event listeners list.

Package

noloop.eventbus.

Source

eventbus.lisp.

Function: on (eventbus event-name listener-fn) ¶

Add one listener to an event. The add-listener event is emitted before adding the new listener.

Package

noloop.eventbus.

Source

eventbus.lisp.

Function: once (eventbus event-name listener-fn) ¶

Add one listener to an event. The listener is removed when the event is emitted. The add-listener event is emitted before adding the new listener.

Package

noloop.eventbus.

Source

eventbus.lisp.

Function: remove-all-listeners-of-event (eventbus event-name) ¶

Removing all listeners from the event. Will be called the off function for each listener, so the remove-listener event is emitted correctly for each listener removed.

Package

noloop.eventbus.

Source

eventbus.lisp.

6.2.1 Ordinary functions

Function: make-listener (listener-fn is-once) ¶

It returns a list, the first element being a listener function, and the following being a boolean saying if it is an once listener.

Package

noloop.eventbus.

Source

eventbus.lisp.