reactor.net.tcp.spec.TcpClients Maven / Gradle / Ivy

Go to download
package reactor.net.tcp.spec;

import reactor.core.Environment;
import reactor.net.tcp.TcpClient;

import javax.annotation.Nonnull;

/**
 * Helper class to make creating {@link reactor.net.tcp.TcpClient} instances more succinct.
 *
 * @author Jon Brisbin
 */
public class TcpClients {

	/**
	 * Create a {@link reactor.net.tcp.spec.TcpClientSpec} for further configuration using the given {@link
	 * reactor.core.Environment} and {@code clientImpl}.
	 *
	 * @param env
	 * 		the {@link reactor.core.Environment} to use
	 * @param clientImpl
	 * 		the {@link reactor.net.tcp.TcpClient} implementation to use
	 * @param 
	 * 		type of the input
	 * @param 
	 * 		type of the output
	 *
	 * @return a new {@link reactor.net.tcp.spec.TcpClientSpec}
	 */
	public static  TcpClientSpec create(Environment env,
	                                                      @Nonnull Class clientImpl) {
		return new TcpClientSpec(clientImpl).env(env);
	}

	/**
	 * Create a {@link reactor.net.tcp.spec.TcpClientSpec} for further configuration using the given {@link
	 * reactor.core.Environment}, {@link reactor.event.dispatch.Dispatcher} type, and {@code clientImpl}.
	 *
	 * @param env
	 * 		the {@link reactor.core.Environment} to use
	 * @param dispatcher
	 * 		the type of {@link reactor.event.dispatch.Dispatcher} to use
	 * @param clientImpl
	 * 		the {@link reactor.net.tcp.TcpClient} implementation to use
	 * @param 
	 * 		type of the input
	 * @param 
	 * 		type of the output
	 *
	 * @return a new {@link reactor.net.tcp.spec.TcpClientSpec}
	 */
	public static  TcpClientSpec create(Environment env,
	                                                      String dispatcher,
	                                                      @Nonnull Class clientImpl) {
		return new TcpClientSpec(clientImpl).env(env).dispatcher(dispatcher);
	}

}