BLEDescriptor Class Reference

A model of a BLE descriptor. More...

#include <BLEDescriptor.hpp>

Inheritance diagram for BLEDescriptor:

Public Member Functions
	BLEDescriptor (const char *uuid, uint16_t max_len=100)
	BLEDescriptor constructor.
	BLEDescriptor (BLEUUID uuid, uint16_t max_len=100)
	BLEDescriptor constructor.
virtual	~BLEDescriptor ()
	BLEDescriptor destructor.
uint16_t	getHandle ()
	Get the BLE handle for this descriptor. More...
size_t	getLength ()
	Get the length of the value of this descriptor. More...
BLEUUID	getUUID ()
	Get the UUID of the descriptor.
uint8_t *	getValue ()
	Get the value of this descriptor. More...
void	handleGATTServerEvent (void *info)
void	setAccessPermissions (ble_gatt_perm_t perm)
void	setCallbacks (BLEDescriptorCallbacks *pCallbacks)
	Set the callback handlers for this descriptor. More...
void	setValue (uint8_t *data, size_t size)
	Set the value of the descriptor. More...
void	setValue (std::string value)
	Set the value of the descriptor. More...
std::string	toString ()
	Return a string representation of the descriptor. More...

Detailed Description

A model of a BLE descriptor.

Member Function Documentation

getHandle()

uint16_t BLEDescriptor::getHandle

(

)

Get the BLE handle for this descriptor.

Returns

The handle for this descriptor.

                                  {
    return m_handle;
} // getHandle

getLength()

size_t BLEDescriptor::getLength

(

)

Get the length of the value of this descriptor.

Returns

The length (in bytes) of the value of this descriptor.

                                {
    return m_value.attr_len;
} // getLength

getValue()

uint8_t * BLEDescriptor::getValue

(

)

Get the value of this descriptor.

Returns

A pointer to the value of this descriptor.

                                 {
    return m_value.attr_value;
} // getValue

setCallbacks()

void BLEDescriptor::setCallbacks

(

BLEDescriptorCallbacks *

pCallback

)

Set the callback handlers for this descriptor.

Parameters

[in]

pCallbacks

An instance of a callback structure used to define any callbacks for the descriptor.

                                                                  {
    _debug_print_p(TAG, ">> setCallbacks", pCallback);
    m_pCallback = pCallback;
    _debug_print(TAG, "<< setCallbacks");
} // setCallbacks

setValue() [1/2]

void BLEDescriptor::setValue

(

std::string

value

)

Set the value of the descriptor.

Parameters

[in]

value

The value of the descriptor in string form.

                                            {
    setValue((uint8_t*) value.data(), value.length());
} // setValue

setValue() [2/2]

void BLEDescriptor::setValue	(	uint8_t *	data,
		size_t	length
	)

Set the value of the descriptor.

Parameters

[in]	data	The data to set for the descriptor.
[in]	length	The length of the data in bytes.

                                                         {
    if (length > BLE_GATT_MAX_ATTR_LEN) {
        void *logCtx __attribute__((unused)) = nullptr;
        _debug_print_d(TAG, "Size too large", length, &logCtx);
        _debug_print_d(TAG, ", must be no bigger than", BLE_GATT_MAX_ATTR_LEN, &logCtx);
        return;
    }
    m_value.attr_len = length;
    memcpy(m_value.attr_value, data, length);
} // setValue

toString()

std::string BLEDescriptor::toString

(

)

Return a string representation of the descriptor.

Returns

A string representation of the descriptor.

                                  {
    std::stringstream stringstream;
    stringstream << std::hex << std::setfill('0');
    stringstream << "UUID: " << m_bleUUID.toString() + ", handle: 0x" << std::setw(2) << m_handle;
    return stringstream.str();
} // toString

---

The documentation for this class was generated from the following files:

• nola-sdk/include/BLEDescriptor.hpp
• src/net/BluetoothLE/BLEDescriptor.cpp