Added in API level 31

VcnGatewayConnectionConfig

class VcnGatewayConnectionConfig
kotlin.Any
   ↳ android.net.vcn.VcnGatewayConnectionConfig

This class represents a configuration for a connection to a Virtual Carrier Network gateway.

Each VcnGatewayConnectionConfig represents a single logical connection to a carrier gateway, and may provide one or more telephony services (as represented by network capabilities). Each gateway is expected to provide mobility for a given session as the device roams across Networks.

A VCN connection based on this configuration will be brought up dynamically based on device settings, and filed NetworkRequests. Underlying Networks must provide INTERNET connectivity, and must be part of the subscription group under which this configuration is registered (see android.net.vcn.VcnManager#setVcnConfig).

As an abstraction of a cellular network, services that can be provided by a VCN network are limited to services provided by cellular networks:

Summary

Nested classes

This class is used to incrementally build VcnGatewayConnectionConfig objects.
Constants
static Int

Perform mobility update to attempt recovery from suspected data stalls.
Public methods
Boolean
equals(other: Any?)

Indicates whether some other object is "equal to" this one.
IntArray

Returns all exposed capabilities.
String

Returns the configured Gateway Connection name.
Int

Retrieves the maximum MTU allowed for this Gateway Connection.
Int

Retrieves the maximum supported IKEv2/IPsec NATT keepalive timeout.
LongArray

Retrieves the configured retry intervals.
MutableList<VcnUnderlyingNetworkTemplate!>

Retrieve the VcnUnderlyingNetworkTemplate list, or a default list if it is not configured.
Boolean

Checks if the given VCN gateway option is enabled.
Int

Boolean

Check whether safe mode is enabled

Constants

VCN_GATEWAY_OPTION_ENABLE_DATA_STALL_RECOVERY_WITH_MOBILITY

Added in API level 34
static val VCN_GATEWAY_OPTION_ENABLE_DATA_STALL_RECOVERY_WITH_MOBILITY: Int

Perform mobility update to attempt recovery from suspected data stalls.

If set, the gateway connection will monitor the data stall detection of the VCN network. When there is a suspected data stall, the gateway connection will attempt recovery by performing a mobility update on the underlying IKE session.

Value: 0

Public methods

equals

Added in API level 31
fun equals(other: Any?): Boolean

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
obj the reference object with which to compare.
other Any?: This value may be null.
Return
Boolean true if this object is the same as the obj argument; false otherwise.

getExposedCapabilities

Added in API level 31
fun getExposedCapabilities(): IntArray

Returns all exposed capabilities.

The returned integer-value capabilities will not contain duplicates, and will be sorted in ascending numerical order.

Return
IntArray This value cannot be null.

getGatewayConnectionName

Added in API level 31
fun getGatewayConnectionName(): String

Returns the configured Gateway Connection name.

This name is used by the configuring apps to distinguish between VcnGatewayConnectionConfigs configured on a single VcnConfig. This will be used as the identifier in VcnStatusCallback invocations.

Return
String This value cannot be null.

getMaxMtu

Added in API level 31
fun getMaxMtu(): Int

Retrieves the maximum MTU allowed for this Gateway Connection.

Return
Int Value is MIN_MTU_V6 or greater

getMinUdpPort4500NatTimeoutSeconds

Added in API level 34
fun getMinUdpPort4500NatTimeoutSeconds(): Int

Retrieves the maximum supported IKEv2/IPsec NATT keepalive timeout.

getRetryIntervalsMillis

Added in API level 31
fun getRetryIntervalsMillis(): LongArray

Retrieves the configured retry intervals.

Return
LongArray This value cannot be null.

getVcnUnderlyingNetworkPriorities

Added in API level 33
fun getVcnUnderlyingNetworkPriorities(): MutableList<VcnUnderlyingNetworkTemplate!>

Retrieve the VcnUnderlyingNetworkTemplate list, or a default list if it is not configured.

Return
MutableList<VcnUnderlyingNetworkTemplate!> This value cannot be null.

hasGatewayOption

Added in API level 34
fun hasGatewayOption(option: Int): Boolean

Checks if the given VCN gateway option is enabled.

Parameters
option Int: the option to check. Value is android.net.vcn.VcnGatewayConnectionConfig#VCN_GATEWAY_OPTION_ENABLE_DATA_STALL_RECOVERY_WITH_MOBILITY
Exceptions
java.lang.IllegalArgumentException if the provided option is invalid.

hashCode

Added in API level 31
fun hashCode(): Int
Return
Int a hash code value for this object.

isSafeModeEnabled

Added in API level 35
fun isSafeModeEnabled(): Boolean

Check whether safe mode is enabled