Package io.vertx.rxjava.core.http

Interface WebSocketBase

    • Method Detail

      • write

        void write​(Buffer data,
           io.vertx.core.Handler<io.vertx.core.AsyncResult<Void>> handler)
        Same as but with an handler called when the operation completes
        Specified by:
        write in interface WriteStream<Buffer>
        Parameters:
        data -
        handler -

      • write

        void write​(Buffer data)
        Same as but with an handler called when the operation completes
        Specified by:
        write in interface WriteStream<Buffer>
        Parameters:
        data -

      • rxWrite

        rx.Single<Void> rxWrite​(Buffer data)
        Same as but with an handler called when the operation completes
        Specified by:
        rxWrite in interface WriteStream<Buffer>
        Parameters:
        data -
        Returns:

      • end

        void end​(Buffer data,
         io.vertx.core.Handler<io.vertx.core.AsyncResult<Void>> handler)
        Same as but with an handler called when the operation completes
        Specified by:
        end in interface WriteStream<Buffer>
        Parameters:
        data -
        handler -

      • end

        void end​(Buffer data)
        Same as but with an handler called when the operation completes
        Specified by:
        end in interface WriteStream<Buffer>
        Parameters:
        data -

      • rxEnd

        rx.Single<Void> rxEnd​(Buffer data)
        Same as but with an handler called when the operation completes
        Specified by:
        rxEnd in interface WriteStream<Buffer>
        Parameters:
        data -
        Returns:

      • pipe

        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

        void pipeTo​(WriteStream<Buffer> dst,
            io.vertx.core.Handler<io.vertx.core.AsyncResult<Void>> handler)
        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
        handler -

      • pipeTo

        void 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

      • rxPipeTo

        rx.Single<Void> 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:

      • handler

        WebSocketBase handler​(io.vertx.core.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

        WebSocketBase 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

        WebSocketBase 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

        WebSocketBase 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

        WebSocketBase endHandler​(io.vertx.core.Handler<Void> 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<Buffer>
        Returns:
        a reference to this, so the API can be used fluently

      • setWriteQueueMaxSize

        WebSocketBase 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

        WebSocketBase drainHandler​(io.vertx.core.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

      • binaryHandlerID

        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 or HttpServerOptions.

        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.

        Returns:
        the binary handler id

      • textHandlerID

        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 or HttpServerOptions.

        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.

        Returns:
        the text handler id

      • subProtocol

        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.

        Returns:

      • closeStatusCode

        Short closeStatusCode()
        Returns the close status code received from the remote endpoint or null when not yet received.
        Returns:

      • closeReason

        String closeReason()
        Returns the close reason message from the remote endpoint or null when not yet received.
        Returns:

      • headers

        MultiMap headers()
        Returns the HTTP headers when the WebSocket is first obtained in the handler.

        The headers will be null on subsequent interactions.

        Returns:
        the headers

      • writePing

        WebSocketBase writePing​(Buffer data,
                        io.vertx.core.Handler<io.vertx.core.AsyncResult<Void>> handler)
        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.

        Parameters:
        data - the data to write, may be at most 125 bytes
        handler - called when the ping frame has been successfully written
        Returns:
        a reference to this, so the API can be used fluently

      • writePing

        WebSocketBase writePing​(Buffer data)
        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.

        Parameters:
        data - the data to write, may be at most 125 bytes
        Returns:
        a reference to this, so the API can be used fluently

      • rxWritePing

        rx.Single<Void> rxWritePing​(Buffer data)
        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.

        Parameters:
        data - the data to write, may be at most 125 bytes
        Returns:
        a reference to this, so the API can be used fluently

      • writePong

        WebSocketBase writePong​(Buffer data,
                        io.vertx.core.Handler<io.vertx.core.AsyncResult<Void>> handler)
        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.

        Parameters:
        data - the data to write, may be at most 125 bytes
        handler - called when the pong frame has been successfully written
        Returns:
        a reference to this, so the API can be used fluently

      • writePong

        WebSocketBase writePong​(Buffer data)
        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.

        Parameters:
        data - the data to write, may be at most 125 bytes
        Returns:
        a reference to this, so the API can be used fluently

      • rxWritePong

        rx.Single<Void> rxWritePong​(Buffer data)
        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.

        Parameters:
        data - the data to write, may be at most 125 bytes
        Returns:
        a reference to this, so the API can be used fluently

      • closeHandler

        WebSocketBase closeHandler​(io.vertx.core.Handler<Void> handler)
        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 closeStatusCode() will return the status code and closeReason() will return the reason.

        Parameters:
        handler - the handler
        Returns:
        a reference to this, so the API can be used fluently

      • frameHandler

        WebSocketBase frameHandler​(io.vertx.core.Handler<WebSocketFrame> handler)
        Set a frame handler on the connection. This handler will be called when frames are read on the connection.
        Parameters:
        handler - the handler
        Returns:
        a reference to this, so the API can be used fluently

      • binaryMessageHandler

        WebSocketBase binaryMessageHandler​(io.vertx.core.Handler<Buffer> handler)
        Set a binary message handler on the connection. This handler serves a similar purpose to handler(io.vertx.core.Handler<io.vertx.rxjava.core.buffer.Buffer>) 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).
        Parameters:
        handler - the handler
        Returns:
        a reference to this, so the API can be used fluently

      • pongHandler

        WebSocketBase pongHandler​(io.vertx.core.Handler<Buffer> handler)
        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.

        Parameters:
        handler - the handler
        Returns:
        a reference to this, so the API can be used fluently

      • remoteAddress

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

      • localAddress

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

      • isSsl

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

      • isClosed

        boolean isClosed()
        Returns:
        true if the WebSocket is closed

      • newInstance

        static WebSocketBase newInstance​(io.vertx.core.http.WebSocketBase arg)