314 lines
11 KiB
Java
314 lines
11 KiB
Java
/*
|
|
* Copyright 2012 The Netty Project
|
|
*
|
|
* The Netty Project licenses this file to you 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:
|
|
*
|
|
* http://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 io.netty.bootstrap;
|
|
|
|
import io.netty.channel.Channel;
|
|
import io.netty.channel.ChannelFuture;
|
|
import io.netty.channel.ChannelFutureListener;
|
|
import io.netty.channel.ChannelOption;
|
|
import io.netty.channel.ChannelPipeline;
|
|
import io.netty.channel.ChannelPromise;
|
|
import io.netty.channel.EventLoop;
|
|
import io.netty.channel.EventLoopGroup;
|
|
import io.netty.resolver.AddressResolver;
|
|
import io.netty.resolver.DefaultAddressResolverGroup;
|
|
import io.netty.resolver.NameResolver;
|
|
import io.netty.resolver.AddressResolverGroup;
|
|
import io.netty.util.AttributeKey;
|
|
import io.netty.util.concurrent.Future;
|
|
import io.netty.util.concurrent.FutureListener;
|
|
import io.netty.util.internal.OneTimeTask;
|
|
import io.netty.util.internal.logging.InternalLogger;
|
|
import io.netty.util.internal.logging.InternalLoggerFactory;
|
|
|
|
import java.net.InetAddress;
|
|
import java.net.InetSocketAddress;
|
|
import java.net.SocketAddress;
|
|
import java.util.Map;
|
|
import java.util.Map.Entry;
|
|
|
|
/**
|
|
* A {@link Bootstrap} that makes it easy to bootstrap a {@link Channel} to use
|
|
* for clients.
|
|
*
|
|
* <p>The {@link #bind()} methods are useful in combination with connectionless transports such as datagram (UDP).
|
|
* For regular TCP connections, please use the provided {@link #connect()} methods.</p>
|
|
*/
|
|
public class Bootstrap extends AbstractBootstrap<Bootstrap, Channel> {
|
|
|
|
private static final InternalLogger logger = InternalLoggerFactory.getInstance(Bootstrap.class);
|
|
|
|
private static final AddressResolverGroup<?> DEFAULT_RESOLVER = DefaultAddressResolverGroup.INSTANCE;
|
|
|
|
@SuppressWarnings("unchecked")
|
|
private volatile AddressResolverGroup<SocketAddress> resolver =
|
|
(AddressResolverGroup<SocketAddress>) DEFAULT_RESOLVER;
|
|
private volatile SocketAddress remoteAddress;
|
|
|
|
public Bootstrap() { }
|
|
|
|
private Bootstrap(Bootstrap bootstrap) {
|
|
super(bootstrap);
|
|
resolver = bootstrap.resolver;
|
|
remoteAddress = bootstrap.remoteAddress;
|
|
}
|
|
|
|
/**
|
|
* Sets the {@link NameResolver} which will resolve the address of the unresolved named address.
|
|
*/
|
|
@SuppressWarnings("unchecked")
|
|
public Bootstrap resolver(AddressResolverGroup<?> resolver) {
|
|
if (resolver == null) {
|
|
throw new NullPointerException("resolver");
|
|
}
|
|
this.resolver = (AddressResolverGroup<SocketAddress>) resolver;
|
|
return this;
|
|
}
|
|
|
|
/**
|
|
* The {@link SocketAddress} to connect to once the {@link #connect()} method
|
|
* is called.
|
|
*/
|
|
public Bootstrap remoteAddress(SocketAddress remoteAddress) {
|
|
this.remoteAddress = remoteAddress;
|
|
return this;
|
|
}
|
|
|
|
/**
|
|
* @see {@link #remoteAddress(SocketAddress)}
|
|
*/
|
|
public Bootstrap remoteAddress(String inetHost, int inetPort) {
|
|
remoteAddress = InetSocketAddress.createUnresolved(inetHost, inetPort);
|
|
return this;
|
|
}
|
|
|
|
/**
|
|
* @see {@link #remoteAddress(SocketAddress)}
|
|
*/
|
|
public Bootstrap remoteAddress(InetAddress inetHost, int inetPort) {
|
|
remoteAddress = new InetSocketAddress(inetHost, inetPort);
|
|
return this;
|
|
}
|
|
|
|
/**
|
|
* Connect a {@link Channel} to the remote peer.
|
|
*/
|
|
public ChannelFuture connect() {
|
|
validate();
|
|
SocketAddress remoteAddress = this.remoteAddress;
|
|
if (remoteAddress == null) {
|
|
throw new IllegalStateException("remoteAddress not set");
|
|
}
|
|
|
|
return doResolveAndConnect(remoteAddress, localAddress());
|
|
}
|
|
|
|
/**
|
|
* Connect a {@link Channel} to the remote peer.
|
|
*/
|
|
public ChannelFuture connect(String inetHost, int inetPort) {
|
|
return connect(InetSocketAddress.createUnresolved(inetHost, inetPort));
|
|
}
|
|
|
|
/**
|
|
* Connect a {@link Channel} to the remote peer.
|
|
*/
|
|
public ChannelFuture connect(InetAddress inetHost, int inetPort) {
|
|
return connect(new InetSocketAddress(inetHost, inetPort));
|
|
}
|
|
|
|
/**
|
|
* Connect a {@link Channel} to the remote peer.
|
|
*/
|
|
public ChannelFuture connect(SocketAddress remoteAddress) {
|
|
if (remoteAddress == null) {
|
|
throw new NullPointerException("remoteAddress");
|
|
}
|
|
|
|
validate();
|
|
return doResolveAndConnect(remoteAddress, localAddress());
|
|
}
|
|
|
|
/**
|
|
* Connect a {@link Channel} to the remote peer.
|
|
*/
|
|
public ChannelFuture connect(SocketAddress remoteAddress, SocketAddress localAddress) {
|
|
if (remoteAddress == null) {
|
|
throw new NullPointerException("remoteAddress");
|
|
}
|
|
validate();
|
|
return doResolveAndConnect(remoteAddress, localAddress);
|
|
}
|
|
|
|
/**
|
|
* @see {@link #connect()}
|
|
*/
|
|
private ChannelFuture doResolveAndConnect(SocketAddress remoteAddress, final SocketAddress localAddress) {
|
|
final ChannelFuture regFuture = initAndRegister();
|
|
if (regFuture.cause() != null) {
|
|
return regFuture;
|
|
}
|
|
|
|
final Channel channel = regFuture.channel();
|
|
final EventLoop eventLoop = channel.eventLoop();
|
|
final AddressResolver<SocketAddress> resolver = this.resolver.getResolver(eventLoop);
|
|
|
|
if (!resolver.isSupported(remoteAddress) || resolver.isResolved(remoteAddress)) {
|
|
// Resolver has no idea about what to do with the specified remote address or it's resolved already.
|
|
return doConnect(remoteAddress, localAddress, regFuture, channel.newPromise());
|
|
}
|
|
|
|
final Future<SocketAddress> resolveFuture = resolver.resolve(remoteAddress);
|
|
final Throwable resolveFailureCause = resolveFuture.cause();
|
|
|
|
if (resolveFailureCause != null) {
|
|
// Failed to resolve immediately
|
|
channel.close();
|
|
return channel.newFailedFuture(resolveFailureCause);
|
|
}
|
|
|
|
if (resolveFuture.isDone()) {
|
|
// Succeeded to resolve immediately; cached? (or did a blocking lookup)
|
|
return doConnect(resolveFuture.getNow(), localAddress, regFuture, channel.newPromise());
|
|
}
|
|
|
|
// Wait until the name resolution is finished.
|
|
final ChannelPromise connectPromise = channel.newPromise();
|
|
resolveFuture.addListener(new FutureListener<SocketAddress>() {
|
|
@Override
|
|
public void operationComplete(Future<SocketAddress> future) throws Exception {
|
|
if (future.cause() != null) {
|
|
channel.close();
|
|
connectPromise.setFailure(future.cause());
|
|
} else {
|
|
doConnect(future.getNow(), localAddress, regFuture, connectPromise);
|
|
}
|
|
}
|
|
});
|
|
|
|
return connectPromise;
|
|
}
|
|
|
|
private static ChannelFuture doConnect(
|
|
final SocketAddress remoteAddress, final SocketAddress localAddress,
|
|
final ChannelFuture regFuture, final ChannelPromise connectPromise) {
|
|
if (regFuture.isDone()) {
|
|
doConnect0(remoteAddress, localAddress, regFuture, connectPromise);
|
|
} else {
|
|
regFuture.addListener(new ChannelFutureListener() {
|
|
@Override
|
|
public void operationComplete(ChannelFuture future) throws Exception {
|
|
doConnect0(remoteAddress, localAddress, regFuture, connectPromise);
|
|
}
|
|
});
|
|
}
|
|
|
|
return connectPromise;
|
|
}
|
|
|
|
private static void doConnect0(
|
|
final SocketAddress remoteAddress, final SocketAddress localAddress, final ChannelFuture regFuture,
|
|
final ChannelPromise connectPromise) {
|
|
|
|
// This method is invoked before channelRegistered() is triggered. Give user handlers a chance to set up
|
|
// the pipeline in its channelRegistered() implementation.
|
|
final Channel channel = connectPromise.channel();
|
|
channel.eventLoop().execute(new OneTimeTask() {
|
|
@Override
|
|
public void run() {
|
|
if (regFuture.isSuccess()) {
|
|
if (localAddress == null) {
|
|
channel.connect(remoteAddress, connectPromise);
|
|
} else {
|
|
channel.connect(remoteAddress, localAddress, connectPromise);
|
|
}
|
|
connectPromise.addListener(ChannelFutureListener.CLOSE_ON_FAILURE);
|
|
} else {
|
|
connectPromise.setFailure(regFuture.cause());
|
|
}
|
|
}
|
|
});
|
|
}
|
|
|
|
@Override
|
|
@SuppressWarnings("unchecked")
|
|
void init(Channel channel) throws Exception {
|
|
ChannelPipeline p = channel.pipeline();
|
|
p.addLast(handler());
|
|
|
|
final Map<ChannelOption<?>, Object> options = options();
|
|
synchronized (options) {
|
|
for (Entry<ChannelOption<?>, Object> e: options.entrySet()) {
|
|
try {
|
|
if (!channel.config().setOption((ChannelOption<Object>) e.getKey(), e.getValue())) {
|
|
logger.warn("Unknown channel option: " + e);
|
|
}
|
|
} catch (Throwable t) {
|
|
logger.warn("Failed to set a channel option: " + channel, t);
|
|
}
|
|
}
|
|
}
|
|
|
|
final Map<AttributeKey<?>, Object> attrs = attrs();
|
|
synchronized (attrs) {
|
|
for (Entry<AttributeKey<?>, Object> e: attrs.entrySet()) {
|
|
channel.attr((AttributeKey<Object>) e.getKey()).set(e.getValue());
|
|
}
|
|
}
|
|
}
|
|
|
|
@Override
|
|
public Bootstrap validate() {
|
|
super.validate();
|
|
if (handler() == null) {
|
|
throw new IllegalStateException("handler not set");
|
|
}
|
|
return this;
|
|
}
|
|
|
|
@Override
|
|
@SuppressWarnings("CloneDoesntCallSuperClone")
|
|
public Bootstrap clone() {
|
|
return new Bootstrap(this);
|
|
}
|
|
|
|
/**
|
|
* Returns a deep clone of this bootstrap which has the identical configuration except that it uses
|
|
* the given {@link EventLoopGroup}. This method is useful when making multiple {@link Channel}s with similar
|
|
* settings.
|
|
*/
|
|
public Bootstrap clone(EventLoopGroup group) {
|
|
Bootstrap bs = new Bootstrap(this);
|
|
bs.group = group;
|
|
return bs;
|
|
}
|
|
|
|
@Override
|
|
public String toString() {
|
|
if (remoteAddress == null) {
|
|
return super.toString();
|
|
}
|
|
|
|
StringBuilder buf = new StringBuilder(super.toString());
|
|
buf.setLength(buf.length() - 1);
|
|
|
|
return buf.append(", remoteAddress: ")
|
|
.append(remoteAddress)
|
|
.append(')')
|
|
.toString();
|
|
}
|
|
}
|