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 Network
s.
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:
NetworkCapabilities#NET_CAPABILITY_MMS
NetworkCapabilities#NET_CAPABILITY_SUPL
NetworkCapabilities#NET_CAPABILITY_DUN
NetworkCapabilities#NET_CAPABILITY_FOTA
NetworkCapabilities#NET_CAPABILITY_IMS
NetworkCapabilities#NET_CAPABILITY_CBS
NetworkCapabilities#NET_CAPABILITY_IA
NetworkCapabilities#NET_CAPABILITY_RCS
NetworkCapabilities#NET_CAPABILITY_XCAP
NetworkCapabilities#NET_CAPABILITY_EIMS
NetworkCapabilities#NET_CAPABILITY_INTERNET
NetworkCapabilities#NET_CAPABILITY_MCX
Summary
Nested classes | |
---|---|
This class is used to incrementally build |
Constants | |
---|---|
static Int |
Perform mobility update to attempt recovery from suspected data stalls. |
Public methods | |
---|---|
Boolean |
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 |
hasGatewayOption(option: Int) Checks if the given VCN gateway option is enabled. |
Int |
hashCode() |
Boolean |
Check whether safe mode is enabled |
Constants
VCN_GATEWAY_OPTION_ENABLE_DATA_STALL_RECOVERY_WITH_MOBILITY
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
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 returntrue
. - It is symmetric: for any non-null reference values
x
andy
,x.equals(y)
should returntrue
if and only ify.equals(x)
returnstrue
. - It is transitive: for any non-null reference values
x
,y
, andz
, ifx.equals(y)
returnstrue
andy.equals(z)
returnstrue
, thenx.equals(z)
should returntrue
. - It is consistent: for any non-null reference values
x
andy
, multiple invocations ofx.equals(y)
consistently returntrue
or consistently returnfalse
, provided no information used inequals
comparisons 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 | |
---|---|
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
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
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
fun getMaxMtu(): Int
Retrieves the maximum MTU allowed for this Gateway Connection.
Return | |
---|---|
Int |
Value is MIN_MTU_V6 or greater |
getMinUdpPort4500NatTimeoutSeconds
fun getMinUdpPort4500NatTimeoutSeconds(): Int
Retrieves the maximum supported IKEv2/IPsec NATT keepalive timeout.
getRetryIntervalsMillis
fun getRetryIntervalsMillis(): LongArray
Retrieves the configured retry intervals.
Return | |
---|---|
LongArray |
This value cannot be null . |
getVcnUnderlyingNetworkPriorities
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
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. |
isSafeModeEnabled
fun isSafeModeEnabled(): Boolean
Check whether safe mode is enabled