Improve documentation of IpSecTunnelInterface#setUnderlyingNetwork

Clarify the consequence of adding IpSecTunnelInterface to the
underlying network.

Bug: 169855650
Test: builds
Change-Id: I2e3c4fe735b3374b2ff6d23850970e36c0aafda5
Merged-In: I2e3c4fe735b3374b2ff6d23850970e36c0aafda5
This commit is contained in:
Treehugger Robot
2021-05-20 21:47:50 +00:00
committed by Yan Yan
parent aca6568d23
commit 4ccd2e2d87

View File

@@ -810,7 +810,9 @@ public final class IpSecManager {
*
* @param underlyingNetwork the new {@link Network} that will carry traffic for this tunnel.
* This network MUST never be the network exposing this IpSecTunnelInterface, otherwise
* this method will throw an {@link IllegalArgumentException}.
* this method will throw an {@link IllegalArgumentException}. If the
* IpSecTunnelInterface is later added to this network, all outbound traffic will be
* blackholed.
*/
// TODO: b/169171001 Update the documentation when transform migration is supported.
// The purpose of making updating network and applying transforms separate is to leave open