Merge "TestNetworkInterface: improve documentation of newly added methods"

This commit is contained in:
Patrick Rohr
2022-11-30 03:31:10 +00:00
committed by Gerrit Code Review

View File

@@ -29,6 +29,9 @@ import java.net.SocketException;
/** /**
* This class is used to return the interface name, fd, MAC, and MTU of the test interface * This class is used to return the interface name, fd, MAC, and MTU of the test interface
* *
* TestNetworkInterfaces are created by TestNetworkService and provide a
* wrapper around a tun/tap interface that can be used in integration tests.
*
* @hide * @hide
*/ */
@SystemApi(client = SystemApi.Client.MODULE_LIBRARIES) @SystemApi(client = SystemApi.Client.MODULE_LIBRARIES)
@@ -97,11 +100,25 @@ public final class TestNetworkInterface implements Parcelable {
return mInterfaceName; return mInterfaceName;
} }
/**
* Returns the tap interface MacAddress.
*
* When TestNetworkInterface wraps a tun interface, the MAC address is null.
*
* @return the tap interface MAC address or null.
*/
@Nullable @Nullable
public MacAddress getMacAddress() { public MacAddress getMacAddress() {
return mMacAddress; return mMacAddress;
} }
/**
* Returns the interface MTU.
*
* MTU defaults to 1500 if an error occurs.
*
* @return MTU in bytes.
*/
public int getMtu() { public int getMtu() {
return mMtu; return mMtu;
} }