Added in API level 8

Summary: Constants | Ctors | Methods | Inherited Methods

TrafficStats

---

Kotlin |Java

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 long	getRxBytes(String iface) Return the number of bytes received on the specified interface since the interface was created.
static long	getRxPackets(String iface) Return the number of packets received on the specified interface since the interface was created.
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	getTxBytes(String iface) Return the number of bytes transmitted on the specified interface since the interface was created.
static long	getTxPackets(String iface) Return the number of packets transmitted on the specified interface since the interface was created.
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

From class java.lang.Object Object clone() Creates and returns a copy of this object. boolean equals(Object obj) Indicates whether some other object is "equal to" this one. void finalize() Called by the garbage collector on an object when garbage collection determines that there are no more references to the object. final Class<?> getClass() Returns the runtime class of this Object. int hashCode() Returns a hash code value for the object. final void notify() Wakes up a single thread that is waiting on this object's monitor. final void notifyAll() Wakes up all threads that are waiting on this object's monitor. String toString() Returns a string representation of the object. final void wait(long timeoutMillis, int nanos) Causes the current thread to wait until it is awakened, typically by being notified or interrupted, or until a certain amount of real time has elapsed. final void wait(long timeoutMillis) Causes the current thread to wait until it is awakened, typically by being notified or interrupted, or until a certain amount of real time has elapsed. final void wait() Causes the current thread to wait until it is awakened, typically by being notified or interrupted.

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.

See also:

• setThreadStatsTag(int)

clearThreadStatsUid

Added in API level 28

public static void clearThreadStatsUid ()

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

See also:

• setThreadStatsUid(int)

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(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.

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

getRxBytes

Added in API level 31

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.

Parameters
iface	String: The name of the interface. This value cannot be null.

Returns
long	The number of received bytes.

getRxPackets

Added in API level 30

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.

Parameters
iface	String: The name of the interface. This value cannot be null.

Returns
long	The number of received packets.

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(java.net.Socket).

Returns
int

See also:

• setThreadStatsTag(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(java.net.Socket).

Returns
int

See also:

• setThreadStatsUid(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

getTxBytes

Added in API level 31

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.

Parameters
iface	String: The name of the interface. This value cannot be null.

Returns
long	The number of transmitted bytes.

getTxPackets

Added in API level 30

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.

Parameters
iface	String: The name of the interface. This value cannot be null.

Returns
long	The number of transmitted packets.

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

See also:

• Process.myUid()
• ApplicationInfo.uid

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

See also:

• Process.myUid()
• ApplicationInfo.uid

getUidTcpRxBytes

Added in API level 12
Deprecated in API level 18

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:

• getUidRxBytes(int)

getUidTcpRxSegments

Added in API level 12
Deprecated in API level 18

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

See also:

• getUidRxPackets(int)

getUidTcpTxBytes

Added in API level 12
Deprecated in API level 18

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:

• getUidTxBytes(int)

getUidTcpTxSegments

Added in API level 12
Deprecated in API level 18

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

See also:

• getUidTxPackets(int)

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

See also:

• Process.myUid()
• ApplicationInfo.uid

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

See also:

• Process.myUid()
• ApplicationInfo.uid

getUidUdpRxBytes

Added in API level 12
Deprecated in API level 18

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:

• getUidRxBytes(int)

getUidUdpRxPackets

Added in API level 12
Deprecated in API level 18

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

See also:

• getUidRxPackets(int)

getUidUdpTxBytes

Added in API level 12
Deprecated in API level 18

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:

• getUidTxBytes(int)

getUidUdpTxPackets

Added in API level 12
Deprecated in API level 18

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

See also:

• getUidTxPackets(int)

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(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.

Parameters
tag	int

See also:

• clearThreadStatsTag()

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(java.net.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(java.net.DatagramSocket) to remove statistics parameters.

Parameters
socket	DatagramSocket: This value cannot be null.

Throws
SocketException

See also:

• setThreadStatsTag(int)

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(java.io.FileDescriptor) to remove statistics parameters.

Parameters
fd	FileDescriptor: This value cannot be null.

Throws
IOException

See also:

• setThreadStatsTag(int)

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(java.net.Socket) to remove statistics parameters.

Parameters
socket	Socket: This value cannot be null.

Throws
SocketException

See also:

• setThreadStatsTag(int)

untagDatagramSocket

Added in API level 24

public static void untagDatagramSocket (DatagramSocket socket)

Remove any statistics parameters from the given DatagramSocket.

Parameters
socket	DatagramSocket: This value cannot be null.

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: This value cannot be null.

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: This value cannot be null.

Throws
SocketException