Added in API level 1

InetSocketAddress

open class InetSocketAddress : SocketAddress

kotlin.Any
↳	java.net.SocketAddress
	↳	java.net.InetSocketAddress

This class implements an IP Socket Address (IP address + port number) It can also be a pair (hostname + port number), in which case an attempt will be made to resolve the hostname. If resolution fails then the address is said to be unresolved but can still be used on some circumstances like connecting through a proxy.

It provides an immutable object used by sockets for binding, connecting, or as returned values.

The wildcard is a special local IP address. It usually means "any" and can only be used for bind operations.

Summary

Public constructors
InetSocketAddress(port: Int) Creates a socket address where the IP address is the wildcard address and the port number a specified value.
InetSocketAddress(addr: InetAddress!, port: Int) Creates a socket address from an IP address and a port number.
InetSocketAddress(hostname: String!, port: Int) Creates a socket address from a hostname and a port number.

Public methods
open static InetSocketAddress!	createUnresolved(host: String!, port: Int) Creates an unresolved socket address from a hostname and a port number.
Boolean	equals(other: Any?) Compares this object against the specified object.
InetAddress!	getAddress() Gets the InetAddress.
String!	getHostName() Gets the hostname.
String!	getHostString() Returns the hostname, or the String form of the address if it doesn't have a hostname (it was created using a literal).
Int	getPort() Gets the port number.
Int	hashCode() Returns a hashcode for this socket address.
Boolean	isUnresolved() Checks whether the address has been resolved or not.
open String	toString() Constructs a string representation of this InetSocketAddress.

Public constructors

InetSocketAddress

Added in API level 1

InetSocketAddress(port: Int)

Creates a socket address where the IP address is the wildcard address and the port number a specified value.

A valid port value is between 0 and 65535. A port number of zero will let the system pick up an ephemeral port in a bind operation.

Parameters
port	Int: The port number

Exceptions
java.lang.IllegalArgumentException	if the port parameter is outside the specified range of valid port values.

InetSocketAddress

Added in API level 1

InetSocketAddress(
    addr: InetAddress!, 
    port: Int)

Creates a socket address from an IP address and a port number.

A valid port value is between 0 and 65535. A port number of zero will let the system pick up an ephemeral port in a bind operation.

A null address will assign the wildcard address.

Parameters
addr	InetAddress!: The IP address
port	Int: The port number

Exceptions
java.lang.IllegalArgumentException	if the port parameter is outside the specified range of valid port values.

InetSocketAddress

Added in API level 1

InetSocketAddress(
    hostname: String!, 
    port: Int)

Creates a socket address from a hostname and a port number.

An attempt will be made to resolve the hostname into an InetAddress. If that attempt fails, the address will be flagged as unresolved.

If there is a security manager, its checkConnect method is called with the host name as its argument to check the permission to resolve it. This could result in a SecurityException.

A valid port value is between 0 and 65535. A port number of zero will let the system pick up an ephemeral port in a bind operation.

Parameters
hostname	String!: the Host name
port	Int: The port number

Exceptions
java.lang.IllegalArgumentException	if the port parameter is outside the range of valid port values, or if the hostname parameter is null.
java.lang.SecurityException	if a security manager is present and permission to resolve the host name is denied.

See Also

• #isUnresolved()

Public methods

createUnresolved

Added in API level 1

open static fun createUnresolved(
    host: String!, 
    port: Int
): InetSocketAddress!

Creates an unresolved socket address from a hostname and a port number.

No attempt will be made to resolve the hostname into an InetAddress. The address will be flagged as unresolved.

A valid port value is between 0 and 65535. A port number of zero will let the system pick up an ephemeral port in a bind operation.

Parameters
host	String!: the Host name
port	Int: The port number

Return
InetSocketAddress!	an InetSocketAddress representing the unresolved socket address

Exceptions
java.lang.IllegalArgumentException	if the port parameter is outside the range of valid port values, or if the hostname parameter is null.

See Also

• #isUnresolved()

equals

Added in API level 1

fun equals(other: Any?): Boolean

Compares this object against the specified object. The result is true if and only if the argument is not null and it represents the same address as this object.

Two instances of InetSocketAddress represent the same address if both the InetAddresses (or hostnames if it is unresolved) and port numbers are equal. If both addresses are unresolved, then the hostname and the port number are compared. Note: Hostnames are case insensitive. e.g. "FooBar" and "foobar" are considered equal.

Parameters
obj	the object to compare against.

Return
Boolean	true if the objects are the same; false otherwise.

See Also

• java.net.InetAddress#equals(java.lang.Object)

getAddress

Added in API level 1

fun getAddress(): InetAddress!

Gets the InetAddress.

Return
InetAddress!	the InetAddress or null if it is unresolved.

getHostName

Added in API level 1

fun getHostName(): String!

Gets the hostname. Note: This method may trigger a name service reverse lookup if the address was created with a literal IP address.

Return
String!	the hostname part of the address.

getHostString

Added in API level 19

fun getHostString(): String!

Returns the hostname, or the String form of the address if it doesn't have a hostname (it was created using a literal). This has the benefit of not attempting a reverse lookup.

Return
String!	the hostname, or String representation of the address.

getPort

Added in API level 1

fun getPort(): Int

Gets the port number.

Return
Int	the port number.

hashCode

Added in API level 1

fun hashCode(): Int

Returns a hashcode for this socket address.

Return
Int	a hash code value for this socket address.

isUnresolved

Added in API level 1

fun isUnresolved(): Boolean

Checks whether the address has been resolved or not.

Return
Boolean	true if the hostname couldn't be resolved into an InetAddress.

toString

Added in API level 1

open fun toString(): String

Constructs a string representation of this InetSocketAddress. This string is constructed by calling InetAddress#toString() on the InetAddress and concatenating the port number (with a colon).

If the address is an IPv6 address, the IPv6 literal is enclosed in square brackets, for example: "localhost/[0:0:0:0:0:0:0:1]:80". If the address is unresolved, <unresolved> is displayed in place of the address literal, for example "foo/<unresolved>:80".

To retrieve a string representation of the hostname or the address, use getHostString(), rather than parsing the string returned by this toString() method.

Return
String	a string representation of this object.