Package io.vertx.mutiny.core.http

Class ServerWebSocketHandshake

java.lang.Object
io.vertx.mutiny.core.http.ServerWebSocketHandshake
All Implemented Interfaces:
MutinyDelegate
public class ServerWebSocketHandshake extends Object implements MutinyDelegate
A server WebSocket handshake, allows to control acceptance or rejection of a WebSocket.

NOTE: This class has been automatically generated from the original non Mutiny-ified interface.

Author:
Julien Viet
See Also:
  • ServerWebSocketHandshake

  • Field Details

  • Constructor Details

    • ServerWebSocketHandshake

      public ServerWebSocketHandshake(io.vertx.core.http.ServerWebSocketHandshake delegate)
      Create a new instance of ServerWebSocketHandshake delegating to the given (non-null) instance of ServerWebSocketHandshake.

    • ServerWebSocketHandshake

      public ServerWebSocketHandshake(Object delegate)

  • Method Details

    • getDelegate

      public io.vertx.core.http.ServerWebSocketHandshake 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:
      getDelegate in interface MutinyDelegate
      Returns:
      the delegate instance

    • accept

      @CheckReturnValue public io.smallrye.mutiny.Uni<ServerWebSocket> accept()
      Accept the WebSocket and terminate the WebSocket handshake.

      This method should be called from the WebSocket handler to explicitly accept the WebSocket and terminate the WebSocket handshake.

      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 Uni representing the asynchronous result of this operation.
      Throws:
      when - the WebSocket handshake is already set
      See Also:
      • ServerWebSocketHandshake.accept()

    • acceptAndAwait

      public ServerWebSocket acceptAndAwait()
      Accept the WebSocket and terminate the WebSocket handshake.

      This method should be called from the WebSocket handler to explicitly accept the WebSocket and terminate the WebSocket handshake.

      Unlike the bare Vert.x variant, this method returns a ServerWebSocket. 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 a RuntimeException).

      Returns:
      The operation result
      Throws:
      when - the WebSocket handshake is already set
      See Also:
      • ServerWebSocketHandshake.accept()

    • acceptAndForget

      public ServerWebSocketHandshake acceptAndForget()
      Accept the WebSocket and terminate the WebSocket handshake.

      This method should be called from the WebSocket handler to explicitly accept the WebSocket and terminate the WebSocket handshake.

      Unlike the bare Vert.x variant, this method ignores the ServerWebSocket result or any failure.

      Returns:
      The current instance to chain operations if needed.
      Throws:
      when - the WebSocket handshake is already set
      See Also:
      • ServerWebSocketHandshake.accept()

    • reject

      @CheckReturnValue public io.smallrye.mutiny.Uni<Void> reject()
      Reject the WebSocket.

      Calling this method from the WebSocket handler when it is first passed to you gives you the opportunity to reject the WebSocket, which will cause the WebSocket handshake to fail by returning a 502 response code.

      You might use this method, if for example you only want to accept WebSockets with a particular path.

      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 Uni representing the asynchronous result of this operation.
      Throws:
      when - the WebSocket handshake is already set
      See Also:
      • ServerWebSocketHandshake.reject()

    • rejectAndAwait

      public void rejectAndAwait()
      Reject the WebSocket.

      Calling this method from the WebSocket handler when it is first passed to you gives you the opportunity to reject the WebSocket, which will cause the WebSocket handshake to fail by returning a 502 response code.

      You might use this method, if for example you only want to accept WebSockets with a particular path.

      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 a RuntimeException).

      Throws:
      when - the WebSocket handshake is already set
      See Also:
      • ServerWebSocketHandshake.reject()

    • rejectAndForget

      public ServerWebSocketHandshake rejectAndForget()
      Reject the WebSocket.

      Calling this method from the WebSocket handler when it is first passed to you gives you the opportunity to reject the WebSocket, which will cause the WebSocket handshake to fail by returning a 502 response code.

      You might use this method, if for example you only want to accept WebSockets with a particular path.

      Unlike the bare Vert.x variant, this method ignores the Void result or any failure.

      Returns:
      The current instance to chain operations if needed.
      Throws:
      when - the WebSocket handshake is already set
      See Also:
      • ServerWebSocketHandshake.reject()

    • reject

      @CheckReturnValue public io.smallrye.mutiny.Uni<Void> reject(int status)
      Like reject() but with a status.

      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 Uni representing the asynchronous result of this operation.
      See Also:
      • ServerWebSocketHandshake.reject(int)

    • rejectAndAwait

      public void rejectAndAwait(int status)
      Like reject() but with a status.

      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 a RuntimeException).

      See Also:
      • ServerWebSocketHandshake.reject(int)

    • rejectAndForget

      public ServerWebSocketHandshake rejectAndForget(int status)
      Like reject() but with a status.

      Unlike the bare Vert.x variant, this method ignores the Void result or any failure.

      Returns:
      The current instance to chain operations if needed.
      See Also:
      • ServerWebSocketHandshake.reject(int)

    • headers

      public io.vertx.core.MultiMap headers()
      Returns the HTTP headers.
      Returns:
      the headers

    • scheme

      public String scheme()
      Returns:
      the WebSocket handshake scheme. Can be null.

    • authority

      public io.vertx.core.net.HostAndPort authority()
      Returns:
      the WebSocket handshake authority. Can be null.

    • uri

      public String uri()

    • path

      public String path()
      Returns:
      the WebSocket handshake path.

    • query

      public String query()
      Returns:
      the WebSocket handshake query string. Can be null.

    • remoteAddress

      public io.vertx.core.net.SocketAddress remoteAddress()
      Returns:
      the remote address for this connection, possibly null (e.g a server bound on a domain socket). If useProxyProtocol is set to true, the address returned will be of the actual connecting client.

    • localAddress

      public io.vertx.core.net.SocketAddress localAddress()
      Returns:
      the local address for this connection, possibly null (e.g a server bound on a domain socket) If useProxyProtocol is set to true, the address returned will be of the proxy.

    • isSsl

      public boolean isSsl()
      Returns:
      true if this HttpConnection is encrypted via SSL/TLS.

    • sslSession

      public SSLSession sslSession()
      Returns:
      SSLSession associated with the underlying socket. Returns null if connection is not SSL.
      See Also:

    • newInstance

      public static ServerWebSocketHandshake newInstance(io.vertx.core.http.ServerWebSocketHandshake delegate)
      Creates a new instance of the ServerWebSocketHandshake.

    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class Object

    • equals

      public boolean equals(Object o)
      Overrides:
      equals in class Object

    • toString

      public String toString()
      Overrides:
      toString in class Object