reactor.netty.ChannelBindException Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of reactor-netty-core Show documentation
Core functionality for the Reactor Netty library
There is a newer version: 1.2.0
/*
 * Copyright (c) 2018-2021 VMware, Inc. or its affiliates, All Rights Reserved.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *   https://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package reactor.netty;

import java.io.IOException;
import java.net.InetSocketAddress;
import java.net.SocketAddress;
import java.util.Objects;

import reactor.util.annotation.Nullable;

/**
 * Represents a failing attempt to bind a local socket address
 *
 * @author Stephane Maldini
 */
public class ChannelBindException extends RuntimeException {

	/**
	 * Build a {@link ChannelBindException}
	 *
	 * @param bindAddress the local address
	 * @param cause the root cause
	 * @return a new {@link ChannelBindException}
	 * @since 0.9.7
	 */
	public static ChannelBindException fail(SocketAddress bindAddress, @Nullable Throwable cause) {
		Objects.requireNonNull(bindAddress, "bindAddress");
		if (cause instanceof java.net.BindException ||
				// With epoll/kqueue transport it is
				// io.netty.channel.unix.Errors$NativeIoException: bind(..) failed: Address already in use
				(cause instanceof IOException && cause.getMessage() != null &&
						cause.getMessage().contains("bind(..)"))) {
			cause = null;
		}
		if (!(bindAddress instanceof InetSocketAddress)) {
			return new ChannelBindException(bindAddress.toString(), cause);
		}
		InetSocketAddress address = (InetSocketAddress) bindAddress;

		return new ChannelBindException(address.getHostString(), address.getPort(), cause);
	}


	final String localHost;
	final int    localPort;

	protected ChannelBindException(String localHost, int localPort, @Nullable Throwable cause) {
		super("Failed to bind on [" + localHost + ":" + localPort + "]", cause);
		this.localHost = localHost;
		this.localPort = localPort;
	}

	protected ChannelBindException(String localHost, @Nullable Throwable cause) {
		super("Failed to bind on [" + localHost + "]", cause);
		this.localHost = localHost;
		this.localPort = -1;
	}

	@Override
	public synchronized Throwable fillInStackTrace() {
		return this;
	}

	/**
	 * Return the configured binding host
	 *
	 * @return the configured binding host
	 */
	public String localHost() {
		return localHost;
	}

	/**
	 * Return the configured binding port
	 *
	 * @return the configured local binding port
	 */
	public int localPort() {
		return localPort;
	}

	private static final long serialVersionUID = 1718814250958680216L;
}