Added usage/deprecation comment for OperationalDeviceProxy.SetConnect…

…edSession
project-chip · Dec 20, 2021 · 8c9607c · 8c9607c
1 parent 7223c2e
commit 8c9607c
Showing 1 changed file with 5 additions and 2 deletions.
diff --git a/src/app/OperationalDeviceProxy.h b/src/app/OperationalDeviceProxy.h
@@ -144,8 +144,11 @@ class DLL_EXPORT OperationalDeviceProxy : public DeviceProxy, SessionReleaseDele
     CHIP_ERROR Disconnect() override;
 
     /**
-     * Grab the SessionHolder and set state of this OperationalDeviceProxy
-     * to SecureConnected
+     * Use SetConnectedSession if 'this' object is a newly allocated device proxy.
+     * It will take an existing session, such as the one established
+     * during commissioning, and use it for this device proxy.
+     *
+     * Note: Avoid using this function generally as it is Deprecated
      */
     void SetConnectedSession(SessionHandle handle);