README.md

miniLoop

🌟 A lightweight C++ wrapper around libevent 🌟

Nothing fancy, miniLoop is a quick and easy-to-use event-loop with basic functionalities :

• Listen on read/write on a file descriptor
• Set timeouts (oneshot and recurrent)
• Register on unix signals
• ... that is pretty much it !

To use it, just start the loop and register your callbacks on the events of your choice.

It wraps libevent and is therefore easily extendable to fit your needs.

How to use

#include <miniLoop/Loop.h>
#include <signal.h>
#include <iostream>
#include <memory>

#define TIMEOUT_HOURLY 3600 * 1000

using namespace loop;

int main(/*int argc, char* argv[]*/) {

    // Subscribe to SIGINT signal for example
    auto sigintEvt{ Loop::UNIX_SIGNAL(SIGINT) };
    sigintEvt.onEvent([](int) { /*graceful_exit(SIGINT);*/ });

    // Remember to take a break from screen every hour !
    auto takeBreak{ std::make_unique<Loop::RecurrentTimeout>(TIMEOUT_HOURLY) };
    takeBreak->onTimeout([](){
        std::cout << "Take a break !" << std::endl;
    });

    // Start the loop
    Loop::singleton().run();

    return EXIT_SUCCESS;
}

How to install

• Install

cmake [-S ${path/to/src}] [-DCMAKE_NSTALL_PREFIX=${install/prefix}] .
make
make install

• Uninstall

make uninstall

• Configuration options

name	type	description	default value
BUILD_SHARED_LIBS	boolean	Build miniLoop as a shared library	ON
BUILD_EXAMPLE	boolean	Also build provided usage example	OFF

Dependencies

miniLoop depends on :

• libevent
• miniJSON, which is easy to install from here.