37  * Describes the properties of a network link.
39  * A link represents a connection to a network.
49     // The interface described by the network link.
64     // Stores the properties of links that are "stacked" above this link.
166      * Sets the interface name for this link.  All {@link RouteInfo} already set for this
169      * @param iface The name of the network interface used for this link.
182      * Gets the interface name for this link.  May be {@code null} if not set.
184      * @return The interface name set for this link or {@code null}.
203      * Returns all the addresses on this link.  We often think of a link having a single address,
205      * {@code LinkProperties} actually contains {@link LinkAddress} objects which also include
207      * {@link LinkProperties#getLinkAddresses}.
209      * @return An umodifiable {@link List} of {@link InetAddress} for this link.
221      * Returns all the addresses on this link and all the links stacked above it.
245      * Adds a {@link LinkAddress} to this {@code LinkProperties} if a {@link LinkAddress} of the
271      * Removes a {@link LinkAddress} from this {@code LinkProperties}.  Specifically, matches
272      * and {@link LinkAddress} with the same address and prefix.
274      * @param toRemove A {@link LinkAddress} specifying the address to remove.
288      * Returns all the {@link LinkAddress} on this link.  Typically a link will have
291      * @return An unmodifiable {@link List} of {@link LinkAddress} for this link.
298      * Returns all the addresses on this link and all the links stacked above it.
311      * Replaces the {@link LinkAddress} in this {@code LinkProperties} with
312      * the given {@link Collection} of {@link LinkAddress}.
314      * @param addresses The {@link Collection} of {@link LinkAddress} to set in this
326      * Adds the given {@link InetAddress} to the list of DNS servers, if not present.
328      * @param dnsServer The {@link InetAddress} to add to the list of DNS servers.
341      * Removes the given {@link InetAddress} from the list of DNS servers.
343      * @param dnsServer The {@link InetAddress} to remove from the list of DNS servers.
356      * the given {@link Collection} of {@link InetAddress} objects.
358      * @param addresses The {@link Collection} of DNS servers to set in this object.
369      * Returns all the {@link InetAddress} for DNS servers on this link.
371      * @return An umodifiable {@link List} of {@link InetAddress} for DNS servers on
372      *         this link.
379      * Sets the DNS domain search path used on this link.
381      * @param domains A {@link String} listing in priority order the comma separated
382      *                domains to search when resolving host names on this link.
390      * Get the DNS domains search path set for this link.
392      * @return A {@link String} containing the comma separated domains to search when resolving
393      *         host names on this link.
400      * Sets the Maximum Transmission Unit size to use on this link.  This should not be used
404      * @param mtu The MTU to use for this link.
412      * Gets any non-default MTU size set for this link.  Note that if the default is being used
415      * @return The mtu value set for this link.
423      * Sets the tcp buffers sizes to be used when this link is the system default.
437      * @return the tcp buffer sizes to use when this link is the system default.
454      * Adds a {@link RouteInfo} to this {@code LinkProperties}, if not present. If the
455      * {@link RouteInfo} had an interface name set and that differs from the interface set for this
456      * {@code LinkProperties} an {@link IllegalArgumentException} will be thrown.  The proper
457      * course is to add either un-named or properly named {@link RouteInfo}.
459      * @param route A {@link RouteInfo} to add to this object.
482      * Removes a {@link RouteInfo} from this {@code LinkProperties}, if present. The route must
497      * Returns all the {@link RouteInfo} set on this link.
499      * @return An unmodifiable {@link List} of {@link RouteInfo} for this link.
507      * of its link addresses. Add any route that is missing.
517      * Returns all the routes on this link and all the links stacked above it.
530      * Sets the recommended {@link ProxyInfo} to use on this link, or {@code null} for none.
534      * @param proxy A {@link ProxyInfo} defining the HTTP Proxy to use on this link.
542      * Gets the recommended {@link ProxyInfo} (or {@code null}) set on this link.
544      * @return The {@link ProxyInfo} set on this link
551      * Adds a stacked link.
553      * If there is already a stacked link with the same interfacename as link,
554      * that link is replaced with link. Otherwise, link is added to the list
555      * of stacked links. If link is null, nothing changes.
557      * @param link The link to add.
558      * @return true if the link was stacked, false otherwise.
561     public boolean addStackedLink(LinkProperties link) {
562         if (link != null && link.getInterfaceName() != null) {
563             mStackedLinks.put(link.getInterfaceName(), link);
570      * Removes a stacked link.
572      * If there is a stacked link with the given interface name, it is
575      * @param iface The interface name of the link to remove.
576      * @return true if the link was removed, false otherwise.
588      * Returns all the links stacked on top of this link.
596         for (LinkProperties link : mStackedLinks.values()) {
597             stacked.add(new LinkProperties(link));
654             for (LinkProperties link: mStackedLinks.values()) {
655                 stacked += " [" + link.toString() + " ],";
664      * Returns true if this link has an IPv4 address.
679      * Returns true if this link or any of its stacked interfaces has an IPv4 address.
691      * Returns true if this link has a global preferred IPv6 address.
706      * Returns true if this link has an IPv4 default route.
721      * Returns true if this link has an IPv6 default route.
736      * Returns true if this link has an IPv4 DNS server.
751      * Returns true if this link has an IPv6 DNS server.
766      * Returns true if this link is provisioned for global IPv4 connectivity.
769      * @return {@code true} if the link is provisioned, {@code false} otherwise.
779      * Returns true if this link is provisioned for global IPv6 connectivity.
782      * @return {@code true} if the link is provisioned, {@code false} otherwise.
792      * Returns true if this link is provisioned for global connectivity,
795      * @return {@code true} if the link is provisioned, {@code false} otherwise.
803      * Evaluate whether the {@link InetAddress} is considered reachable.
805      * @return {@code true} if the given {@link InetAddress} is considered reachable,
824                 // For now, just make sure link-local destinations have
829                 // For non-link-local destinations check that either the best route
974          * stacked interfaces are not so much a property of the link as a
989      * LinkProperties, examining only addresses on the base link.
1018      * LinkProperties, examining only DNS addresses on the base link.
1048      * examining both the the base link and all stacked links.
1077      * LinkProperties, examining both the the base link and all stacked links.

Indexes created Tue Jun 19 19:05:46 CEST 2018