Vert.x 4.5.13 · io.vertx.core.net.SocketAddress · APIdia, the JavaDoc alternative

Method Summary

Modifier and Type	Method and Description
public static SocketAddress	Returns: the created socket address domainSocketAddress(String the address path path) Create a domain socket address from a `path`.
public String	Returns: the host address host() Returns the host name when available or the IP address in string representation.
public String	Returns: the host address hostAddress() Returns the host IP address when available or `null` as a String.
public String	Returns: the host name hostName() Returns the host name when available or `null` Domain socket address returns `null`.
public static SocketAddress	Returns: the created socket address inetSocketAddress(int the port port, String the host host) Create an inet socket address, `host` must be non `null` and `port` must be between `0` and `65536`.
public static SocketAddress	Returns: the created socket address inetSocketAddress(InetSocketAddress the address address) Create a inet socket address from a Java `InetSocketAddress`.
public boolean	Returns: `true` for an domain socket address isDomainSocket()
public boolean	Returns: `true` for an inet socket address isInetSocket()
public String	Returns: the domain socket path or `null` for inet socket address, empty path represents unnamed domain socket addresses. path()
public int	Returns: the address port or `-1` for a domain socket port()
public static SocketAddress	Returns: the created socket address sharedRandomPort(int the shared random port id id, String the host host) Create an inet socket address that binds to a shared random port identified by `id`.

Method Detail

domainSocketAddress back to summary

domainSocketAddress	back to summary
public static SocketAddress domainSocketAddress(String path) Create a domain socket address from a `path`. Parameters path:String the address path Returns:SocketAddress the created socket address

public static SocketAddress domainSocketAddress(String path)

Create a domain socket address from a path.

Parameters

path:String: the address path

Returns:SocketAddress

the created socket address

host back to summary

host	back to summary
public String host() Returns the host name when available or the IP address in string representation. Domain socket address returns `null`. Returns:String the host address Annotations @CacheReturn

public String host()

Returns the host name when available or the IP address in string representation.
Domain socket address returns null.

Returns:String

the host address

Annotations

@CacheReturn

hostAddress back to summary

hostAddress	back to summary
public String hostAddress() Returns the host IP address when available or `null` as a String. Domain socket address returns `null`. Returns:String the host address Annotations @CacheReturn

public String hostAddress()

Returns the host IP address when available or null as a String.
Domain socket address returns null.

Returns:String

the host address

Annotations

@CacheReturn

hostName back to summary

hostName	back to summary
public String hostName() Returns the host name when available or `null` Domain socket address returns `null`. Returns:String the host name Annotations @CacheReturn

public String hostName()

Returns the host name when available or null
Domain socket address returns null.

Returns:String

the host name

Annotations

@CacheReturn

inetSocketAddress back to summary

inetSocketAddress	back to summary
public static SocketAddress inetSocketAddress(int port, String host) Create an inet socket address, `host` must be non `null` and `port` must be between `0` and `65536`. The `host` string can be a host name or a host address. No name resolution will be attempted. Parameters port:int the port host:String the host Returns:SocketAddress the created socket address

public static SocketAddress inetSocketAddress(int port, String host)

Create an inet socket address, host must be non null and port must be between 0 and 65536.
The host string can be a host name or a host address.
No name resolution will be attempted.

Parameters

port:int: the port
host:String: the host

Returns:SocketAddress

the created socket address

inetSocketAddress back to summary

inetSocketAddress	back to summary
public static SocketAddress inetSocketAddress(InetSocketAddress address) Create a inet socket address from a Java `InetSocketAddress`. No name resolution will be attempted. Parameters address:InetSocketAddress the address Returns:SocketAddress the created socket address Annotations @GenIgnore:permitted-type

public static SocketAddress inetSocketAddress(InetSocketAddress address)

Create a inet socket address from a Java InetSocketAddress.
No name resolution will be attempted.

Parameters

address:InetSocketAddress: the address

Returns:SocketAddress

the created socket address

Annotations

@GenIgnore:permitted-type

isDomainSocket	back to summary
public boolean isDomainSocket() Returns:boolean `true` for an domain socket address Annotations @CacheReturn

isInetSocket	back to summary
public boolean isInetSocket() Returns:boolean `true` for an inet socket address Annotations @CacheReturn

path	back to summary
public String path() Returns:String the domain socket path or `null` for inet socket address, empty path represents unnamed domain socket addresses. Annotations @CacheReturn

port	back to summary
public int port() Returns:int the address port or `-1` for a domain socket Annotations @CacheReturn

sharedRandomPort back to summary

sharedRandomPort	back to summary
public static SocketAddress sharedRandomPort(int id, String host) Create an inet socket address that binds to a shared random port identified by `id`. The `host` string can be a host name or a host address. No name resolution will be attempted. Parameters id:int the shared random port id host:String the host Returns:SocketAddress the created socket address

public static SocketAddress sharedRandomPort(int id, String host)

Create an inet socket address that binds to a shared random port identified by id.
The host string can be a host name or a host address.
No name resolution will be attempted.

Parameters

id:int: the shared random port id
host:String: the host

Returns:SocketAddress

the created socket address

public Interface SocketAddress

Method Summary

Method Detail