Package io.vertx.mutiny.core.http

Class ServerWebSocket

java.lang.Object
io.vertx.mutiny.core.http.WebSocket
io.vertx.mutiny.core.http.ServerWebSocket
All Implemented Interfaces:
MutinyDelegate, WebSocketBase, ReadStream<io.vertx.core.buffer.Buffer>, StreamBase, WriteStream<io.vertx.core.buffer.Buffer>
public class ServerWebSocket extends WebSocket implements MutinyDelegate
Represents a server side WebSocket.

Instances of this class are passed into a HttpServer.webSocketHandler(io.vertx.core.Handler<io.vertx.core.http.ServerWebSocket>) or provided when a WebSocket handshake is manually HttpServerRequest.toWebSocket()ed.

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

Author:
Tim Fox
See Also:
  • ServerWebSocket

  • Field Details

  • Constructor Details

    • ServerWebSocket

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

    • ServerWebSocket

      public ServerWebSocket(Object delegate)

  • Method Details

    • getDelegate

      public io.vertx.core.http.ServerWebSocket 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
      Specified by:
      getDelegate in interface ReadStream<io.vertx.core.buffer.Buffer>
      Specified by:
      getDelegate in interface StreamBase
      Specified by:
      getDelegate in interface WebSocketBase
      Specified by:
      getDelegate in interface WriteStream<io.vertx.core.buffer.Buffer>
      Overrides:
      getDelegate in class WebSocket
      Returns:
      the delegate instance

    • close

      @CheckReturnValue public io.smallrye.mutiny.Uni<Void> close()
      Close the WebSocket sending the default close frame.

      No more messages can be sent.

      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.

      The WebSocket handshake will be accepted when it hasn't yet been settled or when an asynchronous handshake is in progress.

      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.

      Specified by:
      close in interface WebSocketBase
      Overrides:
      close in class WebSocket
      Returns:
      A Uni representing the asynchronous result of this operation.
      See Also:
      • ServerWebSocket.close()

    • closeAndAwait

      public void closeAndAwait()
      Close the WebSocket sending the default close frame.

      No more messages can be sent.

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

      The WebSocket handshake will be accepted when it hasn't yet been settled or when an asynchronous handshake is in progress.

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

      Overrides:
      closeAndAwait in class WebSocket
      See Also:
      • ServerWebSocket.close()

    • closeAndForget

      public ServerWebSocket closeAndForget()
      Close the WebSocket sending the default close frame.

      No more messages can be sent.

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

      The WebSocket handshake will be accepted when it hasn't yet been settled or when an asynchronous handshake is in progress.

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

      Overrides:
      closeAndForget in class WebSocket
      Returns:
      The current instance to chain operations if needed.
      See Also:
      • ServerWebSocket.close()

    • shutdown

      @CheckReturnValue public io.smallrye.mutiny.Uni<Void> shutdown(long arg0, TimeUnit arg1, short arg2, String arg3)
      Calls shutdown(Duration, short, String)

      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.

      Specified by:
      shutdown in interface WebSocketBase
      Overrides:
      shutdown in class WebSocket
      Returns:
      A Uni representing the asynchronous result of this operation.
      See Also:
      • WebSocketBase.shutdown(long, TimeUnit, short, String)

    • shutdownAndAwait

      public void shutdownAndAwait(long arg0, TimeUnit arg1, short arg2, String arg3)
      Calls shutdown(Duration, short, String)

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

      Overrides:
      shutdownAndAwait in class WebSocket
      See Also:
      • WebSocketBase.shutdown(long, TimeUnit, short, String)

    • shutdownAndForget

      public ServerWebSocket shutdownAndForget(long arg0, TimeUnit arg1, short arg2, String arg3)
      Calls shutdown(Duration, short, String)

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

      Overrides:
      shutdownAndForget in class WebSocket
      Returns:
      The current instance to chain operations if needed.
      See Also:
      • WebSocketBase.shutdown(long, TimeUnit, short, String)

    • close

      @CheckReturnValue public io.smallrye.mutiny.Uni<Void> close(short arg0, String arg1)
      Close sending a close frame with specified status code and reason. You can give a look at various close payloads here: RFC6455 section 7.4.1

      No more messages can be sent.

      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.

      Specified by:
      close in interface WebSocketBase
      Overrides:
      close in class WebSocket
      Parameters:
      statusCode - the status code
      reason - reason of closure
      Returns:
      A Uni representing the asynchronous result of this operation.
      See Also:
      • WebSocketBase.close(short, String)

    • closeAndAwait

      public void closeAndAwait(short arg0, String arg1)
      Close sending a close frame with specified status code and reason. You can give a look at various close payloads here: RFC6455 section 7.4.1

      No more messages can be sent.

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

      Overrides:
      closeAndAwait in class WebSocket
      Parameters:
      statusCode - the status code
      reason - reason of closure
      See Also:
      • WebSocketBase.close(short, String)

    • closeAndForget

      public ServerWebSocket closeAndForget(short arg0, String arg1)
      Close sending a close frame with specified status code and reason. You can give a look at various close payloads here: RFC6455 section 7.4.1

      No more messages can be sent.

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

      Overrides:
      closeAndForget in class WebSocket
      Parameters:
      statusCode - the status code
      reason - reason of closure
      Returns:
      The current instance to chain operations if needed.
      See Also:
      • WebSocketBase.close(short, String)

    • writePong

      @CheckReturnValue public io.smallrye.mutiny.Uni<Void> writePong(io.vertx.core.buffer.Buffer arg0)
      Writes a pong frame to the connection. This will be written in a single frame. Pong frames may be at most 125 bytes (octets).

      This method should not be used to write application data and should only be used for implementing a keep alive or to ensure the client is still responsive, see RFC 6455 section 5.5.2.

      There is no need to manually write a pong frame, as the server and client both handle responding to a ping from with a pong from automatically and this is exposed to users. RFC 6455 section 5.5.3 states that pongs may be sent unsolicited in order to implement a one way heartbeat.

      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.

      Specified by:
      writePong in interface WebSocketBase
      Overrides:
      writePong in class WebSocket
      Parameters:
      data - the data to write, may be at most 125 bytes
      Returns:
      A Uni representing the asynchronous result of this operation.
      See Also:
      • WebSocketBase.writePong(Buffer)

    • writePongAndAwait

      public void writePongAndAwait(io.vertx.core.buffer.Buffer arg0)
      Writes a pong frame to the connection. This will be written in a single frame. Pong frames may be at most 125 bytes (octets).

      This method should not be used to write application data and should only be used for implementing a keep alive or to ensure the client is still responsive, see RFC 6455 section 5.5.2.

      There is no need to manually write a pong frame, as the server and client both handle responding to a ping from with a pong from automatically and this is exposed to users. RFC 6455 section 5.5.3 states that pongs may be sent unsolicited in order to implement a one way heartbeat.

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

      Overrides:
      writePongAndAwait in class WebSocket
      Parameters:
      data - the data to write, may be at most 125 bytes
      See Also:
      • WebSocketBase.writePong(Buffer)

    • writePongAndForget

      public ServerWebSocket writePongAndForget(io.vertx.core.buffer.Buffer arg0)
      Writes a pong frame to the connection. This will be written in a single frame. Pong frames may be at most 125 bytes (octets).

      This method should not be used to write application data and should only be used for implementing a keep alive or to ensure the client is still responsive, see RFC 6455 section 5.5.2.

      There is no need to manually write a pong frame, as the server and client both handle responding to a ping from with a pong from automatically and this is exposed to users. RFC 6455 section 5.5.3 states that pongs may be sent unsolicited in order to implement a one way heartbeat.

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

      Overrides:
      writePongAndForget in class WebSocket
      Parameters:
      data - the data to write, may be at most 125 bytes
      Returns:
      The current instance to chain operations if needed.
      See Also:
      • WebSocketBase.writePong(Buffer)

    • shutdown

      @CheckReturnValue public io.smallrye.mutiny.Uni<Void> shutdown(long arg0, TimeUnit arg1, short arg2)
      Calls shutdown(long, TimeUnit, short, String) with a null reason.

      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.

      Specified by:
      shutdown in interface WebSocketBase
      Overrides:
      shutdown in class WebSocket
      Returns:
      A Uni representing the asynchronous result of this operation.
      See Also:
      • WebSocketBase.shutdown(long, TimeUnit, short)

    • shutdownAndAwait

      public void shutdownAndAwait(long arg0, TimeUnit arg1, short arg2)
      Calls shutdown(long, TimeUnit, short, String) with a null reason.

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

      Overrides:
      shutdownAndAwait in class WebSocket
      See Also:
      • WebSocketBase.shutdown(long, TimeUnit, short)

    • shutdownAndForget

      public ServerWebSocket shutdownAndForget(long arg0, TimeUnit arg1, short arg2)
      Calls shutdown(long, TimeUnit, short, String) with a null reason.

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

      Overrides:
      shutdownAndForget in class WebSocket
      Returns:
      The current instance to chain operations if needed.
      See Also:
      • WebSocketBase.shutdown(long, TimeUnit, short)

    • end

      @CheckReturnValue public io.smallrye.mutiny.Uni<Void> end()
      Ends the stream.

      Once the stream has ended, it cannot be used any more.

      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.

      Calls WebSocketBase.close()

      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.

      Calls WebSocket.close()

      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.

      Calls close()

      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.

      Specified by:
      end in interface WebSocketBase
      Specified by:
      end in interface WriteStream<io.vertx.core.buffer.Buffer>
      Overrides:
      end in class WebSocket
      Returns:
      A Uni representing the asynchronous result of this operation.
      See Also:
      • WebSocketBase.end()

    • endAndAwait

      public void endAndAwait()
      Calls WebSocket.close()

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

      Calls close()

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

      Overrides:
      endAndAwait in class WebSocket
      See Also:
      • WebSocketBase.end()

    • endAndForget

      public ServerWebSocket endAndForget()
      Calls WebSocket.close()

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

      Calls close()

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

      Overrides:
      endAndForget in class WebSocket
      Returns:
      The current instance to chain operations if needed.
      See Also:
      • WebSocketBase.end()

    • writeFrame

      @CheckReturnValue public io.smallrye.mutiny.Uni<Void> writeFrame(io.vertx.core.http.WebSocketFrame arg0)
      Write a WebSocket frame to the connection

      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.

      Specified by:
      writeFrame in interface WebSocketBase
      Overrides:
      writeFrame in class WebSocket
      Parameters:
      frame - the frame to write
      Returns:
      A Uni representing the asynchronous result of this operation.
      See Also:
      • WebSocketBase.writeFrame(WebSocketFrame)

    • writeFrameAndAwait

      public void writeFrameAndAwait(io.vertx.core.http.WebSocketFrame arg0)
      Write a WebSocket frame to the connection

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

      Overrides:
      writeFrameAndAwait in class WebSocket
      Parameters:
      frame - the frame to write
      See Also:
      • WebSocketBase.writeFrame(WebSocketFrame)

    • writeFrameAndForget

      public ServerWebSocket writeFrameAndForget(io.vertx.core.http.WebSocketFrame arg0)
      Write a WebSocket frame to the connection

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

      Overrides:
      writeFrameAndForget in class WebSocket
      Parameters:
      frame - the frame to write
      Returns:
      The current instance to chain operations if needed.
      See Also:
      • WebSocketBase.writeFrame(WebSocketFrame)

    • shutdown

      @CheckReturnValue public io.smallrye.mutiny.Uni<Void> shutdown(Duration arg0, short arg1)
      Like shutdown(long, TimeUnit, short, String) with a 30 seconds timeout.

      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.

      Specified by:
      shutdown in interface WebSocketBase
      Overrides:
      shutdown in class WebSocket
      Returns:
      A Uni representing the asynchronous result of this operation.
      See Also:
      • WebSocketBase.shutdown(short, String)

    • shutdownAndAwait

      public void shutdownAndAwait(Duration arg0, short arg1)
      Like shutdown(long, TimeUnit, short, String) with a 30 seconds timeout.

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

      Overrides:
      shutdownAndAwait in class WebSocket
      See Also:
      • WebSocketBase.shutdown(short, String)

    • shutdownAndForget

      public ServerWebSocket shutdownAndForget(Duration arg0, short arg1)
      Like shutdown(long, TimeUnit, short, String) with a 30 seconds timeout.

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

      Overrides:
      shutdownAndForget in class WebSocket
      Returns:
      The current instance to chain operations if needed.
      See Also:
      • WebSocketBase.shutdown(short, String)

    • pipeTo

      @CheckReturnValue public io.smallrye.mutiny.Uni<Void> pipeTo(WriteStream<io.vertx.core.buffer.Buffer> arg0)
      Pipe this ReadStream to the WriteStream.

      Elements emitted by this stream will be written to the write stream until this stream ends or fails.

      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.

      Specified by:
      pipeTo in interface ReadStream<io.vertx.core.buffer.Buffer>
      Specified by:
      pipeTo in interface WebSocketBase
      Overrides:
      pipeTo in class WebSocket
      Parameters:
      dst - the destination write stream
      Returns:
      A Uni representing the asynchronous result of this operation.
      See Also:
      • io.vertx.core.http.ServerWebSocket#pipeTo(WriteStream)

    • pipeToAndAwait

      public void pipeToAndAwait(WriteStream<io.vertx.core.buffer.Buffer> arg0)
      Pipe this ReadStream to the WriteStream.

      Elements emitted by this stream will be written to the write stream until this stream ends or fails.

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

      Overrides:
      pipeToAndAwait in class WebSocket
      Parameters:
      dst - the destination write stream
      See Also:
      • io.vertx.core.http.ServerWebSocket#pipeTo(WriteStream)

    • pipeToAndForget

      public ServerWebSocket pipeToAndForget(WriteStream<io.vertx.core.buffer.Buffer> arg0)
      Pipe this ReadStream to the WriteStream.

      Elements emitted by this stream will be written to the write stream until this stream ends or fails.

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

      Overrides:
      pipeToAndForget in class WebSocket
      Parameters:
      dst - the destination write stream
      Returns:
      The current instance to chain operations if needed.
      See Also:
      • io.vertx.core.http.ServerWebSocket#pipeTo(WriteStream)

    • close

      @CheckReturnValue public io.smallrye.mutiny.Uni<Void> close(short arg0)
      Close the WebSocket sending a close frame with specified status code. You can give a look at various close payloads here: RFC6455 section 7.4.1

      No more messages can be sent.

      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.

      Specified by:
      close in interface WebSocketBase
      Overrides:
      close in class WebSocket
      Parameters:
      statusCode - the status code
      Returns:
      A Uni representing the asynchronous result of this operation.
      See Also:
      • WebSocketBase.close(short)

    • closeAndAwait

      public void closeAndAwait(short arg0)
      Close the WebSocket sending a close frame with specified status code. You can give a look at various close payloads here: RFC6455 section 7.4.1

      No more messages can be sent.

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

      Overrides:
      closeAndAwait in class WebSocket
      Parameters:
      statusCode - the status code
      See Also:
      • WebSocketBase.close(short)

    • closeAndForget

      public ServerWebSocket closeAndForget(short arg0)
      Close the WebSocket sending a close frame with specified status code. You can give a look at various close payloads here: RFC6455 section 7.4.1

      No more messages can be sent.

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

      Overrides:
      closeAndForget in class WebSocket
      Parameters:
      statusCode - the status code
      Returns:
      The current instance to chain operations if needed.
      See Also:
      • WebSocketBase.close(short)

    • shutdown

      @CheckReturnValue public io.smallrye.mutiny.Uni<Void> shutdown()
      Like shutdown(long, TimeUnit, short, String) with a 30 seconds timeout, the status code 1000 a null reason.

      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.

      Specified by:
      shutdown in interface WebSocketBase
      Overrides:
      shutdown in class WebSocket
      Returns:
      A Uni representing the asynchronous result of this operation.
      See Also:
      • WebSocketBase.shutdown()

    • shutdownAndAwait

      public void shutdownAndAwait()
      Like shutdown(long, TimeUnit, short, String) with a 30 seconds timeout, the status code 1000 a null reason.

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

      Overrides:
      shutdownAndAwait in class WebSocket
      See Also:
      • WebSocketBase.shutdown()

    • shutdownAndForget

      public ServerWebSocket shutdownAndForget()
      Like shutdown(long, TimeUnit, short, String) with a 30 seconds timeout, the status code 1000 a null reason.

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

      Overrides:
      shutdownAndForget in class WebSocket
      Returns:
      The current instance to chain operations if needed.
      See Also:
      • WebSocketBase.shutdown()

    • writePing

      @CheckReturnValue public io.smallrye.mutiny.Uni<Void> writePing(io.vertx.core.buffer.Buffer arg0)
      Writes a ping frame to the connection. This will be written in a single frame. Ping frames may be at most 125 bytes (octets).

      This method should not be used to write application data and should only be used for implementing a keep alive or to ensure the client is still responsive, see RFC 6455 Section section 5.5.2.

      There is no handler for ping frames because RFC 6455 clearly states that the only response to a ping frame is a pong frame with identical contents.

      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.

      Specified by:
      writePing in interface WebSocketBase
      Overrides:
      writePing in class WebSocket
      Parameters:
      data - the data to write, may be at most 125 bytes
      Returns:
      A Uni representing the asynchronous result of this operation.
      See Also:
      • WebSocketBase.writePing(Buffer)

    • writePingAndAwait

      public void writePingAndAwait(io.vertx.core.buffer.Buffer arg0)
      Writes a ping frame to the connection. This will be written in a single frame. Ping frames may be at most 125 bytes (octets).

      This method should not be used to write application data and should only be used for implementing a keep alive or to ensure the client is still responsive, see RFC 6455 Section section 5.5.2.

      There is no handler for ping frames because RFC 6455 clearly states that the only response to a ping frame is a pong frame with identical contents.

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

      Overrides:
      writePingAndAwait in class WebSocket
      Parameters:
      data - the data to write, may be at most 125 bytes
      See Also:
      • WebSocketBase.writePing(Buffer)

    • writePingAndForget

      public ServerWebSocket writePingAndForget(io.vertx.core.buffer.Buffer arg0)
      Writes a ping frame to the connection. This will be written in a single frame. Ping frames may be at most 125 bytes (octets).

      This method should not be used to write application data and should only be used for implementing a keep alive or to ensure the client is still responsive, see RFC 6455 Section section 5.5.2.

      There is no handler for ping frames because RFC 6455 clearly states that the only response to a ping frame is a pong frame with identical contents.

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

      Overrides:
      writePingAndForget in class WebSocket
      Parameters:
      data - the data to write, may be at most 125 bytes
      Returns:
      The current instance to chain operations if needed.
      See Also:
      • WebSocketBase.writePing(Buffer)

    • shutdown

      @CheckReturnValue public io.smallrye.mutiny.Uni<Void> shutdown(Duration arg0, short arg1, String arg2)
      Calls shutdown(long, TimeUnit, short, String) with a null reason.

      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.

      Specified by:
      shutdown in interface WebSocketBase
      Overrides:
      shutdown in class WebSocket
      Parameters:
      arg0 - the amount of time after which all resources are forcibly closed
      arg1 - the status code
      arg2 - reason of closure. Can be null.
      Returns:
      A Uni representing the asynchronous result of this operation.
      See Also:
      • WebSocketBase.shutdown(long, TimeUnit, short)

    • shutdownAndAwait

      public void shutdownAndAwait(Duration arg0, short arg1, String arg2)
      Calls shutdown(long, TimeUnit, short, String) with a null reason.

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

      Overrides:
      shutdownAndAwait in class WebSocket
      See Also:
      • WebSocketBase.shutdown(long, TimeUnit, short)

    • shutdownAndForget

      public ServerWebSocket shutdownAndForget(Duration arg0, short arg1, String arg2)
      Calls shutdown(long, TimeUnit, short, String) with a null reason.

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

      Overrides:
      shutdownAndForget in class WebSocket
      Returns:
      The current instance to chain operations if needed.
      See Also:
      • WebSocketBase.shutdown(long, TimeUnit, short)

    • write

      @CheckReturnValue public io.smallrye.mutiny.Uni<Void> write(io.vertx.core.buffer.Buffer arg0)
      Write some data to the stream.

      The data is usually put on an internal write queue, and the write actually happens asynchronously. To avoid running out of memory by putting too much on the write queue, check the writeQueueFull() method before writing. This is done automatically if using a Pipe.

      When the data is moved from the queue to the actual medium, the returned Future will be completed with the write result, e.g the uni is succeeded when a server HTTP response buffer is written to the socket and failed if the remote client has closed the socket while the data was still pending for write.

      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.

      Specified by:
      write in interface WebSocketBase
      Specified by:
      write in interface WriteStream<io.vertx.core.buffer.Buffer>
      Overrides:
      write in class WebSocket
      Parameters:
      data - the data to write
      Returns:
      A Uni representing the asynchronous result of this operation.
      See Also:
      • WriteStream.write(T)

    • writeAndAwait

      public void writeAndAwait(io.vertx.core.buffer.Buffer arg0)
      Write some data to the stream.

      The data is usually put on an internal write queue, and the write actually happens asynchronously. To avoid running out of memory by putting too much on the write queue, check the writeQueueFull() method before writing. This is done automatically if using a Pipe.

      When the data is moved from the queue to the actual medium, the returned Future will be completed with the write result, e.g the underlying uni is succeeded when a server HTTP response buffer is written to the socket and failed if the remote client has closed the socket while the data was still pending for write.

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

      Overrides:
      writeAndAwait in class WebSocket
      Parameters:
      data - the data to write
      See Also:
      • WriteStream.write(T)

    • writeAndForget

      public ServerWebSocket writeAndForget(io.vertx.core.buffer.Buffer arg0)
      Write some data to the stream.

      The data is usually put on an internal write queue, and the write actually happens asynchronously. To avoid running out of memory by putting too much on the write queue, check the writeQueueFull() method before writing. This is done automatically if using a Pipe.

      When the data is moved from the queue to the actual medium, the returned Future will be completed with the write result, e.g the underlying uni is succeeded when a server HTTP response buffer is written to the socket and failed if the remote client has closed the socket while the data was still pending for write.

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

      Overrides:
      writeAndForget in class WebSocket
      Parameters:
      data - the data to write
      Returns:
      The current instance to chain operations if needed.
      See Also:
      • WriteStream.write(T)

    • shutdown

      @CheckReturnValue public io.smallrye.mutiny.Uni<Void> shutdown(long arg0, TimeUnit arg1)
      Like shutdown(long, TimeUnit, short, String) with a 30 seconds timeout.

      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.

      Specified by:
      shutdown in interface WebSocketBase
      Overrides:
      shutdown in class WebSocket
      Returns:
      A Uni representing the asynchronous result of this operation.
      See Also:
      • WebSocketBase.shutdown(short, String)

    • shutdownAndAwait

      public void shutdownAndAwait(long arg0, TimeUnit arg1)
      Like shutdown(long, TimeUnit, short, String) with a 30 seconds timeout.

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

      Overrides:
      shutdownAndAwait in class WebSocket
      See Also:
      • WebSocketBase.shutdown(short, String)

    • shutdownAndForget

      public ServerWebSocket shutdownAndForget(long arg0, TimeUnit arg1)
      Like shutdown(long, TimeUnit, short, String) with a 30 seconds timeout.

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

      Overrides:
      shutdownAndForget in class WebSocket
      Returns:
      The current instance to chain operations if needed.
      See Also:
      • WebSocketBase.shutdown(short, String)

    • shutdown

      @CheckReturnValue public io.smallrye.mutiny.Uni<Void> shutdown(Duration arg0)
      Like shutdown(long, TimeUnit, short, String) with a 30 seconds timeout and a null reason.

      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.

      Specified by:
      shutdown in interface WebSocketBase
      Overrides:
      shutdown in class WebSocket
      Returns:
      A Uni representing the asynchronous result of this operation.
      See Also:
      • WebSocketBase.shutdown(short)

    • shutdownAndAwait

      public void shutdownAndAwait(Duration arg0)
      Like shutdown(long, TimeUnit, short, String) with a 30 seconds timeout and a null reason.

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

      Overrides:
      shutdownAndAwait in class WebSocket
      See Also:
      • WebSocketBase.shutdown(short)

    • shutdownAndForget

      public ServerWebSocket shutdownAndForget(Duration arg0)
      Like shutdown(long, TimeUnit, short, String) with a 30 seconds timeout and a null reason.

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

      Overrides:
      shutdownAndForget in class WebSocket
      Returns:
      The current instance to chain operations if needed.
      See Also:
      • WebSocketBase.shutdown(short)

    • end

      @CheckReturnValue public io.smallrye.mutiny.Uni<Void> end(io.vertx.core.buffer.Buffer arg0)
      Same as end() but writes some data to the stream before ending.

      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.

      Specified by:
      end in interface WebSocketBase
      Specified by:
      end in interface WriteStream<io.vertx.core.buffer.Buffer>
      Overrides:
      end in class WebSocket
      Parameters:
      data - the data to write
      Returns:
      A Uni representing the asynchronous result of this operation.
      See Also:
      • WriteStream.end(T)

    • endAndAwait

      public void endAndAwait(io.vertx.core.buffer.Buffer arg0)
      Same as end() but writes some data to the stream before ending.

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

      Overrides:
      endAndAwait in class WebSocket
      Parameters:
      data - the data to write
      See Also:
      • WriteStream.end(T)

    • endAndForget

      public ServerWebSocket endAndForget(io.vertx.core.buffer.Buffer arg0)
      Same as end() but writes some data to the stream before ending.

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

      Overrides:
      endAndForget in class WebSocket
      Parameters:
      data - the data to write
      Returns:
      The current instance to chain operations if needed.
      See Also:
      • WriteStream.end(T)

    • writeFinalBinaryFrame

      @CheckReturnValue public io.smallrye.mutiny.Uni<Void> writeFinalBinaryFrame(io.vertx.core.buffer.Buffer arg0)
      Write a final WebSocket binary frame to the connection

      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.

      Specified by:
      writeFinalBinaryFrame in interface WebSocketBase
      Overrides:
      writeFinalBinaryFrame in class WebSocket
      Parameters:
      data - The data to write
      Returns:
      A Uni representing the asynchronous result of this operation.
      See Also:
      • WebSocketBase.writeFinalBinaryFrame(Buffer)

    • writeFinalBinaryFrameAndAwait

      public void writeFinalBinaryFrameAndAwait(io.vertx.core.buffer.Buffer arg0)
      Write a final WebSocket binary frame to the connection

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

      Overrides:
      writeFinalBinaryFrameAndAwait in class WebSocket
      Parameters:
      data - The data to write
      See Also:
      • WebSocketBase.writeFinalBinaryFrame(Buffer)

    • writeFinalBinaryFrameAndForget

      public ServerWebSocket writeFinalBinaryFrameAndForget(io.vertx.core.buffer.Buffer arg0)
      Write a final WebSocket binary frame to the connection

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

      Overrides:
      writeFinalBinaryFrameAndForget in class WebSocket
      Parameters:
      data - The data to write
      Returns:
      The current instance to chain operations if needed.
      See Also:
      • WebSocketBase.writeFinalBinaryFrame(Buffer)

    • shutdown

      @CheckReturnValue public io.smallrye.mutiny.Uni<Void> shutdown(short arg0, String arg1)
      Like shutdown(long, TimeUnit, short, String) with a 30 seconds timeout.

      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.

      Specified by:
      shutdown in interface WebSocketBase
      Overrides:
      shutdown in class WebSocket
      Returns:
      A Uni representing the asynchronous result of this operation.
      See Also:
      • WebSocketBase.shutdown(short, String)

    • shutdownAndAwait

      public void shutdownAndAwait(short arg0, String arg1)
      Like shutdown(long, TimeUnit, short, String) with a 30 seconds timeout.

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

      Overrides:
      shutdownAndAwait in class WebSocket
      See Also:
      • WebSocketBase.shutdown(short, String)

    • shutdownAndForget

      public ServerWebSocket shutdownAndForget(short arg0, String arg1)
      Like shutdown(long, TimeUnit, short, String) with a 30 seconds timeout.

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

      Overrides:
      shutdownAndForget in class WebSocket
      Returns:
      The current instance to chain operations if needed.
      See Also:
      • WebSocketBase.shutdown(short, String)

    • writeFinalTextFrame

      @CheckReturnValue public io.smallrye.mutiny.Uni<Void> writeFinalTextFrame(String arg0)
      Write a final WebSocket text frame to the connection

      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.

      Specified by:
      writeFinalTextFrame in interface WebSocketBase
      Overrides:
      writeFinalTextFrame in class WebSocket
      Parameters:
      text - The text to write
      Returns:
      A Uni representing the asynchronous result of this operation.
      See Also:
      • WebSocketBase.writeFinalTextFrame(String)

    • writeFinalTextFrameAndAwait

      public void writeFinalTextFrameAndAwait(String arg0)
      Write a final WebSocket text frame to the connection

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

      Overrides:
      writeFinalTextFrameAndAwait in class WebSocket
      Parameters:
      text - The text to write
      See Also:
      • WebSocketBase.writeFinalTextFrame(String)

    • writeFinalTextFrameAndForget

      public ServerWebSocket writeFinalTextFrameAndForget(String arg0)
      Write a final WebSocket text frame to the connection

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

      Overrides:
      writeFinalTextFrameAndForget in class WebSocket
      Parameters:
      text - The text to write
      Returns:
      The current instance to chain operations if needed.
      See Also:
      • WebSocketBase.writeFinalTextFrame(String)

    • writeTextMessage

      @CheckReturnValue public io.smallrye.mutiny.Uni<Void> writeTextMessage(String arg0)
      Writes a (potentially large) piece of text data to the connection. This data might be written as multiple frames if it exceeds the maximum WebSocket frame size.

      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.

      Specified by:
      writeTextMessage in interface WebSocketBase
      Overrides:
      writeTextMessage in class WebSocket
      Parameters:
      text - the data to write
      Returns:
      A Uni representing the asynchronous result of this operation.
      See Also:
      • WebSocketBase.writeTextMessage(String)

    • writeTextMessageAndAwait

      public void writeTextMessageAndAwait(String arg0)
      Writes a (potentially large) piece of text data to the connection. This data might be written as multiple frames if it exceeds the maximum WebSocket frame size.

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

      Overrides:
      writeTextMessageAndAwait in class WebSocket
      Parameters:
      text - the data to write
      See Also:
      • WebSocketBase.writeTextMessage(String)

    • writeTextMessageAndForget

      public ServerWebSocket writeTextMessageAndForget(String arg0)
      Writes a (potentially large) piece of text data to the connection. This data might be written as multiple frames if it exceeds the maximum WebSocket frame size.

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

      Overrides:
      writeTextMessageAndForget in class WebSocket
      Parameters:
      text - the data to write
      Returns:
      The current instance to chain operations if needed.
      See Also:
      • WebSocketBase.writeTextMessage(String)

    • shutdown

      @CheckReturnValue public io.smallrye.mutiny.Uni<Void> shutdown(short arg0)
      Like shutdown(long, TimeUnit, short, String) with a 30 seconds timeout and a null reason.

      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.

      Specified by:
      shutdown in interface WebSocketBase
      Overrides:
      shutdown in class WebSocket
      Returns:
      A Uni representing the asynchronous result of this operation.
      See Also:
      • WebSocketBase.shutdown(short)

    • shutdownAndAwait

      public void shutdownAndAwait(short arg0)
      Like shutdown(long, TimeUnit, short, String) with a 30 seconds timeout and a null reason.

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

      Overrides:
      shutdownAndAwait in class WebSocket
      See Also:
      • WebSocketBase.shutdown(short)

    • shutdownAndForget

      public ServerWebSocket shutdownAndForget(short arg0)
      Like shutdown(long, TimeUnit, short, String) with a 30 seconds timeout and a null reason.

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

      Overrides:
      shutdownAndForget in class WebSocket
      Returns:
      The current instance to chain operations if needed.
      See Also:
      • WebSocketBase.shutdown(short)

    • writeBinaryMessage

      @CheckReturnValue public io.smallrye.mutiny.Uni<Void> writeBinaryMessage(io.vertx.core.buffer.Buffer arg0)
      Writes a (potentially large) piece of binary data to the connection. This data might be written as multiple frames if it exceeds the maximum WebSocket frame size.

      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.

      Specified by:
      writeBinaryMessage in interface WebSocketBase
      Overrides:
      writeBinaryMessage in class WebSocket
      Parameters:
      data - the data to write
      Returns:
      A Uni representing the asynchronous result of this operation.
      See Also:
      • WebSocketBase.writeBinaryMessage(Buffer)

    • writeBinaryMessageAndAwait

      public void writeBinaryMessageAndAwait(io.vertx.core.buffer.Buffer arg0)
      Writes a (potentially large) piece of binary data to the connection. This data might be written as multiple frames if it exceeds the maximum WebSocket frame size.

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

      Overrides:
      writeBinaryMessageAndAwait in class WebSocket
      Parameters:
      data - the data to write
      See Also:
      • WebSocketBase.writeBinaryMessage(Buffer)

    • writeBinaryMessageAndForget

      public ServerWebSocket writeBinaryMessageAndForget(io.vertx.core.buffer.Buffer arg0)
      Writes a (potentially large) piece of binary data to the connection. This data might be written as multiple frames if it exceeds the maximum WebSocket frame size.

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

      Overrides:
      writeBinaryMessageAndForget in class WebSocket
      Parameters:
      data - the data to write
      Returns:
      The current instance to chain operations if needed.
      See Also:
      • WebSocketBase.writeBinaryMessage(Buffer)

    • exceptionHandler

      public ServerWebSocket exceptionHandler(Consumer<Throwable> handler)
      Description copied from interface: ReadStream
      Set an exception handler on the read stream.
      Specified by:
      exceptionHandler in interface ReadStream<io.vertx.core.buffer.Buffer>
      Specified by:
      exceptionHandler in interface StreamBase
      Specified by:
      exceptionHandler in interface WebSocketBase
      Specified by:
      exceptionHandler in interface WriteStream<io.vertx.core.buffer.Buffer>
      Overrides:
      exceptionHandler in class WebSocket
      Parameters:
      handler - the exception handler. Can be null.
      Returns:
      a reference to this, so the API can be used fluently

    • handler

      public ServerWebSocket handler(Consumer<io.vertx.core.buffer.Buffer> handler)
      Description copied from interface: ReadStream
      Set a data handler. As data is read, the handler will be called with the data.
      Specified by:
      handler in interface ReadStream<io.vertx.core.buffer.Buffer>
      Specified by:
      handler in interface WebSocketBase
      Overrides:
      handler in class WebSocket
      Returns:
      a reference to this, so the API can be used fluently

    • pause

      public ServerWebSocket pause()
      Description copied from interface: ReadStream
      Pause the ReadStream, it sets the buffer in fetch mode and clears the actual demand.

      While it's paused, no data will be sent to the data handler.

      Specified by:
      pause in interface ReadStream<io.vertx.core.buffer.Buffer>
      Specified by:
      pause in interface WebSocketBase
      Overrides:
      pause in class WebSocket
      Returns:
      a reference to this, so the API can be used fluently

    • resume

      public ServerWebSocket resume()
      Description copied from interface: ReadStream
      Resume reading, and sets the buffer in flowing mode.

      If the ReadStream has been paused, reading will recommence on it.

      Specified by:
      resume in interface ReadStream<io.vertx.core.buffer.Buffer>
      Specified by:
      resume in interface WebSocketBase
      Overrides:
      resume in class WebSocket
      Returns:
      a reference to this, so the API can be used fluently

    • fetch

      public ServerWebSocket fetch(long amount)
      Description copied from interface: ReadStream
      Fetch the specified amount of elements. If the ReadStream has been paused, reading will recommence with the specified amount of items, otherwise the specified amount will be added to the current stream demand.
      Specified by:
      fetch in interface ReadStream<io.vertx.core.buffer.Buffer>
      Specified by:
      fetch in interface WebSocketBase
      Overrides:
      fetch in class WebSocket
      Returns:
      a reference to this, so the API can be used fluently

    • endHandler

      public ServerWebSocket endHandler(Runnable endHandler)
      Description copied from interface: ReadStream
      Set an end handler. Once the stream has ended, and there is no more data to be read, this handler will be called.
      Specified by:
      endHandler in interface ReadStream<io.vertx.core.buffer.Buffer>
      Specified by:
      endHandler in interface WebSocketBase
      Overrides:
      endHandler in class WebSocket
      Returns:
      a reference to this, so the API can be used fluently

    • setWriteQueueMaxSize

      public ServerWebSocket setWriteQueueMaxSize(int maxSize)
      Description copied from interface: WriteStream
      Set the maximum size of the write queue to maxSize. You will still be able to write to the stream even if there is more than maxSize items in the write queue. This is used as an indicator by classes such as Pipe to provide flow control.

      The value is defined by the implementation of the stream, e.g in bytes for a NetSocket, etc...

      Specified by:
      setWriteQueueMaxSize in interface WebSocketBase
      Specified by:
      setWriteQueueMaxSize in interface WriteStream<io.vertx.core.buffer.Buffer>
      Overrides:
      setWriteQueueMaxSize in class WebSocket
      Parameters:
      maxSize - the max size of the write stream
      Returns:
      a reference to this, so the API can be used fluently

    • drainHandler

      public ServerWebSocket drainHandler(Runnable handler)
      Description copied from interface: WriteStream
      Set a drain handler on the stream. If the write queue is full, then the handler will be called when the write queue is ready to accept buffers again. See Pipe for an example of this being used.

      The stream implementation defines when the drain handler, for example it could be when the queue size has been reduced to maxSize / 2.

      Specified by:
      drainHandler in interface WebSocketBase
      Specified by:
      drainHandler in interface WriteStream<io.vertx.core.buffer.Buffer>
      Overrides:
      drainHandler in class WebSocket
      Parameters:
      handler - the handler. Can be null.
      Returns:
      a reference to this, so the API can be used fluently

    • closeHandler

      public ServerWebSocket closeHandler(Runnable handler)
      Description copied from interface: WebSocketBase
      Set a close handler. This will be called when the WebSocket is closed.

      After this callback, no more messages are expected. When the WebSocket received a close frame, the WebSocketBase.closeStatusCode() will return the status code and WebSocketBase.closeReason() will return the reason.

      Specified by:
      closeHandler in interface WebSocketBase
      Overrides:
      closeHandler in class WebSocket
      Parameters:
      handler - the handler. Can be null.
      Returns:
      a reference to this, so the API can be used fluently

    • frameHandler

      public ServerWebSocket frameHandler(Consumer<io.vertx.core.http.WebSocketFrame> handler)
      Description copied from interface: WebSocketBase
      Set a frame handler on the connection. This handler will be called when frames are read on the connection.
      Specified by:
      frameHandler in interface WebSocketBase
      Overrides:
      frameHandler in class WebSocket
      Parameters:
      handler - the handler. Can be null.
      Returns:
      a reference to this, so the API can be used fluently

    • 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.

    • sslSession

      public SSLSession sslSession()
      Specified by:
      sslSession in interface WebSocketBase
      Overrides:
      sslSession in class WebSocket
      Returns:
      SSLSession associated with the underlying socket. Returns null if connection is not SSL.
      See Also:

    • pipe

      public Pipe<io.vertx.core.buffer.Buffer> pipe()
      Pause this stream and return a Pipe to transfer the elements of this stream to a destination WriteStream.

      The stream will be resumed when the pipe will be wired to a WriteStream.

      Specified by:
      pipe in interface ReadStream<io.vertx.core.buffer.Buffer>
      Specified by:
      pipe in interface WebSocketBase
      Overrides:
      pipe in class WebSocket
      Returns:
      a pipe

    • pongHandler

      public ServerWebSocket pongHandler(Consumer<io.vertx.core.buffer.Buffer> arg0)
      Set a pong frame handler on the connection. This handler will be invoked every time a pong frame is received on the server, and can be used by both clients and servers since the RFC 6455 section 5.5.2 and section 5.5.3 do not specify whether the client or server sends a ping.

      Pong frames may be at most 125 bytes (octets).

      There is no ping handler since ping frames should immediately be responded to with a pong frame with identical content

      Pong frames may be received unsolicited.

      Specified by:
      pongHandler in interface WebSocketBase
      Overrides:
      pongHandler in class WebSocket
      Parameters:
      handler - the handler
      Returns:
      a reference to this, so the API can be used fluently

    • remoteAddress

      public io.vertx.core.net.SocketAddress remoteAddress()
      Specified by:
      remoteAddress in interface WebSocketBase
      Overrides:
      remoteAddress in class WebSocket
      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.

    • closeStatusCode

      public Short closeStatusCode()
      Returns the close status code received from the remote endpoint or null when not yet received.
      Specified by:
      closeStatusCode in interface WebSocketBase
      Overrides:
      closeStatusCode in class WebSocket

    • binaryMessageHandler

      public ServerWebSocket binaryMessageHandler(Consumer<io.vertx.core.buffer.Buffer> arg0)
      Set a binary message handler on the connection. This handler serves a similar purpose to #handler(Handler) except that if a message comes into the socket in multiple frames, the data from the frames will be aggregated into a single buffer before calling the handler (using WebSocketFrame.isFinal() to find the boundaries).
      Specified by:
      binaryMessageHandler in interface WebSocketBase
      Overrides:
      binaryMessageHandler in class WebSocket
      Parameters:
      handler - the handler
      Returns:
      a reference to this, so the API can be used fluently

    • textMessageHandler

      public ServerWebSocket textMessageHandler(Consumer<String> arg0)
      Set a text message handler on the connection. This handler will be called similar to the #binaryMessageHandler(Handler), but the buffer will be converted to a String first
      Specified by:
      textMessageHandler in interface WebSocketBase
      Overrides:
      textMessageHandler in class WebSocket
      Parameters:
      handler - the handler
      Returns:
      a reference to this, so the API can be used fluently

    • textHandlerID

      public String textHandlerID()
      When a WebSocket is created, it may register an event handler with the eventbus, the ID of that handler is given by textHandlerID.

      By default, no handler is registered, the feature must be enabled via WebSocketConnectOptions#setRegisterWriteHandlers(boolean) or HttpServerOptions#setRegisterWebSocketWriteHandlers(boolean).

      Given this ID, a different event loop can send a text frame to that event handler using the event bus and that buffer will be received by this instance in its own event loop and written to the underlying connection. This allows you to write data to other WebSockets which are owned by different event loops.

      Specified by:
      textHandlerID in interface WebSocketBase
      Overrides:
      textHandlerID in class WebSocket
      Returns:
      the text handler id
      See Also:
      • WebSocketConnectOptions#setRegisterWriteHandlers(boolean)
      • HttpServerOptions#setRegisterWebSocketWriteHandlers(boolean)

    • isSsl

      public boolean isSsl()
      Specified by:
      isSsl in interface WebSocketBase
      Overrides:
      isSsl in class WebSocket
      Returns:
      true if this HttpConnection is encrypted via SSL/TLS.

    • headers

      public io.vertx.core.MultiMap headers()
      Returns the HTTP headers.
      Specified by:
      headers in interface WebSocketBase
      Overrides:
      headers in class WebSocket
      Returns:
      the headers

    • closeReason

      public String closeReason()
      Returns the close reason message from the remote endpoint or null when not yet received.
      Specified by:
      closeReason in interface WebSocketBase
      Overrides:
      closeReason in class WebSocket

    • binaryHandlerID

      public String binaryHandlerID()
      When a WebSocket is created, it may register an event handler with the event bus - the ID of that handler is given by this method.

      By default, no handler is registered, the feature must be enabled via WebSocketConnectOptions#setRegisterWriteHandlers(boolean) or HttpServerOptions#setRegisterWebSocketWriteHandlers(boolean).

      Given this ID, a different event loop can send a binary frame to that event handler using the event bus and that buffer will be received by this instance in its own event loop and written to the underlying connection. This allows you to write data to other WebSockets which are owned by different event loops.

      Specified by:
      binaryHandlerID in interface WebSocketBase
      Overrides:
      binaryHandlerID in class WebSocket
      Returns:
      the binary handler id
      See Also:
      • WebSocketConnectOptions#setRegisterWriteHandlers(boolean)
      • HttpServerOptions#setRegisterWebSocketWriteHandlers(boolean)

    • subProtocol

      public String subProtocol()
      Returns the WebSocket sub protocol selected by the WebSocket handshake.

      On the server, the value will be null when the handler receives the WebSocket callback as the handshake will not be completed yet.

      Specified by:
      subProtocol in interface WebSocketBase
      Overrides:
      subProtocol in class WebSocket

    • localAddress

      public io.vertx.core.net.SocketAddress localAddress()
      Specified by:
      localAddress in interface WebSocketBase
      Overrides:
      localAddress in class WebSocket
      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.

    • shutdownHandler

      public ServerWebSocket shutdownHandler(Runnable arg0)
      Set a handler notified when the WebSocket is shutdown: the client or server will close the connection within a certain amount of time. This gives the opportunity to the handler to close the WebSocket gracefully before the WebSocket is forcefully closed.
      Specified by:
      shutdownHandler in interface WebSocketBase
      Overrides:
      shutdownHandler in class WebSocket
      Parameters:
      handler - the handler notified with the remaining shutdown
      Returns:
      a reference to this, so the API can be used fluently

    • writeQueueFull

      public boolean writeQueueFull()
      This will return true if there are more bytes in the write queue than the value set using setWriteQueueMaxSize(int)
      Specified by:
      writeQueueFull in interface WebSocketBase
      Specified by:
      writeQueueFull in interface WriteStream<io.vertx.core.buffer.Buffer>
      Overrides:
      writeQueueFull in class WebSocket
      Returns:
      true if write queue is full

    • isClosed

      public boolean isClosed()
      Specified by:
      isClosed in interface WebSocketBase
      Overrides:
      isClosed in class WebSocket
      Returns:
      true if the WebSocket cannot be used to send message anymore

    • newInstance

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

    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class WebSocket

    • equals

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

    • toString

      public String toString()
      Overrides:
      toString in class WebSocket

    • toMulti

      @CheckReturnValue public io.smallrye.mutiny.Multi<io.vertx.core.buffer.Buffer> toMulti()
      Specified by:
      toMulti in interface WebSocketBase
      Overrides:
      toMulti in class WebSocket

    • toBlockingIterable

      public Iterable<io.vertx.core.buffer.Buffer> toBlockingIterable()
      Overrides:
      toBlockingIterable in class WebSocket

    • toBlockingStream

      public Stream<io.vertx.core.buffer.Buffer> toBlockingStream()
      Overrides:
      toBlockingStream in class WebSocket

    • toSubscriber

      @CheckReturnValue public Flow.Subscriber<io.vertx.core.buffer.Buffer> toSubscriber()
      Converts the current write stream to a subscriber.
      Overrides:
      toSubscriber in class WebSocket