Package io.vertx.mutiny.ext.web.handler.sockjs

Class SockJSSocket

java.lang.Object
io.vertx.mutiny.ext.web.handler.sockjs.SockJSSocket
All Implemented Interfaces:
MutinyDelegate, ReadStream<io.vertx.core.buffer.Buffer>, StreamBase, WriteStream<io.vertx.core.buffer.Buffer>
public class SockJSSocket extends Object implements ReadStream<io.vertx.core.buffer.Buffer>, WriteStream<io.vertx.core.buffer.Buffer>, MutinyDelegate
You interact with SockJS clients through instances of SockJS socket.

The API is very similar to WebSocket. It implements both ReadStream and WriteStream so it can be used with io.vertx.core.streams.Pump to pump data with flow control.

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

Author:
Tim Fox
See Also:
  • SockJSSocket

  • Field Details

  • Constructor Details

    • SockJSSocket

      public SockJSSocket(io.vertx.ext.web.handler.sockjs.SockJSSocket delegate)
      Create a new instance of SockJSSocket delegating to the given (non-null) instance of SockJSSocket.

    • SockJSSocket

      public SockJSSocket(Object delegate)

  • Method Details

    • getDelegate

      public io.vertx.ext.web.handler.sockjs.SockJSSocket 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 WriteStream<io.vertx.core.buffer.Buffer>
      Returns:
      the delegate instance

    • write

      @CheckReturnValue public io.smallrye.mutiny.Uni<Void> write(io.vertx.core.buffer.Buffer data)

      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 WriteStream<io.vertx.core.buffer.Buffer>
      Parameters:
      data - the data to write
      Returns:
      A Uni representing the asynchronous result of this operation.
      See Also:
      • SockJSSocket.write(Buffer)

    • writeAndAwait

      public void writeAndAwait(io.vertx.core.buffer.Buffer data)

      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:
      • SockJSSocket.write(Buffer)

    • writeAndForget

      public SockJSSocket writeAndForget(io.vertx.core.buffer.Buffer data)

      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:
      • SockJSSocket.write(Buffer)

    • write

      @CheckReturnValue public io.smallrye.mutiny.Uni<Void> write(String data)
      Write a String to the socket, encoded in UTF-8.

      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:
      data - the string to write
      Returns:
      A Uni representing the asynchronous result of this operation.
      See Also:
      • SockJSSocket.write(String)

    • writeAndAwait

      public void writeAndAwait(String data)
      Write a String to the socket, encoded in UTF-8.

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

      Parameters:
      data - the string to write
      See Also:
      • SockJSSocket.write(String)

    • writeAndForget

      public SockJSSocket writeAndForget(String data)
      Write a String to the socket, encoded in UTF-8.

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

      Parameters:
      data - the string to write
      Returns:
      The current instance to chain operations if needed.
      See Also:
      • SockJSSocket.write(String)

    • end

      @CheckReturnValue public io.smallrye.mutiny.Uni<Void> end()
      Call 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 WriteStream<io.vertx.core.buffer.Buffer>
      Returns:
      A Uni representing the asynchronous result of this operation.
      See Also:
      • SockJSSocket.end()

    • endAndAwait

      public void endAndAwait()
      Call 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).

      See Also:
      • SockJSSocket.end()

    • endAndForget

      public SockJSSocket endAndForget()
      Call close().

      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:
      • SockJSSocket.end()

    • end

      @CheckReturnValue public io.smallrye.mutiny.Uni<Void> end(io.vertx.core.buffer.Buffer data)
      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 WriteStream<io.vertx.core.buffer.Buffer>
      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 data)
      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).

      Parameters:
      data - the data to write
      See Also:
      • WriteStream.end(T)

    • endAndForget

      public SockJSSocket endAndForget(io.vertx.core.buffer.Buffer data)
      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.

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

    • pipeTo

      @CheckReturnValue public io.smallrye.mutiny.Uni<Void> pipeTo(WriteStream<io.vertx.core.buffer.Buffer> dst)
      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>
      Parameters:
      dst - the destination write stream
      Returns:
      A Uni representing the asynchronous result of this operation.
      See Also:
      • io.vertx.ext.web.handler.sockjs.SockJSSocket#pipeTo(WriteStream)

    • pipeToAndAwait

      public void pipeToAndAwait(WriteStream<io.vertx.core.buffer.Buffer> dst)
      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).

      Parameters:
      dst - the destination write stream
      See Also:
      • io.vertx.ext.web.handler.sockjs.SockJSSocket#pipeTo(WriteStream)

    • pipeToAndForget

      public SockJSSocket pipeToAndForget(WriteStream<io.vertx.core.buffer.Buffer> dst)
      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.

      Parameters:
      dst - the destination write stream
      Returns:
      The current instance to chain operations if needed.
      See Also:
      • io.vertx.ext.web.handler.sockjs.SockJSSocket#pipeTo(WriteStream)

    • exceptionHandler

      public SockJSSocket 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 WriteStream<io.vertx.core.buffer.Buffer>
      Parameters:
      handler - the exception handler. Can be null.
      Returns:
      a reference to this, so the API can be used fluently

    • handler

      public SockJSSocket 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>
      Returns:
      a reference to this, so the API can be used fluently

    • pause

      public SockJSSocket 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>
      Returns:
      a reference to this, so the API can be used fluently

    • resume

      public SockJSSocket 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>
      Returns:
      a reference to this, so the API can be used fluently

    • fetch

      public SockJSSocket 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>
      Returns:
      a reference to this, so the API can be used fluently

    • endHandler

      public SockJSSocket 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>
      Returns:
      a reference to this, so the API can be used fluently

    • closeHandler

      public SockJSSocket closeHandler(Runnable closeHandler)

    • setWriteQueueMaxSize

      public SockJSSocket 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 WriteStream<io.vertx.core.buffer.Buffer>
      Parameters:
      maxSize - the max size of the write stream
      Returns:
      a reference to this, so the API can be used fluently

    • drainHandler

      public SockJSSocket 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 WriteStream<io.vertx.core.buffer.Buffer>
      Parameters:
      handler - the handler. Can be null.
      Returns:
      a reference to this, so the API can be used fluently

    • writeHandlerID

      public String writeHandlerID()
      When a SockJSSocket is created it can register an event handler with the event bus, the ID of that handler is given by writeHandlerID.

      Given this ID, a different event loop can send a buffer 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 socket. This allows you to write data to other sockets which are owned by different event loops.

      Returns:
      the writeHandlerID or null if writeHandler registration is disabled in SockJSHandlerOptions

    • close

      public void close()
      Close it

    • close

      public void close(int statusCode, String reason)
      Close it giving a status code and reason. Only Applicable to RawWebSocket will downgrade to plain close for other transports.

    • remoteAddress

      public io.vertx.core.net.SocketAddress remoteAddress()
      Return the remote address for this socket

    • localAddress

      public io.vertx.core.net.SocketAddress localAddress()
      Return the local address for this socket

    • headers

      public io.vertx.core.MultiMap headers()
      Return the headers corresponding to the last request for this socket or the websocket handshake Any cookie headers will be removed for security reasons

    • uri

      public String uri()
      Return the URI corresponding to the last request for this socket or the websocket handshake

    • routingContext

      public RoutingContext routingContext()
      Returns:
      the Vert.x-Web RoutingContext corresponding to this socket

    • webSession

      public Session webSession()
      Returns:
      the Vert.x-Web session corresponding to this socket. Can be null.

    • webUser

      public User webUser()
      Returns:
      the Vert.x-Web user corresponding to this socket. Can be null.

    • 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 WriteStream<io.vertx.core.buffer.Buffer>
      Returns:
      true if write queue is full

    • 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>
      Returns:
      a pipe

    • newInstance

      public static SockJSSocket newInstance(io.vertx.ext.web.handler.sockjs.SockJSSocket delegate)
      Creates a new instance of the SockJSSocket.

    • 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

    • toMulti

      @CheckReturnValue public io.smallrye.mutiny.Multi<io.vertx.core.buffer.Buffer> toMulti()

    • toBlockingIterable

      public Iterable<io.vertx.core.buffer.Buffer> toBlockingIterable()

    • toBlockingStream

      public Stream<io.vertx.core.buffer.Buffer> toBlockingStream()

    • toSubscriber

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