ScStw/esp-nimble-cpp
2
0
Fork 0
mirror of https://github.com/h2zero/esp-nimble-cpp.git synced 2025-01-22 09:20:51 +01:00
Code Issues Projects Releases Packages Wiki Activity

refactor(Client): Reduce nesting

Browse source 
* Renames serviceDiscoveredCB to serviceDiscCB.
* Adds parameter out to retrieveServices, default value works as the original method.
    * out: if not nullptr, will allow caller to obtain the service
* General cleanup
This commit is contained in:
thekurtovic 2025-01-11 00:56:33 -05:00
parent 5ac7272f5d
commit e843bc7420
2 changed files with 94 additions and 117 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

199
src/NimBLEClient.cpp
View file

@ -101,8 +101,8 @@ NimBLEClient::~NimBLEClient() {
*/ */
void NimBLEClient::deleteServices() { void NimBLEClient::deleteServices() {
// Delete all the services. // Delete all the services.
for (auto& it : m_svcVec) { for (auto& svc : m_svcVec) {
delete it; delete svc;
} }
std::vector<NimBLERemoteService*>().swap(m_svcVec); std::vector<NimBLERemoteService*>().swap(m_svcVec);
@ -243,8 +243,7 @@ bool NimBLEClient::connect(const NimBLEAddress& address, bool deleteAttributes,
break; break;
default: default:
NIMBLE_LOGE(LOG_TAG, NIMBLE_LOGE(LOG_TAG, "Failed to connect to %s, rc=%d; %s",
"Failed to connect to %s, rc=%d; %s",
std::string(m_peerAddress).c_str(), std::string(m_peerAddress).c_str(),
rc, rc,
NimBLEUtils::returnCodeToString(rc)); NimBLEUtils::returnCodeToString(rc));
@ -631,48 +630,36 @@ NimBLERemoteService* NimBLEClient::getService(const char* uuid) {
*/ */
NimBLERemoteService* NimBLEClient::getService(const NimBLEUUID& uuid) { NimBLERemoteService* NimBLEClient::getService(const NimBLEUUID& uuid) {
NIMBLE_LOGD(LOG_TAG, ">> getService: uuid: %s", uuid.toString().c_str()); NIMBLE_LOGD(LOG_TAG, ">> getService: uuid: %s", uuid.toString().c_str());
NimBLERemoteService *pSvc = nullptr;
NimBLEUUID uuidTmp;
for (auto& it : m_svcVec) { for (auto& svc : m_svcVec) {
if (it->getUUID() == uuid) { if (svc->getUUID() == uuid) {
NIMBLE_LOGD(LOG_TAG, "<< getService: found the service with uuid: %s", uuid.toString().c_str()); NIMBLE_LOGD(LOG_TAG, "<< getService: found the service with uuid: %s", uuid.toString().c_str());
return it; return svc;
} }
} }
size_t prevSize = m_svcVec.size(); if (!retrieveServices(&uuid, pSvc) || pSvc) {
if (retrieveServices(&uuid)) { goto Done;
if (m_svcVec.size() > prevSize) {
return m_svcVec.back();
}
// If the request was successful but 16/32 bit uuid not found
// try again with the 128 bit uuid.
if (uuid.bitSize() == BLE_UUID_TYPE_16 || uuid.bitSize() == BLE_UUID_TYPE_32) {
NimBLEUUID uuid128(uuid);
uuid128.to128();
if (retrieveServices(&uuid128)) {
if (m_svcVec.size() > prevSize) {
return m_svcVec.back();
}
}
} else {
// If the request was successful but the 128 bit uuid not found
// try again with the 16 bit uuid.
NimBLEUUID uuid16(uuid);
uuid16.to16();
// if the uuid was 128 bit but not of the BLE base type this check will fail
if (uuid16.bitSize() == BLE_UUID_TYPE_16) {
if (retrieveServices(&uuid16)) {
if (m_svcVec.size() > prevSize) {
return m_svcVec.back();
}
}
}
}
} }
// Try again with 128 bit uuid if request succeeded with no uuid found.
if (uuid.bitSize() == BLE_UUID_TYPE_16 || uuid.bitSize() == BLE_UUID_TYPE_32) {
uuidTmp = NimBLEUUID(uuid).to128();
retrieveServices(&uuidTmp, pSvc);
goto Done;
}
// Try again with 16 bit uuid if request succeeded with no uuid found.
// If the uuid was 128 bit but not of the BLE base type this check will fail.
uuidTmp = NimBLEUUID(uuid).to16();
if (uuidTmp.bitSize() == BLE_UUID_TYPE_16) {
retrieveServices(&uuidTmp, pSvc);
}
Done:
NIMBLE_LOGD(LOG_TAG, "<< getService: not found"); NIMBLE_LOGD(LOG_TAG, "<< getService: not found");
return nullptr; return pSvc;
} // getService } // getService
/** /**
@ -725,7 +712,7 @@ bool NimBLEClient::discoverAttributes() {
* * Here we ask the server for its set of services and wait until we have received them all. * * Here we ask the server for its set of services and wait until we have received them all.
* @return true on success otherwise false if an error occurred * @return true on success otherwise false if an error occurred
*/ */
bool NimBLEClient::retrieveServices(const NimBLEUUID* uuidFilter) { bool NimBLEClient::retrieveServices(const NimBLEUUID* uuidFilter, NimBLERemoteService *out) {
if (!isConnected()) { if (!isConnected()) {
NIMBLE_LOGE(LOG_TAG, "Disconnected, could not retrieve services -aborting"); NIMBLE_LOGE(LOG_TAG, "Disconnected, could not retrieve services -aborting");
return false; return false;
@ -735,9 +722,9 @@ bool NimBLEClient::retrieveServices(const NimBLEUUID* uuidFilter) {
NimBLETaskData taskData(this); NimBLETaskData taskData(this);
if (uuidFilter == nullptr) { if (uuidFilter == nullptr) {
rc = ble_gattc_disc_all_svcs(m_connHandle, NimBLEClient::serviceDiscoveredCB, &taskData); rc = ble_gattc_disc_all_svcs(m_connHandle, NimBLEClient::serviceDiscCB, &taskData);
} else { } else {
rc = ble_gattc_disc_svc_by_uuid(m_connHandle, uuidFilter->getBase(), NimBLEClient::serviceDiscoveredCB, &taskData); rc = ble_gattc_disc_svc_by_uuid(m_connHandle, uuidFilter->getBase(), NimBLEClient::serviceDiscCB, &taskData);
} }
if (rc != 0) { if (rc != 0) {
@ -748,7 +735,10 @@ bool NimBLEClient::retrieveServices(const NimBLEUUID* uuidFilter) {
NimBLEUtils::taskWait(taskData, BLE_NPL_TIME_FOREVER); NimBLEUtils::taskWait(taskData, BLE_NPL_TIME_FOREVER);
rc = taskData.m_flags; rc = taskData.m_flags;
if (rc == 0 || rc == BLE_HS_EDONE) { if (rc == BLE_HS_EDONE) {
if (out) {
out = m_svcVec.back();
}
return true; return true;
} }
@ -762,39 +752,29 @@ bool NimBLEClient::retrieveServices(const NimBLEUUID* uuidFilter) {
* @details When a service is found or there is none left or there was an error * @details When a service is found or there is none left or there was an error
* the API will call this and report findings. * the API will call this and report findings.
*/ */
int NimBLEClient::serviceDiscoveredCB(uint16_t connHandle, int NimBLEClient::serviceDiscCB(uint16_t connHandle,
const struct ble_gatt_error* error, const struct ble_gatt_error* error,
const struct ble_gatt_svc* service, const struct ble_gatt_svc* service,
void* arg) { void* arg) {
NIMBLE_LOGD(LOG_TAG, const int rc = error->status;
"Service Discovered >> status: %d handle: %d", auto pTaskData = (NimBLETaskData*)arg;
error->status, auto pClient = (NimBLEClient*)pTaskData->m_pInstance;
(error->status == 0) ? service->start_handle : -1); NIMBLE_LOGD(LOG_TAG, "Service Discovered >> status: %d handle: %d", rc, !rc ? service->start_handle : -1);
NimBLETaskData* pTaskData = (NimBLETaskData*)arg;
NimBLEClient* pClient = (NimBLEClient*)pTaskData->m_pInstance;
if (error->status == BLE_HS_ENOTCONN) {
NIMBLE_LOGE(LOG_TAG, "<< Service Discovered; Disconnected");
NimBLEUtils::taskRelease(*pTaskData, error->status);
return error->status;
}
// Make sure the service discovery is for this device // Make sure the service discovery is for this device
if (pClient->getConnHandle() != connHandle) { if (pClient->getConnHandle() != connHandle) {
return 0; return 0;
} }
if (error->status == 0) { if (rc == 0) { // Found a service - add it to the vector
// Found a service - add it to the vector
pClient->m_svcVec.push_back(new NimBLERemoteService(pClient, service)); pClient->m_svcVec.push_back(new NimBLERemoteService(pClient, service));
return 0; return 0;
} }
NimBLEUtils::taskRelease(*pTaskData, error->status); NimBLEUtils::taskRelease(*pTaskData, error->status);
NIMBLE_LOGD(LOG_TAG, "<< Service Discovered"); NIMBLE_LOGD(LOG_TAG, "<< Service Discovered%s", (rc == BLE_HS_ENOTCONN) ? "; Disconnected" : "");
return error->status; return error->status;
} // serviceDiscoveredCB } // serviceDiscCB
/** /**
* @brief Get the value of a specific characteristic associated with a specific service. * @brief Get the value of a specific characteristic associated with a specific service.
@ -803,10 +783,8 @@ int NimBLEClient::serviceDiscoveredCB(uint16_t connHandle,
* @returns characteristic value or an empty value if not found. * @returns characteristic value or an empty value if not found.
*/ */
NimBLEAttValue NimBLEClient::getValue(const NimBLEUUID& serviceUUID, const NimBLEUUID& characteristicUUID) { NimBLEAttValue NimBLEClient::getValue(const NimBLEUUID& serviceUUID, const NimBLEUUID& characteristicUUID) {
NIMBLE_LOGD(LOG_TAG, NIMBLE_LOGD(LOG_TAG, ">> getValue: serviceUUID: %s, characteristicUUID: %s",
">> getValue: serviceUUID: %s, characteristicUUID: %s", serviceUUID.toString().c_str(), characteristicUUID.toString().c_str());
serviceUUID.toString().c_str(),
characteristicUUID.toString().c_str());
NimBLEAttValue ret{}; NimBLEAttValue ret{};
auto pService = getService(serviceUUID); auto pService = getService(serviceUUID);
@ -833,15 +811,13 @@ bool NimBLEClient::setValue(const NimBLEUUID& serviceUUID,
const NimBLEUUID& characteristicUUID, const NimBLEUUID& characteristicUUID,
const NimBLEAttValue& value, const NimBLEAttValue& value,
bool response) { bool response) {
NIMBLE_LOGD(LOG_TAG, NIMBLE_LOGD(LOG_TAG, ">> setValue: serviceUUID: %s, characteristicUUID: %s",
">> setValue: serviceUUID: %s, characteristicUUID: %s", serviceUUID.toString().c_str(), characteristicUUID.toString().c_str());
serviceUUID.toString().c_str(),
characteristicUUID.toString().c_str());
bool ret = false; bool ret = false;
auto pService = getService(serviceUUID); auto pService = getService(serviceUUID);
if (pService != nullptr) { if (pService != nullptr) {
NimBLERemoteCharacteristic* pChar = pService->getCharacteristic(characteristicUUID); auto pChar = pService->getCharacteristic(characteristicUUID);
if (pChar != nullptr) { if (pChar != nullptr) {
ret = pChar->writeValue(value, response); ret = pChar->writeValue(value, response);
} }
@ -858,11 +834,13 @@ bool NimBLEClient::setValue(const NimBLEUUID& serviceUUID,
*/ */
NimBLERemoteCharacteristic* NimBLEClient::getCharacteristic(uint16_t handle) { NimBLERemoteCharacteristic* NimBLEClient::getCharacteristic(uint16_t handle) {
for (const auto& svc : m_svcVec) { for (const auto& svc : m_svcVec) {
if (svc->getStartHandle() <= handle && handle <= svc->getEndHandle()) { if (svc->getStartHandle() > handle && handle > svc->getEndHandle()) {
for (const auto& chr : svc->m_vChars) { continue;
if (chr->getHandle() == handle) { }
return chr;
} for (const auto& chr : svc->m_vChars) {
if (chr->getHandle() == handle) {
return chr;
} }
} }
} }
@ -882,28 +860,28 @@ uint16_t NimBLEClient::getMTU() const {
* @brief Callback for the MTU exchange API function. * @brief Callback for the MTU exchange API function.
* @details When the MTU exchange is complete the API will call this and report the new MTU. * @details When the MTU exchange is complete the API will call this and report the new MTU.
*/ */
int NimBLEClient::exchangeMTUCb(uint16_t conn_handle, const ble_gatt_error* error, uint16_t mtu, void* arg) { int NimBLEClient::exchangeMTUCB(uint16_t connHandle, const ble_gatt_error* error, uint16_t mtu, void* arg) {
NIMBLE_LOGD(LOG_TAG, "exchangeMTUCb: status=%d, mtu=%d", error->status, mtu); NIMBLE_LOGD(LOG_TAG, "exchangeMTUCB: status=%d, mtu=%d", error->status, mtu);
NimBLEClient* pClient = (NimBLEClient*)arg; NimBLEClient* pClient = (NimBLEClient*)arg;
if (pClient->getConnHandle() != conn_handle) { if (pClient->getConnHandle() != connHandle) {
return 0; return 0;
} }
if (error->status != 0) { if (error->status != 0) {
NIMBLE_LOGE(LOG_TAG, "exchangeMTUCb() rc=%d %s", error->status, NimBLEUtils::returnCodeToString(error->status)); NIMBLE_LOGE(LOG_TAG, "exchangeMTUCB() rc=%d %s", error->status, NimBLEUtils::returnCodeToString(error->status));
pClient->m_lastErr = error->status; pClient->m_lastErr = error->status;
} }
return 0; return 0;
} // exchangeMTUCb } // exchangeMTUCB
/** /**
* @brief Begin the MTU exchange process with the server. * @brief Begin the MTU exchange process with the server.
* @returns true if the request was sent successfully. * @returns true if the request was sent successfully.
*/ */
bool NimBLEClient::exchangeMTU() { bool NimBLEClient::exchangeMTU() {
int rc = ble_gattc_exchange_mtu(m_connHandle, NimBLEClient::exchangeMTUCb, this); int rc = ble_gattc_exchange_mtu(m_connHandle, NimBLEClient::exchangeMTUCB, this);
if (rc != 0) { if (rc != 0) {
NIMBLE_LOGE(LOG_TAG, "MTU exchange error; rc=%d %s", rc, NimBLEUtils::returnCodeToString(rc)); NIMBLE_LOGE(LOG_TAG, "MTU exchange error; rc=%d %s", rc, NimBLEUtils::returnCodeToString(rc));
m_lastErr = rc; m_lastErr = rc;
@ -989,25 +967,25 @@ int NimBLEClient::handleGapEvent(struct ble_gap_event* event, void* arg) {
pClient->m_pClientCallbacks->onConnect(pClient); pClient->m_pClientCallbacks->onConnect(pClient);
} }
if (pClient->m_config.exchangeMTU) { if (!pClient->m_config.exchangeMTU) {
if (!pClient->exchangeMTU()) { break;
rc = pClient->m_lastErr; // sets the error in the task data
break;
}
return 0; // return as we may have a task waiting for the MTU before releasing it.
} }
} else {
pClient->m_connHandle = BLE_HS_CONN_HANDLE_NONE;
if (pClient->m_config.asyncConnect) { if (!pClient->exchangeMTU()) {
pClient->m_pClientCallbacks->onConnectFail(pClient, rc); rc = pClient->m_lastErr; // sets the error in the task data
if (pClient->m_config.deleteOnConnectFail) { break;
NimBLEDevice::deleteClient(pClient);
}
} }
return 0; // return as we may have a task waiting for the MTU before releasing it.
} }
pClient->m_connHandle = BLE_HS_CONN_HANDLE_NONE;
if (pClient->m_config.asyncConnect) {
pClient->m_pClientCallbacks->onConnectFail(pClient, rc);
if (pClient->m_config.deleteOnConnectFail) {
NimBLEDevice::deleteClient(pClient);
}
}
break; break;
} // BLE_GAP_EVENT_CONNECT } // BLE_GAP_EVENT_CONNECT
@ -1035,23 +1013,23 @@ int NimBLEClient::handleGapEvent(struct ble_gap_event* event, void* arg) {
continue; continue;
} }
NIMBLE_LOGD(LOG_TAG, NIMBLE_LOGD(LOG_TAG, "checking service %s for handle: %d",
"checking service %s for handle: %d",
svc->getUUID().toString().c_str(), svc->getUUID().toString().c_str(),
event->notify_rx.attr_handle); event->notify_rx.attr_handle);
for (const auto& chr : svc->m_vChars) { for (const auto& chr : svc->m_vChars) {
if (chr->getHandle() == event->notify_rx.attr_handle) { if (chr->getHandle() != event->notify_rx.attr_handle) {
NIMBLE_LOGD(LOG_TAG, "Got Notification for characteristic %s", chr->toString().c_str()); continue;
uint32_t data_len = OS_MBUF_PKTLEN(event->notify_rx.om);
chr->m_value.setValue(event->notify_rx.om->om_data, data_len);
if (chr->m_notifyCallback != nullptr) {
chr->m_notifyCallback(chr, event->notify_rx.om->om_data, data_len, !event->notify_rx.indication);
}
break;
} }
NIMBLE_LOGD(LOG_TAG, "Got Notification for characteristic %s", chr->toString().c_str());
uint32_t data_len = OS_MBUF_PKTLEN(event->notify_rx.om);
chr->m_value.setValue(event->notify_rx.om->om_data, data_len);
if (chr->m_notifyCallback != nullptr) {
chr->m_notifyCallback(chr, event->notify_rx.om->om_data, data_len, !event->notify_rx.indication);
}
break;
} }
} }
@ -1064,8 +1042,7 @@ int NimBLEClient::handleGapEvent(struct ble_gap_event* event, void* arg) {
return 0; return 0;
} }
NIMBLE_LOGD(LOG_TAG, "Peer requesting to update connection parameters"); NIMBLE_LOGD(LOG_TAG, "Peer requesting to update connection parameters");
NIMBLE_LOGD(LOG_TAG, NIMBLE_LOGD(LOG_TAG, "MinInterval: %d, MaxInterval: %d, Latency: %d, Timeout: %d",
"MinInterval: %d, MaxInterval: %d, Latency: %d, Timeout: %d",
event->conn_update_req.peer_params->itvl_min, event->conn_update_req.peer_params->itvl_min,
event->conn_update_req.peer_params->itvl_max, event->conn_update_req.peer_params->itvl_max,
event->conn_update_req.peer_params->latency, event->conn_update_req.peer_params->latency,

12
src/NimBLEClient.h
View file

@ -116,13 +116,13 @@ class NimBLEClient {
NimBLEClient(const NimBLEClient&) = delete; NimBLEClient(const NimBLEClient&) = delete;
NimBLEClient& operator=(const NimBLEClient&) = delete; NimBLEClient& operator=(const NimBLEClient&) = delete;
bool retrieveServices(const NimBLEUUID* uuidFilter = nullptr); bool retrieveServices(const NimBLEUUID* uuidFilter = nullptr, NimBLERemoteService *out = nullptr);
static int handleGapEvent(struct ble_gap_event* event, void* arg); static int handleGapEvent(struct ble_gap_event* event, void* arg);
static int exchangeMTUCb(uint16_t conn_handle, const ble_gatt_error* error, uint16_t mtu, void* arg); static int exchangeMTUCB(uint16_t connHandle, const ble_gatt_error* error, uint16_t mtu, void* arg);
static int serviceDiscoveredCB(uint16_t connHandle, static int serviceDiscCB(uint16_t connHandle,
const struct ble_gatt_error* error, const struct ble_gatt_error* error,
const struct ble_gatt_svc* service, const struct ble_gatt_svc* service,
void* arg); void* arg);
NimBLEAddress m_peerAddress; NimBLEAddress m_peerAddress;
mutable int m_lastErr; mutable int m_lastErr;