Package reactor.netty.http.websocket

Interface WebsocketInbound

All Superinterfaces:
NettyInbound
public interface WebsocketInbound extends NettyInbound
A websocket framed inbound.
Since:
0.6
Author:
Stephane Maldini, Simon Baslé

  • Method Details

    • selectedSubprotocol

      @Nullable String selectedSubprotocol()
      Returns the websocket subprotocol negotiated by the client and server during the websocket handshake, or null if none was requested.
      Returns:
      the subprotocol, or null

    • headers

      HttpHeaders headers()
      Returns the websocket remote headers sent during handshake.
      Returns:
      the websocket remote headers sent during handshake

    • receiveCloseStatus

      Mono<WebSocketCloseStatus> receiveCloseStatus()
      Receive the close status code and reason if sent by the remote peer, or empty if the connection completes otherwise.

      Note: Some close status codes are designated for use in applications expecting a status code to indicate that the connection was closed etc. They are not meant to be set as a status code in a Close control frame as such these status codes cannot be used with reactor.netty.http.websocket.WebsocketOutbound#sendClose* methods. Consider checking RFC 6455#section-7.4 for a complete list of the close status codes.

    • aggregateFrames

      default WebsocketInbound aggregateFrames()
      Turn this WebsocketInbound into aggregating mode which will only produce fully formed frame that have been received fragmented. Will aggregate up to 65,536 bytes per frame
      Returns:
      this inbound

    • aggregateFrames

      default WebsocketInbound aggregateFrames(int maxContentLength)
      Turn this WebsocketInbound into aggregating mode which will only produce fully formed frame that have been received fragmented.
      Parameters:
      maxContentLength - the maximum frame length
      Returns:
      this inbound

    • receiveFrames

      default Flux<WebSocketFrame> receiveFrames()
      Receive a Flux of WebSocketFrame formed frame content.
      Returns:
      a Flux of WebSocketFrame formed frame content