Skip to content

Most visited

Recently visited

navigation

RouteInfo

public final class RouteInfo
extends Object implements Parcelable

java.lang.Object
   ↳ android.net.RouteInfo


Represents a network route.

This is used both to describe static network configuration and live network configuration information. A route contains three pieces of information:

  • a destination IpPrefix specifying the network destinations covered by this route. If this is null it indicates a default route of the address family (IPv4 or IPv6) implied by the gateway IP address.
  • a gateway InetAddress indicating the next hop to use. If this is null it indicates a directly-connected route.
  • an interface (which may be unspecified).
Either the destination or the gateway may be null, but not both. If the destination and gateway are both specified, they must be of the same address family (IPv4 or IPv6).

Summary

Inherited constants

From interface android.os.Parcelable

Fields

public static final Creator<RouteInfo> CREATOR

Implement the Parcelable interface.

Public methods

int describeContents()

Implement the Parcelable interface

boolean equals(Object obj)

Compares this RouteInfo object against the specified object and indicates if they are equal.

IpPrefix getDestination()

Retrieves the destination address and prefix length in the form of an IpPrefix.

InetAddress getGateway()

Retrieves the gateway or next hop InetAddress for this route.

String getInterface()

Retrieves the interface used for this route if specified, else null.

int hashCode()

Returns a hashcode for this RouteInfo object.

boolean isDefaultRoute()

Indicates if this route is a default route (ie, has no destination specified).

boolean matches(InetAddress destination)

Determines whether the destination and prefix of this route includes the specified address.

String toString()

Returns a human-readable description of this object.

void writeToParcel(Parcel dest, int flags)

Implement the Parcelable interface

Inherited methods

From class java.lang.Object
From interface android.os.Parcelable

Fields

CREATOR

added in API level 21
Creator<RouteInfo> CREATOR

Implement the Parcelable interface.

Public methods

describeContents

added in API level 21
int describeContents ()

Implement the Parcelable interface

Returns
int a bitmask indicating the set of special object types marshaled by this Parcelable object instance.

equals

added in API level 21
boolean equals (Object obj)

Compares this RouteInfo object against the specified object and indicates if they are equal.

Parameters
obj Object: the reference object with which to compare.
Returns
boolean true if the objects are equal, false otherwise.

getDestination

added in API level 21
IpPrefix getDestination ()

Retrieves the destination address and prefix length in the form of an IpPrefix.

Returns
IpPrefix IpPrefix specifying the destination. This is never null.

getGateway

added in API level 21
InetAddress getGateway ()

Retrieves the gateway or next hop InetAddress for this route.

Returns
InetAddress InetAddress specifying the gateway or next hop. This may be null for a directly-connected route."

getInterface

added in API level 21
String getInterface ()

Retrieves the interface used for this route if specified, else null.

Returns
String The name of the interface used for this route.

hashCode

added in API level 21
int hashCode ()

Returns a hashcode for this RouteInfo object.

Returns
int a hash code value for this object.

isDefaultRoute

added in API level 21
boolean isDefaultRoute ()

Indicates if this route is a default route (ie, has no destination specified).

Returns
boolean true if the destination has a prefix length of 0.

matches

added in API level 21
boolean matches (InetAddress destination)

Determines whether the destination and prefix of this route includes the specified address.

Parameters
destination InetAddress: A InetAddress to test to see if it would match this route.
Returns
boolean true if the destination and prefix length cover the given address.

toString

added in API level 21
String toString ()

Returns a human-readable description of this object.

Returns
String a string representation of the object.

writeToParcel

added in API level 21
void writeToParcel (Parcel dest, 
                int flags)

Implement the Parcelable interface

Parameters
dest Parcel: The Parcel in which the object should be written.
flags int: Additional flags about how the object should be written. May be 0 or PARCELABLE_WRITE_RETURN_VALUE.
This site uses cookies to store your preferences for site-specific language and display options.

Hooray!

This class requires API level or higher

This doc is hidden because your selected API level for the documentation is . You can change the documentation API level with the selector above the left navigation.

For more information about specifying the API level your app requires, read Supporting Different Platform Versions.

Take a one-minute survey?
Help us improve Android tools and documentation.