Skip to content

Latest commit

 

History

History
67 lines (45 loc) · 1.26 KB

README.md

File metadata and controls

67 lines (45 loc) · 1.26 KB

SYNOPSIS

A minimalist event emitter for C++.

DESCRIPTION

This emitter allows you to emit and receive arbitrary/variadic paramaters of equal type. Captures are also allowed.

EXAMPLE

#include "deps/datcxx/cxx-eventemitter/index.h"

int main() {

  EventEmitter ee;

  ee.on("hello", [&](string name, int num) {
    // ...do something with the values.
  });

  ee.emit("hello", "beautiful", 100);
}

USAGE

This module is designed to work with the datcxx build tool. To add this module to your project us the following command...

build add datcxx/cxx-eventemitter

TEST

build run test

API

INSTANCE METHODS

void on(string eventName, lambda callback);

Listen for an event multiple times.

void once(string eventName, lambda callback);

Listen for an event once.

void emit(string eventName [, arg1 [, arg2...]]);

Emit data for a particular event.

void off(string eventName);

Remove listener for a particular event.

void off();

Remove all listeners on the emitter.

int listeners();

Number of listeners an emitter has.

INSTANCE MEMBERS

maxListeners

Number of listeners an event emitter should have before considering that there is a memory leak.