remove overdesign callback

Author: erjiaqing

examples/chip-tool/commands/common/CHIPCommand.cpp

@@ -655,12 +655,12 @@ void CHIPCommand::ExecuteDeferredCleanups(intptr_t ignored)
     sDeferredCleanups.clear();
 }
 
-void CHIPCommand::RegisterOnCheckInCompleteCallback(CheckInCompleteCallback * handler)
+void CHIPCommand::SetOnCheckInCompleteCallback(CheckInCompleteCallback * handler)
 {
-    sCheckInDelegate.RegisterOnCheckInCompleteCallback(handler);
+    sCheckInDelegate.SetOnCheckInCompleteCallback(handler);
 }
 
-void CHIPCommand::UnregisterOnCheckInCompleteCallback(CheckInCompleteCallback * handler)
+void CHIPCommand::UnsetOnCheckInCompleteCallback()
 {
-    sCheckInDelegate.UnregisterOnCheckInCompleteCallback(handler);
+    sCheckInDelegate.UnsetOnCheckInCompleteCallback();
 }

examples/chip-tool/commands/common/CHIPCommand.h

@@ -180,9 +180,9 @@ class CHIPCommand : public Command
 
     ChipDeviceCommissioner & GetCommissioner(std::string identity);
 
-    static void RegisterOnCheckInCompleteCallback(CheckInCompleteCallback * handler);
+    static void SetOnCheckInCompleteCallback(CheckInCompleteCallback * handler);
 
-    static void UnregisterOnCheckInCompleteCallback(CheckInCompleteCallback * handler);
+    static void UnsetOnCheckInCompleteCallback();
 
 private:
     CHIP_ERROR MaybeSetUpStack();

examples/chip-tool/commands/common/ChipToolCheckInDelegate.cpp

@@ -29,6 +29,7 @@ CHIP_ERROR ChipToolCheckInDelegate::Init(ICDClientStorage * storage, Interaction
 {
     VerifyOrReturnError(storage != nullptr, CHIP_ERROR_INVALID_ARGUMENT);
     VerifyOrReturnError(mpStorage == nullptr, CHIP_ERROR_INCORRECT_STATE);
+    VerifyOrReturnError(engine != nullptr, CHIP_ERROR_INVALID_ARGUMENT);
     mpStorage  = storage;
     mpImEngine = engine;
     return CHIP_NO_ERROR;
@@ -39,9 +40,9 @@ void ChipToolCheckInDelegate::OnCheckInComplete(const ICDClientInfo & clientInfo
     ChipLogProgress(
         ICD, "Check In Message processing complete: start_counter=%" PRIu32 " offset=%" PRIu32 " nodeid=" ChipLogFormatScopedNodeId,
         clientInfo.start_icd_counter, clientInfo.offset, ChipLogValueScopedNodeId(clientInfo.peer_node));
-    for (auto handler : mCheckInCompleteCallbacks)
+    if (mpCheckInCompleteCallbacks != nullptr)
     {
-        handler->OnCheckInComplete(clientInfo);
+        mpCheckInCompleteCallbacks->OnCheckInComplete(clientInfo);
     }
 }
 
@@ -83,12 +84,12 @@ void ChipToolCheckInDelegate::OnKeyRefreshDone(RefreshKeySender * refreshKeySend
     }
 }
 
-void ChipToolCheckInDelegate::RegisterOnCheckInCompleteCallback(CheckInCompleteCallback * handler)
+void ChipToolCheckInDelegate::SetOnCheckInCompleteCallback(CheckInCompleteCallback * handler)
 {
-    chip::DeviceLayer::SystemLayer().ScheduleLambda([this, handler]() { mCheckInCompleteCallbacks.insert(handler); });
+    mpCheckInCompleteCallbacks = handler;
 }
 
-void ChipToolCheckInDelegate::UnregisterOnCheckInCompleteCallback(CheckInCompleteCallback * handler)
+void ChipToolCheckInDelegate::UnsetOnCheckInCompleteCallback()
 {
-    chip::DeviceLayer::SystemLayer().ScheduleLambda([this, handler]() { mCheckInCompleteCallbacks.insert(handler); });
+    mpCheckInCompleteCallbacks = nullptr;
 }

examples/chip-tool/commands/common/ChipToolCheckInDelegate.h

@@ -32,7 +32,7 @@ class CheckInCompleteCallback
     /**
      * @brief Callback used to let the application know that a check-in message was received and validated.
      *
-     * The callback will be executed in CHIP main loop. Implementations avoid blocking in this callback.
+     * The callback will be executed in CHIP main loop. Implementations should avoid blocking operations in this callback.
      *
      * @param[in] clientInfo - ICDClientInfo object representing the state associated with the
      *                         node that sent the check-in message.
@@ -51,26 +51,24 @@ class ChipToolCheckInDelegate : public chip::app::CheckInDelegate
     void OnKeyRefreshDone(chip::app::RefreshKeySender * refreshKeySender, CHIP_ERROR error) override;
 
     /**
-     * @brief Reigsters a callback when the check-in completes.
+     * @brief Sets a callback for when the Check-In processing completes.
      *
-     * The registeration will be processed inside CHIP main loop.
+     * This method does not consider the race condition that the callback is changed during OnCheckInComplete.
      *
      * @param[in] handler - A pointer to CheckInCompleteCallback to register.
      */
-    void RegisterOnCheckInCompleteCallback(CheckInCompleteCallback * handler);
+    void SetOnCheckInCompleteCallback(CheckInCompleteCallback * handler);
 
     /**
-     * @brief Unreigsters a callback when the check-in completes.
+     * @brief Unsets the callback for when the Check-In processing completes.
      *
-     * The unregisteration will be processed inside CHIP main loop.
-     *
-     * @param[in] handler - A pointer to CheckInCompleteCallback to unregister.
+     * This method does not consider the race condition that the callback is changed during OnCheckInComplete.
      */
-    void UnregisterOnCheckInCompleteCallback(CheckInCompleteCallback * handler);
+    void UnsetOnCheckInCompleteCallback();
 
 private:
     chip::app::ICDClientStorage * mpStorage        = nullptr;
     chip::app::InteractionModelEngine * mpImEngine = nullptr;
 
-    std::set<CheckInCompleteCallback *> mCheckInCompleteCallbacks;
+    CheckInCompleteCallback * mpCheckInCompleteCallbacks;
 };