Platform.Delegates.TemplateLibrary

LinksPlatform's Platform.Delegates is a Template Library what contains set of C++ abstract class templates for a simple event engine. Use Platform.Delegates.h file to include the library.


Keywords
C++, Native, Delegates, Delegate, MulticastDelegate
License
MIT
Install
Install-Package Platform.Delegates.TemplateLibrary -Version 0.3.7

Documentation

NuGet Version and Downloads count ConanCenter package

Delegates

LinksPlatform's Platform::Delegates Template Class Library

Delegate and MulticastDelegate classes are modeled after .NET Delegates.

Delegate is a container for callable function. Delegate can contain:

  • Pointer to simple function (represented by a single pointer).
  • Pointer to an instanse of class and to a member method of this class.
  • Pointer to std::function instance.

Unlike std::function Delegate class supports primitive by reference comparision for equality.

MulticastDelegate represents a thread-safe collection of Delegates that are callable at the same time. If you call MulticastDelegate all Delegates added to its collection will be called. MulticastDelegate can be used as a basis for simple event model (similar of that you can find in .NET). Because Delegate class supports the comparision for equality you can both subscribe and unsubscribe any Delegate instance to MulticastDelegate. To be able to unsubscribe from event represented by MulticastDelegate instance you should store Delegate instance somewhere. Due to its thread safety MulticastDelegate instance can be global/static object to which every thread is safe to subscribe.

NuGet package: Platform.Delegates.TemplateLibrary

Conan package: platform.delegates

Example

#include <Platform.Delegates.h>

void function(const char *str) 
{ 
    std::cout << "function(" << str << ")" << std::endl; 
}

struct Object
{
    void Method(const char *str) 
    {
        std::cout << "Object::Method(" << str << ")" << std::endl;
    }
};

int main()
{
    MulticastDelegate<void(const char *)> event;

    Delegate<void(const char *)> memberMethod(std::make_shared<Object>(), &Object::Method);

    auto lambda = std::make_shared<std::function<void(const char *)>>([](const char *str) 
    { 
        std::cout << "lambda(" << str << ")" << std::endl;
    });

    // Subscribe
    event += function;
    event += lambda;
    event += memberMethod;

    // Raise the event
    event("value");

    // Unsubscribe
    event -= function;
    event -= lambda;
    event -= memberMethod;
}