/* * 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.buffer.MessageBuf; import io.netty.buffer.Unpooled; import io.netty.channel.Channel; import io.netty.channel.ChannelFuture; import io.netty.channel.ChannelFutureListener; import io.netty.channel.ChannelHandler; import io.netty.channel.ChannelHandlerContext; import io.netty.channel.ChannelInboundHandlerAdapter; import io.netty.channel.ChannelInboundMessageHandler; import io.netty.channel.ChannelInitializer; import io.netty.channel.ChannelOption; import io.netty.channel.ChannelPipeline; import io.netty.channel.EventLoopGroup; import io.netty.channel.ServerChannel; import io.netty.channel.socket.SocketChannel; import io.netty.logging.InternalLogger; import io.netty.logging.InternalLoggerFactory; import io.netty.util.AttributeKey; import java.net.SocketAddress; import java.util.LinkedHashMap; import java.util.Map; import java.util.Map.Entry; /** * {@link Bootstrap} sub-class which allows easy bootstrap of {@link ServerChannel} * */ public final class ServerBootstrap extends AbstractBootstrap { private static final InternalLogger logger = InternalLoggerFactory.getInstance(ServerBootstrap.class); private final ChannelHandler acceptor = new ChannelInitializer() { @Override public void initChannel(Channel ch) throws Exception { ch.pipeline().addLast(new Acceptor()); } }; private final Map, Object> childOptions = new LinkedHashMap, Object>(); private final Map, Object> childAttrs = new LinkedHashMap, Object>(); private EventLoopGroup childGroup; private ChannelHandler childHandler; public ServerBootstrap() { } private ServerBootstrap(ServerBootstrap bootstrap) { super(bootstrap); childGroup = bootstrap.childGroup; childHandler = bootstrap.childHandler; childOptions.putAll(bootstrap.childOptions); childAttrs.putAll(bootstrap.childAttrs); } /** * Specify the {@link EventLoopGroup} which is used for the parent (acceptor) and the child (client). */ @Override public ServerBootstrap group(EventLoopGroup group) { return group(group, group); } /** * Set the {@link EventLoopGroup} for the parent (acceptor) and the child (client). These * {@link EventLoopGroup}'s are used to handle all the events and IO for {@link SocketChannel} and * {@link Channel}'s. */ public ServerBootstrap group(EventLoopGroup parentGroup, EventLoopGroup childGroup) { super.group(parentGroup); if (childGroup == null) { throw new NullPointerException("childGroup"); } if (this.childGroup != null) { throw new IllegalStateException("childGroup set already"); } this.childGroup = childGroup; return this; } /** * Allow to specify a {@link ChannelOption} which is used for the {@link Channel} instances once they get created * (after the acceptor accepted the {@link Channel}). Use a value of {@code null} to remove a previous set * {@link ChannelOption}. */ public ServerBootstrap childOption(ChannelOption childOption, T value) { if (childOption == null) { throw new NullPointerException("childOption"); } if (value == null) { childOptions.remove(childOption); } else { childOptions.put(childOption, value); } return this; } /** * Set the specific {@link AttributeKey} with the given value on every child {@link Channel}. If the value is * {@code null} the {@link AttributeKey} is removed */ public ServerBootstrap childAttr(AttributeKey childKey, T value) { if (childKey == null) { throw new NullPointerException("childKey"); } if (value == null) { childAttrs.remove(childKey); } else { childAttrs.put(childKey, value); } return this; } /** * Set the {@link ChannelHandler} which is used to serve the request for the {@link Channel}'s. */ public ServerBootstrap childHandler(ChannelHandler childHandler) { if (childHandler == null) { throw new NullPointerException("childHandler"); } this.childHandler = childHandler; return this; } @Override ChannelFuture doBind(SocketAddress localAddress) { Channel channel = channelFactory().newChannel(); try { channel.config().setOptions(options()); } catch (Exception e) { channel.close(); return channel.newFailedFuture(e); } for (Entry, Object> e: attrs().entrySet()) { @SuppressWarnings("unchecked") AttributeKey key = (AttributeKey) e.getKey(); channel.attr(key).set(e.getValue()); } ChannelPipeline p = channel.pipeline(); if (handler() != null) { p.addLast(handler()); } p.addLast(acceptor); ChannelFuture f = group().register(channel).awaitUninterruptibly(); if (!f.isSuccess()) { return f; } return channel.bind(localAddress).addListener(ChannelFutureListener.CLOSE_ON_FAILURE); } @Override public void shutdown() { super.shutdown(); if (childGroup != null) { childGroup.shutdown(); } } @Override public void validate() { super.validate(); if (childHandler == null) { throw new IllegalStateException("childHandler not set"); } if (childGroup == null) { logger.warn("childGroup is not set. Using parentGroup instead."); childGroup = group(); } } private class Acceptor extends ChannelInboundHandlerAdapter implements ChannelInboundMessageHandler { @Override public MessageBuf newInboundBuffer(ChannelHandlerContext ctx) throws Exception { return Unpooled.messageBuffer(); } @Override @SuppressWarnings("unchecked") public void inboundBufferUpdated(ChannelHandlerContext ctx) { MessageBuf in = ctx.inboundMessageBuffer(); for (;;) { Channel child = in.poll(); if (child == null) { break; } child.pipeline().addLast(childHandler); for (Entry, Object> e: childOptions.entrySet()) { try { if (!child.config().setOption((ChannelOption) e.getKey(), e.getValue())) { logger.warn("Unknown channel option: " + e); } } catch (Throwable t) { logger.warn("Failed to set a channel option: " + child, t); } } for (Entry, Object> e: childAttrs.entrySet()) { child.attr((AttributeKey) e.getKey()).set(e.getValue()); } try { childGroup.register(child); } catch (Throwable t) { child.unsafe().closeForcibly(); logger.warn("Failed to register an accepted channel: " + child, t); } } } } @Override @SuppressWarnings("CloneDoesntCallSuperClone") public ServerBootstrap clone() { return new ServerBootstrap(this); } @Override public String toString() { StringBuilder buf = new StringBuilder(super.toString()); buf.setLength(buf.length() - 1); buf.append(", "); if (childGroup != null) { buf.append("childGroup: "); buf.append(childGroup.getClass().getSimpleName()); buf.append(", "); } if (childOptions != null && !childOptions.isEmpty()) { buf.append("childOptions: "); buf.append(childOptions); buf.append(", "); } if (childAttrs != null && !childAttrs.isEmpty()) { buf.append("childAttrs: "); buf.append(childAttrs); buf.append(", "); } if (childHandler != null) { buf.append("childHandler: "); buf.append(childHandler); buf.append(", "); } if (buf.charAt(buf.length() - 1) == '(') { buf.append(')'); } else { buf.setCharAt(buf.length() - 2, ')'); buf.setLength(buf.length() - 1); } return buf.toString(); } }