reactor.net.tcp.TcpServer Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of reactor-net Show documentation
Reactor TCP components
The newest version!
/*
 * Copyright (c) 2011-2013 GoPivotal, 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.net.tcp;

import reactor.core.Environment;
import reactor.core.Reactor;
import reactor.core.composable.Deferred;
import reactor.core.composable.Promise;
import reactor.core.composable.spec.Promises;
import reactor.function.Consumer;
import reactor.io.Buffer;
import reactor.io.encoding.Codec;
import reactor.net.AbstractNetPeer;
import reactor.net.NetChannel;
import reactor.net.NetServer;
import reactor.net.config.ServerSocketOptions;
import reactor.net.config.SslOptions;
import reactor.util.Assert;

import javax.annotation.Nonnull;
import javax.annotation.Nullable;
import java.net.InetSocketAddress;
import java.util.Collection;

/**
 * Base functionality needed by all servers that communicate with clients over TCP.
 *
 * @param 
 * 		The type that will be received by this server
 * @param 
 * 		The type that will be sent by this server
 *
 * @author Jon Brisbin
 * @author Stephane Maldini
 */
public abstract class TcpServer
		extends AbstractNetPeer
		implements NetServer {

	private final InetSocketAddress   listenAddress;
	private final ServerSocketOptions options;
	private final SslOptions          sslOptions;

	protected TcpServer(@Nonnull Environment env,
	                    @Nonnull Reactor reactor,
	                    @Nullable InetSocketAddress listenAddress,
	                    ServerSocketOptions options,
	                    SslOptions sslOptions,
	                    @Nullable Codec codec,
	                    @Nonnull Collection>> consumers) {
		super(env, reactor, codec, consumers);
		this.listenAddress = listenAddress;
		Assert.notNull(options, "ServerSocketOptions cannot be null");
		this.options = options;
		this.sslOptions = sslOptions;
	}

	/**
	 * Start this server.
	 *
	 * @return {@literal this}
	 */
	public Promise start() {
		final Deferred> d = Promises.defer(getEnvironment(), getReactor().getDispatcher());
		start(new Runnable() {
			@Override
			public void run() {
				d.accept(true);
			}
		});
		return d.compose();
	}

	/**
	 * Start this server, invoking the given callback when the server has started.
	 *
	 * @param started
	 * 		Callback to invoke when the server is started. May be {@literal null}.
	 *
	 * @return {@literal this}
	 */
	public abstract TcpServer start(@Nullable Runnable started);

	/**
	 * Get the address to which this server is bound.
	 *
	 * @return
	 */
	protected InetSocketAddress getListenAddress() {
		return listenAddress;
	}

	/**
	 * Get the {@link reactor.net.config.ServerSocketOptions} currently in effect.
	 *
	 * @return
	 */
	protected ServerSocketOptions getOptions() {
		return options;
	}

	/**
	 * Get the {@link reactor.net.config.SslOptions} current in effect.
	 *
	 * @return the SSL options
	 */
	protected SslOptions getSslOptions() {
		return sslOptions;
	}

}