Class QuicServer
- All Implemented Interfaces:
MutinyDelegate,Measured
NOTE: This class has been automatically generated from the original non Mutiny-ified interface.
- Author:
- Julien Viet
- See Also:
-
QuicServer
-
Nested Class Summary
Nested classes/interfaces inherited from interface io.vertx.mutiny.core.metrics.Measured
Measured.MeasuredImpl -
Field Summary
Fields -
Constructor Summary
ConstructorsConstructorDescriptionQuicServer(io.vertx.core.net.QuicServer delegate) Create a new instance ofQuicServerdelegating to the given (non-null) instance ofQuicServer.QuicServer(Object delegate) -
Method Summary
Modifier and TypeMethodDescriptionio.smallrye.mutiny.Uni<io.vertx.core.net.SocketAddress>bind(io.vertx.core.net.SocketAddress arg0) Binds a UDP socket at the givenaddress.io.vertx.core.net.SocketAddressbindAndAwait(io.vertx.core.net.SocketAddress arg0) Binds a UDP socket at the givenaddress.bindAndForget(io.vertx.core.net.SocketAddress arg0) Binds a UDP socket at the givenaddress.io.smallrye.mutiny.Uni<Void>close()Close the endpoint and release all associated resources.voidClose the endpoint and release all associated resources.Close the endpoint and release all associated resources.connectHandler(Consumer<QuicConnection> handler) Set the handler processingQuicConnection, the handler must be set before the server is bound.booleanexceptionHandler(Consumer<Throwable> handler) Set an exception handler called for socket errors happening before the QUIC connection is established, e.g. during the TLS handshake.io.vertx.core.net.QuicServerGet the delegate instance.inthashCode()booleanWhether the metrics are enabled for this measured objectio.smallrye.mutiny.Uni<io.vertx.core.net.SocketAddress>listen()Start listening on theportandhostas configured in theio.vertx.mutiny.core.net.QuicServerConfigused when creating the server.io.smallrye.mutiny.Uni<io.vertx.core.net.SocketAddress>listen(int port) Start listening on the specified port and host "0.0.0.0".io.smallrye.mutiny.Uni<io.vertx.core.net.SocketAddress>Start listening on the specifiedportandhost.io.smallrye.mutiny.Uni<io.vertx.core.net.SocketAddress>listen(io.vertx.core.net.SocketAddress localAddress) Start listening on the specified local address.io.vertx.core.net.SocketAddressStart listening on theportandhostas configured in theio.vertx.mutiny.core.net.QuicServerConfigused when creating the server.io.vertx.core.net.SocketAddresslistenAndAwait(int port) Start listening on the specified port and host "0.0.0.0".io.vertx.core.net.SocketAddresslistenAndAwait(int port, String host) Start listening on the specifiedportandhost.io.vertx.core.net.SocketAddresslistenAndAwait(io.vertx.core.net.SocketAddress localAddress) Start listening on the specified local address.Start listening on theportandhostas configured in theio.vertx.mutiny.core.net.QuicServerConfigused when creating the server.listenAndForget(int port) Start listening on the specified port and host "0.0.0.0".listenAndForget(int port, String host) Start listening on the specifiedportandhost.listenAndForget(io.vertx.core.net.SocketAddress localAddress) Start listening on the specified local address.static QuicServernewInstance(io.vertx.core.net.QuicServer delegate) Creates a new instance of theQuicServer.io.smallrye.mutiny.Uni<Void>shutdown()Shutdown the endpoint with a 30 seconds grace period (shutdown(30, TimeUnit.SECONDS)).io.smallrye.mutiny.Uni<Void>Initiate the endpoint shutdown sequence.voidShutdown the endpoint with a 30 seconds grace period (shutdown(30, TimeUnit.SECONDS)).voidshutdownAndAwait(Duration arg0) Initiate the endpoint shutdown sequence.Shutdown the endpoint with a 30 seconds grace period (shutdown(30, TimeUnit.SECONDS)).shutdownAndForget(Duration arg0) Initiate the endpoint shutdown sequence.streamHandler(Consumer<QuicStream> handler) Set a handler processing incoming Quic streams, this is a short-cut ofserver.connectHandler(connection -> connection.streamHandler(stream)).toString()io.smallrye.mutiny.Uni<Boolean>updateSSLOptions(io.vertx.core.net.ServerSSLOptions options) Update the server with new SSLoptions, the update happens if the options object is valid and different from the existing options object.io.smallrye.mutiny.Uni<Boolean>updateSSLOptions(io.vertx.core.net.ServerSSLOptions options, boolean force) Update the server with new SSLoptions, the update happens if the options object is valid and different from the existing options object.updateSSLOptionsAndAwait(io.vertx.core.net.ServerSSLOptions options) Update the server with new SSLoptions, the update happens if the options object is valid and different from the existing options object.updateSSLOptionsAndAwait(io.vertx.core.net.ServerSSLOptions options, boolean force) Update the server with new SSLoptions, the update happens if the options object is valid and different from the existing options object.updateSSLOptionsAndForget(io.vertx.core.net.ServerSSLOptions options) Update the server with new SSLoptions, the update happens if the options object is valid and different from the existing options object.updateSSLOptionsAndForget(io.vertx.core.net.ServerSSLOptions options, boolean force) Update the server with new SSLoptions, the update happens if the options object is valid and different from the existing options object.Methods inherited from class io.vertx.mutiny.core.net.QuicEndpoint
newInstance
-
Field Details
-
__TYPE_ARG
-
-
Constructor Details
-
QuicServer
public QuicServer(io.vertx.core.net.QuicServer delegate) Create a new instance ofQuicServerdelegating to the given (non-null) instance ofQuicServer. -
QuicServer
-
-
Method Details
-
getDelegate
public io.vertx.core.net.QuicServer getDelegate()Get the delegate instance.This method returns the instance on which this shim is delegating the calls. And so, give you access to the bare API.
- Specified by:
getDelegatein interfaceMeasured- Specified by:
getDelegatein interfaceMutinyDelegate- Overrides:
getDelegatein classQuicEndpoint- Returns:
- the delegate instance
-
listen
@CheckReturnValue public io.smallrye.mutiny.Uni<io.vertx.core.net.SocketAddress> listen()Start listening on theportandhostas configured in theio.vertx.mutiny.core.net.QuicServerConfigused when creating the server.Unlike the bare Vert.x variant, this method returns a
Uni. The uni emits the result of the operation as item. If the operation fails, the uni emits the failure.Don't forget to subscribe on it to trigger the operation.
- Returns:
- A
Unirepresenting the asynchronous result of this operation. - See Also:
-
QuicServer.listen()
-
listenAndAwait
public io.vertx.core.net.SocketAddress listenAndAwait()Start listening on theportandhostas configured in theio.vertx.mutiny.core.net.QuicServerConfigused when creating the server.Unlike the bare Vert.x variant, this method returns a
SocketAddress. This method awaits indefinitely for the completion of the underlying asynchronous operation. If the operation completes successfully, the result is returned, otherwise the failure is thrown (potentially wrapped in aRuntimeException).- Returns:
- The operation result
- See Also:
-
QuicServer.listen()
-
listenAndForget
Start listening on theportandhostas configured in theio.vertx.mutiny.core.net.QuicServerConfigused when creating the server.Unlike the bare Vert.x variant, this method ignores the
SocketAddressresult or any failure.- Returns:
- The current instance to chain operations if needed.
- See Also:
-
QuicServer.listen()
-
listen
@CheckReturnValue public io.smallrye.mutiny.Uni<io.vertx.core.net.SocketAddress> listen(int port, String host) Start listening on the specifiedportandhost.Port
0can be specified meaning "choose a random port".Host
0.0.0.0can be specified meaning "listen on all available interfaces".Unlike the bare Vert.x variant, this method returns a
Uni. The uni emits the result of the operation as item. If the operation fails, the uni emits the failure.Don't forget to subscribe on it to trigger the operation.
- Returns:
- A
Unirepresenting the asynchronous result of this operation. - See Also:
-
QuicServer.listen(int, String)
-
listenAndAwait
Start listening on the specifiedportandhost.Port
0can be specified meaning "choose a random port".Host
0.0.0.0can be specified meaning "listen on all available interfaces".Unlike the bare Vert.x variant, this method returns a
SocketAddress. This method awaits indefinitely for the completion of the underlying asynchronous operation. If the operation completes successfully, the result is returned, otherwise the failure is thrown (potentially wrapped in aRuntimeException).- Returns:
- The operation result
- See Also:
-
QuicServer.listen(int, String)
-
listenAndForget
Start listening on the specifiedportandhost.Port
0can be specified meaning "choose a random port".Host
0.0.0.0can be specified meaning "listen on all available interfaces".Unlike the bare Vert.x variant, this method ignores the
SocketAddressresult or any failure.- Returns:
- The current instance to chain operations if needed.
- See Also:
-
QuicServer.listen(int, String)
-
listen
@CheckReturnValue public io.smallrye.mutiny.Uni<io.vertx.core.net.SocketAddress> listen(int port) Start listening on the specified port and host "0.0.0.0".Port
0can be specified meaning "choose an random port".Unlike the bare Vert.x variant, this method returns a
Uni. The uni emits the result of the operation as item. If the operation fails, the uni emits the failure.Don't forget to subscribe on it to trigger the operation.
- Returns:
- A
Unirepresenting the asynchronous result of this operation. - See Also:
-
QuicServer.listen(int)
-
listenAndAwait
public io.vertx.core.net.SocketAddress listenAndAwait(int port) Start listening on the specified port and host "0.0.0.0".Port
0can be specified meaning "choose an random port".Unlike the bare Vert.x variant, this method returns a
SocketAddress. This method awaits indefinitely for the completion of the underlying asynchronous operation. If the operation completes successfully, the result is returned, otherwise the failure is thrown (potentially wrapped in aRuntimeException).- Returns:
- The operation result
- See Also:
-
QuicServer.listen(int)
-
listenAndForget
Start listening on the specified port and host "0.0.0.0".Port
0can be specified meaning "choose an random port".Unlike the bare Vert.x variant, this method ignores the
SocketAddressresult or any failure.- Returns:
- The current instance to chain operations if needed.
- See Also:
-
QuicServer.listen(int)
-
listen
@CheckReturnValue public io.smallrye.mutiny.Uni<io.vertx.core.net.SocketAddress> listen(io.vertx.core.net.SocketAddress localAddress) Start listening on the specified local address.Unlike the bare Vert.x variant, this method returns a
Uni. The uni emits the result of the operation as item. If the operation fails, the uni emits the failure.Don't forget to subscribe on it to trigger the operation.
- Parameters:
localAddress- the local address to listen on- Returns:
- A
Unirepresenting the asynchronous result of this operation. - See Also:
-
QuicServer.listen(SocketAddress)
-
listenAndAwait
public io.vertx.core.net.SocketAddress listenAndAwait(io.vertx.core.net.SocketAddress localAddress) Start listening on the specified local address.Unlike the bare Vert.x variant, this method returns a
SocketAddress. This method awaits indefinitely for the completion of the underlying asynchronous operation. If the operation completes successfully, the result is returned, otherwise the failure is thrown (potentially wrapped in aRuntimeException).- Parameters:
localAddress- the local address to listen on- Returns:
- The operation result
- See Also:
-
QuicServer.listen(SocketAddress)
-
listenAndForget
Start listening on the specified local address.Unlike the bare Vert.x variant, this method ignores the
SocketAddressresult or any failure.- Parameters:
localAddress- the local address to listen on- Returns:
- The current instance to chain operations if needed.
- See Also:
-
QuicServer.listen(SocketAddress)
-
updateSSLOptions
@CheckReturnValue public io.smallrye.mutiny.Uni<Boolean> updateSSLOptions(io.vertx.core.net.ServerSSLOptions options) 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 uni result indicates whether the update occurred.
Unlike the bare Vert.x variant, this method returns a
Uni. The uni emits the result of the operation as item. If the operation fails, the uni emits the failure.Don't forget to subscribe on it to trigger the operation.
- Parameters:
options- the new SSL options- Returns:
- A
Unirepresenting the asynchronous result of this operation. - See Also:
-
QuicServer.updateSSLOptions(ServerSSLOptions)
-
updateSSLOptionsAndAwait
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 underlying uni result indicates whether the update occurred.
Unlike the bare Vert.x variant, this method returns a
Boolean. This method awaits indefinitely for the completion of the underlying asynchronous operation. If the operation completes successfully, the result is returned, otherwise the failure is thrown (potentially wrapped in aRuntimeException).- Parameters:
options- the new SSL options- Returns:
- The operation result
- See Also:
-
QuicServer.updateSSLOptions(ServerSSLOptions)
-
updateSSLOptionsAndForget
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 underlying uni result indicates whether the update occurred.
Unlike the bare Vert.x variant, this method ignores the
Booleanresult or any failure.- Parameters:
options- the new SSL options- Returns:
- The current instance to chain operations if needed.
- See Also:
-
QuicServer.updateSSLOptions(ServerSSLOptions)
-
updateSSLOptions
@CheckReturnValue public io.smallrye.mutiny.Uni<Boolean> updateSSLOptions(io.vertx.core.net.ServerSSLOptions options, boolean force) Update the server with new SSL
options, the update happens if the options object is valid and different from the existing options object.The
optionsobject is compared using itsequalsmethod 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, settingforcetotrueforces the update.The boolean succeeded uni result indicates whether the update occurred.
Unlike the bare Vert.x variant, this method returns a
Uni. The uni emits the result of the operation as item. If the operation fails, the uni emits the failure.Don't forget to subscribe on it to trigger the operation.
- Parameters:
options- the new SSL optionsforce- force the update when options are equals- Returns:
- A
Unirepresenting the asynchronous result of this operation. - See Also:
-
QuicServer.updateSSLOptions(ServerSSLOptions, boolean)
-
updateSSLOptionsAndAwait
Update the server with new SSL
options, the update happens if the options object is valid and different from the existing options object.The
optionsobject is compared using itsequalsmethod 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, settingforcetotrueforces the update.The boolean succeeded underlying uni result indicates whether the update occurred.
Unlike the bare Vert.x variant, this method returns a
Boolean. This method awaits indefinitely for the completion of the underlying asynchronous operation. If the operation completes successfully, the result is returned, otherwise the failure is thrown (potentially wrapped in aRuntimeException).- Parameters:
options- the new SSL optionsforce- force the update when options are equals- Returns:
- The operation result
- See Also:
-
QuicServer.updateSSLOptions(ServerSSLOptions, boolean)
-
updateSSLOptionsAndForget
public QuicServer updateSSLOptionsAndForget(io.vertx.core.net.ServerSSLOptions options, boolean force) Update the server with new SSL
options, the update happens if the options object is valid and different from the existing options object.The
optionsobject is compared using itsequalsmethod 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, settingforcetotrueforces the update.The boolean succeeded underlying uni result indicates whether the update occurred.
Unlike the bare Vert.x variant, this method ignores the
Booleanresult or any failure.- Parameters:
options- the new SSL optionsforce- force the update when options are equals- Returns:
- The current instance to chain operations if needed.
- See Also:
-
QuicServer.updateSSLOptions(ServerSSLOptions, boolean)
-
close
Close the endpoint and release all associated resources.Unlike the bare Vert.x variant, this method returns a
Uni. The uni emits the result of the operation as item. If the operation fails, the uni emits the failure.Don't forget to subscribe on it to trigger the operation.
- Overrides:
closein classQuicEndpoint- Returns:
- A
Unirepresenting the asynchronous result of this operation. - See Also:
-
QuicEndpoint.close()
-
closeAndAwait
public void closeAndAwait()Close the endpoint and release all associated resources.Unlike the bare Vert.x variant, this method returns a
Void. This method awaits indefinitely for the completion of the underlying asynchronous operation. If the operation completes successfully, the result is returned, otherwise the failure is thrown (potentially wrapped in aRuntimeException).- Overrides:
closeAndAwaitin classQuicEndpoint- See Also:
-
QuicEndpoint.close()
-
closeAndForget
Close the endpoint and release all associated resources.Unlike the bare Vert.x variant, this method ignores the
Voidresult or any failure.- Overrides:
closeAndForgetin classQuicEndpoint- Returns:
- The current instance to chain operations if needed.
- See Also:
-
QuicEndpoint.close()
-
shutdown
Initiate the endpoint shutdown sequence.Unlike the bare Vert.x variant, this method returns a
Uni. The uni emits the result of the operation as item. If the operation fails, the uni emits the failure.Don't forget to subscribe on it to trigger the operation.
- Overrides:
shutdownin classQuicEndpoint- Parameters:
timeout- the amount of time after which all resources are forcibly closed- Returns:
- A
Unirepresenting the asynchronous result of this operation. - See Also:
-
QuicEndpoint.shutdown(Duration)
-
shutdownAndAwait
Initiate the endpoint shutdown sequence.Unlike the bare Vert.x variant, this method returns a
Void. This method awaits indefinitely for the completion of the underlying asynchronous operation. If the operation completes successfully, the result is returned, otherwise the failure is thrown (potentially wrapped in aRuntimeException).- Overrides:
shutdownAndAwaitin classQuicEndpoint- Parameters:
timeout- the amount of time after which all resources are forcibly closed- See Also:
-
QuicEndpoint.shutdown(Duration)
-
shutdownAndForget
Initiate the endpoint shutdown sequence.Unlike the bare Vert.x variant, this method ignores the
Voidresult or any failure.- Overrides:
shutdownAndForgetin classQuicEndpoint- Parameters:
timeout- the amount of time after which all resources are forcibly closed- Returns:
- The current instance to chain operations if needed.
- See Also:
-
QuicEndpoint.shutdown(Duration)
-
shutdown
Shutdown the endpoint with a 30 seconds grace period (shutdown(30, TimeUnit.SECONDS)).Unlike the bare Vert.x variant, this method returns a
Uni. The uni emits the result of the operation as item. If the operation fails, the uni emits the failure.Don't forget to subscribe on it to trigger the operation.
- Overrides:
shutdownin classQuicEndpoint- Returns:
- A
Unirepresenting the asynchronous result of this operation. - See Also:
-
QuicEndpoint.shutdown()
-
shutdownAndAwait
public void shutdownAndAwait()Shutdown the endpoint with a 30 seconds grace period (shutdown(30, TimeUnit.SECONDS)).Unlike the bare Vert.x variant, this method returns a
Void. This method awaits indefinitely for the completion of the underlying asynchronous operation. If the operation completes successfully, the result is returned, otherwise the failure is thrown (potentially wrapped in aRuntimeException).- Overrides:
shutdownAndAwaitin classQuicEndpoint- See Also:
-
QuicEndpoint.shutdown()
-
shutdownAndForget
Shutdown the endpoint with a 30 seconds grace period (shutdown(30, TimeUnit.SECONDS)).Unlike the bare Vert.x variant, this method ignores the
Voidresult or any failure.- Overrides:
shutdownAndForgetin classQuicEndpoint- Returns:
- The current instance to chain operations if needed.
- See Also:
-
QuicEndpoint.shutdown()
-
bind
@CheckReturnValue public io.smallrye.mutiny.Uni<io.vertx.core.net.SocketAddress> bind(io.vertx.core.net.SocketAddress arg0) Binds a UDP socket at the givenaddress.>When the endpoint is successfully bound, a</p
QuicClientcan connect to a Quic serverQuicServercan accept connections from a Quic client
Unlike the bare Vert.x variant, this method returns a
Uni. The uni emits the result of the operation as item. If the operation fails, the uni emits the failure.Don't forget to subscribe on it to trigger the operation.
- Overrides:
bindin classQuicEndpoint- Parameters:
address- the bind address- Returns:
- A
Unirepresenting the asynchronous result of this operation. - See Also:
-
QuicEndpoint.bind(SocketAddress)
-
bindAndAwait
public io.vertx.core.net.SocketAddress bindAndAwait(io.vertx.core.net.SocketAddress arg0) Binds a UDP socket at the givenaddress.>When the endpoint is successfully bound, a</p
QuicClientcan connect to a Quic serverQuicServercan accept connections from a Quic client
Unlike the bare Vert.x variant, this method returns a
SocketAddress. This method awaits indefinitely for the completion of the underlying asynchronous operation. If the operation completes successfully, the result is returned, otherwise the failure is thrown (potentially wrapped in aRuntimeException).- Overrides:
bindAndAwaitin classQuicEndpoint- Parameters:
address- the bind address- Returns:
- The operation result
- See Also:
-
QuicEndpoint.bind(SocketAddress)
-
bindAndForget
Binds a UDP socket at the givenaddress.>When the endpoint is successfully bound, a</p
QuicClientcan connect to a Quic serverQuicServercan accept connections from a Quic client
Unlike the bare Vert.x variant, this method ignores the
SocketAddressresult or any failure.- Overrides:
bindAndForgetin classQuicEndpoint- Parameters:
address- the bind address- Returns:
- The current instance to chain operations if needed.
- See Also:
-
QuicEndpoint.bind(SocketAddress)
-
connectHandler
Set the handler processingQuicConnection, the handler must be set before the server is bound.- Parameters:
handler- the connection handler- Returns:
- this object instance
-
streamHandler
Set a handler processing incoming Quic streams, this is a short-cut ofserver.connectHandler(connection -> connection.streamHandler(stream)).- Parameters:
handler- the handler processing streams- Returns:
- this object instance
-
exceptionHandler
Set an exception handler called for socket errors happening before the QUIC connection is established, e.g. during the TLS handshake.- Parameters:
handler- the handler to set- Returns:
- a reference to this, so the API can be used fluently
-
isMetricsEnabled
public boolean isMetricsEnabled()Whether the metrics are enabled for this measured object- Specified by:
isMetricsEnabledin interfaceMeasured- Overrides:
isMetricsEnabledin classQuicEndpoint- Returns:
trueif metrics are enabled
-
newInstance
Creates a new instance of theQuicServer. -
hashCode
public int hashCode()- Overrides:
hashCodein classQuicEndpoint
-
equals
- Overrides:
equalsin classQuicEndpoint
-
toString
- Overrides:
toStringin classQuicEndpoint
-