Add warning about GetDiscriminator

project-chip · Jun 14, 2024 · df49964 · df49964
1 parent 65ce85f
commit df49964
Showing 1 changed file with 4 additions and 0 deletions.
diff --git a/src/protocols/secure_channel/RendezvousParameters.h b/src/protocols/secure_channel/RendezvousParameters.h
@@ -62,6 +62,10 @@ class RendezvousParameters
     // discriminators.
     bool HasDiscriminator() const { return mHasDiscriminator; }
 
+    // Obtains the long version of the discriminator, or 0 if short.
+    // WARNING: This is lossy and a bad idea to use. The correct method to use
+    //          is GetSetupDiscriminator(). This method exists for public
+    //          API backwards compatibility.
     uint16_t GetDiscriminator() const
     {
         if (mSetupDiscriminator.IsShortDiscriminator())