README.md

signal-slot component, a replacement for Qt's signal-slot system, base on sigslot

1.Main Features

a.Supported Connection Types

b.Supported Slot Types

c.Slots Execution Order

2.Paramaters Copy Times

a.Pass By Value

b.Pass By Reference

3.Performance

a.Test environment:

CPU: 2.6 GHz 6-Core Intel Core i7

Memory：16 GB 2667 MHz DDR4

Operating System: macOS 13.6.4 (22G513)

Call Times: 1000000 times empty function calls

Execution thread: The task queue used is from webrtc (based on the C++ standard thread library)

Qt version: 6.2.4

b.Test Cases

Member Functions:

Lambda:

4.Examples

#include <iostream>
#include <list>
#include <memory>
#include "signal.hpp"
#include "core/task_queue.h"
#include "core/task_queue_manager.h"

struct DeviceInfo {
    std::string deviceId;
    std::string deviceName;
};

// Slot object with shared_ptr
class UiController1 {
public:
    ~UiController1() {}

    void onDevicePlugged(const std::shared_ptr<DeviceInfo>& info) {
        std::cout << "onDevicePlugged: " << info->deviceName << std::endl;
    }
};

// Slot object with observer
class UiController2 : public sigslot::observer {
public:
    ~UiController2() {
        // Needed to ensure proper disconnection prior to object destruction in multithreaded contexts.
        this->disconnect_all();
    }

    void onDevicePlugged(const std::shared_ptr<DeviceInfo>& info) {
        std::cout << "onDevicePlugged: " << info->deviceName << std::endl;
    }
};

class DeviceController {
public:
    std::list<std::shared_ptr<DeviceInfo>> getDeviceList();

    void mockCallback() {
        auto deviceInfo = std::make_shared<DeviceInfo>();
        deviceInfo->deviceId = "uuid-12345678900987654321";
        deviceInfo->deviceName = "microphone";
        onDeviceEventTriggered(deviceInfo);
    }
private:
    void onDeviceEventTriggered(const std::shared_ptr<DeviceInfo>& info) {
        pluggedSignal(info);
    }

public:
    sigslot::signal<const std::shared_ptr<DeviceInfo>&> pluggedSignal;
};

int main()
{
    // create a task queue
    TQMgr->create({"worker"});

    auto dc = std::make_shared<DeviceController>();

    // example 1, slot object with shared_ptr
    auto ui1 = std::make_shared<UiController1>();
    dc->pluggedSignal.connect(ui1.get(), &UiController1::onDevicePlugged, sigslot::connection_type::auto_connection, TQ("worker"));

    // example 2, slot object with observer
    UiController2 ui2;
    dc->pluggedSignal.connect(&ui2, &UiController2::onDevicePlugged, sigslot::connection_type::queued_connection, TQ("worker"));

    dc->mockCallback();

    // expamle 3
    sigslot::signal<int> printSignal;

    printSignal.connect([](int x){
        std::cout << "Hello World: " << x << std::endl;
    }, sigslot::connection_type::blocking_queued_connection, TQ("worker"));

    printSignal(5);

    return 0;
}

5.Dependence

sigslot: https://github.com/palacaze/sigslot

core: The source code for the task queue comes from webrtc, and the namespace has been renamed