77 lines
2.8 KiB
C++
77 lines
2.8 KiB
C++
/*
|
|
* Copyright 2020-2025 Ryan Powell <ryan@nable-embedded.io> and
|
|
* esp-nimble-cpp, NimBLE-Arduino contributors.
|
|
*
|
|
* Licensed under the Apache License, Version 2.0 (the "License");
|
|
* you may not use this file except in compliance with the License.
|
|
* You may obtain a copy of the License at
|
|
*
|
|
* http://www.apache.org/licenses/LICENSE-2.0
|
|
*
|
|
* Unless required by applicable law or agreed to in writing, software
|
|
* distributed under the License is distributed on an "AS IS" BASIS,
|
|
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
* See the License for the specific language governing permissions and
|
|
* limitations under the License.
|
|
*/
|
|
|
|
#ifndef NIMBLE_CPP_DESCRIPTOR_H_
|
|
#define NIMBLE_CPP_DESCRIPTOR_H_
|
|
|
|
#include "nimconfig.h"
|
|
#if CONFIG_BT_ENABLED && CONFIG_BT_NIMBLE_ROLE_PERIPHERAL
|
|
|
|
# include "NimBLELocalValueAttribute.h"
|
|
# include <string>
|
|
|
|
class NimBLECharacteristic;
|
|
class NimBLEDescriptorCallbacks;
|
|
|
|
/**
|
|
* @brief A model of a BLE descriptor.
|
|
*/
|
|
class NimBLEDescriptor : public NimBLELocalValueAttribute {
|
|
public:
|
|
NimBLEDescriptor(const char* uuid, uint16_t properties, uint16_t maxLen, NimBLECharacteristic* pCharacteristic = nullptr);
|
|
|
|
NimBLEDescriptor(const NimBLEUUID& uuid,
|
|
uint16_t properties,
|
|
uint16_t maxLen,
|
|
NimBLECharacteristic* pCharacteristic = nullptr);
|
|
~NimBLEDescriptor() = default;
|
|
|
|
std::string toString() const;
|
|
void setCallbacks(NimBLEDescriptorCallbacks* pCallbacks);
|
|
NimBLECharacteristic* getCharacteristic() const;
|
|
|
|
private:
|
|
friend class NimBLECharacteristic;
|
|
friend class NimBLEService;
|
|
|
|
void setCharacteristic(NimBLECharacteristic* pChar);
|
|
void readEvent(NimBLEConnInfo& connInfo) override;
|
|
void writeEvent(const uint8_t* val, uint16_t len, NimBLEConnInfo& connInfo) override;
|
|
|
|
NimBLEDescriptorCallbacks* m_pCallbacks{nullptr};
|
|
NimBLECharacteristic* m_pCharacteristic{nullptr};
|
|
}; // NimBLEDescriptor
|
|
|
|
/**
|
|
* @brief Callbacks that can be associated with a %BLE descriptors to inform of events.
|
|
*
|
|
* When a server application creates a %BLE descriptor, we may wish to be informed when there is either
|
|
* a read or write request to the descriptors value. An application can register a
|
|
* sub-classed instance of this class and will be notified when such an event happens.
|
|
*/
|
|
class NimBLEDescriptorCallbacks {
|
|
public:
|
|
virtual ~NimBLEDescriptorCallbacks() = default;
|
|
virtual void onRead(NimBLEDescriptor* pDescriptor, NimBLEConnInfo& connInfo);
|
|
virtual void onWrite(NimBLEDescriptor* pDescriptor, NimBLEConnInfo& connInfo);
|
|
};
|
|
|
|
# include "NimBLE2904.h"
|
|
|
|
#endif // CONFIG_BT_ENABLED && CONFIG_BT_NIMBLE_ROLE_PERIPHERAL
|
|
#endif // NIMBLE_CPP_DESCRIPTOR_H_
|