RouteSelectionDescriptor

public final class RouteSelectionDescriptor
extends Object implements Parcelable

java.lang.Object
   ↳ android.telephony.data.RouteSelectionDescriptor


Represents a single route selection descriptor as defined in 3GPP TS 24.526.

Summary

Constants

int ROUTE_SSC_MODE_1

The route selection descriptor is using SSC mode 1.

int ROUTE_SSC_MODE_2

The route selection descriptor is using SSC mode 2.

int ROUTE_SSC_MODE_3

The route selection descriptor is using SSC mode 3.

int SESSION_TYPE_IPV4

The route selection descriptor is for the session with IPV4 type.

int SESSION_TYPE_IPV4V6

The route selection descriptor is for the session with both IP and IPV6 types.

int SESSION_TYPE_IPV6

The route selection descriptor is for the session with IPV6 type.

Inherited constants

Fields

public static final Creator<RouteSelectionDescriptor> 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.

List<String> getDataNetworkName()

DNN stands for Data Network Name and represents an APN as defined in 3GPP TS 23.003.

int getPrecedence()

Precedence value in the range of 0 to 255.

int getSessionType()

This is used for checking which session type defined in 3GPP TS 23.501 is allowed for the route in a route selection descriptor.

List<NetworkSliceInfo> getSliceInfo()

This is the list of all the slices available in the route selection descriptor as indicated by the network.

int getSscMode()

SSC mode stands for Session and Service Continuity mode (which specifies the IP continuity mode) as defined in 3GPP TS 23.501.

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

ROUTE_SSC_MODE_1

Added in API level 31
public static final int ROUTE_SSC_MODE_1

The route selection descriptor is using SSC mode 1. The session will provide continual support when UE's location is updated.

Constant Value: 1 (0x00000001)

ROUTE_SSC_MODE_2

Added in API level 31
public static final int ROUTE_SSC_MODE_2

The route selection descriptor is using SSC mode 2. The new session for the same network will be established after releasing the old session when UE's location is updated.

Constant Value: 2 (0x00000002)

ROUTE_SSC_MODE_3

Added in API level 31
public static final int ROUTE_SSC_MODE_3

The route selection descriptor is using SSC mode 3. The new session for the same network is allowed to be established before releasing the old session when UE's location is updated.

Constant Value: 3 (0x00000003)

SESSION_TYPE_IPV4

Added in API level 31
public static final int SESSION_TYPE_IPV4

The route selection descriptor is for the session with IPV4 type.

Constant Value: 0 (0x00000000)

SESSION_TYPE_IPV4V6

Added in API level 31
public static final int SESSION_TYPE_IPV4V6

The route selection descriptor is for the session with both IP and IPV6 types.

Constant Value: 2 (0x00000002)

SESSION_TYPE_IPV6

Added in API level 31
public static final int SESSION_TYPE_IPV6

The route selection descriptor is for the session with IPV6 type.

Constant Value: 1 (0x00000001)

Fields

CREATOR

Added in API level 31
public static final Creator<RouteSelectionDescriptor> CREATOR

Public methods

describeContents

Added in API level 31
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 CONTENTS_FILE_DESCRIPTOR

equals

Added in API level 31
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 return true.
  • It is symmetric: for any non-null reference values x and y, x.equals(y) should return true if and only if y.equals(x) returns true.
  • It is transitive: for any non-null reference values x, y, and z, if x.equals(y) returns true and y.equals(z) returns true, then x.equals(z) should return true.
  • It is consistent: for any non-null reference values x and y, multiple invocations of x.equals(y) consistently return true or consistently return false, provided no information used in equals comparisons on the objects is modified.
  • For any non-null reference value x, x.equals(null) should return false.

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.

getDataNetworkName

Added in API level 31
public List<String> getDataNetworkName ()

DNN stands for Data Network Name and represents an APN as defined in 3GPP TS 23.003. There can be 0 or more DNNs specified in a route selection descriptor.

Returns
List<String> the list of DNN for this route selection descriptor. This value cannot be null.

getPrecedence

Added in API level 31
public int getPrecedence ()

Precedence value in the range of 0 to 255. Higher value has lower precedence.

Returns
int the precedence value for this route selection descriptor. Value is between MIN_ROUTE_PRECEDENCE and MAX_ROUTE_PRECEDENCE inclusive

getSessionType

Added in API level 31
public int getSessionType ()

This is used for checking which session type defined in 3GPP TS 23.501 is allowed for the route in a route selection descriptor.

Returns
int the session type for this route selection descriptor. Value is SESSION_TYPE_IPV4, SESSION_TYPE_IPV6, or SESSION_TYPE_IPV4V6

getSliceInfo

Added in API level 31
public List<NetworkSliceInfo> getSliceInfo ()

This is the list of all the slices available in the route selection descriptor as indicated by the network. These are the slices that can be used by the device if this route selection descriptor is used based the traffic (see 3GPP TS 23.501 for details).

Returns
List<NetworkSliceInfo> the list of all the slices available in the route selection descriptor. This value cannot be null.

getSscMode

Added in API level 31
public int getSscMode ()

SSC mode stands for Session and Service Continuity mode (which specifies the IP continuity mode) as defined in 3GPP TS 23.501.

Returns
int the SSC mode for this route selection descriptor. Value is ROUTE_SSC_MODE_1, ROUTE_SSC_MODE_2, or ROUTE_SSC_MODE_3

hashCode

Added in API level 31
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 hashCode method must consistently return the same integer, provided no information used in equals comparisons 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 equals method, then calling the hashCode method 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 equals method, then calling the hashCode method 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

Added in API level 31
public String toString ()

Returns a string representation of the object.

Returns
String a string representation of the object.

writeToParcel

Added in API level 31
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 Parcelable.PARCELABLE_WRITE_RETURN_VALUE, and android.os.Parcelable.PARCELABLE_ELIDE_DUPLICATES