kdeconnect-kde/plugins/ping/pingplugin.h

/**
 * SPDX-FileCopyrightText: 2013 Albert Vaca <albertvaka@gmail.com>
 *
 * SPDX-License-Identifier: GPL-2.0-only OR GPL-3.0-only OR LicenseRef-KDE-Accepted-GPL
 */

#pragma once

#include <QObject>

#include <core/kdeconnectplugin.h>

#define PACKET_TYPE_PING QStringLiteral("kdeconnect.ping")

class PingPlugin : public KdeConnectPlugin
{
    Q_OBJECT
    Q_CLASSINFO("D-Bus Interface", "org.kde.kdeconnect.device.ping")

public:
    using KdeConnectPlugin::KdeConnectPlugin;

    Q_SCRIPTABLE void sendPing();
    Q_SCRIPTABLE void sendPing(const QString &customMessage);

    void receivePacket(const NetworkPacket &np) override;
    QString dbusPath() const override;
};
Rewritten old package emitters and receivers using the new package format Splitted up ping receiver from notification receiver in KDE Improved pausemusic receiver Fixed same computer being discovered multiple times Fixed some other minor bugs and compilation warnings 2013-07-04 18:17:22 +01:00			`/**`
Convert license headers to SPDX expressions 2020-08-17 10:48:10 +01:00			`* SPDX-FileCopyrightText: 2013 Albert Vaca <albertvaka@gmail.com>`
Rewritten old package emitters and receivers using the new package format Splitted up ping receiver from notification receiver in KDE Improved pausemusic receiver Fixed same computer being discovered multiple times Fixed some other minor bugs and compilation warnings 2013-07-04 18:17:22 +01:00			`*`
Convert license headers to SPDX expressions 2020-08-17 10:48:10 +01:00			`* SPDX-License-Identifier: GPL-2.0-only OR GPL-3.0-only OR LicenseRef-KDE-Accepted-GPL`
Rewritten old package emitters and receivers using the new package format Splitted up ping receiver from notification receiver in KDE Improved pausemusic receiver Fixed same computer being discovered multiple times Fixed some other minor bugs and compilation warnings 2013-07-04 18:17:22 +01:00			`*/`

Use pragma once in plugins For non-library code, this is simpler and more concise 2023-07-21 19:22:59 +01:00			`#pragma once`
Rewritten old package emitters and receivers using the new package format Splitted up ping receiver from notification receiver in KDE Improved pausemusic receiver Fixed same computer being discovered multiple times Fixed some other minor bugs and compilation warnings 2013-07-04 18:17:22 +01:00
Plugins are now owned by devices and not by daemon Plugins can no longer emit networkpackages for every device. Plugins are stored in device, wich selectively loads them. A Device is needed in order to instantiate a Plugin (via PluginLoader) PluginLoader is a singleton, because every instance of Device need it. Added KPluginSelector in the KCM to select the plugins to load. Added architecture explanation to README Only PingPlugin is working by now. 2013-08-13 04:07:32 +01:00			`#include <QObject>`
Rewritten old package emitters and receivers using the new package format Splitted up ping receiver from notification receiver in KDE Improved pausemusic receiver Fixed same computer being discovered multiple times Fixed some other minor bugs and compilation warnings 2013-07-04 18:17:22 +01:00
Move the plugins into a different top-ĺevel directory Reviewed by Albert Vaca 2014-06-14 15:34:00 +01:00			`#include <core/kdeconnectplugin.h>`
Rewritten old package emitters and receivers using the new package format Splitted up ping receiver from notification receiver in KDE Improved pausemusic receiver Fixed same computer being discovered multiple times Fixed some other minor bugs and compilation warnings 2013-07-04 18:17:22 +01:00
Rename NetworkPackage -> NetworkPacket Summary: KDE Connect, now with correct naming! Test Plan: It still builds. Reviewers: #kde_connect, apol, nicolasfella Reviewed By: #kde_connect, apol, nicolasfella Subscribers: nicolasfella Differential Revision: https://phabricator.kde.org/D11036 2018-03-04 19:48:51 +00:00			`#define PACKET_TYPE_PING QStringLiteral("kdeconnect.ping")`
Port ping away from kDebug 2014-09-21 23:45:41 +01:00
Do not mark plugin classes as exported This is not needed, because only a symbol to create the KPluginFactory instance must be exported. The KPluginFactory macros or rather the underlying Q_PLUGIN_METADATA macro already take care of that. In other plugin code of KDE, we also do not export classes. The size of the generated plugin files is nearly identical, but removing the macros avoids confusion for developers. 2023-07-22 10:37:35 +01:00			`class PingPlugin : public KdeConnectPlugin`
Rewritten old package emitters and receivers using the new package format Splitted up ping receiver from notification receiver in KDE Improved pausemusic receiver Fixed same computer being discovered multiple times Fixed some other minor bugs and compilation warnings 2013-07-04 18:17:22 +01:00			`{`
Moved plugins into separate folders and added KServiceTypeTrader 2013-08-12 15:09:52 +01:00			`Q_OBJECT`
Move the send ping code to the ping plugin turn it into a dbus call to the plugin Reviewed by Albert Vaca 2014-06-27 17:21:40 +01:00			`Q_CLASSINFO("D-Bus Interface", "org.kde.kdeconnect.device.ping")`
Rewritten old package emitters and receivers using the new package format Splitted up ping receiver from notification receiver in KDE Improved pausemusic receiver Fixed same computer being discovered multiple times Fixed some other minor bugs and compilation warnings 2013-07-04 18:17:22 +01:00
			`public:`
plugins: Prefer using statements with baseclass over empty constructor Those plugins re really simple and don't need any initialization logic. With the using statement, we do not need to add a constructor and pass the parent/args to the baseclass 2023-07-28 09:36:48 +01:00			`using KdeConnectPlugin::KdeConnectPlugin;`
Port ping away from kDebug 2014-09-21 23:45:41 +01:00
Move the send ping code to the ping plugin turn it into a dbus call to the plugin Reviewed by Albert Vaca 2014-06-27 17:21:40 +01:00			`Q_SCRIPTABLE void sendPing();`
Add and make use of ECM's clang-format integration 2022-09-10 22:23:52 +01:00			`Q_SCRIPTABLE void sendPing(const QString &customMessage);`
Move the send ping code to the ping plugin turn it into a dbus call to the plugin Reviewed by Albert Vaca 2014-06-27 17:21:40 +01:00
Simplify KDEConnectPlugin::recievePacket - We do not need the return type. If a plugin declares it can handle the packet it should do so. We don't have any fallback logic in place and the packet types are namespaced with the plugin IDs anyway. - Provide a default implementation with a warning, not all plugins need to overwrite this 2023-07-31 08:25:45 +01:00			`void receivePacket(const NetworkPacket &np) override;`
Reduce API exposed through dbus Summary: Don't use QDBusConnection::ExportAllContents No need to make connect and receivedPackage public slots (they're are the parent's already) Fixes T4975 Test Plan: Rough manual test Reviewers: #kde_connect, albertvaka Reviewed By: #kde_connect, albertvaka Maniphest Tasks: T4975 Differential Revision: https://phabricator.kde.org/D3871 2016-12-30 15:38:12 +00:00			`QString dbusPath() const override;`
Rewritten old package emitters and receivers using the new package format Splitted up ping receiver from notification receiver in KDE Improved pausemusic receiver Fixed same computer being discovered multiple times Fixed some other minor bugs and compilation warnings 2013-07-04 18:17:22 +01:00			`};`