LineageOS/android_packages_modules_Connectivity
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Update TrafficStats docs to reflect behavior.

Browse Source 
Bug: 8399623
Change-Id: If9ccd305e8a077f318a09ac1bb160b8efbf903aa
This commit is contained in:
Jeff Sharkey
2013-03-26 13:46:05 -07:00
parent 7de8125565
commit 39fb9cd9c2
1 changed files with 72 additions and 61 deletions
Download Patch File Download Diff File Expand all files Collapse all files

133
core/java/android/net/TrafficStats.java
View File

@@ -119,6 +119,8 @@ public class TrafficStats {
* Tags between {@code 0xFFFFFF00} and {@code 0xFFFFFFFF} are reserved and * Tags between {@code 0xFFFFFF00} and {@code 0xFFFFFFFF} are reserved and
* used internally by system services like {@link DownloadManager} when * used internally by system services like {@link DownloadManager} when
* performing traffic on behalf of an application. * performing traffic on behalf of an application.
*
* @see #clearThreadStatsTag()
*/ */
public static void setThreadStatsTag(int tag) { public static void setThreadStatsTag(int tag) {
NetworkManagementSocketTagger.setThreadSocketStatsTag(tag); NetworkManagementSocketTagger.setThreadSocketStatsTag(tag);
@@ -128,11 +130,19 @@ public class TrafficStats {
* Get the active tag used when accounting {@link Socket} traffic originating * Get the active tag used when accounting {@link Socket} traffic originating
* from the current thread. Only one active tag per thread is supported. * from the current thread. Only one active tag per thread is supported.
* {@link #tagSocket(Socket)}. * {@link #tagSocket(Socket)}.
*
* @see #setThreadStatsTag(int)
*/ */
public static int getThreadStatsTag() { public static int getThreadStatsTag() {
return NetworkManagementSocketTagger.getThreadSocketStatsTag(); return NetworkManagementSocketTagger.getThreadSocketStatsTag();
} }
/**
* Clear any active tag set to account {@link Socket} traffic originating
* from the current thread.
*
* @see #setThreadStatsTag(int)
*/
public static void clearThreadStatsTag() { public static void clearThreadStatsTag() {
NetworkManagementSocketTagger.setThreadSocketStatsTag(-1); NetworkManagementSocketTagger.setThreadSocketStatsTag(-1);
} }
@@ -148,7 +158,7 @@ public class TrafficStats {
* To take effect, caller must hold * To take effect, caller must hold
* {@link android.Manifest.permission#UPDATE_DEVICE_STATS} permission. * {@link android.Manifest.permission#UPDATE_DEVICE_STATS} permission.
* *
* {@hide} * @hide
*/ */
public static void setThreadStatsUid(int uid) { public static void setThreadStatsUid(int uid) {
NetworkManagementSocketTagger.setThreadSocketStatsUid(uid); NetworkManagementSocketTagger.setThreadSocketStatsUid(uid);
@@ -260,10 +270,13 @@ public class TrafficStats {
} }
/** /**
* Get the total number of packets transmitted through the mobile interface. * Return number of packets transmitted across mobile networks since device
* * boot. Counts packets across all mobile network interfaces, and always
* @return number of packets. If the statistics are not supported by this device, * increases monotonically since device boot. Statistics are measured at the
* {@link #UNSUPPORTED} will be returned. * network layer, so they include both TCP and UDP usage.
* <p>
* Before {@link android.os.Build.VERSION_CODES#JELLY_BEAN_MR2}, this may
* return {@link #UNSUPPORTED} on devices where statistics aren't available.
*/ */
public static long getMobileTxPackets() { public static long getMobileTxPackets() {
long total = 0; long total = 0;
@@ -274,10 +287,13 @@ public class TrafficStats {
} }
/** /**
* Get the total number of packets received through the mobile interface. * Return number of packets received across mobile networks since device
* * boot. Counts packets across all mobile network interfaces, and always
* @return number of packets. If the statistics are not supported by this device, * increases monotonically since device boot. Statistics are measured at the
* {@link #UNSUPPORTED} will be returned. * network layer, so they include both TCP and UDP usage.
* <p>
* Before {@link android.os.Build.VERSION_CODES#JELLY_BEAN_MR2}, this may
* return {@link #UNSUPPORTED} on devices where statistics aren't available.
*/ */
public static long getMobileRxPackets() { public static long getMobileRxPackets() {
long total = 0; long total = 0;
@@ -288,10 +304,13 @@ public class TrafficStats {
} }
/** /**
* Get the total number of bytes transmitted through the mobile interface. * Return number of bytes transmitted across mobile networks since device
* * boot. Counts packets across all mobile network interfaces, and always
* @return number of bytes. If the statistics are not supported by this device, * increases monotonically since device boot. Statistics are measured at the
* {@link #UNSUPPORTED} will be returned. * network layer, so they include both TCP and UDP usage.
* <p>
* Before {@link android.os.Build.VERSION_CODES#JELLY_BEAN_MR2}, this may
* return {@link #UNSUPPORTED} on devices where statistics aren't available.
*/ */
public static long getMobileTxBytes() { public static long getMobileTxBytes() {
long total = 0; long total = 0;
@@ -302,10 +321,13 @@ public class TrafficStats {
} }
/** /**
* Get the total number of bytes received through the mobile interface. * Return number of bytes received across mobile networks since device boot.
* * Counts packets across all mobile network interfaces, and always increases
* @return number of bytes. If the statistics are not supported by this device, * monotonically since device boot. Statistics are measured at the network
* {@link #UNSUPPORTED} will be returned. * layer, so they include both TCP and UDP usage.
* <p>
* Before {@link android.os.Build.VERSION_CODES#JELLY_BEAN_MR2}, this may
* return {@link #UNSUPPORTED} on devices where statistics aren't available.
*/ */
public static long getMobileRxBytes() { public static long getMobileRxBytes() {
long total = 0; long total = 0;
@@ -339,85 +361,73 @@ public class TrafficStats {
return total; return total;
} }
/** /** {@hide} */
* Get the total number of packets transmitted through the specified interface.
*
* @return number of packets. If the statistics are not supported by this interface,
* {@link #UNSUPPORTED} will be returned.
* @hide
*/
public static long getTxPackets(String iface) { public static long getTxPackets(String iface) {
return nativeGetIfaceStat(iface, TYPE_TX_PACKETS); return nativeGetIfaceStat(iface, TYPE_TX_PACKETS);
} }
/** /** {@hide} */
* Get the total number of packets received through the specified interface.
*
* @return number of packets. If the statistics are not supported by this interface,
* {@link #UNSUPPORTED} will be returned.
* @hide
*/
public static long getRxPackets(String iface) { public static long getRxPackets(String iface) {
return nativeGetIfaceStat(iface, TYPE_RX_PACKETS); return nativeGetIfaceStat(iface, TYPE_RX_PACKETS);
} }
/** /** {@hide} */
* Get the total number of bytes transmitted through the specified interface.
*
* @return number of bytes. If the statistics are not supported by this interface,
* {@link #UNSUPPORTED} will be returned.
* @hide
*/
public static long getTxBytes(String iface) { public static long getTxBytes(String iface) {
return nativeGetIfaceStat(iface, TYPE_TX_BYTES); return nativeGetIfaceStat(iface, TYPE_TX_BYTES);
} }
/** /** {@hide} */
* Get the total number of bytes received through the specified interface.
*
* @return number of bytes. If the statistics are not supported by this interface,
* {@link #UNSUPPORTED} will be returned.
* @hide
*/
public static long getRxBytes(String iface) { public static long getRxBytes(String iface) {
return nativeGetIfaceStat(iface, TYPE_RX_BYTES); return nativeGetIfaceStat(iface, TYPE_RX_BYTES);
} }
/** /**
* Get the total number of packets sent through all network interfaces. * Return number of packets transmitted since device boot. Counts packets
* * across all network interfaces, and always increases monotonically since
* @return the number of packets. If the statistics are not supported by this device, * device boot. Statistics are measured at the network layer, so they
* {@link #UNSUPPORTED} will be returned. * include both TCP and UDP usage.
* <p>
* Before {@link android.os.Build.VERSION_CODES#JELLY_BEAN_MR2}, this may
* return {@link #UNSUPPORTED} on devices where statistics aren't available.
*/ */
public static long getTotalTxPackets() { public static long getTotalTxPackets() {
return nativeGetTotalStat(TYPE_TX_PACKETS); return nativeGetTotalStat(TYPE_TX_PACKETS);
} }
/** /**
* Get the total number of packets received through all network interfaces. * Return number of packets received since device boot. Counts packets
* * across all network interfaces, and always increases monotonically since
* @return number of packets. If the statistics are not supported by this device, * device boot. Statistics are measured at the network layer, so they
* {@link #UNSUPPORTED} will be returned. * include both TCP and UDP usage.
* <p>
* Before {@link android.os.Build.VERSION_CODES#JELLY_BEAN_MR2}, this may
* return {@link #UNSUPPORTED} on devices where statistics aren't available.
*/ */
public static long getTotalRxPackets() { public static long getTotalRxPackets() {
return nativeGetTotalStat(TYPE_RX_PACKETS); return nativeGetTotalStat(TYPE_RX_PACKETS);
} }
/** /**
* Get the total number of bytes sent through all network interfaces. * Return number of bytes transmitted since device boot. Counts packets
* * across all network interfaces, and always increases monotonically since
* @return number of bytes. If the statistics are not supported by this device, * device boot. Statistics are measured at the network layer, so they
* {@link #UNSUPPORTED} will be returned. * include both TCP and UDP usage.
* <p>
* Before {@link android.os.Build.VERSION_CODES#JELLY_BEAN_MR2}, this may
* return {@link #UNSUPPORTED} on devices where statistics aren't available.
*/ */
public static long getTotalTxBytes() { public static long getTotalTxBytes() {
return nativeGetTotalStat(TYPE_TX_BYTES); return nativeGetTotalStat(TYPE_TX_BYTES);
} }
/** /**
* Get the total number of bytes received through all network interfaces. * Return number of bytes received since device boot. Counts packets across
* * all network interfaces, and always increases monotonically since device
* @return number of bytes. If the statistics are not supported by this device, * boot. Statistics are measured at the network layer, so they include both
* {@link #UNSUPPORTED} will be returned. * TCP and UDP usage.
* <p>
* Before {@link android.os.Build.VERSION_CODES#JELLY_BEAN_MR2}, this may
* return {@link #UNSUPPORTED} on devices where statistics aren't available.
*/ */
public static long getTotalRxBytes() { public static long getTotalRxBytes() {
return nativeGetTotalStat(TYPE_RX_BYTES); return nativeGetTotalStat(TYPE_RX_BYTES);
@@ -580,6 +590,7 @@ public class TrafficStats {
* special permission. * special permission.
*/ */
private static NetworkStats getDataLayerSnapshotForUid(Context context) { private static NetworkStats getDataLayerSnapshotForUid(Context context) {
// TODO: take snapshot locally, since proc file is now visible
final int uid = android.os.Process.myUid(); final int uid = android.os.Process.myUid();
try { try {
return getStatsService().getDataLayerSnapshotForUid(uid); return getStatsService().getDataLayerSnapshotForUid(uid);