gecko/dom/bluetooth/bluetooth2/BluetoothGattDescriptor.h
2015-05-03 15:32:37 -04:00

112 lines
3.4 KiB
C++

/* -*- Mode: C++; tab-width: 8; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
/* vim: set ts=8 sts=2 et sw=2 tw=80: */
/* This Source Code Form is subject to the terms of the Mozilla Public
* License, v. 2.0. If a copy of the MPL was not distributed with this file,
* You can obtain one at http://mozilla.org/MPL/2.0/. */
#ifndef mozilla_dom_bluetooth_bluetoothgattdescriptor_h__
#define mozilla_dom_bluetooth_bluetoothgattdescriptor_h__
#include "mozilla/Attributes.h"
#include "mozilla/dom/BluetoothGattDescriptorBinding.h"
#include "mozilla/dom/bluetooth/BluetoothCommon.h"
#include "mozilla/dom/Promise.h"
#include "mozilla/dom/TypedArray.h"
#include "nsCOMPtr.h"
#include "nsWrapperCache.h"
#include "nsPIDOMWindow.h"
BEGIN_BLUETOOTH_NAMESPACE
class BluetoothGattCharacteristic;
class BluetoothSignal;
class BluetoothGattDescriptor final : public nsISupports
, public nsWrapperCache
, public BluetoothSignalObserver
{
public:
NS_DECL_CYCLE_COLLECTING_ISUPPORTS
NS_DECL_CYCLE_COLLECTION_SCRIPT_HOLDER_CLASS(BluetoothGattDescriptor)
/****************************************************************************
* Attribute Getters
***************************************************************************/
BluetoothGattCharacteristic* Characteristic() const
{
return mCharacteristic;
}
void GetUuid(nsString& aUuidStr) const
{
aUuidStr = mUuidStr;
}
void GetValue(JSContext* cx, JS::MutableHandle<JSObject*> aValue) const;
/****************************************************************************
* Methods (Web API Implementation)
***************************************************************************/
already_AddRefed<Promise> ReadValue(ErrorResult& aRv);
already_AddRefed<Promise> WriteValue(
const RootedTypedArray<ArrayBuffer>& aValue, ErrorResult& aRv);
/****************************************************************************
* Others
***************************************************************************/
void Notify(const BluetoothSignal& aData); // BluetoothSignalObserver
nsPIDOMWindow* GetParentObject() const
{
return mOwner;
}
virtual JSObject* WrapObject(JSContext* aCx,
JS::Handle<JSObject*> aGivenProto) override;
BluetoothGattDescriptor(nsPIDOMWindow* aOwner,
BluetoothGattCharacteristic* aCharacteristic,
const BluetoothGattId& aDescriptorId);
private:
~BluetoothGattDescriptor();
/**
* Update the value of this descriptor.
*
* @param aValue [in] BluetoothValue which contains an uint8_t array.
*/
void HandleDescriptorValueUpdated(const BluetoothValue& aValue);
/****************************************************************************
* Variables
***************************************************************************/
nsCOMPtr<nsPIDOMWindow> mOwner;
/**
* Characteristic that this descriptor belongs to.
*/
nsRefPtr<BluetoothGattCharacteristic> mCharacteristic;
/**
* GattId of this GATT descriptor which contains
* 1) mUuid: UUID of this descriptor in byte array format.
* 2) mInstanceId: Instance id of this descriptor.
*/
BluetoothGattId mDescriptorId;
/**
* UUID string of this GATT descriptor.
*/
nsString mUuidStr;
/**
* Value of this GATT descriptor.
*/
nsTArray<uint8_t> mValue;
};
END_BLUETOOTH_NAMESPACE
#endif