Rename UpdateBreadcrumb

project-chip · May 17, 2022 · 3f46d39 · 3f46d39
1 parent 496db29
commit 3f46d39
Show file tree

Hide file tree

Showing 2 changed files with 10 additions and 5 deletions.
diff --git a/src/app/clusters/network-commissioning/network-commissioning.cpp b/src/app/clusters/network-commissioning/network-commissioning.cpp
@@ -401,7 +401,7 @@ void Instance::UpdateBreadcrumb(const Optional<uint64_t> & breadcrumb)
     GeneralCommissioning::SetBreadcrumb(breadcrumb.Value());
 }
 
-void Instance::UpdateBreadcrumb()
+void Instance::CommitSavedBreadcrumb()
 {
     // We rejected the command when there is another ongoing command, so mCurrentOperationBreadcrumb reflects the breadcrumb
     // argument in the only background command.
@@ -503,7 +503,7 @@ void Instance::OnResult(Status commissioningError, CharSpan debugText, int32_t i
     commandHandle->AddResponse(mPath, response);
     if (commissioningError == NetworkCommissioningStatus::kSuccess)
     {
-        UpdateBreadcrumb();
+        CommitSavedBreadcrumb();
     }
 }
 
@@ -569,7 +569,7 @@ void Instance::OnFinished(Status status, CharSpan debugText, ThreadScanResponseI
     }
     if (status == NetworkCommissioningStatus::kSuccess)
     {
-        UpdateBreadcrumb();
+        CommitSavedBreadcrumb();
     }
     networks->Release();
 }
@@ -632,7 +632,7 @@ void Instance::OnFinished(Status status, CharSpan debugText, WiFiScanResponseIte
     }
     if (status == NetworkCommissioningStatus::kSuccess)
     {
-        UpdateBreadcrumb();
+        CommitSavedBreadcrumb();
     }
     if (networks != nullptr)
     {

diff --git a/src/app/clusters/network-commissioning/network-commissioning.h b/src/app/clusters/network-commissioning/network-commissioning.h
@@ -101,8 +101,13 @@ class Instance : public CommandHandlerInterface,
     uint8_t mLastNetworkIDLen = 0;
 
     Optional<uint64_t> mCurrentOperationBreadcrumb;
+
+    // Commits the breadcrumb value saved in mCurrentOperationBreadcrumb to the breadcrumb attribute in GeneralCommissioning
+    // cluster. Will set mCurrentOperationBreadcrumb to NullOptional.
+    void CommitSavedBreadcrumb();
+
+    // Sets the breadcrumb attribute in GeneralCommissioning cluster, no-op when breadcrumbValue is NullOptional.
     void UpdateBreadcrumb(const Optional<uint64_t> & breadcrumbValue);
-    void UpdateBreadcrumb();
 
     // Actual handlers of the commands
     void HandleScanNetworks(HandlerContext & ctx, const Commands::ScanNetworks::DecodableType & req);