BLEDescriptorMap Class Reference

A management structure for BLE descriptors. More...

#include <BLECharacteristic.hpp>

Public Member Functions
void	setByUUID (const char *uuid, BLEDescriptor *pDescriptor)
	Set the descriptor by UUID. More...
void	setByUUID (BLEUUID uuid, BLEDescriptor *pDescriptor)
	Set the descriptor by UUID. More...
void	setByHandle (uint16_t handle, BLEDescriptor *pDescriptor)
	Set the descriptor by handle. More...
BLEDescriptor *	getByUUID (const char *uuid)
	Return the descriptor by UUID. More...
BLEDescriptor *	getByUUID (BLEUUID uuid)
	Return the descriptor by UUID. More...
BLEDescriptor *	getByHandle (uint16_t handle)
	Return the descriptor by handle. More...
std::string	toString ()
	Return a string representation of the descriptor map. More...
void	handleGATTServerEvent (void *info)
BLEDescriptor *	getFirst ()
	Get the first descriptor in the map. More...
BLEDescriptor *	getNext ()
	Get the next descriptor in the map. More...

Detailed Description

A management structure for BLE descriptors.

Member Function Documentation

getByHandle()

BLEDescriptor * BLEDescriptorMap::getByHandle

(

uint16_t

handle

)

Return the descriptor by handle.

Parameters

[in]

handle

The handle to look up the descriptor.

Returns

The descriptor.

                                                            {
    return m_handleMap.at(handle);
} // getByHandle

getByUUID() [1/2]

BLEDescriptor * BLEDescriptorMap::getByUUID

(

BLEUUID

uuid

)

Return the descriptor by UUID.

Parameters

[in]

UUID

The UUID to look up the descriptor.

Returns

The descriptor. If not present, then nullptr is returned.

                                                       {
    for (auto &myPair : m_uuidMap) {
        if (myPair.first->getUUID().equals(uuid)) {
            return myPair.first;
        }
    }
    //return m_uuidMap.at(uuid.toString());
    return nullptr;
} // getByUUID

getByUUID() [2/2]

BLEDescriptor * BLEDescriptorMap::getByUUID

(

const char *

uuid

)

Return the descriptor by UUID.

Parameters

[in]

UUID

The UUID to look up the descriptor.

Returns

The descriptor. If not present, then nullptr is returned.

                                                           {
    return getByUUID(BLEUUID(uuid));
}

getFirst()

BLEDescriptor * BLEDescriptorMap::getFirst

(

)

Get the first descriptor in the map.

Returns

The first descriptor in the map.

                                          {
    m_iterator = m_uuidMap.begin();
    if (m_iterator == m_uuidMap.end()) return nullptr;
    BLEDescriptor* pRet = m_iterator->first;
    m_iterator++;
    return pRet;
} // getFirst

getNext()

BLEDescriptor * BLEDescriptorMap::getNext

(

)

Get the next descriptor in the map.

Returns

The next descriptor in the map.

                                         {
    if (m_iterator == m_uuidMap.end()) return nullptr;
    BLEDescriptor* pRet = m_iterator->first;
    m_iterator++;
    return pRet;
} // getNext

handleGATTServerEvent()

void BLEDescriptorMap::handleGATTServerEvent

(

void *

info

)

@breif Pass the GATT server event onwards to each of the descriptors found in the mapping

Parameters

[in]	event
[in]	gatts_if
[in]	param

                                                       {
    // Invoke the handler for every descriptor we have.
    for (auto &myPair : m_uuidMap) {
        myPair.first->handleGATTServerEvent(info);
    }
} // handleGATTServerEvent

setByHandle()

void BLEDescriptorMap::setByHandle	(	uint16_t	handle,
		BLEDescriptor *	pDescriptor
	)

Set the descriptor by handle.

Parameters

[in]	handle	The handle of the descriptor.
[in]	descriptor	The descriptor to cache.

Returns

N/A.

                                                                              {
    m_handleMap.insert(std::pair<uint16_t, BLEDescriptor*>(handle, pDescriptor));
} // setByHandle

setByUUID() [1/2]

void BLEDescriptorMap::setByUUID	(	BLEUUID	uuid,
		BLEDescriptor *	pDescriptor
	)

Set the descriptor by UUID.

Parameters

[in]	uuid	The uuid of the descriptor.
[in]	characteristic	The descriptor to cache.

Returns

N/A.

                                                                         {
    m_uuidMap.insert(std::pair<BLEDescriptor*, std::string>(pDescriptor, uuid.toString()));
} // setByUUID

setByUUID() [2/2]

void BLEDescriptorMap::setByUUID	(	const char *	uuid,
		BLEDescriptor *	pDescriptor
	)

Set the descriptor by UUID.

Parameters

[in]	uuid	The uuid of the descriptor.
[in]	characteristic	The descriptor to cache.

Returns

N/A.

                                                                            {
    m_uuidMap.insert(std::pair<BLEDescriptor*, std::string>(pDescriptor, uuid));
} // setByUUID

toString()

std::string BLEDescriptorMap::toString

(

)

Return a string representation of the descriptor map.

Returns

A string representation of the descriptor map.

                                     {
    std::stringstream stringStream;
    stringStream << std::hex << std::setfill('0');
    int count = 0;
    for (auto &myPair : m_uuidMap) {
        if (count > 0) {
            stringStream << "\n";
        }
        count++;
        stringStream << "handle: 0x" << std::setw(2) << myPair.first->getHandle() << ", uuid: " + myPair.first->getUUID().toString();
    }
    return stringStream.str();
} // toString

---

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

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