reactor.ipc.netty.udp.UdpClient Maven / Gradle / Ivy
Show all versions of reactor-netty Show documentation
/*
* Copyright (c) 2011-2018 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.udp;
import java.net.SocketAddress;
import java.util.Objects;
import java.util.function.BiFunction;
import java.util.function.Consumer;
import io.netty.bootstrap.Bootstrap;
import io.netty.buffer.ByteBuf;
import io.netty.channel.socket.DatagramChannel;
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.channel.ChannelOperations;
import reactor.ipc.netty.channel.ContextHandler;
import reactor.ipc.netty.options.ClientOptions;
import reactor.ipc.netty.options.NettyOptions;
/**
* A UDP client connector.
*
* @author Stephane Maldini
* @author Violeta Georgieva
*/
public final class UdpClient implements NettyConnector {
/**
* Bind a new UDP client to the "localhost" address and {@link NettyOptions#DEFAULT_PORT port 12012}.
* The type of emitted data or received data is {@link ByteBuf}
*
* @return a new {@link UdpClient}
*/
public static UdpClient create() {
return create(NetUtil.LOCALHOST.getHostAddress());
}
/**
* Bind a new UDP client to the given bind address and {@link NettyOptions#DEFAULT_PORT port 12012}.
*
The type of emitted data or received data is {@link ByteBuf}
*
* @param bindAddress bind address (e.g. "127.0.0.1") to create the client on default port
* @return a new {@link UdpClient}
*/
public static UdpClient create(String bindAddress) {
return create(bindAddress, NettyOptions.DEFAULT_PORT);
}
/**
* Bind a new UDP client to the "localhost" address and specified port.
*
The type of emitted data or received data is {@link ByteBuf}
*
* @param port the port to listen on the localhost bind address
* @return a new {@link UdpClient}
*/
public static UdpClient create(int port) {
return create(NetUtil.LOCALHOST.getHostAddress(), port);
}
/**
* Bind a new UDP client to the given bind address and port.
*
The type of emitted data or received data is {@link ByteBuf}
*
* @param bindAddress bind address (e.g. "127.0.0.1") to create the client on the
* passed port
* @param port the port to listen on the passed bind address
* @return a new {@link UdpClient}
*/
public static UdpClient create(String bindAddress, int port) {
return create(opts -> opts.host(bindAddress).port(port));
}
/**
* Bind a new UDP client to the bind address and port provided through the options.
*
The type of emitted data or received data is {@link ByteBuf}
*
* @param options the configurator
* @return a new {@link UdpClient}
*/
public static UdpClient create(Consumer> options) {
return builder().options(options).build();
}
/**
* Creates a builder for {@link UdpClient UdpClient}
*
* @return a new UdpClient builder
*/
public static UdpClient.Builder builder() {
return new UdpClient.Builder();
}
final UdpClientOptions options;
private UdpClient(UdpClient.Builder builder) {
UdpClientOptions.Builder clientOptionsBuilder = UdpClientOptions.builder();
if (Objects.nonNull(builder.options)) {
builder.options.accept(clientOptionsBuilder);
}
if (!clientOptionsBuilder.isLoopAvailable()) {
clientOptionsBuilder.loopResources(UdpResources.get());
}
this.options = clientOptionsBuilder.build();
}
@Override
public Mono newHandler(BiFunction> handler) {
final BiFunction>
targetHandler =
null == handler ? ChannelOperations.noopHandler() : handler;
return Mono.create(sink -> {
Bootstrap b = options.get();
SocketAddress adr = options.getAddress();
if(adr == null){
sink.error(new NullPointerException("Provided UdpClientOptions do not " +
"define any address to bind to "));
return;
}
b.remoteAddress(adr);
ContextHandler c = doHandler(targetHandler, sink, adr);
b.handler(c);
c.setFuture(b.connect());
});
}
/**
* Create a {@link ContextHandler} for {@link Bootstrap#handler()}
*
* @param handler user provided in/out handler
* @param sink user provided bind handler
*
* @return a new {@link ContextHandler}
*/
protected ContextHandler doHandler(BiFunction> handler,
MonoSink sink,
SocketAddress providedAddress) {
return ContextHandler.newClientContext(sink,
options,
loggingHandler,
false,
providedAddress,
(ch, c, msg) -> UdpOperations.bind(ch, handler, c));
}
static final LoggingHandler loggingHandler = new LoggingHandler(UdpClient.class);
public static final class Builder {
private Consumer options;
private Builder() {
}
/**
* The options for the client, including address and port.
*
* @param options the options for the client, including address and port.
* @return {@code this}
*/
public final Builder options(Consumer options) {
this.options = Objects.requireNonNull(options, "options");
return this;
}
public UdpClient build() {
return new UdpClient(this);
}
}
}