Management

Managing the system allows for:

1. Initial setup

2. Clearing topics of subscriptions

3. Cleaning up stale bindings

Setup

Achieved by calling Setup function. Currently the only purpose is to manage the automated cleanup of stale bindings. By default the system runs the cleanup every 30 seconds. You can change the interval by modifying a CleanupInterval parameter. You can also disable the cleanup entirely by setting CleanupStaleBindings to false. The function can be called at any point to allow for fine-tuning of the whole process. This is the only function that has no counterpart in the Blueprint Library.

Blueprint

C++

UDispatchitoSubsystem* subsystem = GEngine->GetEngineSubsystem<UDispatchitoSubsystem>();

bool cleanupStaleBindings = true;
float cleanupInterval = 30;

subsystem->Setup(cleanupStaleBindings, cleanupInterval);

Clearing topics

Achieved by calling either ClearTopic and providing single topic to be cleared or ClearAllTopics to have all the topics cleared. This removes all the subscriptions made to topic(s).

Blueprint

C++

UDispatchitoSubsystem* subsystem = GEngine->GetEngineSubsystem<UDispatchitoSubsystem>();

subsystem->ClearTopic(EventTopic);

subsystem->ClearAllTopics();

Cleaning up stale bindings

Achieved by calling CleanupStaleBindings function. By default this is called every 30 seconds so there is no need to call it manually. If automated cleanup is disabled, consider calling it from time to time if your case entails many bound objects being created and destroyed without prior calls to unsubscribe them or their bindings.

Blueprint

C++

UDispatchitoSubsystem* subsystem = GEngine->GetEngineSubsystem<UDispatchitoSubsystem>();

subsystem->CleanupStaleBindings();