reactor.ipc.netty.tcp.TcpServer.java Source code

Introduction

Here is the source code for reactor.ipc.netty.tcp.TcpServer.java

Source

/*
 * Copyright (c) 2011-2016 Pivotal Software Inc, 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
 *
 *       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 reactor.ipc.netty.tcp;

import java.util.Objects;
import java.util.function.BiFunction;
import java.util.function.Consumer;

import io.netty.bootstrap.ServerBootstrap;
import io.netty.buffer.ByteBuf;
import io.netty.channel.Channel;
import io.netty.handler.logging.LoggingHandler;
import io.netty.util.NetUtil;
import org.reactivestreams.Publisher;
import reactor.core.publisher.Mono;
import reactor.core.publisher.MonoSink;
import reactor.ipc.netty.NettyConnector;
import reactor.ipc.netty.NettyContext;
import reactor.ipc.netty.NettyInbound;
import reactor.ipc.netty.NettyOutbound;
import reactor.ipc.netty.channel.ChannelOperations;
import reactor.ipc.netty.channel.ContextHandler;
import reactor.ipc.netty.options.ServerOptions;
import reactor.util.Logger;
import reactor.util.Loggers;

/**
 * * A TCP server connector.
 *
 * @author Stephane Maldini
 */
public class TcpServer implements NettyConnector<NettyInbound, NettyOutbound> {

    /**
     * Bind a new TCP server to "loopback" on port {@literal 12012}.
     * Handlers will run on the same thread they have beem receiving IO events.
     * <p> The type of emitted data or received data is {@link ByteBuf}
     *
     * @return a new {@link TcpServer}
     */
    public static TcpServer create() {
        return create(NetUtil.LOCALHOST.getHostAddress());
    }

    /**
     * Bind a new TCP server to the given bind address and port.
     * Handlers will run on the same thread they have beem receiving IO events.
     * <p> The type of emitted data or received data is {@link ByteBuf}
     *
     * @param options {@link ServerOptions} configuration input
     *
     * @return a new {@link TcpServer}
     */
    public static TcpServer create(Consumer<? super ServerOptions> options) {
        Objects.requireNonNull(options, "options");
        ServerOptions serverOptions = ServerOptions.create();
        serverOptions.loopResources(TcpResources.get());
        options.accept(serverOptions);
        return new TcpServer(serverOptions.duplicate());
    }

    /**
     * Bind a new TCP server to "loopback" on the given port.
     * Handlers will run on the same thread they have beem receiving IO events.
     * <p> The type of emitted data or received data is {@link ByteBuf}
     *
     * @param port the port to listen on loopback
     *
     * @return a new {@link TcpServer}
     */
    public static TcpServer create(int port) {
        return create(NetUtil.LOCALHOST.getHostAddress(), port);
    }

    /**
     * Bind a new TCP server to the given bind address on port {@literal 12012}.
     * Handlers will run on the same thread they have beem receiving IO events.
     * <p> The type of emitted data or received data is {@link ByteBuf}
     *
     * @param bindAddress bind address (e.g. "127.0.0.1") to create the server on the
     * default port 12012
     *
     * @return a new {@link TcpServer}
     */
    public static TcpServer create(String bindAddress) {
        return create(bindAddress, 0);
    }

    /**
     * Bind a new TCP server to the given bind address and port.
     * Handlers will run on the same thread they have beem receiving IO events.
     * <p> The type of emitted data or received data is {@link ByteBuf}
     *
     * @param port the port to listen on the passed bind address
     * @param bindAddress bind address (e.g. "127.0.0.1") to create the server on the
     * passed port
     *
     * @return a new {@link TcpServer}
     */
    public static TcpServer create(String bindAddress, int port) {
        return create(opts -> opts.listen(bindAddress, port));
    }

    final ServerOptions options;

    /**
     * @param options server options
     */
    protected TcpServer(ServerOptions options) {
        this.options = Objects.requireNonNull(options, "options");
    }

    @Override
    public final Mono<? extends NettyContext> newHandler(
            BiFunction<? super NettyInbound, ? super NettyOutbound, ? extends Publisher<Void>> handler) {
        Objects.requireNonNull(handler, "handler");
        return Mono.create(sink -> {
            ServerBootstrap b = options.get();
            ContextHandler<Channel> contextHandler = doHandler(handler, sink);
            b.childHandler(contextHandler);
            if (log.isDebugEnabled()) {
                b.handler(loggingHandler());
            }
            contextHandler.setFuture(b.bind());
        });
    }

    @Override
    public String toString() {
        return "TcpServer:" + options.toString();
    }

    /**
     * Return the current logging handler for the server
     * @return the current logging handler for the server
     */
    protected LoggingHandler loggingHandler() {
        return loggingHandler;
    }

    /**
     * Create a {@link ContextHandler} for {@link ServerBootstrap#childHandler()}
     *
     * @param handler user provided in/out handler
     * @param sink user provided bind handler
     *
     * @return a new {@link ContextHandler}
     */
    protected ContextHandler<Channel> doHandler(
            BiFunction<? super NettyInbound, ? super NettyOutbound, ? extends Publisher<Void>> handler,
            MonoSink<NettyContext> sink) {
        return ContextHandler.newServerContext(sink, options, loggingHandler(),
                (ch, c, msg) -> ChannelOperations.bind(ch, handler, c));
    }

    static final LoggingHandler loggingHandler = new LoggingHandler(TcpServer.class);

    static final Logger log = Loggers.getLogger(TcpServer.class);
}