TrafficStats

public class TrafficStats
extends Object

java.lang.Object
   ↳ android.net.TrafficStats


Class that provides network traffic statistics. These statistics include bytes transmitted and received and network packets transmitted and received, over all interfaces, over the mobile interface, and on a per-UID basis.

These statistics may not be available on all platforms. If the statistics are not supported by this device, UNSUPPORTED will be returned.

Note that the statistics returned by this class reset and start from zero after every reboot. To access more robust historical network statistics data, use NetworkStatsManager instead.

Summary

Constants

int UNSUPPORTED

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

Public constructors

TrafficStats()

Public methods

static void clearThreadStatsTag()

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

static void clearThreadStatsUid()

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

static int getAndSetThreadStatsTag(int tag)

Set active tag to use when accounting Socket traffic originating from the current thread.

static long getMobileRxBytes()

Return number of bytes received across mobile networks since device boot.

static long getMobileRxPackets()

Return number of packets received across mobile networks since device boot.

static long getMobileTxBytes()

Return number of bytes transmitted across mobile networks since device boot.

static long getMobileTxPackets()

Return number of packets transmitted across mobile networks since device boot.

static int getThreadStatsTag()

Get the active tag used when accounting Socket traffic originating from the current thread.

static int getThreadStatsUid()

Get the active UID used when accounting Socket traffic originating from the current thread.

static long getTotalRxBytes()

Return number of bytes received since device boot.

static long getTotalRxPackets()

Return number of packets received since device boot.

static long getTotalTxBytes()

Return number of bytes transmitted since device boot.

static long getTotalTxPackets()

Return number of packets transmitted since device boot.

static long getUidRxBytes(int uid)

Return number of bytes received by the given UID since device boot.

static long getUidRxPackets(int uid)

Return number of packets received by the given UID since device boot.

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.

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.

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.

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.

static long getUidTxBytes(int uid)

Return number of bytes transmitted by the given UID since device boot.

static long getUidTxPackets(int uid)

Return number of packets transmitted by the given UID since device boot.

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.

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.

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.

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.

static void incrementOperationCount(int operationCount)

Increment count of network operations performed under the accounting tag currently active on the calling thread.

static void incrementOperationCount(int tag, int operationCount)

Increment count of network operations performed under the given accounting tag.

static void setThreadStatsTag(int tag)

Set active tag to use when accounting Socket traffic originating from the current thread.

static void setThreadStatsUid(int uid)

Set specific UID to use when accounting Socket traffic originating from the current thread.

static void tagDatagramSocket(DatagramSocket socket)

Tag the given DatagramSocket with any statistics parameters active for the current thread.

static void tagFileDescriptor(FileDescriptor fd)

Tag the given FileDescriptor socket with any statistics parameters active for the current thread.

static void tagSocket(Socket socket)

Tag the given Socket with any statistics parameters active for the current thread.

static void untagDatagramSocket(DatagramSocket socket)

Remove any statistics parameters from the given DatagramSocket.

static void untagFileDescriptor(FileDescriptor fd)

Remove any statistics parameters from the given FileDescriptor socket.

static void untagSocket(Socket socket)

Remove any statistics parameters from the given Socket.

Inherited methods

Constants

UNSUPPORTED

added in API level 8
public static final int UNSUPPORTED

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

Constant Value: -1 (0xffffffff)

Public constructors

TrafficStats

added in API level 8
public TrafficStats ()

Public methods

clearThreadStatsTag

added in API level 14
public static void clearThreadStatsTag ()

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

clearThreadStatsUid

added in API level 28
public static void clearThreadStatsUid ()

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

getAndSetThreadStatsTag

added in API level 26
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(Socket).

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

Parameters
tag int

Returns
int the current tag for the calling thread, which can be used to restore any existing values after a nested operation is finished

getMobileRxBytes

added in API level 8
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.

Returns
long

getMobileRxPackets

added in API level 8
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.

Returns
long

getMobileTxBytes

added in API level 8
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.

Returns
long

getMobileTxPackets

added in API level 8
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.

Returns
long

getThreadStatsTag

added in API level 14
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(Socket).

Returns
int

getThreadStatsUid

added in API level 28
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(Socket).

Returns
int

getTotalRxBytes

added in API level 8
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.

Returns
long

getTotalRxPackets

added in API level 8
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.

Returns
long

getTotalTxBytes

added in API level 8
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.

Returns
long

getTotalTxPackets

added in API level 8
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.

Returns
long

getUidRxBytes

added in API level 8
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.

Parameters
uid int

Returns
long

getUidRxPackets

added in API level 12
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.

Parameters
uid int

Returns
long

getUidTcpRxBytes

added in API level 12
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.

Parameters
uid int

Returns
long

See also:

getUidTcpRxSegments

added in API level 12
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.

Parameters
uid int

Returns
long

getUidTcpTxBytes

added in API level 12
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.

Parameters
uid int

Returns
long

See also:

getUidTcpTxSegments

added in API level 12
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.

Parameters
uid int

Returns
long

getUidTxBytes

added in API level 8
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.

Parameters
uid int

Returns
long

getUidTxPackets

added in API level 12
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.

Parameters
uid int

Returns
long

getUidUdpRxBytes

added in API level 12
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.

Parameters
uid int

Returns
long

See also:

getUidUdpRxPackets

added in API level 12
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.

Parameters
uid int

Returns
long

getUidUdpTxBytes

added in API level 12
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.

Parameters
uid int

Returns
long

See also:

getUidUdpTxPackets

added in API level 12
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.

Parameters
uid int

Returns
long

incrementOperationCount

added in API level 14
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.

Parameters
operationCount int: Number of operations to increment count by.

incrementOperationCount

added in API level 14
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.

Parameters
tag int: Accounting tag used in setThreadStatsTag(int).

operationCount int: Number of operations to increment count by.

setThreadStatsTag

added in API level 14
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(Socket).

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

Parameters
tag int

setThreadStatsUid

added in API level 28
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(Socket).

Parameters
uid int

tagDatagramSocket

added in API level 24
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(DatagramSocket) to remove statistics parameters.

Parameters
socket DatagramSocket

Throws
SocketException

tagFileDescriptor

added in API level 28
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(FileDescriptor) to remove statistics parameters.

Parameters
fd FileDescriptor

Throws
IOException

tagSocket

added in API level 14
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(Socket) to remove statistics parameters.

Parameters
socket Socket

Throws
SocketException

untagDatagramSocket

added in API level 24
public static void untagDatagramSocket (DatagramSocket socket)

Remove any statistics parameters from the given DatagramSocket.

Parameters
socket DatagramSocket

Throws
SocketException

untagFileDescriptor

added in API level 28
public static void untagFileDescriptor (FileDescriptor fd)

Remove any statistics parameters from the given FileDescriptor socket.

Parameters
fd FileDescriptor

Throws
IOException

untagSocket

added in API level 14
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.

Parameters
socket Socket

Throws
SocketException