Merge pull request #14602 from paul-szczepanek-arm/conf

Deprecate indications event onConfirmationReceived

Author: 0xc0170

connectivity/FEATURE_BLE/include/ble/GattServer.h

@@ -122,8 +122,9 @@ class GattServer {
         }
 
         /**
-         * Function invoked when the server has sent data to a client as
-         * part of a notification/indication.
+         * Function invoked when the server has sent data to a client. For
+         * notifications this is triggered when data is sent, for indications
+         * it's only triggered when the confirmation has been received.
          *
          * @note params has a temporary scope and should be copied by the
          * application if needed later
@@ -188,12 +189,13 @@ class GattServer {
         }
 
         /**
-         * Function invoked when an ACK has been received for an
-         * indication sent to the client.
+         * Event not used.
          *
          * @note params has a temporary scope and should be copied by the
          * application if needed later
          */
+        MBED_DEPRECATED_SINCE("mbed-os-6.11.0", "This event is never triggered. Indication triggers onDataSent"
+                                                "when confirmation is received.")
         virtual void onConfirmationReceived(const GattConfirmationReceivedCallbackParams &params) {
             (void)params;
         }
@@ -274,7 +276,7 @@ class GattServer {
      * Event handler that handles subscription to characteristic updates,
      * unsubscription from characteristic updates and notification confirmation.
      *
-     * @see onUpdatesEnabled() onUpdateDisabled() onConfirmationReceived()
+     * @see onUpdatesEnabled() onUpdateDisabled()
      */
     typedef FunctionPointerWithContext<GattAttribute::Handle_t> EventCallback_t;
 
@@ -705,7 +707,8 @@ class GattServer {
      * @param[in] callback Event handler being registered.
      */
     MBED_DEPRECATED_SINCE("mbed-os-6.3.0", "Individual callback-registering functions have"
-                          "been replaced by GattServer::setEventHandler. Use that function instead.")
+                          "been replaced by an event handler. Indication confirmation triggers"
+                          "GattServer::onDataSent event instead.")
     void onConfirmationReceived(EventCallback_t callback);
 
 #if !defined(DOXYGEN_ONLY)

connectivity/FEATURE_BLE/source/cordio/source/GattServerImpl.cpp

@@ -1767,21 +1767,6 @@ void GattServer::handleEvent(
                 updatesDisabledCallback(attributeHandle);
             }
             break;
-        case GattServerEvents::GATT_EVENT_CONFIRMATION_RECEIVED:
-            tr_debug("Confirmation received for attribute %d on connection %d", attributeHandle, connHandle);
-            if(eventHandler) {
-                GattConfirmationReceivedCallbackParams params({
-                    .connHandle = connHandle,
-                    .attHandle = attributeHandle
-                });
-                eventHandler->onConfirmationReceived(params);
-            }
-
-            // Execute deprecated callback
-            if (confirmationReceivedCallback) {
-                confirmationReceivedCallback(attributeHandle);
-            }
-            break;
 
         case GattServerEvents::GATT_EVENT_DATA_SENT:
             tr_debug("Data sent for attribute %d on connection %d", attributeHandle, connHandle);

connectivity/FEATURE_BLE/source/generic/GattServerEvents.h

@@ -63,6 +63,8 @@ class GattServerEvents
 
         /**
          * Response received from Characteristic Value Indication message.
+         * @deprecated This event is never used. Indications use GATT_EVENT_DATA_SENT
+         * only after confirmation is received.
          */
         GATT_EVENT_CONFIRMATION_RECEIVED = 5,