io.vertx.rxjava.core.http.HttpServer Maven / Gradle / Ivy
/*
* Copyright 2014 Red Hat, Inc.
*
* Red Hat licenses this file to you 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 io.vertx.rxjava.core.http;
import rx.Observable;
import rx.Single;
import io.vertx.rx.java.RxHelper;
import io.vertx.rx.java.WriteStreamSubscriber;
import io.vertx.rx.java.SingleOnSubscribeAdapter;
import java.util.Map;
import java.util.Set;
import java.util.List;
import java.util.Iterator;
import java.util.function.Function;
import java.util.function.Supplier;
import java.util.stream.Collectors;
import io.vertx.core.Handler;
import io.vertx.core.AsyncResult;
import io.vertx.core.json.JsonObject;
import io.vertx.core.json.JsonArray;
import io.vertx.lang.rx.RxGen;
import io.vertx.lang.rx.TypeArg;
import io.vertx.lang.rx.MappingIterator;
/**
* An HTTP and WebSockets server.
*
* You receive HTTP requests by providing a {@link io.vertx.rxjava.core.http.HttpServer#requestHandler}. As requests arrive on the server the handler
* will be called with the requests.
*
* You receive WebSockets by providing a {@link io.vertx.rxjava.core.http.HttpServer#webSocketHandler}. As WebSocket connections arrive on the server, the
* WebSocket is passed to the handler.
*
*
* NOTE: This class has been automatically generated from the {@link io.vertx.core.http.HttpServer original} non RX-ified interface using Vert.x codegen.
*/
@RxGen(io.vertx.core.http.HttpServer.class)
public class HttpServer implements io.vertx.rxjava.core.metrics.Measured {
@Override
public String toString() {
return delegate.toString();
}
@Override
public boolean equals(Object o) {
if (this == o) return true;
if (o == null || getClass() != o.getClass()) return false;
HttpServer that = (HttpServer) o;
return delegate.equals(that.delegate);
}
@Override
public int hashCode() {
return delegate.hashCode();
}
public static final TypeArg __TYPE_ARG = new TypeArg<>( obj -> new HttpServer((io.vertx.core.http.HttpServer) obj),
HttpServer::getDelegate
);
private final io.vertx.core.http.HttpServer delegate;
public HttpServer(io.vertx.core.http.HttpServer delegate) {
this.delegate = delegate;
}
public HttpServer(Object delegate) {
this.delegate = (io.vertx.core.http.HttpServer)delegate;
}
public io.vertx.core.http.HttpServer getDelegate() {
return delegate;
}
private static final TypeArg TYPE_ARG_0 = new TypeArg(o1 -> io.vertx.rxjava.core.http.HttpServer.newInstance((io.vertx.core.http.HttpServer)o1), o1 -> o1.getDelegate());
private static final TypeArg TYPE_ARG_1 = new TypeArg(o1 -> io.vertx.rxjava.core.http.HttpServer.newInstance((io.vertx.core.http.HttpServer)o1), o1 -> o1.getDelegate());
private static final TypeArg TYPE_ARG_2 = new TypeArg(o1 -> io.vertx.rxjava.core.http.HttpServer.newInstance((io.vertx.core.http.HttpServer)o1), o1 -> o1.getDelegate());
private static final TypeArg TYPE_ARG_3 = new TypeArg(o1 -> io.vertx.rxjava.core.http.HttpServer.newInstance((io.vertx.core.http.HttpServer)o1), o1 -> o1.getDelegate());
/**
* Whether the metrics are enabled for this measured object
* @return true if metrics are enabled
*/
public boolean isMetricsEnabled() {
boolean ret = delegate.isMetricsEnabled();
return ret;
}
/**
* Set the request handler for the server to requestHandler. As HTTP requests are received by the server,
* instances of {@link io.vertx.rxjava.core.http.HttpServerRequest} will be created and passed to this handler.
* @param handler
* @return a reference to this, so the API can be used fluently
*/
public io.vertx.rxjava.core.http.HttpServer requestHandler(io.vertx.core.Handler handler) {
delegate.requestHandler(new io.vertx.lang.rx.DelegatingHandler<>(handler, event -> io.vertx.rxjava.core.http.HttpServerRequest.newInstance((io.vertx.core.http.HttpServerRequest)event)));
return this;
}
/**
* Set a handler for handling invalid requests. When an invalid request is received by the server
* this handler will be called with the request. The handler can send any HTTP response, when the response
* ends, the server shall close the connection. {@link io.vertx.rxjava.core.http.HttpServerRequest#decoderResult} can be used
* to obtain the Netty decoder result and the failure cause reported by the decoder.
*
* Currently this handler is only used for HTTP/1.x requests.
*
*
When no specific handler is set, the {@link io.vertx.rxjava.core.http.HttpServerRequest} is used.
* @param handler
* @return a reference to this, so the API can be used fluently
*/
public io.vertx.rxjava.core.http.HttpServer invalidRequestHandler(io.vertx.core.Handler handler) {
io.vertx.rxjava.core.http.HttpServer ret = io.vertx.rxjava.core.http.HttpServer.newInstance((io.vertx.core.http.HttpServer)delegate.invalidRequestHandler(new io.vertx.lang.rx.DelegatingHandler<>(handler, event -> io.vertx.rxjava.core.http.HttpServerRequest.newInstance((io.vertx.core.http.HttpServerRequest)event))));
return ret;
}
/**
* Set a connection handler for the server.
*
* The handler will always be called on the event-loop thread.
* @param handler
* @return a reference to this, so the API can be used fluently
*/
public io.vertx.rxjava.core.http.HttpServer connectionHandler(io.vertx.core.Handler handler) {
delegate.connectionHandler(new io.vertx.lang.rx.DelegatingHandler<>(handler, event -> io.vertx.rxjava.core.http.HttpConnection.newInstance((io.vertx.core.http.HttpConnection)event)));
return this;
}
/**
* Set a handler for WebSocket handshake.
*
* When an inbound HTTP request presents a WebSocket upgrade, this handler is called first. The handler
* can chose to {@link io.vertx.rxjava.core.http.ServerWebSocketHandshake#accept} or {@link io.vertx.rxjava.core.http.ServerWebSocketHandshake#reject} the request.
*
* Setting no handler, implicitly accepts any HTTP request connection presenting an upgrade header and upgrades it
* to a WebSocket.
* @param handler
* @return
*/
public io.vertx.rxjava.core.http.HttpServer webSocketHandshakeHandler(io.vertx.core.Handler handler) {
delegate.webSocketHandshakeHandler(new io.vertx.lang.rx.DelegatingHandler<>(handler, event -> io.vertx.rxjava.core.http.ServerWebSocketHandshake.newInstance((io.vertx.core.http.ServerWebSocketHandshake)event)));
return this;
}
/**
* Set an exception handler called for socket errors happening before the HTTP connection
* is established, e.g during the TLS handshake.
* @param handler the handler to set
* @return a reference to this, so the API can be used fluently
*/
public io.vertx.rxjava.core.http.HttpServer exceptionHandler(io.vertx.core.Handler handler) {
delegate.exceptionHandler(handler);
return this;
}
/**
* Set the WebSocket handler for the server to wsHandler. If a WebSocket connect handshake is successful a
* new {@link io.vertx.rxjava.core.http.ServerWebSocket} instance will be created and passed to the handler.
* @param handler
* @return a reference to this, so the API can be used fluently
*/
public io.vertx.rxjava.core.http.HttpServer webSocketHandler(io.vertx.core.Handler handler) {
delegate.webSocketHandler(new io.vertx.lang.rx.DelegatingHandler<>(handler, event -> io.vertx.rxjava.core.http.ServerWebSocket.newInstance((io.vertx.core.http.ServerWebSocket)event)));
return this;
}
/**
* Update the server with new SSL options, the update happens if the options object is valid and different
* from the existing options object.
*
* The boolean succeeded future result indicates whether the update occurred.
* @param options the new SSL options
* @return a future signaling the update success
*/
public io.vertx.core.Future updateSSLOptions(io.vertx.core.net.ServerSSLOptions options) {
io.vertx.core.Future ret = delegate.updateSSLOptions(options).map(val -> val);
return ret;
}
/**
* Update the server with new SSL options, the update happens if the options object is valid and different
* from the existing options object.
*
* The boolean succeeded future result indicates whether the update occurred.
* @param options the new SSL options
* @return a future signaling the update success
*/
public rx.Single rxUpdateSSLOptions(io.vertx.core.net.ServerSSLOptions options) {
return Single.create(new SingleOnSubscribeAdapter<>(fut -> {
this.updateSSLOptions(options).onComplete(fut);
}));
}
/**
* Update the server with new SSL options, the update happens if the options object is valid and different
* from the existing options object.
*
*
The options object is compared using its equals method against the existing options to prevent
* an update when the objects are equals since loading options can be costly, this can happen for share TCP servers.
* When object are equals, setting force to true forces the update.
*
*
The boolean succeeded future result indicates whether the update occurred.
* @param options the new SSL options
* @param force force the update when options are equals
* @return a future signaling the update success
*/
public io.vertx.core.Future updateSSLOptions(io.vertx.core.net.ServerSSLOptions options, boolean force) {
io.vertx.core.Future ret = delegate.updateSSLOptions(options, force).map(val -> val);
return ret;
}
/**
* Update the server with new SSL options, the update happens if the options object is valid and different
* from the existing options object.
*
*
The options object is compared using its equals method against the existing options to prevent
* an update when the objects are equals since loading options can be costly, this can happen for share TCP servers.
* When object are equals, setting force to true forces the update.
*
*
The boolean succeeded future result indicates whether the update occurred.
* @param options the new SSL options
* @param force force the update when options are equals
* @return a future signaling the update success
*/
public rx.Single rxUpdateSSLOptions(io.vertx.core.net.ServerSSLOptions options, boolean force) {
return Single.create(new SingleOnSubscribeAdapter<>(fut -> {
this.updateSSLOptions(options, force).onComplete(fut);
}));
}
/**
* Update traffic shaping options options, the update happens if valid values are passed for traffic
* shaping options. This update happens synchronously and at best effort for rate update to take effect immediately.
* @param options the new traffic shaping options
*/
public void updateTrafficShapingOptions(io.vertx.core.net.TrafficShapingOptions options) {
delegate.updateTrafficShapingOptions(options);
}
/**
* Tell the server to start listening. The server will listen on the port and host specified in the
* {@link io.vertx.core.http.HttpServerOptions} that was used when creating the server.
*
* The listen happens asynchronously and the server may not be listening until some time after the call has returned.
* @return a future completed with the listen operation result
*/
public io.vertx.core.Future listen() {
io.vertx.core.Future ret = delegate.listen().map(val -> io.vertx.rxjava.core.http.HttpServer.newInstance((io.vertx.core.http.HttpServer)val));
return ret;
}
/**
* Tell the server to start listening. The server will listen on the port and host specified in the
* {@link io.vertx.core.http.HttpServerOptions} that was used when creating the server.
*
* The listen happens asynchronously and the server may not be listening until some time after the call has returned.
* @return a future completed with the listen operation result
*/
public rx.Single rxListen() {
return Single.create(new SingleOnSubscribeAdapter<>(fut -> {
this.listen().onComplete(fut);
}));
}
/**
* Tell the server to start listening. The server will listen on the port and host specified here,
* ignoring any value set in the {@link io.vertx.core.http.HttpServerOptions} that was used when creating the server.
*
* The listen happens asynchronously and the server may not be listening until some time after the call has returned.
* @param port the port to listen on
* @param host the host to listen on
* @return a future completed with the listen operation result
*/
public io.vertx.core.Future listen(int port, java.lang.String host) {
io.vertx.core.Future ret = delegate.listen(port, host).map(val -> io.vertx.rxjava.core.http.HttpServer.newInstance((io.vertx.core.http.HttpServer)val));
return ret;
}
/**
* Tell the server to start listening. The server will listen on the port and host specified here,
* ignoring any value set in the {@link io.vertx.core.http.HttpServerOptions} that was used when creating the server.
*
* The listen happens asynchronously and the server may not be listening until some time after the call has returned.
* @param port the port to listen on
* @param host the host to listen on
* @return a future completed with the listen operation result
*/
public rx.Single rxListen(int port, java.lang.String host) {
return Single.create(new SingleOnSubscribeAdapter<>(fut -> {
this.listen(port, host).onComplete(fut);
}));
}
/**
* Tell the server to start listening on the given address supplying
* a handler that will be called when the server is actually
* listening (or has failed).
* @param address the address to listen on
* @return a future completed with the listen operation result
*/
public io.vertx.core.Future listen(io.vertx.core.net.SocketAddress address) {
io.vertx.core.Future ret = delegate.listen(address).map(val -> io.vertx.rxjava.core.http.HttpServer.newInstance((io.vertx.core.http.HttpServer)val));
return ret;
}
/**
* Tell the server to start listening on the given address supplying
* a handler that will be called when the server is actually
* listening (or has failed).
* @param address the address to listen on
* @return a future completed with the listen operation result
*/
public rx.Single rxListen(io.vertx.core.net.SocketAddress address) {
return Single.create(new SingleOnSubscribeAdapter<>(fut -> {
this.listen(address).onComplete(fut);
}));
}
/**
* Like {@link io.vertx.rxjava.core.http.HttpServer#listen} but the server will listen on host "0.0.0.0" and port specified here ignoring
* any value in the {@link io.vertx.core.http.HttpServerOptions} that was used when creating the server.
* @param port the port to listen on
* @return a future completed with the listen operation result
*/
public io.vertx.core.Future listen(int port) {
io.vertx.core.Future ret = delegate.listen(port).map(val -> io.vertx.rxjava.core.http.HttpServer.newInstance((io.vertx.core.http.HttpServer)val));
return ret;
}
/**
* Like {@link io.vertx.rxjava.core.http.HttpServer#listen} but the server will listen on host "0.0.0.0" and port specified here ignoring
* any value in the {@link io.vertx.core.http.HttpServerOptions} that was used when creating the server.
* @param port the port to listen on
* @return a future completed with the listen operation result
*/
public rx.Single rxListen(int port) {
return Single.create(new SingleOnSubscribeAdapter<>(fut -> {
this.listen(port).onComplete(fut);
}));
}
/**
* Close the server. Any open HTTP connections will be closed.
*
* The close happens asynchronously and the server may not be closed until some time after the call has returned.
* @return a future completed with the result
*/
public io.vertx.core.Future close() {
io.vertx.core.Future ret = delegate.close().map(val -> val);
return ret;
}
/**
* Close the server. Any open HTTP connections will be closed.
*
* The close happens asynchronously and the server may not be closed until some time after the call has returned.
* @return a future completed with the result
*/
public rx.Single rxClose() {
return Single.create(new SingleOnSubscribeAdapter<>(fut -> {
this.close().onComplete(fut);
}));
}
/**
* Shutdown with a 30 seconds timeout (shutdown(30, TimeUnit.SECONDS)).
* @return a future completed when shutdown has completed
*/
public io.vertx.core.Future shutdown() {
io.vertx.core.Future ret = delegate.shutdown().map(val -> val);
return ret;
}
/**
* Shutdown with a 30 seconds timeout (shutdown(30, TimeUnit.SECONDS)).
* @return a future completed when shutdown has completed
*/
public rx.Single rxShutdown() {
return Single.create(new SingleOnSubscribeAdapter<>(fut -> {
this.shutdown().onComplete(fut);
}));
}
/**
* Initiate the server shutdown sequence.
*
* Connections are taken out of service and closed when all inflight requests are processed. When all connections are closed
* the server is closed. When the timeout expires, all unclosed connections are immediately closed.
*
*
* - HTTP/2 connections will send a go away frame immediately to signal the other side the connection will close
* - HTTP/1.x server connection will be closed after the current response is sent
*
* @param timeout the amount of time after which all resources are forcibly closed
* @param unit the of the timeout
* @return a future notified when the client is closed
*/
public io.vertx.core.Future shutdown(long timeout, java.util.concurrent.TimeUnit unit) {
io.vertx.core.Future ret = delegate.shutdown(timeout, unit).map(val -> val);
return ret;
}
/**
* Initiate the server shutdown sequence.
*
* Connections are taken out of service and closed when all inflight requests are processed. When all connections are closed
* the server is closed. When the timeout expires, all unclosed connections are immediately closed.
*
*
* - HTTP/2 connections will send a go away frame immediately to signal the other side the connection will close
* - HTTP/1.x server connection will be closed after the current response is sent
*
* @param timeout the amount of time after which all resources are forcibly closed
* @param unit the of the timeout
* @return a future notified when the client is closed
*/
public rx.Single rxShutdown(long timeout, java.util.concurrent.TimeUnit unit) {
return Single.create(new SingleOnSubscribeAdapter<>(fut -> {
this.shutdown(timeout, unit).onComplete(fut);
}));
}
/**
* The actual port the server is listening on. This is useful if you bound the server specifying 0 as port number
* signifying an ephemeral port
* @return the actual port the server is listening on.
*/
public int actualPort() {
int ret = delegate.actualPort();
return ret;
}
public static HttpServer newInstance(io.vertx.core.http.HttpServer arg) {
return arg != null ? new HttpServer(arg) : null;
}
}