# Print output for @column tags ?> VcnGatewayConnectionConfig - Android SDK | Android Developers

Most visited

Recently visited

VcnGatewayConnectionConfig

public final class VcnGatewayConnectionConfig
extends Object

java.lang.Object
   ↳ 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 VcnManager.setVcnConfig(ParcelUuid, VcnConfig)).

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

class VcnGatewayConnectionConfig.Builder

This class is used to incrementally build VcnGatewayConnectionConfig objects. 

Public methods

boolean equals(Object other)

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

int[] getExposedCapabilities()

Returns all exposed capabilities.

String getGatewayConnectionName()

Returns the configured Gateway Connection name.

int getMaxMtu()

Retrieves the maximum MTU allowed for this Gateway Connection.

long[] getRetryIntervalsMillis()

Retrieves the configured retry intervals.

int hashCode()

Returns a hash code value for the object.

Inherited methods

Public methods

equals

public boolean equals (Object other)

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.

The equals method for class Object implements the most discriminating possible equivalence relation on objects; that is, for any non-null reference values x and y, this method returns true if and only if x and y refer to the same object (x == y has the value true).

Note that it is generally necessary to override the hashCode method whenever this method is overridden, so as to maintain the general contract for the hashCode method, which states that equal objects must have equal hash codes.

Parameters
other Object: This value may be null.

Returns
boolean true if this object is the same as the obj argument; false otherwise.

getExposedCapabilities

public int[] getExposedCapabilities ()

Returns all exposed capabilities.

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

Returns
int[] This value cannot be null.

See also:

getGatewayConnectionName

public String getGatewayConnectionName ()

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.

Returns
String This value cannot be null.

See also:

getMaxMtu

public int getMaxMtu ()

Retrieves the maximum MTU allowed for this Gateway Connection.

Returns
int Value is MIN_MTU_V6 or greater

See also:

getRetryIntervalsMillis

public long[] getRetryIntervalsMillis ()

Retrieves the configured retry intervals.

Returns
long[] This value cannot be null.

See also:

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 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(Object) 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(java.lang.Object) 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.

As much as is reasonably practical, the hashCode method defined by class Object does return distinct integers for distinct objects. (This is typically implemented by converting the internal address of the object into an integer, but this implementation technique is not required by the Java™ programming language.)

Returns
int a hash code value for this object.