Skip to content

Commit

Permalink
Clarify some documentation for Matter.framework.
Browse files Browse the repository at this point in the history
People were being confused about when the MRP parameter overrides took effect.
  • Loading branch information
bzbarsky-apple committed Apr 16, 2024
1 parent d8245cb commit 91b72c8
Showing 1 changed file with 7 additions and 2 deletions.
9 changes: 7 additions & 2 deletions src/darwin/Framework/CHIP/MTRDeviceControllerFactory.h
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down

0 comments on commit 91b72c8

Please sign in to comment.