Package io.vertx.mutiny.core.net

Class NetSocket

java.lang.Object
io.vertx.mutiny.core.net.NetSocket
All Implemented Interfaces:
MutinyDelegate, StreamChannel, ReadStream<io.vertx.core.buffer.Buffer>, StreamBase, WriteStream<io.vertx.core.buffer.Buffer>
public class NetSocket extends Object implements StreamChannel, MutinyDelegate
Represents a socket-like interface to a TCP connection on either the client or the server side.

Instances of this class are created on the client side by an NetClient when a connection to a server is made, or on the server side by a NetServer when a server accepts a connection.

It implements both ReadStream and WriteStream so it can be used with Pipe to pipe data with flow control.

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

Author:
Tim Fox
See Also:
  • NetSocket

  • Field Details

  • Constructor Details

    • NetSocket

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

    • NetSocket

      public NetSocket(Object delegate)

  • Method Details

    • getDelegate

      public io.vertx.core.net.NetSocket 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 StreamChannel
      Specified by:
      getDelegate in interface WriteStream<io.vertx.core.buffer.Buffer>
      Returns:
      the delegate instance

    • write

      @CheckReturnValue public io.smallrye.mutiny.Uni<Void> write(String str)
      Write a String to the connection, 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.

      Specified by:
      write in interface StreamChannel
      Parameters:
      str - the string to write
      Returns:
      A Uni representing the asynchronous result of this operation.
      See Also:
      • NetSocket.write(String)

    • writeAndAwait

      public void writeAndAwait(String str)
      Write a String to the connection, 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:
      str - the string to write
      See Also:
      • NetSocket.write(String)

    • writeAndForget

      public NetSocket writeAndForget(String str)
      Write a String to the connection, encoded in UTF-8.

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

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

    • write

      @CheckReturnValue public io.smallrye.mutiny.Uni<Void> write(String str, String enc)
      Write a String to the connection, encoded using the encoding enc.

      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 StreamChannel
      Parameters:
      str - the string to write
      enc - the encoding to use
      Returns:
      A Uni representing the asynchronous result of this operation.
      See Also:
      • NetSocket.write(String, String)

    • writeAndAwait

      public void writeAndAwait(String str, String enc)
      Write a String to the connection, encoded using the encoding enc.

      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:
      str - the string to write
      enc - the encoding to use
      See Also:
      • NetSocket.write(String, String)

    • writeAndForget

      public NetSocket writeAndForget(String str, String enc)
      Write a String to the connection, encoded using the encoding enc.

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

      Parameters:
      str - the string to write
      enc - the encoding to use
      Returns:
      The current instance to chain operations if needed.
      See Also:
      • NetSocket.write(String, String)

    • sendFile

      @CheckReturnValue public io.smallrye.mutiny.Uni<Void> sendFile(String filename)
      Tell the operating system to stream a file as specified by filename directly from disk to the outgoing connection, bypassing userspace altogether (where supported by the underlying operating system. This is a very efficient way to stream files.

      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:
      sendFile in interface StreamChannel
      Parameters:
      filename - file name of the file to send
      Returns:
      A Uni representing the asynchronous result of this operation.
      See Also:
      • NetSocket.sendFile(String)

    • sendFileAndAwait

      public void sendFileAndAwait(String filename)
      Tell the operating system to stream a file as specified by filename directly from disk to the outgoing connection, bypassing userspace altogether (where supported by the underlying operating system. This is a very efficient way to stream files.

      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:
      filename - file name of the file to send
      See Also:
      • NetSocket.sendFile(String)

    • sendFileAndForget

      public NetSocket sendFileAndForget(String filename)
      Tell the operating system to stream a file as specified by filename directly from disk to the outgoing connection, bypassing userspace altogether (where supported by the underlying operating system. This is a very efficient way to stream files.

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

      Parameters:
      filename - file name of the file to send
      Returns:
      The current instance to chain operations if needed.
      See Also:
      • NetSocket.sendFile(String)

    • sendFile

      @CheckReturnValue public io.smallrye.mutiny.Uni<Void> sendFile(String filename, long offset)
      Tell the operating system to stream a file as specified by filename directly from disk to the outgoing connection, bypassing userspace altogether (where supported by the underlying operating system. This is a very efficient way to stream files.

      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:
      sendFile in interface StreamChannel
      Parameters:
      filename - file name of the file to send
      offset - offset
      Returns:
      A Uni representing the asynchronous result of this operation.
      See Also:
      • NetSocket.sendFile(String, long)

    • sendFileAndAwait

      public void sendFileAndAwait(String filename, long offset)
      Tell the operating system to stream a file as specified by filename directly from disk to the outgoing connection, bypassing userspace altogether (where supported by the underlying operating system. This is a very efficient way to stream files.

      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:
      filename - file name of the file to send
      offset - offset
      See Also:
      • NetSocket.sendFile(String, long)

    • sendFileAndForget

      public NetSocket sendFileAndForget(String filename, long offset)
      Tell the operating system to stream a file as specified by filename directly from disk to the outgoing connection, bypassing userspace altogether (where supported by the underlying operating system. This is a very efficient way to stream files.

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

      Parameters:
      filename - file name of the file to send
      offset - offset
      Returns:
      The current instance to chain operations if needed.
      See Also:
      • NetSocket.sendFile(String, long)

    • sendFile

      @CheckReturnValue public io.smallrye.mutiny.Uni<Void> sendFile(String filename, long offset, long length)
      Tell the operating system to stream a file as specified by filename directly from disk to the outgoing connection, bypassing userspace altogether (where supported by the underlying operating system. This is a very efficient way to stream files.

      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:
      sendFile in interface StreamChannel
      Parameters:
      filename - file name of the file to send
      offset - offset
      length - length
      Returns:
      A Uni representing the asynchronous result of this operation.
      See Also:
      • NetSocket.sendFile(String, long, long)

    • sendFileAndAwait

      public void sendFileAndAwait(String filename, long offset, long length)
      Tell the operating system to stream a file as specified by filename directly from disk to the outgoing connection, bypassing userspace altogether (where supported by the underlying operating system. This is a very efficient way to stream files.

      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:
      filename - file name of the file to send
      offset - offset
      length - length
      See Also:
      • NetSocket.sendFile(String, long, long)

    • sendFileAndForget

      public NetSocket sendFileAndForget(String filename, long offset, long length)
      Tell the operating system to stream a file as specified by filename directly from disk to the outgoing connection, bypassing userspace altogether (where supported by the underlying operating system. This is a very efficient way to stream files.

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

      Parameters:
      filename - file name of the file to send
      offset - offset
      length - length
      Returns:
      The current instance to chain operations if needed.
      See Also:
      • NetSocket.sendFile(String, long, long)

    • end

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

    • endAndAwait

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

      See Also:
      • NetSocket.end()

    • endAndForget

      public NetSocket endAndForget()
      Calls 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:
      • NetSocket.end()

    • close

      @CheckReturnValue public io.smallrye.mutiny.Uni<Void> close()
      Close the socket

      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 StreamChannel
      Returns:
      A Uni representing the asynchronous result of this operation.
      See Also:
      • NetSocket.close()

    • closeAndAwait

      public void closeAndAwait()
      Close the socket

      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:
      • NetSocket.close()

    • closeAndForget

      public NetSocket closeAndForget()
      Close the socket

      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:
      • NetSocket.close()

    • upgradeToSsl

      @CheckReturnValue public io.smallrye.mutiny.Uni<Void> upgradeToSsl()
      Like upgradeToSsl(SSLOptions, String, Buffer) with the default SSL options, without indicating a server name, without an upgrade message.

      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:
      • NetSocket.upgradeToSsl()

    • upgradeToSslAndAwait

      public void upgradeToSslAndAwait()
      Like upgradeToSsl(SSLOptions, String, Buffer) with the default SSL options, without indicating a server name, without an upgrade message.

      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:
      • NetSocket.upgradeToSsl()

    • upgradeToSslAndForget

      public NetSocket upgradeToSslAndForget()
      Like upgradeToSsl(SSLOptions, String, Buffer) with the default SSL options, without indicating a server name, without an upgrade message.

      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:
      • NetSocket.upgradeToSsl()

    • upgradeToSsl

      @CheckReturnValue public io.smallrye.mutiny.Uni<Void> upgradeToSsl(io.vertx.core.buffer.Buffer msg)
      Like upgradeToSsl(SSLOptions, String, Buffer) with the default SSL options and without indicating a server name.

      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:
      • NetSocket.upgradeToSsl(Buffer)

    • upgradeToSslAndAwait

      public void upgradeToSslAndAwait(io.vertx.core.buffer.Buffer msg)
      Like upgradeToSsl(SSLOptions, String, Buffer) with the default SSL options and without indicating a server name.

      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:
      • NetSocket.upgradeToSsl(Buffer)

    • upgradeToSslAndForget

      public NetSocket upgradeToSslAndForget(io.vertx.core.buffer.Buffer msg)
      Like upgradeToSsl(SSLOptions, String, Buffer) with the default SSL options and without indicating a server name.

      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:
      • NetSocket.upgradeToSsl(Buffer)

    • upgradeToSsl

      @CheckReturnValue public io.smallrye.mutiny.Uni<Void> upgradeToSsl(String serverName)
      Like upgradeToSsl(SSLOptions, String, Buffer) with the default SSL options and without an update message.

      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:
      • NetSocket.upgradeToSsl(String)

    • upgradeToSslAndAwait

      public void upgradeToSslAndAwait(String serverName)
      Like upgradeToSsl(SSLOptions, String, Buffer) with the default SSL options and without an update message.

      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:
      • NetSocket.upgradeToSsl(String)

    • upgradeToSslAndForget

      public NetSocket upgradeToSslAndForget(String serverName)
      Like upgradeToSsl(SSLOptions, String, Buffer) with the default SSL options and without an update message.

      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:
      • NetSocket.upgradeToSsl(String)

    • upgradeToSsl

      @CheckReturnValue public io.smallrye.mutiny.Uni<Void> upgradeToSsl(String serverName, io.vertx.core.buffer.Buffer msg)
      Like upgradeToSsl(SSLOptions, String, Buffer) with the default SSL options.

      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:
      • NetSocket.upgradeToSsl(String, Buffer)

    • upgradeToSslAndAwait

      public void upgradeToSslAndAwait(String serverName, io.vertx.core.buffer.Buffer msg)
      Like upgradeToSsl(SSLOptions, String, Buffer) with the default SSL options.

      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:
      • NetSocket.upgradeToSsl(String, Buffer)

    • upgradeToSslAndForget

      public NetSocket upgradeToSslAndForget(String serverName, io.vertx.core.buffer.Buffer msg)
      Like upgradeToSsl(SSLOptions, String, Buffer) with the default SSL options.

      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:
      • NetSocket.upgradeToSsl(String, Buffer)

    • upgradeToSsl

      @CheckReturnValue public io.smallrye.mutiny.Uni<Void> upgradeToSsl(io.vertx.core.net.SSLOptions sslOptions, String serverName)
      Like upgradeToSsl(SSLOptions, String, Buffer) without an upgrade message.

      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:
      • NetSocket.upgradeToSsl(SSLOptions, String)

    • upgradeToSslAndAwait

      public void upgradeToSslAndAwait(io.vertx.core.net.SSLOptions sslOptions, String serverName)
      Like upgradeToSsl(SSLOptions, String, Buffer) without an upgrade message.

      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:
      • NetSocket.upgradeToSsl(SSLOptions, String)

    • upgradeToSslAndForget

      public NetSocket upgradeToSslAndForget(io.vertx.core.net.SSLOptions sslOptions, String serverName)
      Like upgradeToSsl(SSLOptions, String, Buffer) without an upgrade message.

      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:
      • NetSocket.upgradeToSsl(SSLOptions, String)

    • upgradeToSsl

      @CheckReturnValue public io.smallrye.mutiny.Uni<Void> upgradeToSsl(io.vertx.core.net.SSLOptions sslOptions, io.vertx.core.buffer.Buffer msg)
      Like upgradeToSsl(SSLOptions, String, Buffer) without indicating a server name

      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:
      • NetSocket.upgradeToSsl(SSLOptions, Buffer)

    • upgradeToSslAndAwait

      public void upgradeToSslAndAwait(io.vertx.core.net.SSLOptions sslOptions, io.vertx.core.buffer.Buffer msg)
      Like upgradeToSsl(SSLOptions, String, Buffer) without indicating a server name

      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:
      • NetSocket.upgradeToSsl(SSLOptions, Buffer)

    • upgradeToSslAndForget

      public NetSocket upgradeToSslAndForget(io.vertx.core.net.SSLOptions sslOptions, io.vertx.core.buffer.Buffer msg)
      Like upgradeToSsl(SSLOptions, String, Buffer) without indicating a server name

      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:
      • NetSocket.upgradeToSsl(SSLOptions, Buffer)

    • upgradeToSsl

      @CheckReturnValue public io.smallrye.mutiny.Uni<Void> upgradeToSsl(io.vertx.core.net.SSLOptions sslOptions, String serverName, io.vertx.core.buffer.Buffer upgrade)

      Upgrade the channel to use SSL/TLS, in other words proceeds to the TLS handshake.

      The upgrade message will be sent after the socket is ready to proceed to the TLS handshake in order to avoid data races. In practice is usually send by a server when it sends a message to the client to proceed to the handshake, e.g. 250 STARTTLS for an SMTP server, it should be null on a client

      The server name is sent in the client handshake, it should be null on a server.

      Unlike the bare Vert.x variant, this method returns a Uni. The uni emits the result of the operation as item. If the operation fails, the uni emits the failure.

      Don't forget to subscribe on it to trigger the operation.

      Parameters:
      sslOptions - the SSL options
      serverName - the server name
      upgrade - the upgrade message to send
      Returns:
      A Uni representing the asynchronous result of this operation.
      See Also:
      • NetSocket.upgradeToSsl(SSLOptions, String, Buffer)

    • upgradeToSslAndAwait

      public void upgradeToSslAndAwait(io.vertx.core.net.SSLOptions sslOptions, String serverName, io.vertx.core.buffer.Buffer upgrade)

      Upgrade the channel to use SSL/TLS, in other words proceeds to the TLS handshake.

      The upgrade message will be sent after the socket is ready to proceed to the TLS handshake in order to avoid data races. In practice is usually send by a server when it sends a message to the client to proceed to the handshake, e.g. 250 STARTTLS for an SMTP server, it should be null on a client

      The server name is sent in the client handshake, it should be null on a server.

      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:
      sslOptions - the SSL options
      serverName - the server name
      upgrade - the upgrade message to send
      See Also:
      • NetSocket.upgradeToSsl(SSLOptions, String, Buffer)

    • upgradeToSslAndForget

      public NetSocket upgradeToSslAndForget(io.vertx.core.net.SSLOptions sslOptions, String serverName, io.vertx.core.buffer.Buffer upgrade)

      Upgrade the channel to use SSL/TLS, in other words proceeds to the TLS handshake.

      The upgrade message will be sent after the socket is ready to proceed to the TLS handshake in order to avoid data races. In practice is usually send by a server when it sends a message to the client to proceed to the handshake, e.g. 250 STARTTLS for an SMTP server, it should be null on a client

      The server name is sent in the client handshake, it should be null on a server.

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

      Parameters:
      sslOptions - the SSL options
      serverName - the server name
      upgrade - the upgrade message to send
      Returns:
      The current instance to chain operations if needed.
      See Also:
      • NetSocket.upgradeToSsl(SSLOptions, String, Buffer)

    • upgradeToSsl

      @CheckReturnValue public io.smallrye.mutiny.Uni<Void> upgradeToSsl(io.vertx.core.net.SSLOptions sslOptions)
      Upgrade channel to use SSL/TLS. Be aware that for this to work SSL must be configured.

      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:
      sslOptions - the SSL options
      Returns:
      A Uni representing the asynchronous result of this operation.
      See Also:
      • NetSocket.upgradeToSsl(SSLOptions)

    • upgradeToSslAndAwait

      public void upgradeToSslAndAwait(io.vertx.core.net.SSLOptions sslOptions)
      Upgrade channel to use SSL/TLS. Be aware that for this to work SSL must be configured.

      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:
      sslOptions - the SSL options
      See Also:
      • NetSocket.upgradeToSsl(SSLOptions)

    • upgradeToSslAndForget

      public NetSocket upgradeToSslAndForget(io.vertx.core.net.SSLOptions sslOptions)
      Upgrade channel to use SSL/TLS. Be aware that for this to work SSL must be configured.

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

      Parameters:
      sslOptions - the SSL options
      Returns:
      The current instance to chain operations if needed.
      See Also:
      • NetSocket.upgradeToSsl(SSLOptions)

    • 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 StreamChannel
      Parameters:
      dst - the destination write stream
      Returns:
      A Uni representing the asynchronous result of this operation.
      See Also:
      • io.vertx.core.net.NetSocket#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).

      Parameters:
      dst - the destination write stream
      See Also:
      • io.vertx.core.net.NetSocket#pipeTo(WriteStream)

    • pipeToAndForget

      public NetSocket 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.

      Parameters:
      dst - the destination write stream
      Returns:
      The current instance to chain operations if needed.
      See Also:
      • io.vertx.core.net.NetSocket#pipeTo(WriteStream)

    • 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 StreamChannel
      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:
      • NetSocket.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).

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

    • writeAndForget

      public NetSocket 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.

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

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

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

    • endAndForget

      public NetSocket 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.

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

    • exceptionHandler

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

    • pause

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

    • resume

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

    • fetch

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

    • endHandler

      public NetSocket endHandler(Runnable endHandler)
      Set an end handler. Once the stream has ended, and there is no more data to be read, this handler will be called.

      This handler might be called after the close handler when the channel is paused and there are still buffers to deliver.

      This handler might be called after the close handler when the socket is paused and there are still buffers to deliver.

      Specified by:
      endHandler in interface ReadStream<io.vertx.core.buffer.Buffer>
      Specified by:
      endHandler in interface StreamChannel
      Returns:
      a reference to this, so the API can be used fluently

    • setWriteQueueMaxSize

      public NetSocket 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 StreamChannel
      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 NetSocket 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 StreamChannel
      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 NetSocket is created, it may register an event handler with the event bus, the ID of that handler is given by writeHandlerID.

      By default, no handler is registered, the feature must be enabled via NetClientOptions#setRegisterWriteHandler(boolean) or NetServerOptions#setRegisterWriteHandler(boolean).

      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 connection. This allows you to write data to other connections which are owned by different event loops.

      Returns:
      the write handler ID
      See Also:
      • NetClientOptions#setRegisterWriteHandler(boolean)
      • NetServerOptions#setRegisterWriteHandler(boolean)

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

    • remoteAddress

      public io.vertx.core.net.SocketAddress remoteAddress(boolean real)
      Like remoteAddress() but returns the proxy remote address when real is true

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

    • localAddress

      public io.vertx.core.net.SocketAddress localAddress(boolean real)
      Like localAddress() ()} but returns the server local address when real is true

    • closeHandler

      public NetSocket closeHandler(Runnable handler)
      Set a handler notified when the socket is closed
      Specified by:
      closeHandler in interface StreamChannel
      Parameters:
      handler - the handler. Can be null.
      Returns:
      a reference to this, so the API can be used fluently

    • shutdownHandler

      public NetSocket shutdownHandler(Consumer<Duration> handler)
      Set a handler notified when the socket 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 socket gracefully before the socket is closed.
      Specified by:
      shutdownHandler in interface StreamChannel
      Parameters:
      handler - the handler notified. Can be null.
      Returns:
      a reference to this, so the API can be used fluently

    • isSsl

      public boolean isSsl()
      Returns:
      true if this NetSocket 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:

    • indicatedServerName

      public String indicatedServerName()
      Returns the SNI server name presented during the SSL handshake by the client.
      Returns:
      the indicated server name

    • applicationLayerProtocol

      public String applicationLayerProtocol()
      Returns:
      the application-level protocol negotiated during the TLS handshake

    • 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 StreamChannel
      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>
      Specified by:
      pipe in interface StreamChannel
      Returns:
      a pipe

    • newInstance

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

    • 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()
      Specified by:
      toMulti in interface StreamChannel

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