2025-09-30 14:56:47 -04:00
|
|
|
#ifndef LOGOS_API_CLIENT_H
|
|
|
|
|
#define LOGOS_API_CLIENT_H
|
|
|
|
|
|
|
|
|
|
#include <QObject>
|
|
|
|
|
#include <QString>
|
|
|
|
|
#include <QVariant>
|
|
|
|
|
#include <QVariantList>
|
|
|
|
|
#include <QMap>
|
|
|
|
|
#include <functional>
|
2026-04-16 12:41:17 -04:00
|
|
|
#include <string>
|
2025-09-30 14:56:47 -04:00
|
|
|
|
2025-12-11 13:40:41 -05:00
|
|
|
#include "logos_mode.h"
|
|
|
|
|
|
2025-09-30 14:56:47 -04:00
|
|
|
class LogosAPIConsumer;
|
2026-03-23 11:45:25 -04:00
|
|
|
class LogosObject;
|
2025-09-30 14:56:47 -04:00
|
|
|
class TokenManager;
|
|
|
|
|
|
|
|
|
|
/**
|
|
|
|
|
* @brief LogosAPIClient provides a high-level interface for remote method calls
|
|
|
|
|
*
|
|
|
|
|
* This class serves as a facade over LogosAPIConsumer, providing a clean interface
|
2026-03-23 11:45:25 -04:00
|
|
|
* for applications that need to call remote methods and handle events.
|
2025-09-30 14:56:47 -04:00
|
|
|
*/
|
|
|
|
|
class LogosAPIClient : public QObject
|
|
|
|
|
{
|
|
|
|
|
Q_OBJECT
|
|
|
|
|
|
|
|
|
|
public:
|
|
|
|
|
explicit LogosAPIClient(const QString& module_to_talk_to, const QString& origin_module, TokenManager* token_manager, QObject *parent = nullptr);
|
|
|
|
|
~LogosAPIClient();
|
|
|
|
|
|
|
|
|
|
/**
|
2026-03-23 11:45:25 -04:00
|
|
|
* @brief Request a LogosObject handle by name
|
|
|
|
|
* @return LogosObject* handle, or nullptr if failed
|
2025-09-30 14:56:47 -04:00
|
|
|
*/
|
2026-03-23 11:45:25 -04:00
|
|
|
LogosObject* requestObject(const QString& objectName, Timeout timeout = Timeout());
|
2025-09-30 14:56:47 -04:00
|
|
|
|
|
|
|
|
bool isConnected() const;
|
|
|
|
|
QString registryUrl() const;
|
|
|
|
|
bool reconnect();
|
|
|
|
|
|
|
|
|
|
QVariant invokeRemoteMethod(const QString& objectName, const QString& methodName,
|
2025-12-11 13:40:41 -05:00
|
|
|
const QVariantList& args = QVariantList(), Timeout timeout = Timeout());
|
2025-09-30 14:56:47 -04:00
|
|
|
|
|
|
|
|
QVariant invokeRemoteMethod(const QString& objectName, const QString& methodName,
|
2025-12-11 13:40:41 -05:00
|
|
|
const QVariant& arg, Timeout timeout = Timeout());
|
2025-09-30 14:56:47 -04:00
|
|
|
|
|
|
|
|
QVariant invokeRemoteMethod(const QString& objectName, const QString& methodName,
|
2025-12-11 13:40:41 -05:00
|
|
|
const QVariant& arg1, const QVariant& arg2, Timeout timeout = Timeout());
|
2025-09-30 14:56:47 -04:00
|
|
|
|
|
|
|
|
QVariant invokeRemoteMethod(const QString& objectName, const QString& methodName,
|
2025-12-11 13:40:41 -05:00
|
|
|
const QVariant& arg1, const QVariant& arg2, const QVariant& arg3, Timeout timeout = Timeout());
|
2025-09-30 14:56:47 -04:00
|
|
|
|
|
|
|
|
QVariant invokeRemoteMethod(const QString& objectName, const QString& methodName,
|
|
|
|
|
const QVariant& arg1, const QVariant& arg2, const QVariant& arg3,
|
2025-12-11 13:40:41 -05:00
|
|
|
const QVariant& arg4, Timeout timeout = Timeout());
|
2025-09-30 14:56:47 -04:00
|
|
|
|
2026-03-23 11:45:25 -04:00
|
|
|
QVariant invokeRemoteMethod(const QString& objectName, const QString& methodName,
|
|
|
|
|
const QVariant& arg1, const QVariant& arg2, const QVariant& arg3,
|
2025-12-11 13:40:41 -05:00
|
|
|
const QVariant& arg4, const QVariant& arg5, Timeout timeout = Timeout());
|
2025-09-30 14:56:47 -04:00
|
|
|
|
2026-03-23 11:45:25 -04:00
|
|
|
using AsyncResultCallback = std::function<void(QVariant)>;
|
|
|
|
|
|
2026-03-19 20:57:08 +01:00
|
|
|
void invokeRemoteMethodAsync(const QString& objectName, const QString& methodName,
|
2026-03-23 11:45:25 -04:00
|
|
|
const QVariantList& args, AsyncResultCallback callback,
|
|
|
|
|
Timeout timeout = Timeout());
|
|
|
|
|
|
|
|
|
|
void invokeRemoteMethodAsync(const QString& objectName, const QString& methodName,
|
|
|
|
|
const QVariant& arg, AsyncResultCallback callback,
|
|
|
|
|
Timeout timeout = Timeout());
|
|
|
|
|
|
|
|
|
|
void invokeRemoteMethodAsync(const QString& objectName, const QString& methodName,
|
|
|
|
|
const QVariant& arg1, const QVariant& arg2,
|
|
|
|
|
AsyncResultCallback callback, Timeout timeout = Timeout());
|
|
|
|
|
|
|
|
|
|
void invokeRemoteMethodAsync(const QString& objectName, const QString& methodName,
|
|
|
|
|
const QVariant& arg1, const QVariant& arg2, const QVariant& arg3,
|
|
|
|
|
AsyncResultCallback callback, Timeout timeout = Timeout());
|
|
|
|
|
|
|
|
|
|
void invokeRemoteMethodAsync(const QString& objectName, const QString& methodName,
|
|
|
|
|
const QVariant& arg1, const QVariant& arg2, const QVariant& arg3,
|
|
|
|
|
const QVariant& arg4, AsyncResultCallback callback,
|
|
|
|
|
Timeout timeout = Timeout());
|
|
|
|
|
|
|
|
|
|
void invokeRemoteMethodAsync(const QString& objectName, const QString& methodName,
|
|
|
|
|
const QVariant& arg1, const QVariant& arg2, const QVariant& arg3,
|
|
|
|
|
const QVariant& arg4, const QVariant& arg5,
|
|
|
|
|
AsyncResultCallback callback, Timeout timeout = Timeout());
|
2026-03-19 20:57:08 +01:00
|
|
|
|
|
|
|
|
/**
|
2026-03-23 11:45:25 -04:00
|
|
|
* @brief Register an event listener via LogosObject's callback mechanism
|
|
|
|
|
* @param originObject The LogosObject that will emit the event
|
2025-09-30 14:56:47 -04:00
|
|
|
* @param eventName The name of the event to listen for
|
|
|
|
|
* @param callback Function to call when the event is triggered
|
|
|
|
|
*/
|
2026-03-23 11:45:25 -04:00
|
|
|
void onEvent(LogosObject* originObject, const QString& eventName,
|
2025-09-30 14:56:47 -04:00
|
|
|
std::function<void(const QString&, const QVariantList&)> callback);
|
|
|
|
|
|
|
|
|
|
/**
|
2026-03-23 11:45:25 -04:00
|
|
|
* @brief Emit an event on a LogosObject (for plugins that act as event sources)
|
|
|
|
|
* @param object The LogosObject to emit the event on
|
2025-09-30 14:56:47 -04:00
|
|
|
* @param eventName The name of the event
|
|
|
|
|
* @param data The event data
|
|
|
|
|
*/
|
2026-03-23 11:45:25 -04:00
|
|
|
void onEventResponse(LogosObject* object, const QString& eventName, const QVariantList& data);
|
2025-09-30 14:56:47 -04:00
|
|
|
|
|
|
|
|
/**
|
2026-03-23 11:45:25 -04:00
|
|
|
* @brief Backward-compatible overload for QObject-based plugins.
|
|
|
|
|
*
|
|
|
|
|
* Old-API plugins call onEventResponse(this, ...) where `this` is a QObject*.
|
|
|
|
|
* This overload invokes the eventResponse signal on the QObject via QMetaObject.
|
2025-09-30 14:56:47 -04:00
|
|
|
*/
|
2026-03-23 11:45:25 -04:00
|
|
|
void onEventResponse(QObject* object, const QString& eventName, const QVariantList& data);
|
2025-09-30 14:56:47 -04:00
|
|
|
|
2026-03-23 11:45:25 -04:00
|
|
|
bool informModuleToken(const QString& authToken, const QString& moduleName, const QString& token);
|
2026-04-16 12:41:17 -04:00
|
|
|
bool informModuleToken(const char* authToken, const char* moduleName, const char* token)
|
|
|
|
|
{ return informModuleToken(QString(authToken), QString(moduleName), QString(token)); }
|
|
|
|
|
bool informModuleToken(const std::string& authToken, const std::string& moduleName, const std::string& token);
|
2025-09-30 14:56:47 -04:00
|
|
|
bool informModuleToken_module(const QString& authToken, const QString& originModule, const QString& moduleName, const QString& token);
|
|
|
|
|
|
|
|
|
|
TokenManager* getTokenManager() const;
|
|
|
|
|
QString getToken(const QString& module_name);
|
|
|
|
|
|
|
|
|
|
private:
|
|
|
|
|
LogosAPIConsumer* m_consumer;
|
|
|
|
|
QMap<QString, QString> m_tokens;
|
|
|
|
|
TokenManager* m_token_manager;
|
|
|
|
|
QString m_origin_module;
|
|
|
|
|
};
|
|
|
|
|
|
2026-03-23 11:45:25 -04:00
|
|
|
#endif // LOGOS_API_CLIENT_H
|