mirror of
https://github.com/logos-co/logos-cpp-sdk.git
synced 2026-08-31 01:31:10 +00:00
* Marshal inter-module calls to the owner thread Logos inter-module calls go over Qt Remote Objects, whose replicas only work on the thread that created them (the module's main/event-loop thread). A module that makes calls from a worker thread — e.g. an embedded HTTP server serving /metrics — would otherwise hang on replica acquisition. Make LogosAPIClient transparently marshal to its owner thread when called off-thread (guarded so same-thread calls run directly with no overhead): - LogosAPI::getClient creates the client/consumer/replicas on the owner thread - LogosAPIClient::invokeRemoteMethod / requestObject / onEvent run there too New header logos_thread_marshal.h (runOnOwnerThread). No new data members — ABI-safe for statically-linked plugins. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com> * Add regression test for worker-thread inter-module calls A provider records the thread its method runs on; a consumer calls it from a worker thread via LogosAPIClient::invokeRemoteMethod. The call must execute on the owner (main/event-loop) thread, not the worker thread. Fails without the marshaling change (the call runs on the worker thread — 0x..d80d0 vs owner 0x..c53e0, "executed on the worker thread instead of the owner thread"); passes with it (511/511). Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com> * Address review: async marshaling, helper constraints, test ownership - invokeRemoteMethodAsync now also marshals to the owner thread (non-blocking QueuedConnection) — the async path acquires a replica too, so calling it from a worker thread previously re-introduced the off-thread bug. - runOnOwnerThread: document the return-type constraints (void or default-constructible, non-reference) and static_assert against references. - test: declare the provider before its LogosAPI so the ModuleProxy (which holds a raw pointer to it) is torn down first — removes the leak and the inaccurate comment. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com> * doctest: call a module from a worker thread (HTTP server) Adds cpp-sdk-worker-thread-http.test.yaml: builds a sensor_module callee and an http_module caller that embeds a libmicrohttpd server, runs them in logoscore, starts the server, and curls it. The HTTP handler calls sensor_module.readTemperature() from the server's worker thread — which only works because the SDK marshals the cross-module call onto the module's owner thread. The module stays pure C++. Wired into doctests/run.sh and the doctests CI workflow. Validated locally (23/23 steps pass): `curl` returns `temperature 42`. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com> --------- Co-authored-by: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
52 lines
1.9 KiB
C++
52 lines
1.9 KiB
C++
#ifndef LOGOS_THREAD_MARSHAL_H
|
|
#define LOGOS_THREAD_MARSHAL_H
|
|
|
|
#include <type_traits>
|
|
|
|
#include <QMetaObject>
|
|
#include <QObject>
|
|
#include <QThread>
|
|
|
|
namespace logos {
|
|
|
|
// Run `fn` on `obj`'s (owner) thread, blocking the caller until it completes,
|
|
// and forward the return value. If already on that thread, runs directly with
|
|
// no marshaling and no overhead (the common case).
|
|
//
|
|
// Why: Logos inter-module calls go over Qt Remote Objects, whose replicas only
|
|
// work on the thread that owns them (the module's main/event-loop thread). This
|
|
// lets a module call other modules from a worker thread (e.g. an HTTP server
|
|
// thread) without the module touching Qt — the SDK transparently marshals the
|
|
// call onto the owner thread.
|
|
//
|
|
// Requirements:
|
|
// - `obj`'s thread must be running an event loop (it is — the module's main
|
|
// thread runs QCoreApplication::exec()). The same-thread guard avoids the
|
|
// BlockingQueuedConnection self-deadlock.
|
|
// - The return type must be void or default-constructible (the marshaled
|
|
// branch holds the result in a local before assigning it), and must not be
|
|
// a reference (there'd be nothing to bind the local to). Both are satisfied
|
|
// by the SDK's uses here (void, QVariant, LogosObject*, LogosAPIClient*).
|
|
template <typename Fn>
|
|
auto runOnOwnerThread(QObject* obj, Fn&& fn) -> decltype(fn())
|
|
{
|
|
using Ret = decltype(fn());
|
|
static_assert(!std::is_reference_v<Ret>,
|
|
"runOnOwnerThread does not support reference return types");
|
|
if (QThread::currentThread() == obj->thread()) {
|
|
return fn();
|
|
}
|
|
if constexpr (std::is_void_v<Ret>) {
|
|
QMetaObject::invokeMethod(obj, [&]() { fn(); }, Qt::BlockingQueuedConnection);
|
|
return;
|
|
} else {
|
|
Ret ret{};
|
|
QMetaObject::invokeMethod(obj, [&]() { ret = fn(); }, Qt::BlockingQueuedConnection);
|
|
return ret;
|
|
}
|
|
}
|
|
|
|
} // namespace logos
|
|
|
|
#endif // LOGOS_THREAD_MARSHAL_H
|