diff --git a/api/src/main/java/de/cyface/api/HttpServer.java b/api/src/main/java/de/cyface/api/HttpServer.java index 3aee4c5..31c64b8 100644 --- a/api/src/main/java/de/cyface/api/HttpServer.java +++ b/api/src/main/java/de/cyface/api/HttpServer.java @@ -1,5 +1,5 @@ /* - * Copyright 2020-2022 Cyface GmbH + * Copyright 2020-2023 Cyface GmbH * * This file is part of the Cyface API Library. * @@ -34,7 +34,7 @@ * A wrapper which starts the {@code HttpServer} for {@code ApiVerticle}s. * * @author Armin Schnabel - * @version 1.0.2 + * @version 1.1.0 * @since 1.0.0 */ @SuppressWarnings("unused") // Part of the API @@ -59,7 +59,9 @@ public HttpServer(final int port) { } /** - * Starts the HTTP server provided by this application. This server runs the Cyface Collector REST-API. + * Starts the HTTP server provided by this application. + *
+ * This server runs the Cyface Collector REST-API.
*
* @param vertx The Vertx instance to get the parameters from
* @param router The router for all the endpoints the HTTP server should serve
@@ -67,9 +69,22 @@ public HttpServer(final int port) {
*/
@SuppressWarnings("unused") // Part of the API
public void start(final Vertx vertx, final Router router, final Promise
+ * This server runs the Cyface Collector REST-API.
+ *
+ * @param vertx The Vertx instance to get the parameters from
+ * @param router The router for all the endpoints the HTTP server should serve
+ * @param startPromise Informs the caller about the successful or failed start of the server
+ */
+ @SuppressWarnings("unused") // Part of the API
+ public void startWithWebSocket(final Vertx vertx, final Router router, final Promise
+ * This server runs the Cyface Collector REST-API.
+ *
+ * @param vertx The Vertx instance to get the parameters from
+ * @param router The router for all the endpoints the HTTP server should serve
+ * @param startPromise Informs the caller about the successful or failed start of the server
+ * @param options The options for the Http server.
+ */
+ private void start(final Vertx vertx, final Router router, final Promise