From 91b72c86e127d251fa8c6804173d7373943d4e66 Mon Sep 17 00:00:00 2001 From: Boris Zbarsky Date: Tue, 16 Apr 2024 14:09:08 -0400 Subject: [PATCH] Clarify some documentation for Matter.framework. People were being confused about when the MRP parameter overrides took effect. --- src/darwin/Framework/CHIP/MTRDeviceControllerFactory.h | 9 +++++++-- 1 file changed, 7 insertions(+), 2 deletions(-) diff --git a/src/darwin/Framework/CHIP/MTRDeviceControllerFactory.h b/src/darwin/Framework/CHIP/MTRDeviceControllerFactory.h index b5ef1ffaa6cf32..62080b305ee635 100644 --- a/src/darwin/Framework/CHIP/MTRDeviceControllerFactory.h +++ b/src/darwin/Framework/CHIP/MTRDeviceControllerFactory.h @@ -180,8 +180,13 @@ MTR_AVAILABLE(ios(16.4), macos(13.3), watchos(9.4), tvos(16.4)) @end /** - * Set the Message Reliability Protocol parameters for all controllers. This - * allows control over retransmit delays to account for high-latency networks. + * Set the Message Reliability Protocol parameters for all controllers, + * including already-running ones. This allows control over retransmit delays + * to account for high-latency networks. + * + * Since MRP parameters are communicated to peers during session setup, existing + * sessions will not be affected when this function is called, but all sessions + * established after the call will be. * * Setting all arguments to nil will reset to the MRP parameters to their * default values.