diff options
Diffstat (limited to 'src/GattInterface.cpp')
| -rw-r--r-- | src/GattInterface.cpp | 123 |
1 files changed, 123 insertions, 0 deletions
diff --git a/src/GattInterface.cpp b/src/GattInterface.cpp new file mode 100644 index 0000000..bb80481 --- /dev/null +++ b/src/GattInterface.cpp @@ -0,0 +1,123 @@ +// 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 our abstraction layer for GATT interfaces, used by GattService, GattCharacteristic & GattDescriptor +// +// >> +// >>> DISCUSSION +// >> +// +// This class is intended to be used within the server description. For an explanation of how this class is used, see the detailed +// description in Server.cpp. +// ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +#include "GattInterface.h" +#include "GattProperty.h" +#include "DBusObject.h" +#include "Logger.h" + +// +// Standard constructor +// +GattInterface::GattInterface(DBusObject &owner, const std::string &name) +: DBusInterface(owner, name) +{ +} + +GattInterface::~GattInterface() +{ +} + +// +// GATT Characteristic properties +// + +// Returns the list of GATT properties +const std::list<GattProperty> &GattInterface::getProperties() const +{ + return properties; +} + +// When responding to a method, we need to return a GVariant value wrapped in a tuple. This method will simplify this slightly by +// wrapping a GVariant of the type "ay" and wrapping it in a tuple before sending it off as the method response. +// +// This is the generalized form that accepts a GVariant *. There is a templated helper method (`methodReturnValue()`) that accepts +// common types. +void GattInterface::methodReturnVariant(GDBusMethodInvocation *pInvocation, GVariant *pVariant, bool wrapInTuple) const +{ + if (wrapInTuple) + { + pVariant = g_variant_new_tuple(&pVariant, 1); + } + g_dbus_method_invocation_return_value(pInvocation, pVariant); +} + +// Locates a `GattProperty` within the interface +// +// This method returns a pointer to the property or nullptr if not found +const GattProperty *GattInterface::findProperty(const std::string &name) const +{ + for (const GattProperty &property : properties) + { + if (property.getName() == name) + { + return &property; + } + } + + return nullptr; +} + +// Internal method used to generate introspection XML used to describe our services on D-Bus +std::string GattInterface::generateIntrospectionXML(int depth) const +{ + std::string prefix; + prefix.insert(0, depth * 2, ' '); + + std::string xml = std::string(); + + if (methods.size() && getProperties().empty()) + { + xml += prefix + "<interface name='" + getName() + "' />\n"; + } + else + { + xml += prefix + "<interface name='" + getName() + "'>\n"; + + // Describe our methods + for (const DBusMethod &method : methods) + { + xml += method.generateIntrospectionXML(depth + 1); + } + + // Describe our properties + for (const GattProperty &property : getProperties()) + { + xml += property.generateIntrospectionXML(depth + 1); + } + + xml += prefix + "</interface>\n"; + } + + return xml; +} |