com.arangodb.shaded.vertx.core.net.NetServer Maven / Gradle / Ivy
/*
* Copyright (c) 2011-2019 Contributors to the Eclipse Foundation
*
* This program and the accompanying materials are made available under the
* terms of the Eclipse Public License 2.0 which is available at
* http://www.eclipse.org/legal/epl-2.0, or the Apache License, Version 2.0
* which is available at https://www.apache.org/licenses/LICENSE-2.0.
*
* SPDX-License-Identifier: EPL-2.0 OR Apache-2.0
*/
package com.arangodb.shaded.vertx.core.net;
import com.arangodb.shaded.vertx.codegen.annotations.GenIgnore;
import com.arangodb.shaded.vertx.codegen.annotations.Nullable;
import com.arangodb.shaded.vertx.core.AsyncResult;
import com.arangodb.shaded.vertx.core.Future;
import com.arangodb.shaded.vertx.core.Handler;
import com.arangodb.shaded.vertx.codegen.annotations.Fluent;
import com.arangodb.shaded.vertx.codegen.annotations.VertxGen;
import com.arangodb.shaded.vertx.core.metrics.Measured;
import com.arangodb.shaded.vertx.core.net.impl.SocketAddressImpl;
import com.arangodb.shaded.vertx.core.streams.ReadStream;
/**
* Represents a TCP server
*
* @author Tim Fox
*/
@VertxGen
public interface NetServer extends Measured {
/**
* Return the connect stream for this server. The server can only have at most one handler at any one time.
* As the server accepts TCP or SSL connections it creates an instance of {@link NetSocket} and passes it to the
* connect stream {@link ReadStream#handler(com.arangodb.shaded.vertx.core.Handler)}.
*
* @return the connect stream
* @deprecated instead use {@link #connectHandler(Handler)}
*/
@Deprecated
ReadStream connectStream();
/**
* Supply a connect handler for this server. The server can only have at most one connect handler at any one time.
* As the server accepts TCP or SSL connections it creates an instance of {@link NetSocket} and passes it to the
* connect handler.
*
* @return a reference to this, so the API can be used fluently
*/
NetServer connectHandler(@Nullable Handler handler);
@GenIgnore
Handler connectHandler();
/**
* Start listening on the port and host as configured in the {@link com.arangodb.shaded.vertx.core.net.NetServerOptions} used when
* creating the server.
*
* The server may not be listening until some time after the call to listen has returned.
*
* @return a future completed with the listen operation result
*/
Future listen();
/**
* Like {@link #listen} but providing a handler that will be notified when the server is listening, or fails.
*
* @param listenHandler handler that will be notified when listening or failed
* @return a reference to this, so the API can be used fluently
*/
@Fluent
default NetServer listen(Handler> listenHandler) {
Future fut = listen();
if (listenHandler != null) {
fut.onComplete(listenHandler);
}
return this;
}
/**
* Start listening on the specified port and host, ignoring port and host configured in the {@link com.arangodb.shaded.vertx.core.net.NetServerOptions} used when
* creating the server.
*
* Port {@code 0} can be specified meaning "choose an random port".
*
* Host {@code 0.0.0.0} can be specified meaning "listen on all available interfaces".
*
* The server may not be listening until some time after the call to listen has returned.
*
* @return a future completed with the listen operation result
*/
default Future listen(int port, String host) {
return listen(new SocketAddressImpl(port, host));
}
/**
* Like {@link #listen(int, String)} but providing a handler that will be notified when the server is listening, or fails.
*
* @param port the port to listen on
* @param host the host to listen on
* @param listenHandler handler that will be notified when listening or failed
* @return a reference to this, so the API can be used fluently
*/
@Fluent
default NetServer listen(int port, String host, Handler> listenHandler) {
Future fut = listen(port, host);
if (listenHandler != null) {
fut.onComplete(listenHandler);
}
return this;
}
/**
* Start listening on the specified port and host "0.0.0.0", ignoring port and host configured in the
* {@link com.arangodb.shaded.vertx.core.net.NetServerOptions} used when creating the server.
*
* Port {@code 0} can be specified meaning "choose an random port".
*
* The server may not be listening until some time after the call to listen has returned.
*
* @return a future completed with the listen operation result
*/
default Future listen(int port) {
return listen(port, "0.0.0.0");
}
/**
* Like {@link #listen(int)} but providing a handler that will be notified when the server is listening, or fails.
*
* @param port the port to listen on
* @param listenHandler handler that will be notified when listening or failed
* @return a reference to this, so the API can be used fluently
*/
@Fluent
default NetServer listen(int port, Handler> listenHandler) {
return listen(port, "0.0.0.0", listenHandler);
}
/**
* Start listening on the specified local address, ignoring port and host configured in the {@link com.arangodb.shaded.vertx.core.net.NetServerOptions} used when
* creating the server.
*
* The server may not be listening until some time after the call to listen has returned.
*
* @param localAddress the local address to listen on
* @return a future completed with the listen operation result
*/
Future listen(SocketAddress localAddress);
/**
* Like {@link #listen(SocketAddress)} but providing a handler that will be notified when the server is listening, or fails.
*
* @param localAddress the local address to listen on
* @param listenHandler handler that will be notified when listening or failed
* @return a reference to this, so the API can be used fluently
*/
@Fluent
default NetServer listen(SocketAddress localAddress, Handler> listenHandler) {
Future fut = listen(localAddress);
if (listenHandler != null) {
fut.onComplete(listenHandler);
}
return this;
}
/**
* Set an exception handler called for socket errors happening before the connection
* is passed to the {@link #connectHandler}, e.g during the TLS handshake.
*
* @param handler the handler to set
* @return a reference to this, so the API can be used fluently
*/
@GenIgnore
@Fluent
NetServer exceptionHandler(Handler handler);
/**
* Close the server. This will close any currently open connections. The close may not complete until after this
* method has returned.
*
* @return a future completed with the listen operation result
*/
Future close();
/**
* Like {@link #close} but supplying a handler that will be notified when close is complete.
*
* @param completionHandler the handler
*/
void close(Handler> completionHandler);
/**
* 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.
*/
int actualPort();
/**
* Update the server SSL options.
*
* Update only happens if the SSL options is valid.
*
* @param options the new SSL options
* @return a future signaling the update success
*/
Future updateSSLOptions(SSLOptions options);
/**
* Like {@link #updateSSLOptions(SSLOptions)} but supplying a handler that will be called when the update
* happened (or has failed).
*
* @param options the new SSL options
* @param handler the update handler
*/
default void updateSSLOptions(SSLOptions options, Handler> handler) {
Future fut = updateSSLOptions(options);
if (handler != null) {
fut.onComplete(handler);
}
}}