TrafficDescriptor
public
final
class
TrafficDescriptor
extends Object
implements
Parcelable
| java.lang.Object | |
| ↳ | android.telephony.data.TrafficDescriptor |
A traffic descriptor, as defined in 3GPP TS 24.526 Section 5.2. It is used for UE Route Selection Policy(URSP) traffic matching as described in 3GPP TS 24.526 Section 4.2.2. It includes optional components like Data Network Name (DNN), an OS/App ID, and/or Connection Capabilities, which, if present, must be used for traffic matching. This descriptor does not specify the end point to be used for the data call.
Summary
Nested classes | |
|---|---|
class |
TrafficDescriptor.Builder
Provides a convenient way to set the fields of a |
Constants | |
|---|---|
int |
CONNECTION_CAPABILITY_BACKGROUND
Any traffic that is not time-sensitive, e.g., firmware/software updates over the air. |
int |
CONNECTION_CAPABILITY_DOWNLINK_STREAMING
Downlink streaming, characterized as downlink high data rates content and low latency. |
int |
CONNECTION_CAPABILITY_IMS
IMS Voice + Video comprising voice, video telephony and multimedia communications over IP networks. |
int |
CONNECTION_CAPABILITY_INTERNET
Internet data traffic with wide availability but no critical requirements on latency or data rates. |
int |
CONNECTION_CAPABILITY_IOT_DELAY_TOLERANT
Delay-tolerant, low sustained data rate IoT traffic. |
int |
CONNECTION_CAPABILITY_IOT_NON_DELAY_TOLERANT
Non-delay-tolerant, low sustained data rate IoT traffic |
int |
CONNECTION_CAPABILITY_LCS_USER_PLANE_POSITIONING
LCS user plane positioning |
int |
CONNECTION_CAPABILITY_LOW_LATENCY_LOSS_TOLERANT_UNACK
Traffic which has low latency requirements and is tolerant to some loss, hence using un-acknowledged mode at the Radio Link Control (RLC) layer. |
int |
CONNECTION_CAPABILITY_MISSION_CRITICAL_COMMUNICATIONS
Mission-critical communications, may include MC-PTT, MC video, and MC data. |
int |
CONNECTION_CAPABILITY_MMS
MMS (Multimedia Messaging Service) |
int |
CONNECTION_CAPABILITY_REAL_TIME_INTERACTIVE
Real time interactive traffic, for example, for gaming or AR/VR. |
int |
CONNECTION_CAPABILITY_SUPL
SUPL (Secure User Plane Location) |
int |
CONNECTION_CAPABILITY_TIME_CRITICAL_COMMUNICATIONS
Time Critical Communications, with bounded, low to very low latency requirements, and high availability. |
int |
CONNECTION_CAPABILITY_UNIFIED_COMMUNICATIONS
Unified communications traffic, which comprise communications through a single user interface at the UE, for instance instant messaging, VoIP, and video collaboration through the same application. |
int |
CONNECTION_CAPABILITY_UNKNOWN
Unknown connection capability. |
int |
CONNECTION_CAPABILITY_UPLINK_STREAMING
Uplink streaming, characterized as uplink high data rates content and low latency |
int |
CONNECTION_CAPABILITY_VEHICULAR_COMMUNICATIONS
Vehicle-to-Everything (V2X) traffic comprising V2X messages, characterized by low latency, high reliability, and high availability. |
Inherited constants |
|---|
Fields | |
|---|---|
public
static
final
Creator<TrafficDescriptor> |
CREATOR
|
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. |
int
|
getConnectionCapability()
Get the connection capability of the traffic. |
String
|
getDataNetworkName()
DNN stands for Data Network Name and represents an APN as defined in 3GPP TS 23.003. |
byte[]
|
getOsAppId()
OsAppId identifies a broader traffic category. |
int
|
hashCode()
Returns a hash code value for the object. |
String
|
toString()
Returns a string representation of the object. |
void
|
writeToParcel(Parcel dest, int flags)
Flatten this object in to a Parcel. |
Inherited methods | |
|---|---|
Constants
CONNECTION_CAPABILITY_BACKGROUND
public static final int CONNECTION_CAPABILITY_BACKGROUND
Any traffic that is not time-sensitive, e.g., firmware/software updates over the air. This traffic has no critical requirements from latency or data rates perspective. This traffic should/can be subject of scheduling (e.g., at specific time of day) by the applications/networks.
Constant Value: 168 (0x000000a8)
CONNECTION_CAPABILITY_DOWNLINK_STREAMING
public static final int CONNECTION_CAPABILITY_DOWNLINK_STREAMING
Downlink streaming, characterized as downlink high data rates content and low latency.
Constant Value: 163 (0x000000a3)
CONNECTION_CAPABILITY_IMS
public static final int CONNECTION_CAPABILITY_IMS
IMS Voice + Video comprising voice, video telephony and multimedia communications over IP networks. Voice, Video and SMS over IMS DNN, as well as RCS (Rich Communication Services) are included in this traffic category.
Constant Value: 1 (0x00000001)
CONNECTION_CAPABILITY_INTERNET
public static final int CONNECTION_CAPABILITY_INTERNET
Internet data traffic with wide availability but no critical requirements on latency or data rates.
Constant Value: 8 (0x00000008)
CONNECTION_CAPABILITY_IOT_DELAY_TOLERANT
public static final int CONNECTION_CAPABILITY_IOT_DELAY_TOLERANT
Delay-tolerant, low sustained data rate IoT traffic.
Constant Value: 161 (0x000000a1)
CONNECTION_CAPABILITY_IOT_NON_DELAY_TOLERANT
public static final int CONNECTION_CAPABILITY_IOT_NON_DELAY_TOLERANT
Non-delay-tolerant, low sustained data rate IoT traffic
Constant Value: 162 (0x000000a2)
CONNECTION_CAPABILITY_LCS_USER_PLANE_POSITIONING
public static final int CONNECTION_CAPABILITY_LCS_USER_PLANE_POSITIONING
LCS user plane positioning
Constant Value: 16 (0x00000010)
CONNECTION_CAPABILITY_LOW_LATENCY_LOSS_TOLERANT_UNACK
public static final int CONNECTION_CAPABILITY_LOW_LATENCY_LOSS_TOLERANT_UNACK
Traffic which has low latency requirements and is tolerant to some loss, hence using un-acknowledged mode at the Radio Link Control (RLC) layer. E.g., for certain real time voice or video traffic.
Constant Value: 171 (0x000000ab)
CONNECTION_CAPABILITY_MISSION_CRITICAL_COMMUNICATIONS
public static final int CONNECTION_CAPABILITY_MISSION_CRITICAL_COMMUNICATIONS
Mission-critical communications, may include MC-PTT, MC video, and MC data.
Constant Value: 169 (0x000000a9)
CONNECTION_CAPABILITY_MMS
public static final int CONNECTION_CAPABILITY_MMS
MMS (Multimedia Messaging Service)
Constant Value: 2 (0x00000002)
CONNECTION_CAPABILITY_REAL_TIME_INTERACTIVE
public static final int CONNECTION_CAPABILITY_REAL_TIME_INTERACTIVE
Real time interactive traffic, for example, for gaming or AR/VR.
Constant Value: 166 (0x000000a6)
CONNECTION_CAPABILITY_SUPL
public static final int CONNECTION_CAPABILITY_SUPL
SUPL (Secure User Plane Location)
Constant Value: 4 (0x00000004)
CONNECTION_CAPABILITY_TIME_CRITICAL_COMMUNICATIONS
public static final int CONNECTION_CAPABILITY_TIME_CRITICAL_COMMUNICATIONS
Time Critical Communications, with bounded, low to very low latency requirements, and high availability.
Constant Value: 170 (0x000000aa)
CONNECTION_CAPABILITY_UNIFIED_COMMUNICATIONS
public static final int CONNECTION_CAPABILITY_UNIFIED_COMMUNICATIONS
Unified communications traffic, which comprise communications through a single user interface at the UE, for instance instant messaging, VoIP, and video collaboration through the same application.
Constant Value: 167 (0x000000a7)
CONNECTION_CAPABILITY_UNKNOWN
public static final int CONNECTION_CAPABILITY_UNKNOWN
Unknown connection capability.
Constant Value: 0 (0x00000000)
CONNECTION_CAPABILITY_UPLINK_STREAMING
public static final int CONNECTION_CAPABILITY_UPLINK_STREAMING
Uplink streaming, characterized as uplink high data rates content and low latency
Constant Value: 164 (0x000000a4)
CONNECTION_CAPABILITY_VEHICULAR_COMMUNICATIONS
public static final int CONNECTION_CAPABILITY_VEHICULAR_COMMUNICATIONS
Vehicle-to-Everything (V2X) traffic comprising V2X messages, characterized by low latency, high reliability, and high availability.
Constant Value: 165 (0x000000a5)
Fields
Public methods
describeContents
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
|
equals
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:
- It is reflexive: for any non-null reference value
x,x.equals(x)should returntrue. - It is symmetric: for any non-null reference values
xandy,x.equals(y)should returntrueif and only ify.equals(x)returnstrue. - It is transitive: for any non-null reference values
x,y, andz, ifx.equals(y)returnstrueandy.equals(z)returnstrue, thenx.equals(z)should returntrue. - It is consistent: for any non-null reference values
xandy, multiple invocations ofx.equals(y)consistently returntrueor consistently returnfalse, provided no information used inequalscomparisons on the objects is modified. - For any non-null reference value
x,x.equals(null)should returnfalse.
An equivalence relation partitions the elements it operates on into equivalence classes; all the members of an equivalence class are equal to each other. Members of an equivalence class are substitutable for each other, at least for some purposes.
| Parameters | |
|---|---|
o |
Object: This value may be null. |
| Returns | |
|---|---|
boolean |
true if this object is the same as the obj
argument; false otherwise. |
getConnectionCapability
public int getConnectionCapability ()
Get the connection capability of the traffic.
The connection capability indicates the type of traffic. The values are defined in 3GPP TS 24.526, Table 5.2.1. This is used by the network for UE Route Selection Policy (URSP) traffic matching.
When used to request a data connection, the framework may only use one specific connection capability to match a network capability, even if the underlying APN supports multiple (e.g., both internet and MMS). In such cases, only the single matched connection capability from the network request will be sent to the modem.
getDataNetworkName
public String getDataNetworkName ()
DNN stands for Data Network Name and represents an APN as defined in 3GPP TS 23.003.
| Returns | |
|---|---|
String |
the DNN of this traffic descriptor if one is included by the network, null otherwise. |
getOsAppId
public byte[] getOsAppId ()
OsAppId identifies a broader traffic category. Although it names Os/App id, it only includes OS version with a general/broader category id used as app id.
| Returns | |
|---|---|
byte[] |
The id in byte format. null if not available. |
hashCode
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:
- Whenever it is invoked on the same object more than once during
an execution of a Java application, the
hashCodemethod must consistently return the same integer, provided no information used inequalscomparisons on the object is modified. This integer need not remain consistent from one execution of an application to another execution of the same application. - If two objects are equal according to the
equalsmethod, then calling thehashCodemethod on each of the two objects must produce the same integer result. - It is not required that if two objects are unequal
according to the
equalsmethod, then calling thehashCodemethod 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.
| Returns | |
|---|---|
int |
a hash code value for this object. |
toString
public String toString ()
Returns a string representation of the object.
| Returns | |
|---|---|
String |
This value cannot be null. |
writeToParcel
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 the following:
|
Content and code samples on this page are subject to the licenses described in the Content License. Java and OpenJDK are trademarks or registered trademarks of Oracle and/or its affiliates.
Last updated 2026-02-13 UTC.