TrafficStats

UNSUPPORTED

public static final int UNSUPPORTED

The return value to indicate that the device does not support the statistic.

Constant Value: -1 (0xffffffff)

TrafficStats

public TrafficStats ()

clearThreadStatsTag

public static void clearThreadStatsTag ()

Clear any active tag set to account Socket traffic originating from the current thread.

clearThreadStatsUid

public static void clearThreadStatsUid ()

Clear any active UID set to account Socket traffic originating from the current thread.

getAndSetThreadStatsTag

public static int getAndSetThreadStatsTag (int tag)

Set active tag to use when accounting Socket traffic originating from the current thread. Only one active tag per thread is supported.

Changes only take effect during subsequent calls to tagSocket(java.net.Socket).

Tags between 0xFFFFFF00 and 0xFFFFFFFF are reserved and used internally by system services like DownloadManager when performing traffic on behalf of an application.

getMobileRxBytes

public static long getMobileRxBytes ()

Return number of bytes received across mobile networks since device boot. Counts packets across all mobile network interfaces, and always increases monotonically since device boot. Statistics are measured at the network layer, so they include both TCP and UDP usage.

Before Build.VERSION_CODES.JELLY_BEAN_MR2, this may return UNSUPPORTED on devices where statistics aren't available.

getMobileRxPackets

public static long getMobileRxPackets ()

Return number of packets received across mobile networks since device boot. Counts packets across all mobile network interfaces, and always increases monotonically since device boot. Statistics are measured at the network layer, so they include both TCP and UDP usage.

Before Build.VERSION_CODES.JELLY_BEAN_MR2, this may return UNSUPPORTED on devices where statistics aren't available.

getMobileTxBytes

public static long getMobileTxBytes ()

Return number of bytes transmitted across mobile networks since device boot. Counts packets across all mobile network interfaces, and always increases monotonically since device boot. Statistics are measured at the network layer, so they include both TCP and UDP usage.

Before Build.VERSION_CODES.JELLY_BEAN_MR2, this may return UNSUPPORTED on devices where statistics aren't available.

getMobileTxPackets

public static long getMobileTxPackets ()

Return number of packets transmitted across mobile networks since device boot. Counts packets across all mobile network interfaces, and always increases monotonically since device boot. Statistics are measured at the network layer, so they include both TCP and UDP usage.

Before Build.VERSION_CODES.JELLY_BEAN_MR2, this may return UNSUPPORTED on devices where statistics aren't available.

getRxBytes

public static long getRxBytes (String iface)

Return the number of bytes received on the specified interface since the interface was created. Statistics are measured at the network layer, so both TCP and UDP usage are included. Note that the returned values are partial statistics that do not count data from several sources and do not apply several adjustments that are necessary for correctness, such as adjusting for VPN apps, IPv6-in-IPv4 translation, etc. These values can be used to determine whether traffic is being transferred on the specific interface but are not a substitute for the more accurate statistics provided by the NetworkStatsManager APIs.

getRxPackets

public static long getRxPackets (String iface)

Return the number of packets received on the specified interface since the interface was created. Statistics are measured at the network layer, so both TCP and UDP usage are included. Note that the returned values are partial statistics that do not count data from several sources and do not apply several adjustments that are necessary for correctness, such as adjusting for VPN apps, IPv6-in-IPv4 translation, etc. These values can be used to determine whether traffic is being transferred on the specific interface but are not a substitute for the more accurate statistics provided by the NetworkStatsManager APIs.

getThreadStatsTag

public static int getThreadStatsTag ()

Get the active tag used when accounting Socket traffic originating from the current thread. Only one active tag per thread is supported. tagSocket(java.net.Socket).

getThreadStatsUid

public static int getThreadStatsUid ()

Get the active UID used when accounting Socket traffic originating from the current thread. Only one active tag per thread is supported. tagSocket(java.net.Socket).

getTotalRxBytes

public static long getTotalRxBytes ()

Return number of bytes received since device boot. Counts packets across all network interfaces, and always increases monotonically since device boot. Statistics are measured at the network layer, so they include both TCP and UDP usage.

Before Build.VERSION_CODES.JELLY_BEAN_MR2, this may return UNSUPPORTED on devices where statistics aren't available.

getTotalRxPackets

public static long getTotalRxPackets ()

Return number of packets received since device boot. Counts packets across all network interfaces, and always increases monotonically since device boot. Statistics are measured at the network layer, so they include both TCP and UDP usage.

Before Build.VERSION_CODES.JELLY_BEAN_MR2, this may return UNSUPPORTED on devices where statistics aren't available.

getTotalTxBytes

public static long getTotalTxBytes ()

Return number of bytes transmitted since device boot. Counts packets across all network interfaces, and always increases monotonically since device boot. Statistics are measured at the network layer, so they include both TCP and UDP usage.

Before Build.VERSION_CODES.JELLY_BEAN_MR2, this may return UNSUPPORTED on devices where statistics aren't available.

getTotalTxPackets

public static long getTotalTxPackets ()

Return number of packets transmitted since device boot. Counts packets across all network interfaces, and always increases monotonically since device boot. Statistics are measured at the network layer, so they include both TCP and UDP usage.

Before Build.VERSION_CODES.JELLY_BEAN_MR2, this may return UNSUPPORTED on devices where statistics aren't available.

getTxBytes

public static long getTxBytes (String iface)

Return the number of bytes transmitted on the specified interface since the interface was created. Statistics are measured at the network layer, so both TCP and UDP usage are included. Note that the returned values are partial statistics that do not count data from several sources and do not apply several adjustments that are necessary for correctness, such as adjusting for VPN apps, IPv6-in-IPv4 translation, etc. These values can be used to determine whether traffic is being transferred on the specific interface but are not a substitute for the more accurate statistics provided by the NetworkStatsManager APIs.

getTxPackets

public static long getTxPackets (String iface)

Return the number of packets transmitted on the specified interface since the interface was created. Statistics are measured at the network layer, so both TCP and UDP usage are included. Note that the returned values are partial statistics that do not count data from several sources and do not apply several adjustments that are necessary for correctness, such as adjusting for VPN apps, IPv6-in-IPv4 translation, etc. These values can be used to determine whether traffic is being transferred on the specific interface but are not a substitute for the more accurate statistics provided by the NetworkStatsManager APIs.

getUidRxBytes

public static long getUidRxBytes (int uid)

Return number of bytes received by the given UID since device boot. Counts packets across all network interfaces, and always increases monotonically since device boot. Statistics are measured at the network layer, so they include both TCP and UDP usage.

Before Build.VERSION_CODES.JELLY_BEAN_MR2, this may return UNSUPPORTED on devices where statistics aren't available.

Starting in Build.VERSION_CODES.N this will only report traffic statistics for the calling UID. It will return UNSUPPORTED for all other UIDs for privacy reasons. To access historical network statistics belonging to other UIDs, use NetworkStatsManager.

getUidRxPackets

public static long getUidRxPackets (int uid)

Return number of packets received by the given UID since device boot. Counts packets across all network interfaces, and always increases monotonically since device boot. Statistics are measured at the network layer, so they include both TCP and UDP usage.

Before Build.VERSION_CODES.JELLY_BEAN_MR2, this may return UNSUPPORTED on devices where statistics aren't available.

Starting in Build.VERSION_CODES.N this will only report traffic statistics for the calling UID. It will return UNSUPPORTED for all other UIDs for privacy reasons. To access historical network statistics belonging to other UIDs, use NetworkStatsManager.

getUidTcpRxBytes

public static long getUidTcpRxBytes (int uid)

This method was deprecated in API level 18.
Starting in Build.VERSION_CODES.JELLY_BEAN_MR2, transport layer statistics are no longer available, and will always return UNSUPPORTED.

getUidTcpRxSegments

public static long getUidTcpRxSegments (int uid)

This method was deprecated in API level 18.
Starting in Build.VERSION_CODES.JELLY_BEAN_MR2, transport layer statistics are no longer available, and will always return UNSUPPORTED.

getUidTcpTxBytes

public static long getUidTcpTxBytes (int uid)

This method was deprecated in API level 18.
Starting in Build.VERSION_CODES.JELLY_BEAN_MR2, transport layer statistics are no longer available, and will always return UNSUPPORTED.

getUidTcpTxSegments

public static long getUidTcpTxSegments (int uid)

This method was deprecated in API level 18.
Starting in Build.VERSION_CODES.JELLY_BEAN_MR2, transport layer statistics are no longer available, and will always return UNSUPPORTED.

getUidTxBytes

public static long getUidTxBytes (int uid)

Return number of bytes transmitted by the given UID since device boot. Counts packets across all network interfaces, and always increases monotonically since device boot. Statistics are measured at the network layer, so they include both TCP and UDP usage.

Before Build.VERSION_CODES.JELLY_BEAN_MR2, this may return UNSUPPORTED on devices where statistics aren't available.

Starting in Build.VERSION_CODES.N this will only report traffic statistics for the calling UID. It will return UNSUPPORTED for all other UIDs for privacy reasons. To access historical network statistics belonging to other UIDs, use NetworkStatsManager.

getUidTxPackets

public static long getUidTxPackets (int uid)

Return number of packets transmitted by the given UID since device boot. Counts packets across all network interfaces, and always increases monotonically since device boot. Statistics are measured at the network layer, so they include both TCP and UDP usage.

Before Build.VERSION_CODES.JELLY_BEAN_MR2, this may return UNSUPPORTED on devices where statistics aren't available.

Starting in Build.VERSION_CODES.N this will only report traffic statistics for the calling UID. It will return UNSUPPORTED for all other UIDs for privacy reasons. To access historical network statistics belonging to other UIDs, use NetworkStatsManager.

getUidUdpRxBytes

public static long getUidUdpRxBytes (int uid)

This method was deprecated in API level 18.
Starting in Build.VERSION_CODES.JELLY_BEAN_MR2, transport layer statistics are no longer available, and will always return UNSUPPORTED.

getUidUdpRxPackets

public static long getUidUdpRxPackets (int uid)

This method was deprecated in API level 18.
Starting in Build.VERSION_CODES.JELLY_BEAN_MR2, transport layer statistics are no longer available, and will always return UNSUPPORTED.

getUidUdpTxBytes

public static long getUidUdpTxBytes (int uid)

This method was deprecated in API level 18.
Starting in Build.VERSION_CODES.JELLY_BEAN_MR2, transport layer statistics are no longer available, and will always return UNSUPPORTED.

getUidUdpTxPackets

public static long getUidUdpTxPackets (int uid)

This method was deprecated in API level 18.
Starting in Build.VERSION_CODES.JELLY_BEAN_MR2, transport layer statistics are no longer available, and will always return UNSUPPORTED.

incrementOperationCount

public static void incrementOperationCount (int operationCount)

Increment count of network operations performed under the accounting tag currently active on the calling thread. This can be used to derive bytes-per-operation.

incrementOperationCount

public static void incrementOperationCount (int tag, 
                int operationCount)

Increment count of network operations performed under the given accounting tag. This can be used to derive bytes-per-operation.

setThreadStatsTag

public static void setThreadStatsTag (int tag)

Set active tag to use when accounting Socket traffic originating from the current thread. Only one active tag per thread is supported.

Changes only take effect during subsequent calls to tagSocket(java.net.Socket).

Tags between 0xFFFFFF00 and 0xFFFFFFFF are reserved and used internally by system services like DownloadManager when performing traffic on behalf of an application.

setThreadStatsUid

public static void setThreadStatsUid (int uid)

Set specific UID to use when accounting Socket traffic originating from the current thread. Designed for use when performing an operation on behalf of another application, or when another application is performing operations on your behalf.

Any app can accept blame for traffic performed on a socket originally created by another app by calling this method with the Os.getuid() value. However, only apps holding the android.Manifest.permission#UPDATE_DEVICE_STATS permission may assign blame to another UIDs.

Changes only take effect during subsequent calls to tagSocket(java.net.Socket).

tagDatagramSocket

public static void tagDatagramSocket (DatagramSocket socket)

Tag the given DatagramSocket with any statistics parameters active for the current thread. Subsequent calls always replace any existing parameters. When finished, call untagDatagramSocket(java.net.DatagramSocket) to remove statistics parameters.

tagFileDescriptor

public static void tagFileDescriptor (FileDescriptor fd)

Tag the given FileDescriptor socket with any statistics parameters active for the current thread. Subsequent calls always replace any existing parameters. When finished, call untagFileDescriptor(java.io.FileDescriptor) to remove statistics parameters.

tagSocket

public static void tagSocket (Socket socket)

Tag the given Socket with any statistics parameters active for the current thread. Subsequent calls always replace any existing parameters. When finished, call untagSocket(java.net.Socket) to remove statistics parameters.

untagDatagramSocket

public static void untagDatagramSocket (DatagramSocket socket)

Remove any statistics parameters from the given DatagramSocket.

untagFileDescriptor

public static void untagFileDescriptor (FileDescriptor fd)

Remove any statistics parameters from the given FileDescriptor socket.

untagSocket

public static void untagSocket (Socket socket)

Remove any statistics parameters from the given Socket.

In Android 8.1 (API level 27) and lower, a socket is automatically untagged when it's sent to another process using binder IPC with a ParcelFileDescriptor container. In Android 9.0 (API level 28) and higher, the socket tag is kept when the socket is sent to another process using binder IPC. You can mimic the previous behavior by calling untagSocket() before sending the socket to another process.