BLECharacteristicMap Class Reference

A data mapping used to manage the set of BLE characteristics known to the server. More...

#include <BLEService.hpp>

Public Member Functions
void	setByUUID (BLECharacteristic *pCharacteristic, const char *uuid)
void	setByUUID (BLECharacteristic *pCharacteristic, BLEUUID uuid)
	Set the characteristic by UUID. More...
void	setByHandle (uint16_t handle, BLECharacteristic *pCharacteristic)
	Set the characteristic by handle. More...
BLECharacteristic *	getByUUID (const char *uuid)
	Return the characteristic by UUID. More...
BLECharacteristic *	getByUUID (BLEUUID uuid)
	Return the characteristic by UUID. More...
BLECharacteristic *	getByHandle (uint16_t handle)
	Return the characteristic by handle. More...
BLECharacteristic *	getFirst ()
	Get the first characteristic in the map. More...
BLECharacteristic *	getNext ()
	Get the next characteristic in the map. More...
std::string	toString ()
	Return a string representation of the characteristic map. More...
void	handleGATTServerEvent (void *)
	Pass the GATT server event onwards to each of the characteristics found in the mapping. More...

Detailed Description

A data mapping used to manage the set of BLE characteristics known to the server.

Member Function Documentation

getByHandle()

BLECharacteristic * BLECharacteristicMap::getByHandle

(

uint16_t

handle

)

Return the characteristic by handle.

Parameters

[in]

handle

The handle to look up the characteristic.

Returns

The characteristic.

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

getByUUID() [1/2]

BLECharacteristic * BLECharacteristicMap::getByUUID

(

BLEUUID

uuid

)

Return the characteristic by UUID.

Parameters

[in]

UUID

The UUID to look up the characteristic.

Returns

The characteristic.

                                                               {
    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]

BLECharacteristic * BLECharacteristicMap::getByUUID

(

const char *

uuid

)

Return the characteristic by UUID.

Parameters

[in]

UUID

The UUID to look up the characteristic.

Returns

The characteristic.

                                                                   {
    return getByUUID(BLEUUID(uuid));
}

getFirst()

BLECharacteristic * BLECharacteristicMap::getFirst

(

)

Get the first characteristic in the map.

Returns

The first characteristic in the map.

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

getNext()

BLECharacteristic * BLECharacteristicMap::getNext

(

)

Get the next characteristic in the map.

Returns

The next characteristic in the map.

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

handleGATTServerEvent()

void BLECharacteristicMap::handleGATTServerEvent

(

void *

info

)

Pass the GATT server event onwards to each of the characteristics found in the mapping.

Parameters

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

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

setByHandle()

void BLECharacteristicMap::setByHandle	(	uint16_t	handle,
		BLECharacteristic *	characteristic
	)

Set the characteristic by handle.

Parameters

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

Returns

N/A.

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

setByUUID()

void BLECharacteristicMap::setByUUID	(	BLECharacteristic *	pCharacteristic,
		BLEUUID	uuid
	)

Set the characteristic by UUID.

Parameters

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

Returns

N/A.

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

toString()

std::string BLECharacteristicMap::toString

(

)

Return a string representation of the characteristic map.

Returns

A string representation of the characteristic 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/BLEService.hpp
• src/net/BluetoothLE/BLECharacteristicMap.cpp