forked from h2zero/esp-nimble-cpp
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.
66 lines
2.4 KiB
C++
66 lines
2.4 KiB
C++
/*
|
|
* NimBLERemoteService.h
|
|
*
|
|
* Created: on Jan 27 2020
|
|
* Author H2zero
|
|
*
|
|
* Originally:
|
|
*
|
|
* BLERemoteService.h
|
|
*
|
|
* Created on: Jul 8, 2017
|
|
* Author: kolban
|
|
*/
|
|
|
|
#ifndef NIMBLE_CPP_REMOTE_SERVICE_H_
|
|
#define NIMBLE_CPP_REMOTE_SERVICE_H_
|
|
|
|
#include "nimconfig.h"
|
|
#if defined(CONFIG_BT_ENABLED) && defined(CONFIG_BT_NIMBLE_ROLE_CENTRAL)
|
|
|
|
# include "NimBLEAttribute.h"
|
|
# include <vector>
|
|
|
|
class NimBLERemoteCharacteristic;
|
|
class NimBLEClient;
|
|
class NimBLEAttValue;
|
|
|
|
/**
|
|
* @brief A model of a remote BLE service.
|
|
*/
|
|
class NimBLERemoteService : public NimBLEAttribute {
|
|
public:
|
|
NimBLERemoteCharacteristic* getCharacteristic(const char* uuid) const;
|
|
NimBLERemoteCharacteristic* getCharacteristic(const NimBLEUUID& uuid) const;
|
|
void deleteCharacteristics() const;
|
|
size_t deleteCharacteristic(const NimBLEUUID& uuid) const;
|
|
NimBLEClient* getClient(void) const;
|
|
NimBLEAttValue getValue(const NimBLEUUID& characteristicUuid) const;
|
|
bool setValue(const NimBLEUUID& characteristicUuid, const NimBLEAttValue& value) const;
|
|
std::string toString(void) const;
|
|
uint16_t getStartHandle() const { return getHandle(); }
|
|
uint16_t getEndHandle() const { return m_endHandle; }
|
|
|
|
const std::vector<NimBLERemoteCharacteristic*>& getCharacteristics(bool refresh = false) const;
|
|
std::vector<NimBLERemoteCharacteristic*>::iterator begin() const;
|
|
std::vector<NimBLERemoteCharacteristic*>::iterator end() const;
|
|
|
|
private:
|
|
friend class NimBLEClient;
|
|
|
|
NimBLERemoteService(NimBLEClient* pClient, const struct ble_gatt_svc* service);
|
|
~NimBLERemoteService();
|
|
bool retrieveCharacteristics(const NimBLEUUID* uuidFilter = nullptr) const;
|
|
static int characteristicDiscCB(uint16_t conn_handle,
|
|
const struct ble_gatt_error* error,
|
|
const struct ble_gatt_chr* chr,
|
|
void* arg);
|
|
|
|
mutable std::vector<NimBLERemoteCharacteristic*> m_vChars{};
|
|
NimBLEClient* m_pClient{nullptr};
|
|
uint16_t m_endHandle{0};
|
|
}; // NimBLERemoteService
|
|
|
|
#endif /* CONFIG_BT_ENABLED && CONFIG_BT_NIMBLE_ROLE_CENTRAL */
|
|
#endif /* NIMBLE_CPP_REMOTE_SERVICE_H_*/
|