Added javadoc to apn retry \ throttling related methods

Bug: 175092152
Test: N/A
Merged-In: I35a3b97f3e52eef68310a92178bb14495641c6e7
Change-Id: I35a3b97f3e52eef68310a92178bb14495641c6e7
This commit is contained in:
Daniel Bright
2021-01-08 14:44:50 -08:00
parent cefc4f6864
commit 43b78ebef7
2 changed files with 11 additions and 4 deletions

View File

@@ -22,6 +22,7 @@ import android.annotation.NonNull;
import android.annotation.Nullable;
import android.annotation.SystemApi;
import android.net.LinkAddress;
import android.net.LinkProperties;
import android.os.Parcel;
import android.os.Parcelable;
import android.telephony.Annotation.DataFailureCause;
@@ -274,9 +275,11 @@ public final class DataCallResponse implements Parcelable {
}
/**
* @return The network suggested data retry duration in milliseconds. {@code Long.MAX_VALUE}
* indicates data retry should not occur. {@link #RETRY_DURATION_UNDEFINED} indicates network
* did not suggest any retry duration.
* @return The network suggested data retry duration in milliseconds as specified in
* 3GPP TS 24.302 section 8.2.9.1. The APN associated to this data call will be throttled for
* the specified duration unless {@link DataServiceCallback#onApnUnthrottled} is called.
* {@code Long.MAX_VALUE} indicates data retry should not occur.
* {@link #RETRY_DURATION_UNDEFINED} indicates network did not suggest any retry duration.
*/
public long getRetryDurationMillis() {
return mSuggestedRetryTime;

View File

@@ -250,7 +250,11 @@ public class DataServiceCallback {
}
/**
* Indicates that the specified APN is no longer throttled.
* The APN is throttled for the duration specified in
* {@link DataCallResponse#getRetryDurationMillis}. Calling this method unthrottles that
* APN.
* <p/>
* see: {@link DataCallResponse#getRetryDurationMillis}
*
* @param apn Access Point Name defined by the carrier.
*/