struct Core::Bluetooth::IGattCentralCharacteristic

Overview

#include <coregattcentral.h>

struct IGattCentralCharacteristic: public Core::Bluetooth::IGattCentralAttribute
{
    // methods

    virtual UIDBytes getUid () const = 0;
    virtual CharacteristicProperties getProperties () const = 0;
    virtual ErrorCode getDescriptorsAsync (const IDFilter& descriptorFilter) = 0;
    virtual ErrorCode subscribeAsync () = 0;
    virtual ErrorCode unsubscribeAsync () = 0;
    virtual void addObserver (IGattCentralCharacteristicObserver* observer) = 0;
    virtual void removeObserver (IGattCentralCharacteristicObserver* observer) = 0;
};

Inherited Members

public:
    // methods

    virtual ErrorCode readAsync () = 0;
    virtual ErrorCode writeAsync (const uint8 valueBuffer [], int valueSize) = 0;

Detailed Documentation

Methods

virtual UIDBytes getUid () const = 0

Get the id of this characteristic.

virtual CharacteristicProperties getProperties () const = 0

Get the properties.

These properties indicate which operations this characteristic supports.

virtual ErrorCode getDescriptorsAsync (const IDFilter& descriptorFilter) = 0

Retrieve all descriptors of this characteristic.

If the descriptorFilter is not empty, it will only return the descriptors whose ids are in the descriptorFilter.

virtual ErrorCode subscribeAsync () = 0

Subscribe to characteristic value updates.

It calls onNotificationReceived() whenever the value changes.

virtual ErrorCode unsubscribeAsync () = 0

Unsubscribe from characteristic value updates.

virtual void addObserver (IGattCentralCharacteristicObserver* observer) = 0

Start receiving callbacks.

virtual void removeObserver (IGattCentralCharacteristicObserver* observer) = 0

Stop receiving callbacks.