mirror of
https://github.com/h2zero/esp-nimble-cpp.git
synced 2024-12-18 09:10:47 +01:00
91210b8610
Refactor attributes to reduce code duplication and improve maintainability. * Add attribute base classes to provide common code. * Add const where possible to functions and parameters. * `NimBLECharacteristic::notify` no longer takes a `bool is_notification` parameter, instead `indicate()` should be called to send indications. * `NimBLECharacteristic::indicate` now takes the same parameters as `notify`. * `NimBLECharacteristicCallbacks` and `NimBLEDescriptorCallbacks` methods now take `const NimBLEConnInfo&` instead of non-const. * `NimBLECharacteristic::onNotify` callback removed as unnecessary, the library does not call notify without app input. * `NimBLERemoteCharacteristic::getRemoteService` now returns a `const NimBLERemoteService*` instead of non-const. * Add NimBLEUUID constructor that takes a reference to `ble_uuid_any_t`. * `NimBLERemoteService::getCharacteristics` now returns a `const std::vector<NimBLERemoteCharacteristic*>&` instead of non-const `std::vector<NimBLERemoteCharacteristic*>*` * `NimBLERemoteService::getValue` now returns `NimBLEAttValue` instead of `std::string` * `NimBLEService::getCharacteristics` now returns a `const std::vector<NimBLECharacteristic*>&` instead of a copy of std::vector<NimBLECharacteristic *>. * Remove const requirement for NimBLEConnInfo parameter in callbacks. Const is unnecessary as the data can't be changed by application code. * Change NimBLERemoteCharacteristic::getRemoteService to return const pointer.
78 lines
3 KiB
C++
78 lines
3 KiB
C++
/*
|
|
* NimBLERemoteCharacteristic.h
|
|
*
|
|
* Created: on Jan 27 2020
|
|
* Author H2zero
|
|
*
|
|
* Originally:
|
|
*
|
|
* BLERemoteCharacteristic.h
|
|
*
|
|
* Created on: Jul 8, 2017
|
|
* Author: kolban
|
|
*/
|
|
|
|
#ifndef NIMBLE_CPP_REMOTE_CHARACTERISTIC_H_
|
|
#define NIMBLE_CPP_REMOTE_CHARACTERISTIC_H_
|
|
|
|
#include "nimconfig.h"
|
|
#if defined(CONFIG_BT_ENABLED) && defined(CONFIG_BT_NIMBLE_ROLE_CENTRAL)
|
|
|
|
# include "NimBLERemoteValueAttribute.h"
|
|
# include <vector>
|
|
# include <functional>
|
|
|
|
class NimBLERemoteService;
|
|
class NimBLERemoteDescriptor;
|
|
|
|
/**
|
|
* @brief A model of a remote BLE characteristic.
|
|
*/
|
|
class NimBLERemoteCharacteristic : public NimBLERemoteValueAttribute {
|
|
public:
|
|
std::string toString() const;
|
|
const NimBLERemoteService* getRemoteService() const;
|
|
void deleteDescriptors() const;
|
|
size_t deleteDescriptor(const NimBLEUUID& uuid) const;
|
|
bool canBroadcast() const;
|
|
bool canRead() const;
|
|
bool canWriteNoResponse() const;
|
|
bool canWrite() const;
|
|
bool canNotify() const;
|
|
bool canIndicate() const;
|
|
bool canWriteSigned() const;
|
|
bool hasExtendedProps() const;
|
|
NimBLEClient* getClient() const override;
|
|
|
|
typedef std::function<void(NimBLERemoteCharacteristic* pBLERemoteCharacteristic, uint8_t* pData, size_t length, bool isNotify)> notify_callback;
|
|
|
|
bool subscribe(bool notifications = true, const notify_callback notifyCallback = nullptr, bool response = true) const;
|
|
bool unsubscribe(bool response = true) const;
|
|
|
|
std::vector<NimBLERemoteDescriptor*>::iterator begin() const;
|
|
std::vector<NimBLERemoteDescriptor*>::iterator end() const;
|
|
NimBLERemoteDescriptor* getDescriptor(const NimBLEUUID& uuid) const;
|
|
const std::vector<NimBLERemoteDescriptor*>& getDescriptors(bool refresh = false) const;
|
|
|
|
private:
|
|
friend class NimBLEClient;
|
|
friend class NimBLERemoteService;
|
|
|
|
NimBLERemoteCharacteristic(const NimBLERemoteService* pRemoteService, const ble_gatt_chr* chr);
|
|
~NimBLERemoteCharacteristic();
|
|
|
|
bool setNotify(uint16_t val, notify_callback notifyCallback = nullptr, bool response = true) const;
|
|
bool retrieveDescriptors(const NimBLEUUID* uuidFilter = nullptr) const;
|
|
|
|
static int descriptorDiscCB(
|
|
uint16_t conn_handle, const ble_gatt_error* error, uint16_t chr_val_handle, const ble_gatt_dsc* dsc, void* arg);
|
|
|
|
const NimBLERemoteService* m_pRemoteService{nullptr};
|
|
uint8_t m_properties{0};
|
|
mutable notify_callback m_notifyCallback{nullptr};
|
|
mutable std::vector<NimBLERemoteDescriptor*> m_vDescriptors{};
|
|
|
|
}; // NimBLERemoteCharacteristic
|
|
|
|
#endif /* CONFIG_BT_ENABLED && CONFIG_BT_NIMBLE_ROLE_CENTRAL */
|
|
#endif /* NIMBLE_CPP_REMOTE_CHARACTERISTIC_H_ */
|