com.arangodb.shaded.vertx.core.net.SocketAddress Maven / Gradle / Ivy
/*
* Copyright (c) 2011-2019 Contributors to the Eclipse Foundation
*
* This program and the accompanying materials are made available under the
* terms of the Eclipse Public License 2.0 which is available at
* http://www.eclipse.org/legal/epl-2.0, or the Apache License, Version 2.0
* which is available at https://www.apache.org/licenses/LICENSE-2.0.
*
* SPDX-License-Identifier: EPL-2.0 OR Apache-2.0
*/
package com.arangodb.shaded.vertx.core.net;
import com.arangodb.shaded.vertx.codegen.annotations.CacheReturn;
import com.arangodb.shaded.vertx.codegen.annotations.GenIgnore;
import com.arangodb.shaded.vertx.codegen.annotations.VertxGen;
import com.arangodb.shaded.vertx.core.impl.Arguments;
import com.arangodb.shaded.vertx.core.net.impl.SocketAddressImpl;
import java.net.InetSocketAddress;
/**
* The address of a socket, an inet socket address or a domain socket address.
*
* Use {@link #inetSocketAddress(int, String)} to create an inet socket address and {@link #domainSocketAddress(String)}
* to create a domain socket address
*
* @author Tim Fox
*/
@VertxGen
public interface SocketAddress {
/**
* Create an inet socket address that binds to a shared random port identified by {@code id}.
*
* The {@code host} string can be a host name or a host address.
*
* No name resolution will be attempted.
*
* @param id the shared random port id
* @param host the host
* @return the created socket address
*/
static SocketAddress sharedRandomPort(int id, String host) {
if (id < 1) {
throw new IllegalArgumentException("Shared random port ID " + id + " must be > 0");
}
return new SocketAddressImpl(-id, host);
}
/**
* Create an inet socket address, {@code host} must be non {@code null} and {@code port} must be between {@code 0}
* and {@code 65536}.
*
* The {@code host} string can be a host name or a host address.
*
* No name resolution will be attempted.
*
* @param port the port
* @param host the host
* @return the created socket address
*/
static SocketAddress inetSocketAddress(int port, String host) {
Arguments.requireInRange(port, 0, 65535, "port p must be in range 0 <= p <= 65535");
return new SocketAddressImpl(port, host);
}
/**
* Create a domain socket address from a {@code path}.
*
* @param path the address path
* @return the created socket address
*/
static SocketAddress domainSocketAddress(String path) {
return new SocketAddressImpl(path);
}
/**
* Create a inet socket address from a Java {@link InetSocketAddress}.
*
* No name resolution will be attempted.
*
* @param address the address
* @return the created socket address
*/
@GenIgnore(GenIgnore.PERMITTED_TYPE)
static SocketAddress inetSocketAddress(InetSocketAddress address) {
return new SocketAddressImpl(address);
}
/**
* Returns the host name when available or the IP address in string representation.
*
* Domain socket address returns {@code null}.
*
* @return the host address
*/
@CacheReturn
String host();
/**
* Returns the host name when available or {@code null}
*
* Domain socket address returns {@code null}.
*
* @return the host name
*/
@CacheReturn
String hostName();
/**
* Returns the host IP address when available or {@code null} as a String.
*
* Domain socket address returns {@code null}.
*
* @return the host address
*/
@CacheReturn
String hostAddress();
/**
* @return the address port or {@code -1} for a domain socket
*/
@CacheReturn
int port();
/**
* @return the domain socket path or {@code null} for a inet socket address.
*/
@CacheReturn
String path();
/**
* @return {@code true} for an inet socket address
*/
@CacheReturn
boolean isInetSocket();
/**
* @return {@code true} for an domain socket address
*/
@CacheReturn
boolean isDomainSocket();
}