Added in API level 21

Summary: Inherited Constants | Fields | Methods | Inherited Methods

Network

---

Kotlin |Java

public class Network
extends Object implements Parcelable

java.lang.Object
↳	android.net.Network

---

Identifies a Network. This is supplied to applications via ConnectivityManager.NetworkCallback in response to the active ConnectivityManager.requestNetwork or passive ConnectivityManager.registerNetworkCallback calls. It is used to direct traffic to the given Network, either on a Socket basis through a targeted SocketFactory or process-wide via ConnectivityManager.bindProcessToNetwork.

Summary

Inherited constants

From interface android.os.Parcelable int CONTENTS_FILE_DESCRIPTOR Descriptor bit used with describeContents(): indicates that the Parcelable object's flattened representation includes a file descriptor. int PARCELABLE_WRITE_RETURN_VALUE Flag for use with writeToParcel(Parcel, int): the object being written is a return value, that is the result of a function such as "Parcelable someFunction()", "void someFunction(out Parcelable)", or "void someFunction(inout Parcelable)".

Fields
public static final Creator<Network>	CREATOR

Public methods
void	bindSocket(DatagramSocket socket) Binds the specified DatagramSocket to this Network.
void	bindSocket(Socket socket) Binds the specified Socket to this Network.
void	bindSocket(FileDescriptor fd) Binds the specified FileDescriptor to this Network.
int	describeContents() Describe the kinds of special objects contained in this Parcelable instance's marshaled representation.
boolean	equals(Object obj) Indicates whether some other object is "equal to" this one.
static Network	fromNetworkHandle(long networkHandle) Returns a Network object given a handle returned from getNetworkHandle().
InetAddress[]	getAllByName(String host) Operates the same as InetAddress.getAllByName except that host resolution is done on this network.
InetAddress	getByName(String host) Operates the same as InetAddress.getByName except that host resolution is done on this network.
long	getNetworkHandle() Returns a handle representing this Network, for use with the NDK API.
SocketFactory	getSocketFactory() Returns a SocketFactory bound to this network.
int	hashCode() Returns a hash code value for the object.
URLConnection	openConnection(URL url) Opens the specified URL on this Network, such that all traffic will be sent on this Network.
URLConnection	openConnection(URL url, Proxy proxy) Opens the specified URL on this Network, such that all traffic will be sent on this Network.
String	toString() Returns a string representation of the object.
void	writeToParcel(Parcel dest, int flags) Flatten this object in to a Parcel.

Inherited methods
From class java.lang.Object Object clone() Creates and returns a copy of this object. boolean equals(Object obj) Indicates whether some other object is "equal to" this one. void finalize() Called by the garbage collector on an object when garbage collection determines that there are no more references to the object. final Class<?> getClass() Returns the runtime class of this Object. int hashCode() Returns a hash code value for the object. final void notify() Wakes up a single thread that is waiting on this object's monitor. final void notifyAll() Wakes up all threads that are waiting on this object's monitor. String toString() Returns a string representation of the object. final void wait(long timeoutMillis, int nanos) Causes the current thread to wait until it is awakened, typically by being notified or interrupted, or until a certain amount of real time has elapsed. final void wait(long timeoutMillis) Causes the current thread to wait until it is awakened, typically by being notified or interrupted, or until a certain amount of real time has elapsed. final void wait() Causes the current thread to wait until it is awakened, typically by being notified or interrupted.
From interface android.os.Parcelable abstract int describeContents() Describe the kinds of special objects contained in this Parcelable instance's marshaled representation. abstract void writeToParcel(Parcel dest, int flags) Flatten this object in to a Parcel.

Fields

CREATOR

Added in API level 21

public static final Creator<Network> CREATOR

Public methods

bindSocket

Added in API level 22

public void bindSocket (DatagramSocket socket)

Binds the specified DatagramSocket to this Network. All data traffic on the socket will be sent on this Network, irrespective of any process-wide network binding set by ConnectivityManager.bindProcessToNetwork. The socket must not be connected.

Parameters
socket	DatagramSocket

Throws
IOException

bindSocket

Added in API level 21

public void bindSocket (Socket socket)

Binds the specified Socket to this Network. All data traffic on the socket will be sent on this Network, irrespective of any process-wide network binding set by ConnectivityManager.bindProcessToNetwork. The socket must not be connected.

Parameters
socket	Socket

Throws
IOException

bindSocket

Added in API level 23

public void bindSocket (FileDescriptor fd)

Binds the specified FileDescriptor to this Network. All data traffic on the socket represented by this file descriptor will be sent on this Network, irrespective of any process-wide network binding set by ConnectivityManager.bindProcessToNetwork. The socket must not be connected.

Parameters
fd	FileDescriptor

Throws
IOException

describeContents

Added in API level 21

public int describeContents ()

Describe the kinds of special objects contained in this Parcelable instance's marshaled representation. For example, if the object will include a file descriptor in the output of writeToParcel(android.os.Parcel, int), the return value of this method must include the CONTENTS_FILE_DESCRIPTOR bit.

Returns
int	a bitmask indicating the set of special object types marshaled by this Parcelable object instance. Value is either 0 or CONTENTS_FILE_DESCRIPTOR

equals

Added in API level 21

public boolean equals (Object obj)

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	Object: This value may be null.

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

fromNetworkHandle

Added in API level 28

public static Network fromNetworkHandle (long networkHandle)

Returns a Network object given a handle returned from getNetworkHandle().

Parameters
networkHandle	long: a handle returned from getNetworkHandle().

Returns
Network	A Network object derived from networkHandle.

getAllByName

Added in API level 21

public InetAddress[] getAllByName (String host)

Operates the same as InetAddress.getAllByName except that host resolution is done on this network.

Parameters
host	String: the hostname or literal IP string to be resolved.

Returns
InetAddress[]	the array of addresses associated with the specified host.

Throws
UnknownHostException	if the address lookup fails.

getByName

Added in API level 21

public InetAddress getByName (String host)

Operates the same as InetAddress.getByName except that host resolution is done on this network.

Parameters
host	String: the hostname to be resolved to an address or null.

Returns
InetAddress	the InetAddress instance representing the host.

Throws
UnknownHostException	if the address lookup fails.

getNetworkHandle

Added in API level 23

public long getNetworkHandle ()

Returns a handle representing this Network, for use with the NDK API.

Returns
long

getSocketFactory

Added in API level 21

public SocketFactory getSocketFactory ()

Returns a SocketFactory bound to this network. Any Socket created by this factory will have its traffic sent over this Network. Note that if this Network ever disconnects, this factory and any Socket it produced in the past or future will cease to work.

Returns
SocketFactory	a SocketFactory which produces Socket instances bound to this Network.

hashCode

Added in API level 21

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 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 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.

Returns
int	a hash code value for this object.

openConnection

Added in API level 21

public URLConnection openConnection (URL url)

Opens the specified URL on this Network, such that all traffic will be sent on this Network. The URL protocol must be HTTP or HTTPS.

Parameters
url	URL

Returns
URLConnection	a URLConnection to the resource referred to by this URL.

Throws
MalformedURLException	if the URL protocol is not HTTP or HTTPS.
IOException	if an error occurs while opening the connection.

See also:

• URL.openConnection()

openConnection

Added in API level 23

public URLConnection openConnection (URL url, 
                Proxy proxy)

Opens the specified URL on this Network, such that all traffic will be sent on this Network. The URL protocol must be HTTP or HTTPS.

Parameters
url	URL
proxy	Proxy: the proxy through which the connection will be established.

Returns
URLConnection	a URLConnection to the resource referred to by this URL.

Throws
MalformedURLException	if the URL protocol is not HTTP or HTTPS.
IllegalArgumentException	if the argument proxy is null.
IOException	if an error occurs while opening the connection.

See also:

• URL.openConnection()

toString

Added in API level 21

public String toString ()

Returns a string representation of the object.

Returns
String	a string representation of the object.

writeToParcel

Added in API level 21

public void writeToParcel (Parcel dest, 
                int flags)

Flatten this object in to a Parcel.

Parameters
dest	Parcel: The Parcel in which the object should be written. This value cannot be null.
flags	int: Additional flags about how the object should be written. May be 0 or Parcelable.PARCELABLE_WRITE_RETURN_VALUE. Value is either 0 or a combination of Parcelable.PARCELABLE_WRITE_RETURN_VALUE, and android.os.Parcelable.PARCELABLE_ELIDE_DUPLICATES