diff options
Diffstat (limited to 'src/DBusInterface.h')
| -rw-r--r-- | src/DBusInterface.h | 140 |
1 files changed, 140 insertions, 0 deletions
diff --git a/src/DBusInterface.h b/src/DBusInterface.h new file mode 100644 index 0000000..8598675 --- /dev/null +++ b/src/DBusInterface.h @@ -0,0 +1,140 @@ +// Copyright 2017 Paul Nettle. +// +// This file is part of Gobbledegook. +// +// Gobbledegook is free software: you can redistribute it and/or modify +// it under the terms of the GNU General Public License as published by +// the Free Software Foundation, either version 3 of the License, or +// (at your option) any later version. +// +// Gobbledegook is distributed in the hope that it will be useful, +// but WITHOUT ANY WARRANTY; without even the implied warranty of +// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +// GNU General Public License for more details. +// +// You should have received a copy of the GNU General Public License +// along with Gobbledegook. If not, see <http://www.gnu.org/licenses/>. + +// ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +// +// >> +// >>> INSIDE THIS FILE +// >> +// +// This is an abstraction layer for a D-Bus interface, the base class for all interfaces. +// +// >> +// >>> DISCUSSION +// >> +// +// See the discussion in DBusInterface.cpp. +// ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +#pragma once + +#include <gio/gio.h> +#include <string> +#include <list> + +#include "TickEvent.h" +#include "DBusMethod.h" +#include "DBusObjectPath.h" + +// --------------------------------------------------------------------------------------------------------------------------------- +// Forward declarations +// --------------------------------------------------------------------------------------------------------------------------------- + +struct DBusInterface; +struct GattProperty; +struct DBusObject; + +// --------------------------------------------------------------------------------------------------------------------------------- +// Useful Lambdas +// --------------------------------------------------------------------------------------------------------------------------------- + +#define INTERFACE_METHOD_CALLBACK_LAMBDA [] \ +( \ + const DBusInterface &self, \ + GDBusConnection *pConnection, \ + const std::string &methodName, \ + GVariant *pParameters, \ + GDBusMethodInvocation *pInvocation, \ + void *pUserData \ +) + +#define TRY_GET_INTERFACE_OF_TYPE(pInterface, type) \ + (pInterface->getInterfaceType() == type::kInterfaceType ? \ + std::static_pointer_cast<type>(pInterface) : \ + nullptr) + +#define TRY_GET_CONST_INTERFACE_OF_TYPE(pInterface, type) \ + (pInterface->getInterfaceType() == type::kInterfaceType ? \ + std::static_pointer_cast<const type>(pInterface) : \ + nullptr) + +// --------------------------------------------------------------------------------------------------------------------------------- +// Representation of a D-Bus interface +// --------------------------------------------------------------------------------------------------------------------------------- + +struct DBusInterface +{ + // Our interface type + static constexpr const char *kInterfaceType = "DBusInterface"; + + typedef void (*MethodCallback)(const DBusInterface &self, GDBusConnection *pConnection, const std::string &methodName, GVariant *pParameters, GDBusMethodInvocation *pInvocation, void *pUserData); + typedef void (*EventCallback)(const DBusInterface &self, const TickEvent &event, GDBusConnection *pConnection, void *pUserData); + + // Standard constructor + DBusInterface(DBusObject &owner, const std::string &name); + virtual ~DBusInterface(); + + // Returns a string identifying the type of interface + virtual const std::string getInterfaceType() const { return DBusInterface::kInterfaceType; } + + // + // Interface name (ex: "org.freedesktop.DBus.Properties") + // + + const std::string &getName() const; + DBusInterface &setName(const std::string &name); + + // + // Owner information + // + + DBusObject &getOwner() const; + DBusObjectPath getPathNode() const; + DBusObjectPath getPath() const; + + // + // D-Bus interface methods + // + + DBusInterface &addMethod(const std::string &name, const char *pInArgs[], const char *pOutArgs, DBusMethod::Callback callback); + + // NOTE: Subclasses are encouraged to override this method in order to support different callback types that are specific to + // their subclass type. + virtual bool callMethod(const std::string &methodName, GDBusConnection *pConnection, GVariant *pParameters, GDBusMethodInvocation *pInvocation, gpointer pUserData) const; + + // + // Interface events (our home-grown poor-mans's method of allowing interfaces to do things periodically) + // + + // NOTE: Subclasses are encouraged to overload this method in order to support different callback types that are specific to + // their subclass type. In addition, they should return their own type. This simplifies the server description by allowing + // calls to chain. + DBusInterface &onEvent(int tickFrequency, void *pUserData, TickEvent::Callback callback); + + // NOTE: Subclasses are encouraged to override this method in order to support different callback types that are specific to + // their subclass type. + virtual void tickEvents(GDBusConnection *pConnection, void *pUserData) const; + + // Internal method used to generate introspection XML used to describe our services on D-Bus + virtual std::string generateIntrospectionXML(int depth) const; + +protected: + DBusObject &owner; + std::string name; + std::list<DBusMethod> methods; + std::list<TickEvent> events; +}; |