Package io.vertx.rxjava3.core.net

Class NetSocket

  • All Implemented Interfaces:
    RxDelegate, ReadStream<Buffer>, StreamBase, WriteStream<Buffer>
    public class NetSocket
extends Object
implements RxDelegate, ReadStream<Buffer>, WriteStream<Buffer>
    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 and so it can be used with Pipe to pipe data with flow control.

    NOTE: This class has been automatically generated from the original non RX-ified interface using Vert.x codegen.

    • Constructor Detail

      • NetSocket

        public NetSocket​(NetSocket delegate)

      • NetSocket

        public NetSocket​(Object delegate)

    • Method Detail

      • hashCode

        public int hashCode()
        Overrides:
        hashCode in class Object

      • pipe

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

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

        Specified by:
        pipe in interface ReadStream<Buffer>
        Returns:
        a pipe

      • pipeTo

        public io.reactivex.rxjava3.core.Completable pipeTo​(WriteStream<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.

        Once this stream has ended or failed, the write stream will be ended and the handler will be called with the result.

        Specified by:
        pipeTo in interface ReadStream<Buffer>
        Parameters:
        dst - the destination write stream
        Returns:

      • rxPipeTo

        public io.reactivex.rxjava3.core.Completable rxPipeTo​(WriteStream<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.

        Once this stream has ended or failed, the write stream will be ended and the handler will be called with the result.

        Specified by:
        rxPipeTo in interface ReadStream<Buffer>
        Parameters:
        dst - the destination write stream
        Returns:

      • end

        public io.reactivex.rxjava3.core.Completable end​(Buffer data)
        Same as but with an handler called when the operation completes
        Specified by:
        end in interface WriteStream<Buffer>
        Parameters:
        data -
        Returns:

      • rxEnd

        public io.reactivex.rxjava3.core.Completable rxEnd​(Buffer data)
        Same as but with an handler called when the operation completes
        Specified by:
        rxEnd in interface WriteStream<Buffer>
        Parameters:
        data -
        Returns:

      • handler

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

      • endHandler

        public NetSocket endHandler​(Handler<Void> endHandler)

        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<Buffer>
        Parameters:
        endHandler -
        Returns:

      • 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 WriteStream<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​(Handler<Void> 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<Buffer>
        Parameters:
        handler - the handler
        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 or NetServerOptions.

        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

      • write

        public io.reactivex.rxjava3.core.Completable write​(String str)
        Same as write(java.lang.String) but with an handler called when the operation completes
        Parameters:
        str -
        Returns:

      • rxWrite

        public io.reactivex.rxjava3.core.Completable rxWrite​(String str)
        Same as write(java.lang.String) but with an handler called when the operation completes
        Parameters:
        str -
        Returns:

      • write

        public io.reactivex.rxjava3.core.Completable write​(String str,
                                                   String enc)
        Same as write(java.lang.String) but with an handler called when the operation completes
        Parameters:
        str -
        enc -
        Returns:

      • rxWrite

        public io.reactivex.rxjava3.core.Completable rxWrite​(String str,
                                                     String enc)
        Same as write(java.lang.String) but with an handler called when the operation completes
        Parameters:
        str -
        enc -
        Returns:

      • write

        public io.reactivex.rxjava3.core.Completable write​(Buffer message)
        Like WriteStream.write(T) but with an handler called when the message has been written or failed to be written.
        Specified by:
        write in interface WriteStream<Buffer>
        Parameters:
        message -
        Returns:

      • rxWrite

        public io.reactivex.rxjava3.core.Completable rxWrite​(Buffer message)
        Like WriteStream.write(T) but with an handler called when the message has been written or failed to be written.
        Specified by:
        rxWrite in interface WriteStream<Buffer>
        Parameters:
        message -
        Returns:

      • sendFile

        public io.reactivex.rxjava3.core.Completable sendFile​(String filename)
        Same as sendFile(java.lang.String) but also takes a handler that will be called when the send has completed or a failure has occurred
        Parameters:
        filename - file name of the file to send
        Returns:
        a reference to this, so the API can be used fluently

      • rxSendFile

        public io.reactivex.rxjava3.core.Completable rxSendFile​(String filename)
        Same as sendFile(java.lang.String) but also takes a handler that will be called when the send has completed or a failure has occurred
        Parameters:
        filename - file name of the file to send
        Returns:
        a reference to this, so the API can be used fluently

      • sendFile

        public io.reactivex.rxjava3.core.Completable sendFile​(String filename,
                                                      long offset)
        Same as sendFile(java.lang.String) but also takes a handler that will be called when the send has completed or a failure has occurred
        Parameters:
        filename - file name of the file to send
        offset - offset
        Returns:
        a reference to this, so the API can be used fluently

      • rxSendFile

        public io.reactivex.rxjava3.core.Completable rxSendFile​(String filename,
                                                        long offset)
        Same as sendFile(java.lang.String) but also takes a handler that will be called when the send has completed or a failure has occurred
        Parameters:
        filename - file name of the file to send
        offset - offset
        Returns:
        a reference to this, so the API can be used fluently

      • sendFile

        public io.reactivex.rxjava3.core.Completable sendFile​(String filename,
                                                      long offset,
                                                      long length)
        Same as sendFile(java.lang.String) but also takes a handler that will be called when the send has completed or a failure has occurred
        Parameters:
        filename - file name of the file to send
        offset - offset
        length - length
        Returns:
        a reference to this, so the API can be used fluently

      • rxSendFile

        public io.reactivex.rxjava3.core.Completable rxSendFile​(String filename,
                                                        long offset,
                                                        long length)
        Same as sendFile(java.lang.String) but also takes a handler that will be called when the send has completed or a failure has occurred
        Parameters:
        filename - file name of the file to send
        offset - offset
        length - length
        Returns:
        a reference to this, so the API can be used fluently

      • remoteAddress

        public 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 SocketAddress remoteAddress​(boolean real)
        Like remoteAddress() but returns the proxy remote address when real is true
        Parameters:
        real -
        Returns:

      • localAddress

        public 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 SocketAddress localAddress​(boolean real)
        Like localAddress() ()} but returns the server local address when real is true
        Parameters:
        real -
        Returns:

      • close

        public io.reactivex.rxjava3.core.Completable close()
        Close the NetSocket and notify the handler when the operation completes.
        Returns:

      • rxClose

        public io.reactivex.rxjava3.core.Completable rxClose()
        Close the NetSocket and notify the handler when the operation completes.
        Returns:

      • closeHandler

        public NetSocket closeHandler​(Handler<Void> handler)
        Set a handler that will be called when the NetSocket is closed
        Parameters:
        handler - the handler
        Returns:
        a reference to this, so the API can be used fluently

      • upgradeToSsl

        public io.reactivex.rxjava3.core.Completable upgradeToSsl()
        Upgrade channel to use SSL/TLS. Be aware that for this to work SSL must be configured.
        Returns:
        a reference to this, so the API can be used fluently

      • rxUpgradeToSsl

        public io.reactivex.rxjava3.core.Completable rxUpgradeToSsl()
        Upgrade channel to use SSL/TLS. Be aware that for this to work SSL must be configured.
        Returns:
        a reference to this, so the API can be used fluently

      • upgradeToSsl

        public io.reactivex.rxjava3.core.Completable upgradeToSsl​(String serverName)
        Upgrade channel to use SSL/TLS. Be aware that for this to work SSL must be configured.
        Parameters:
        serverName - the server name
        Returns:
        a reference to this, so the API can be used fluently

      • rxUpgradeToSsl

        public io.reactivex.rxjava3.core.Completable rxUpgradeToSsl​(String serverName)
        Upgrade channel to use SSL/TLS. Be aware that for this to work SSL must be configured.
        Parameters:
        serverName - the server name
        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.

      • 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

      • sslSession

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