# Print output for @column tags ?>
public
static
final
class
ConnectivityDiagnosticsManager.ConnectivityReport
extends Object
implements
Parcelable
java.lang.Object | |
↳ | android.net.ConnectivityDiagnosticsManager.ConnectivityReport |
Class that includes connectivity information for a specific Network at a specific time.
Constants | |
---|---|
String |
KEY_NETWORK_PROBES_ATTEMPTED_BITMASK
A bitmask of network validation probes that were attempted. |
String |
KEY_NETWORK_PROBES_SUCCEEDED_BITMASK
A bitmask of network validation probes that succeeded. |
String |
KEY_NETWORK_VALIDATION_RESULT
The overall validation result for the Network being reported on. |
int |
NETWORK_PROBE_DNS
DNS probe. |
int |
NETWORK_PROBE_FALLBACK
Captive portal fallback probe. |
int |
NETWORK_PROBE_HTTP
HTTP probe. |
int |
NETWORK_PROBE_HTTPS
HTTPS probe. |
int |
NETWORK_PROBE_PRIVATE_DNS
Private DNS (DNS over TLS) probd. |
int |
NETWORK_VALIDATION_RESULT_INVALID
The overall status of the network is that it is invalid; it neither provides connectivity nor has been exempted from validation. |
int |
NETWORK_VALIDATION_RESULT_PARTIALLY_VALID
The overall status of the network is that it provides partial connectivity; some probed services succeeded but others failed. |
int |
NETWORK_VALIDATION_RESULT_SKIPPED
Due to the properties of the network, validation was not performed. |
int |
NETWORK_VALIDATION_RESULT_VALID
The overall status of the network is that it is valid, this may be because it provides full Internet access (all probes succeeded), or because other properties of the network caused probes not to be run. |
Inherited constants |
---|
Fields | |
---|---|
public
static
final
Creator<ConnectivityDiagnosticsManager.ConnectivityReport> |
CREATOR
Implement the Parcelable interface |
Public constructors | |
---|---|
ConnectivityReport(Network network, long reportTimestamp, LinkProperties linkProperties, NetworkCapabilities networkCapabilities, PersistableBundle additionalInfo)
Constructor for ConnectivityReport. |
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. |
PersistableBundle
|
getAdditionalInfo()
Returns a PersistableBundle with additional info for this report. |
LinkProperties
|
getLinkProperties()
Returns the LinkProperties available when this report was taken. |
Network
|
getNetwork()
Returns the Network for this ConnectivityReport. |
NetworkCapabilities
|
getNetworkCapabilities()
Returns the NetworkCapabilities when this report was taken. |
long
|
getReportTimestamp()
Returns the epoch timestamp (milliseconds) for when this report was taken. |
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 | |
---|---|
public static final String KEY_NETWORK_PROBES_ATTEMPTED_BITMASK
A bitmask of network validation probes that were attempted.
These probes may have failed or may be incomplete at the time of this report.
The possible bits values reported by this key are:
NETWORK_PROBE_DNS
,
NETWORK_PROBE_HTTP
,
NETWORK_PROBE_HTTPS
,
NETWORK_PROBE_FALLBACK
,
NETWORK_PROBE_PRIVATE_DNS
.
Value is NETWORK_PROBE_DNS
, NETWORK_PROBE_HTTP
, NETWORK_PROBE_HTTPS
, NETWORK_PROBE_FALLBACK
, or NETWORK_PROBE_PRIVATE_DNS
Constant Value: "networkProbesAttempted"
public static final String KEY_NETWORK_PROBES_SUCCEEDED_BITMASK
A bitmask of network validation probes that succeeded.
The possible bits values reported by this key are:
NETWORK_PROBE_DNS
,
NETWORK_PROBE_HTTP
,
NETWORK_PROBE_HTTPS
,
NETWORK_PROBE_FALLBACK
,
NETWORK_PROBE_PRIVATE_DNS
.
Value is NETWORK_PROBE_DNS
, NETWORK_PROBE_HTTP
, NETWORK_PROBE_HTTPS
, NETWORK_PROBE_FALLBACK
, or NETWORK_PROBE_PRIVATE_DNS
Constant Value: "networkProbesSucceeded"
public static final String KEY_NETWORK_VALIDATION_RESULT
The overall validation result for the Network being reported on.
The possible values for this key are:
NETWORK_VALIDATION_RESULT_INVALID
,
NETWORK_VALIDATION_RESULT_VALID
,
NETWORK_VALIDATION_RESULT_PARTIALLY_VALID
,
NETWORK_VALIDATION_RESULT_SKIPPED
.
Value is NETWORK_VALIDATION_RESULT_INVALID
, NETWORK_VALIDATION_RESULT_VALID
, NETWORK_VALIDATION_RESULT_PARTIALLY_VALID
, or NETWORK_VALIDATION_RESULT_SKIPPED
Constant Value: "networkValidationResult"
public static final int NETWORK_PROBE_DNS
DNS probe.
Constant Value: 4 (0x00000004)
public static final int NETWORK_PROBE_FALLBACK
Captive portal fallback probe.
Constant Value: 32 (0x00000020)
public static final int NETWORK_PROBE_HTTP
HTTP probe.
Constant Value: 8 (0x00000008)
public static final int NETWORK_PROBE_HTTPS
HTTPS probe.
Constant Value: 16 (0x00000010)
public static final int NETWORK_PROBE_PRIVATE_DNS
Private DNS (DNS over TLS) probd.
Constant Value: 64 (0x00000040)
public static final int NETWORK_VALIDATION_RESULT_INVALID
The overall status of the network is that it is invalid; it neither provides connectivity nor has been exempted from validation.
Constant Value: 0 (0x00000000)
public static final int NETWORK_VALIDATION_RESULT_PARTIALLY_VALID
The overall status of the network is that it provides partial connectivity; some probed services succeeded but others failed.
Constant Value: 2 (0x00000002)
public static final int NETWORK_VALIDATION_RESULT_SKIPPED
Due to the properties of the network, validation was not performed.
Constant Value: 3 (0x00000003)
public static final int NETWORK_VALIDATION_RESULT_VALID
The overall status of the network is that it is valid, this may be because it provides full Internet access (all probes succeeded), or because other properties of the network caused probes not to be run.
Constant Value: 1 (0x00000001)
public static final Creator<ConnectivityDiagnosticsManager.ConnectivityReport> CREATOR
Implement the Parcelable interface
public ConnectivityReport (Network network, long reportTimestamp, LinkProperties linkProperties, NetworkCapabilities networkCapabilities, PersistableBundle additionalInfo)
Constructor for ConnectivityReport.
Apps should obtain instances through ConnectivityDiagnosticsCallback#onConnectivityReportAvailable
instead of instantiating
their own instances (unless for testing purposes).
Parameters | |
---|---|
network |
Network : The Network for which this ConnectivityReport applies
This value cannot be null . |
reportTimestamp |
long : The timestamp for the report |
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 . |
additionalInfo |
PersistableBundle : A PersistableBundle that may contain additional info about the
report
This value cannot be null . |
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 |
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:
x
, x.equals(x)
should return
true
.
x
and y
, x.equals(y)
should return true
if and only if
y.equals(x)
returns true
.
x
, y
, and z
, if
x.equals(y)
returns true
and
y.equals(z)
returns true
, then
x.equals(z)
should return true
.
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.
x
,
x.equals(null)
should return false
.
The equals
method for class Object
implements
the most discriminating possible equivalence relation on objects;
that is, for any non-null reference values x
and
y
, this method returns true
if and only
if x
and y
refer to the same object
(x == y
has the value true
).
Note that it is generally necessary to override the hashCode
method whenever this method is overridden, so as to maintain the
general contract for the hashCode
method, which states
that equal objects must have equal hash codes.
Parameters | |
---|---|
o |
Object : This value may be null . |
Returns | |
---|---|
boolean |
true if this object is the same as the obj
argument; false otherwise. |
public PersistableBundle getAdditionalInfo ()
Returns a PersistableBundle with additional info for this report.
Returns | |
---|---|
PersistableBundle |
PersistableBundle that may contain additional info about the report
This value cannot be null . |
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 . |
public Network getNetwork ()
Returns the Network for this ConnectivityReport.
Returns | |
---|---|
Network |
The Network for which this ConnectivityReport applied
This value cannot be null . |
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 . |
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 . |
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:
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.
equals(Object)
method, then calling the hashCode
method on each of
the two objects must produce the same integer result.
equals(java.lang.Object)
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.
As much as is reasonably practical, the hashCode method defined by
class Object
does return distinct integers for distinct
objects. (This is typically implemented by converting the internal
address of the object into an integer, but this implementation
technique is not required by the
Java™ programming language.)
Returns | |
---|---|
int |
a hash code value for this object. |
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 |