diff options
Diffstat (limited to 'src/bluetooth/osx/osxbtcentralmanager_p.h')
| -rw-r--r-- | src/bluetooth/osx/osxbtcentralmanager_p.h | 217 |
1 files changed, 217 insertions, 0 deletions
diff --git a/src/bluetooth/osx/osxbtcentralmanager_p.h b/src/bluetooth/osx/osxbtcentralmanager_p.h new file mode 100644 index 00000000..e8d7d234 --- /dev/null +++ b/src/bluetooth/osx/osxbtcentralmanager_p.h @@ -0,0 +1,217 @@ +/**************************************************************************** +** +** Copyright (C) 2015 The Qt Company Ltd. +** Contact: http://www.qt.io/licensing/ +** +** This file is part of the QtBluetooth module of the Qt Toolkit. +** +** $QT_BEGIN_LICENSE:LGPL21$ +** Commercial License Usage +** Licensees holding valid commercial Qt licenses may use this file in +** accordance with the commercial license agreement provided with the +** Software or, alternatively, in accordance with the terms contained in +** a written agreement between you and The Qt Company. For licensing terms +** and conditions see http://www.qt.io/terms-conditions. For further +** information use the contact form at http://www.qt.io/contact-us. +** +** GNU Lesser General Public License Usage +** Alternatively, this file may be used under the terms of the GNU Lesser +** General Public License version 2.1 or version 3 as published by the Free +** Software Foundation and appearing in the file LICENSE.LGPLv21 and +** LICENSE.LGPLv3 included in the packaging of this file. Please review the +** following information to ensure the GNU Lesser General Public License +** requirements will be met: https://www.gnu.org/licenses/lgpl.html and +** http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html. +** +** As a special exception, The Qt Company gives you certain additional +** rights. These rights are described in The Qt Company LGPL Exception +** version 1.1, included in the file LGPL_EXCEPTION.txt in this package. +** +** $QT_END_LICENSE$ +** +****************************************************************************/ + +#ifndef OSXBTCENTRALMANAGER_P_H +#define OSXBTCENTRALMANAGER_P_H + +#include "qlowenergycontroller.h" +#include "qlowenergyservice.h" +#include "qbluetoothuuid.h" +#include "osxbtutility_p.h" + +#include <QtCore/qbytearray.h> +#include <QtCore/qglobal.h> +#include <QtCore/qqueue.h> +#include <QtCore/qhash.h> + +// Foundation.h must be included before corebluetoothwrapper_p.h - +// a workaround for a broken 10.9 SDK. +#include <Foundation/Foundation.h> + +#include "corebluetoothwrapper_p.h" + +@class QT_MANGLE_NAMESPACE(OSXBTCentralManager); + +QT_BEGIN_NAMESPACE + +class QLowEnergyServicePrivate; + +namespace OSXBluetooth { + +class CentralManagerDelegate +{ +public: + typedef QT_MANGLE_NAMESPACE(OSXBTCentralManager) ObjCCentralManager; + typedef ObjCStrongReference<NSArray> LEServices; + typedef QSharedPointer<QLowEnergyServicePrivate> LEService; + typedef ObjCStrongReference<CBCharacteristic> LECharacteristic; + + virtual ~CentralManagerDelegate(); + + virtual void LEnotSupported() = 0; + virtual void connectSuccess() = 0; + virtual void serviceDiscoveryFinished(LEServices services) = 0; + virtual void serviceDetailsDiscoveryFinished(LEService service) = 0; + virtual void characteristicReadNotification(QLowEnergyHandle charHandle, + const QByteArray &value) = 0; + virtual void characteristicWriteNotification(QLowEnergyHandle charHandle, + const QByteArray &value) = 0; + virtual void characteristicUpdateNotification(QLowEnergyHandle charHandle, + const QByteArray &value) = 0; + virtual void descriptorReadNotification(QLowEnergyHandle descHandle, + const QByteArray &value) = 0; + virtual void descriptorWriteNotification(QLowEnergyHandle descHandle, + const QByteArray &value) = 0; + virtual void disconnected() = 0; + + // General errors. + virtual void error(QLowEnergyController::Error error) = 0; + // Service related errors. + virtual void error(const QBluetoothUuid &serviceUuid, + QLowEnergyController::Error error) = 0; + // Characteristics/descriptors related errors. + virtual void error(const QBluetoothUuid &serviceUuid, + QLowEnergyService::ServiceError error) = 0; +}; + +enum CentralManagerState +{ + // QLowEnergyController already has some of these states, + // but it's not enough and we need more special states here. + CentralManagerIdle, + // Required by CBCentralManager to avoid problems with dangled pointers. + CentralManagerUpdating, + CentralManagerConnecting, + CentralManagerDiscovering, + CentralManagerDisconnecting +}; + +// In Qt we work with handles and UUIDs. Core Bluetooth +// has NSArrays (and nested NSArrays inside servces/characteristics). +// To simplify a navigation, I need a simple way to map from a handle +// to a Core Bluetooth object. These are weak pointers, +// will probably require '__weak' with ARC. +typedef QHash<QLowEnergyHandle, CBService *> ServiceHash; +typedef QHash<QLowEnergyHandle, CBCharacteristic *> CharHash; +typedef QHash<QLowEnergyHandle, CBDescriptor *> DescHash; + +// Descriptor/charactesirsti read/write requests +// - we have to serialize 'concurrent' write requests. +struct LERequest { + enum RequestType { + CharRead, + CharWrite, + DescRead, + DescWrite, + ClientConfiguration, + Invalid + }; + + LERequest() : type(Invalid), + withResponse(false), + handle(0) + {} + + RequestType type; + bool withResponse; + QLowEnergyHandle handle; + QByteArray value; +}; + +typedef QQueue<LERequest> RequestQueue; + +// Core Bluetooth's write confirmation does not provide +// the updated value (characteristic or descriptor). +// But the Qt's Bluetooth API ('write with response') +// expects this updated value as a response, so we have +// to cache this write value and report it back. +// 'NSObject *' will require '__weak' with ARC. +typedef QHash<NSObject *, QByteArray> ValueHash; + +} + +QT_END_NAMESPACE + +@interface QT_MANGLE_NAMESPACE(OSXBTCentralManager) : NSObject<CBCentralManagerDelegate, CBPeripheralDelegate> +{ + CBCentralManager *manager; + QT_PREPEND_NAMESPACE(OSXBluetooth)::CentralManagerState managerState; + bool disconnectPending; + + QT_PREPEND_NAMESPACE(QBluetoothUuid) deviceUuid; + CBPeripheral *peripheral; + + QT_PREPEND_NAMESPACE(OSXBluetooth)::CentralManagerDelegate *delegate; + + // Quite a verbose service discovery machinery + // (a "graph traversal"). + QT_PREPEND_NAMESPACE(OSXBluetooth)::ObjCStrongReference<NSMutableArray> servicesToVisit; + // The service we're discovering now (included services discovery): + NSUInteger currentService; + // Included services, we'll iterate through at the end of 'servicesToVisit': + QT_PREPEND_NAMESPACE(OSXBluetooth)::ObjCStrongReference<NSMutableArray> servicesToVisitNext; + // We'd like to avoid loops in a services' topology: + QT_PREPEND_NAMESPACE(OSXBluetooth)::ObjCStrongReference<NSMutableSet> visitedServices; + + QT_PREPEND_NAMESPACE(QList)<QT_PREPEND_NAMESPACE(QBluetoothUuid)> servicesToDiscoverDetails; + + QT_PREPEND_NAMESPACE(OSXBluetooth)::ServiceHash serviceMap; + QT_PREPEND_NAMESPACE(OSXBluetooth)::CharHash charMap; + QT_PREPEND_NAMESPACE(OSXBluetooth)::DescHash descMap; + + QT_PREPEND_NAMESPACE(QLowEnergyHandle) lastValidHandle; + + bool requestPending; + QT_PREPEND_NAMESPACE(OSXBluetooth)::RequestQueue requests; + QT_PREPEND_NAMESPACE(QLowEnergyHandle) currentReadHandle; + + QT_PREPEND_NAMESPACE(OSXBluetooth)::ValueHash valuesToWrite; +} + +- (id)initWithDelegate:(QT_PREPEND_NAMESPACE(OSXBluetooth)::CentralManagerDelegate *)aDelegate; +- (void)dealloc; + +- (QT_PREPEND_NAMESPACE(QLowEnergyController)::Error) + connectToDevice:(const QT_PREPEND_NAMESPACE(QBluetoothUuid) &)aDeviceUuid; + +- (void)disconnectFromDevice; + +- (void)discoverServices; +- (bool)discoverServiceDetails:(const QT_PREPEND_NAMESPACE(QBluetoothUuid) &)serviceUuid; + +- (bool)setNotifyValue:(const QT_PREPEND_NAMESPACE(QByteArray) &)value + forCharacteristic:(QT_PREPEND_NAMESPACE(QLowEnergyHandle))charHandle; + +- (bool)readCharacteristic:(QT_PREPEND_NAMESPACE(QLowEnergyHandle))charHandle; + +- (bool)write:(const QT_PREPEND_NAMESPACE(QByteArray) &)value + charHandle:(QT_PREPEND_NAMESPACE(QLowEnergyHandle))charHandle + withResponse:(bool)writeWithResponse; + +- (bool)readDescriptor:(QT_PREPEND_NAMESPACE(QLowEnergyHandle))descHandle; + +- (bool)write:(const QT_PREPEND_NAMESPACE(QByteArray) &)value + descHandle:(QT_PREPEND_NAMESPACE(QLowEnergyHandle))descHandle; +@end + +#endif |