Clarify UDP encapsulation socket API

This change updates the getSocket() methods for IPsec to improve clarity
of the return types, both for public APIs, and internal-only methods.

Bug: 72473753
Test: APIs updated, CTS + unit tests ran.
Change-Id: I0afebd432c5d04c47c93daa1ce616d712aa323d7
This commit is contained in:
Benedict Wong
2018-03-27 16:55:48 -07:00
parent e5623e2b61
commit 50b0ab8086
2 changed files with 4 additions and 4 deletions

View File

@@ -484,7 +484,7 @@ public final class IpSecManager {
* signalling and UDP encapsulated IPsec traffic. Instances can be obtained by calling {@link
* IpSecManager#openUdpEncapsulationSocket}. The provided socket cannot be re-bound by the
* caller. The caller should not close the {@code FileDescriptor} returned by {@link
* #getSocket}, but should use {@link #close} instead.
* #getFileDescriptor}, but should use {@link #close} instead.
*
* <p>Allowing the user to close or unbind a UDP encapsulation socket could impact the traffic
* of the next user who binds to that port. To prevent this scenario, these sockets are held
@@ -523,8 +523,8 @@ public final class IpSecManager {
mCloseGuard.open("constructor");
}
/** Get the wrapped socket. */
public FileDescriptor getSocket() {
/** Get the encapsulation socket's file descriptor. */
public FileDescriptor getFileDescriptor() {
if (mPfd == null) {
return null;
}