ConnectivityDiagnosticsManager.DataStallReport


public static final class ConnectivityDiagnosticsManager.DataStallReport
extends Object implements Parcelable

java.lang.Object
   ↳ android.net.ConnectivityDiagnosticsManager.DataStallReport


Class that includes information for a suspected data stall on a specific Network

Summary

Constants

int DETECTION_METHOD_DNS_EVENTS

Indicates that the Data Stall was detected using DNS events.

int DETECTION_METHOD_TCP_METRICS

Indicates that the Data Stall was detected using TCP metrics.

String KEY_DNS_CONSECUTIVE_TIMEOUTS

This key represents the consecutive number of DNS timeouts that have occurred.

String KEY_TCP_METRICS_COLLECTION_PERIOD_MILLIS

This key represents the period in milliseconds over which other included TCP metrics were measured.

String KEY_TCP_PACKET_FAIL_RATE

This key represents the fail rate of TCP packets when the suspected data stall was detected.

Inherited constants

Fields

public static final Creator<ConnectivityDiagnosticsManager.DataStallReport> CREATOR

Implement the Parcelable interface

Public constructors

DataStallReport(Network network, long reportTimestamp, int detectionMethod, LinkProperties linkProperties, NetworkCapabilities networkCapabilities, PersistableBundle stallDetails)

Constructor for DataStallReport.

Public methods

int describeContents()

Describe the kinds of special objects contained in this Parcelable instance's marshaled representation.

boolean equals(Object o)

Indicates whether some other object is "equal to" this one.

int getDetectionMethod()

Returns the bitmask of detection methods used to identify this suspected data stall.

LinkProperties getLinkProperties()

Returns the LinkProperties available when this report was taken.

Network getNetwork()

Returns the Network for this DataStallReport.

NetworkCapabilities getNetworkCapabilities()

Returns the NetworkCapabilities when this report was taken.

long getReportTimestamp()

Returns the epoch timestamp (milliseconds) for when this report was taken.

PersistableBundle getStallDetails()

Returns a PersistableBundle with additional info for this report.

int hashCode()

Returns a hash code value for the object.

void writeToParcel(Parcel dest, int flags)

Flatten this object in to a Parcel.

Inherited methods

Constants

DETECTION_METHOD_DNS_EVENTS

Added in API level 30
public static final int DETECTION_METHOD_DNS_EVENTS

Indicates that the Data Stall was detected using DNS events.

Constant Value: 1 (0x00000001)

DETECTION_METHOD_TCP_METRICS

Added in API level 30
public static final int DETECTION_METHOD_TCP_METRICS

Indicates that the Data Stall was detected using TCP metrics.

Constant Value: 2 (0x00000002)

KEY_DNS_CONSECUTIVE_TIMEOUTS

Added in API level 30
public static final String KEY_DNS_CONSECUTIVE_TIMEOUTS

This key represents the consecutive number of DNS timeouts that have occurred.

The consecutive count will be reset any time a DNS response is received.

This key will be included if the data stall detection method is DETECTION_METHOD_DNS_EVENTS.

This value is an int.

Constant Value: "dnsConsecutiveTimeouts"

KEY_TCP_METRICS_COLLECTION_PERIOD_MILLIS

Added in API level 30
public static final String KEY_TCP_METRICS_COLLECTION_PERIOD_MILLIS

This key represents the period in milliseconds over which other included TCP metrics were measured.

This key will be included if the data stall detection method is DETECTION_METHOD_TCP_METRICS.

This value is an int.

Constant Value: "tcpMetricsCollectionPeriodMillis"

KEY_TCP_PACKET_FAIL_RATE

Added in API level 30
public static final String KEY_TCP_PACKET_FAIL_RATE

This key represents the fail rate of TCP packets when the suspected data stall was detected.

This key will be included if the data stall detection method is DETECTION_METHOD_TCP_METRICS.

This value is an int percentage between 0 and 100.

Constant Value: "tcpPacketFailRate"

Fields

CREATOR

Added in API level 30
public static final Creator<ConnectivityDiagnosticsManager.DataStallReport> CREATOR

Implement the Parcelable interface

Public constructors

DataStallReport

Added in API level 30
public DataStallReport (Network network, 
                long reportTimestamp, 
                int detectionMethod, 
                LinkProperties linkProperties, 
                NetworkCapabilities networkCapabilities, 
                PersistableBundle stallDetails)

Constructor for DataStallReport.

Apps should obtain instances through ConnectivityDiagnosticsManager.ConnectivityDiagnosticsCallback.onDataStallSuspected(DataStallReport) instead of instantiating their own instances (unless for testing purposes).

Parameters
network Network: The Network for which this DataStallReport applies This value cannot be null.

reportTimestamp long: The timestamp for the report

detectionMethod int: The detection method used to identify this data stall Value is DETECTION_METHOD_DNS_EVENTS, or DETECTION_METHOD_TCP_METRICS

linkProperties LinkProperties: The LinkProperties available on network at reportTimestamp This value cannot be null.

networkCapabilities NetworkCapabilities: The NetworkCapabilities available on network at reportTimestamp This value cannot be null.

stallDetails PersistableBundle: A PersistableBundle that may contain additional info about the report This value cannot be null.

Public methods

describeContents

Added in API level 30
public int describeContents ()

Describe the kinds of special objects contained in this Parcelable instance's marshaled representation. For example, if the object will include a file descriptor in the output of writeToParcel(android.os.Parcel, int), the return value of this method must include the CONTENTS_FILE_DESCRIPTOR bit.

Returns
int a bitmask indicating the set of special object types marshaled by this Parcelable object instance. Value is either 0 or CONTENTS_FILE_DESCRIPTOR

equals

Added in API level 30
public boolean equals (Object o)

Indicates whether some other object is "equal to" this one.

The equals method implements an equivalence relation on non-null object references:

  • It is reflexive: for any non-null reference value x, x.equals(x) should return true.
  • It is symmetric: for any non-null reference values x and y, x.equals(y) should return true if and only if y.equals(x) returns true.
  • It is transitive: for any non-null reference values x, y, and z, if x.equals(y) returns true and y.equals(z) returns true, then x.equals(z) should return true.
  • It is consistent: for any non-null reference values x and y, multiple invocations of x.equals(y) consistently return true or consistently return false, provided no information used in equals comparisons on the objects is modified.
  • For any non-null reference value x, x.equals(null) should return false.

An equivalence relation partitions the elements it operates on into equivalence classes; all the members of an equivalence class are equal to each other. Members of an equivalence class are substitutable for each other, at least for some purposes.

Parameters
o Object: This value may be null.

Returns
boolean true if this object is the same as the obj argument; false otherwise.

getDetectionMethod

Added in API level 30
public int getDetectionMethod ()

Returns the bitmask of detection methods used to identify this suspected data stall.

Returns
int The bitmask of detection methods used to identify the suspected data stall

getLinkProperties

Added in API level 30
public LinkProperties getLinkProperties ()

Returns the LinkProperties available when this report was taken.

Returns
LinkProperties LinkProperties available on the Network at the reported timestamp This value cannot be null.

getNetwork

Added in API level 30
public Network getNetwork ()

Returns the Network for this DataStallReport.

Returns
Network The Network for which this DataStallReport applied This value cannot be null.

getNetworkCapabilities

Added in API level 30
public NetworkCapabilities getNetworkCapabilities ()

Returns the NetworkCapabilities when this report was taken.

Returns
NetworkCapabilities NetworkCapabilities available on the Network at the reported timestamp This value cannot be null.

getReportTimestamp

Added in API level 30
public long getReportTimestamp ()

Returns the epoch timestamp (milliseconds) for when this report was taken.

Returns
long The timestamp for the report. Taken from System#currentTimeMillis.

getStallDetails

Added in API level 30
public PersistableBundle getStallDetails ()

Returns a PersistableBundle with additional info for this report.

Gets a bundle with details about the suspected data stall including information specific to the monitoring method that detected the data stall.

Returns
PersistableBundle PersistableBundle that may contain additional information on the suspected data stall This value cannot be null.

hashCode

Added in API level 30
public int hashCode ()

Returns a hash code value for the object. This method is supported for the benefit of hash tables such as those provided by HashMap.

The general contract of hashCode is:

  • Whenever it is invoked on the same object more than once during an execution of a Java application, the hashCode method must consistently return the same integer, provided no information used in equals comparisons on the object is modified. This integer need not remain consistent from one execution of an application to another execution of the same application.
  • If two objects are equal according to the equals method, then calling the hashCode method on each of the two objects must produce the same integer result.
  • It is not required that if two objects are unequal according to the equals method, then calling the hashCode method on each of the two objects must produce distinct integer results. However, the programmer should be aware that producing distinct integer results for unequal objects may improve the performance of hash tables.

Returns
int a hash code value for this object.

writeToParcel

Added in API level 30
public void writeToParcel (Parcel dest, 
                int flags)

Flatten this object in to a Parcel.

Parameters
dest Parcel: This value cannot be null.

flags int: Additional flags about how the object should be written. May be 0 or Parcelable.PARCELABLE_WRITE_RETURN_VALUE. Value is either 0 or a combination of Parcelable.PARCELABLE_WRITE_RETURN_VALUE, and android.os.Parcelable.PARCELABLE_ELIDE_DUPLICATES