From e1f73e7fd108e6c35b5ab258e51dc2983a676a20 Mon Sep 17 00:00:00 2001 From: DocWilco Date: Tue, 9 Dec 2025 17:06:31 +0100 Subject: [PATCH] Fix thread/realtime safety documentation errors * `abl_link_capture_app_session_state` Descrepancy between C and C++ docs. C++ correctly says thread safe, not realtime safe. This matches the implementation. * `abl_link_enable_start_stop_sync` * `abl_link_is_start_stop_sync_enabled` * `Link::enableStartStopSync` * `Link::isStartStopSyncEnabled` These read/write a `std::atomic`, so both thread & realtime safe. --- extensions/abl_link/include/abl_link.h | 8 ++++---- include/ableton/Link.hpp | 4 ++-- 2 files changed, 6 insertions(+), 6 deletions(-) diff --git a/extensions/abl_link/include/abl_link.h b/extensions/abl_link/include/abl_link.h index 34ac71b0..8d4b6f3d 100644 --- a/extensions/abl_link/include/abl_link.h +++ b/extensions/abl_link/include/abl_link.h @@ -92,13 +92,13 @@ extern "C" /*! @brief: Is start/stop synchronization enabled? * Thread-safe: yes - * Realtime-safe: no + * Realtime-safe: yes */ bool abl_link_is_start_stop_sync_enabled(abl_link link); /*! @brief: Enable start/stop synchronization. * Thread-safe: yes - * Realtime-safe: no + * Realtime-safe: yes */ void abl_link_enable_start_stop_sync(abl_link link, bool enabled); @@ -209,8 +209,8 @@ extern "C" abl_link link, abl_link_session_state session_state); /*! @brief Capture the current Link Session State from an application thread. - * Thread-safe: no - * Realtime-safe: yes + * Thread-safe: yes + * Realtime-safe: no * * @discussion Provides a mechanism for capturing the Link Session State from an * application thread (other than the audio thread). After capturing the session_state diff --git a/include/ableton/Link.hpp b/include/ableton/Link.hpp index fc3c9536..89b9b718 100644 --- a/include/ableton/Link.hpp +++ b/include/ableton/Link.hpp @@ -103,13 +103,13 @@ class BasicLink /*! @brief: Is start/stop synchronization enabled? * Thread-safe: yes - * Realtime-safe: no + * Realtime-safe: yes */ bool isStartStopSyncEnabled() const; /*! @brief: Enable start/stop synchronization. * Thread-safe: yes - * Realtime-safe: no + * Realtime-safe: yes */ void enableStartStopSync(bool bEnable);