reactor.net.zmq.ZeroMQClientSocketOptions 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!
package reactor.net.zmq;

import org.zeromq.ZContext;
import org.zeromq.ZMQ;
import reactor.function.Consumer;
import reactor.net.config.ClientSocketOptions;
import reactor.util.Assert;

/**
 * {@link reactor.net.config.ClientSocketOptions} that include ZeroMQ-specific configuration options.
 *
 * @author Jon Brisbin
 */
public class ZeroMQClientSocketOptions extends ClientSocketOptions {

	private ZContext context;
	private int socketType = ZMQ.ROUTER;
	private Consumer socketConfigurer;
	private String connectAddresses;

	/**
	 * Get the {@link org.zeromq.ZContext} to use for IO.
	 *
	 * @return the {@link org.zeromq.ZContext} to use
	 */
	public ZContext context() {
		return context;
	}

	/**
	 * Set the {@link org.zeromq.ZContext} to use for IO.
	 *
	 * @param context
	 * 		the {@link org.zeromq.ZContext} to use
	 *
	 * @return {@literal this}
	 */
	public ZeroMQClientSocketOptions context(ZContext context) {
		Assert.notNull(context, "ZeroMQ Context cannot be null");
		this.context = context;
		return this;
	}

	/**
	 * The type of the ZMQ socket to create.
	 *
	 * @return the ZMQ socket type
	 */
	public int socketType() {
		return socketType;
	}

	/**
	 * Set the type of ZMQ socket to create.
	 *
	 * @param socketType
	 * 		the ZMQ socket type
	 *
	 * @return {@literal this}
	 */
	public ZeroMQClientSocketOptions socketType(int socketType) {
		this.socketType = socketType;
		return this;
	}

	/**
	 * The {@link reactor.function.Consumer} responsible for configuring the underlying ZeroMQ socket.
	 *
	 * @return the ZMQ.Socket configurer
	 */
	public Consumer socketConfigurer() {
		return socketConfigurer;
	}

	/**
	 * Set the {@link reactor.function.Consumer} responsible for configure the underlying ZeroMQ socket.
	 *
	 * @param socketConfigurer
	 * 		the ZMQ.Socket configurer
	 *
	 * @return {@literal this}
	 */
	public ZeroMQClientSocketOptions socketConfigurer(Consumer socketConfigurer) {
		this.socketConfigurer = socketConfigurer;
		return this;
	}

	public String connectAddresses() {
		return connectAddresses;
	}

	public ZeroMQClientSocketOptions connectAddresses(String connectAddresses) {
		this.connectAddresses = connectAddresses;
		return this;
	}

}