Removed error param from OnCommissioningSessionStopped and added docs…

… for all of AppDelegate
project-chip · Jul 24, 2023 · 42f6eae · 42f6eae
1 parent f3f7801
commit 42f6eae
Show file tree

Hide file tree

Showing 5 changed files with 24 additions and 7 deletions.
diff --git a/examples/all-clusters-app/esp32/main/main.cpp b/examples/all-clusters-app/esp32/main/main.cpp
@@ -87,7 +87,7 @@ class AppCallbacks : public AppDelegate
 public:
     void OnCommissioningSessionEstablishmentStarted() {}
     void OnCommissioningSessionStarted() override { bluetoothLED.Set(true); }
-    void OnCommissioningSessionStopped(CHIP_ERROR err) override
+    void OnCommissioningSessionStopped() override
     {
         bluetoothLED.Set(false);
         pairingWindowLED.Set(false);

diff --git a/examples/all-clusters-minimal-app/esp32/main/main.cpp b/examples/all-clusters-minimal-app/esp32/main/main.cpp
@@ -86,7 +86,7 @@ class AppCallbacks : public AppDelegate
 public:
     void OnCommissioningSessionEstablishmentStarted() {}
     void OnCommissioningSessionStarted() override { bluetoothLED.Set(true); }
-    void OnCommissioningSessionStopped(CHIP_ERROR err) override
+    void OnCommissioningSessionStopped() override
     {
         bluetoothLED.Set(false);
         pairingWindowLED.Set(false);

diff --git a/examples/platform/telink/common/src/AppTaskCommon.cpp b/examples/platform/telink/common/src/AppTaskCommon.cpp
@@ -140,7 +140,7 @@ class AppCallbacks : public AppDelegate
 public:
     void OnCommissioningSessionEstablishmentStarted() {}
     void OnCommissioningSessionStarted() override { isComissioningStarted = true; }
-    void OnCommissioningSessionStopped(CHIP_ERROR err) override { isComissioningStarted = false; }
+    void OnCommissioningSessionStopped() override { isComissioningStarted = false; }
     void OnCommissioningWindowClosed() override
     {
         if (!isComissioningStarted)

diff --git a/src/app/server/AppDelegate.h b/src/app/server/AppDelegate.h
@@ -29,12 +29,26 @@ class AppDelegate
 public:
     virtual ~AppDelegate() {}
     /**
-     * This is called on start of session establishment process
+     * This is called when the PBKDFParamRequest is received and indicates the start of the session establishment process
      */
     virtual void OnCommissioningSessionEstablishmentStarted() {}
+
+    /**
+     * This is called when the commissioning session has been established
+     */
     virtual void OnCommissioningSessionStarted() {}
+
+    /**
+     * This is called when there is an error in establishing a commissioning session (such as, when an invalid passcode is provided)
+     *
+     * @param err CHIP_ERROR indicating the error that occurred during session establishment
+     */
     virtual void OnCommissioningSessionEstablishmentError(CHIP_ERROR err) {}
-    virtual void OnCommissioningSessionStopped(CHIP_ERROR err) {}
+
+    /**
+     * This is called when the commissioning session establishment stops
+     */
+    virtual void OnCommissioningSessionStopped() {}
 
     /*
      * This is called anytime a basic or enhanced commissioning window is opened.
@@ -45,5 +59,9 @@ class AppDelegate
      * fact open.
      */
     virtual void OnCommissioningWindowOpened() {}
+
+    /*
+     * This is called anytime a basic or enhanced commissioning window is closed.
+     */
     virtual void OnCommissioningWindowClosed() {}
 };
diff --git a/src/app/server/CommissioningWindowManager.cpp b/src/app/server/CommissioningWindowManager.cpp
@@ -161,7 +161,6 @@ void CommissioningWindowManager::HandleFailedAttempt(CHIP_ERROR err)
 
     if (mAppDelegate != nullptr)
     {
-        ChipLogProgress(AppServer, "Calling mAppDelegate->OnCommissioningSessionEstablishmentError");
         mAppDelegate->OnCommissioningSessionEstablishmentError(prevErr);
     }
 
@@ -173,7 +172,7 @@ void CommissioningWindowManager::HandleFailedAttempt(CHIP_ERROR err)
 
         if (mAppDelegate != nullptr)
         {
-            mAppDelegate->OnCommissioningSessionStopped(err);
+            mAppDelegate->OnCommissioningSessionStopped();
         }
     }
 }