Package reactor.netty.http.websocket

Interface WebsocketSpec

All Known Subinterfaces:
WebsocketClientSpec, WebsocketServerSpec
All Known Implementing Classes:
WebsocketSpecImpl
public interface WebsocketSpec
Wrapper for websocket configuration.
Since:
0.9.5
Author:
Dmitrii Borin, Violeta Georgieva

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Interface
    Description
    static class 
    WebsocketSpec.Builder<SPEC extends WebsocketSpec.Builder<SPEC>>
     

  • Method Summary

    Modifier and Type
    Method
    Description
    boolean
    compress()
    Returns whether the websocket compression extension is enabled.
    boolean
    handlePing()
    Returns whether to proxy websocket PING frames or respond to them.
    default int
    maxDecompressionBufferSize()
    Returns the configured maximum allowed size, in bytes, of the buffer used to decompress a websocket message/frame when the compression extension is enabled.
    int
    maxFramePayloadLength()
    Returns the configured maximum allowable frame payload length.
    @Nullable String
    protocols()
    Returns the configured sub protocols.

  • Method Details

    • protocols

      @Nullable String protocols()
      Returns the configured sub protocols.
      Returns:
      returns the configured sub protocols.

    • maxFramePayloadLength

      int maxFramePayloadLength()
      Returns the configured maximum allowable frame payload length.

      Note: When a websocket compression extension is enabled, this setting is applied on the compressed data.

      Returns:
      returns the configured maximum allowable frame payload length.

    • handlePing

      boolean handlePing()
      Returns whether to proxy websocket PING frames or respond to them.
      Returns:
      returns whether to proxy websocket PING frames or respond to them.

    • compress

      boolean compress()
      Returns whether the websocket compression extension is enabled.
      Returns:
      returns whether the websocket compression extension is enabled.

    • maxDecompressionBufferSize

      default int maxDecompressionBufferSize()
      Returns the configured maximum allowed size, in bytes, of the buffer used to decompress a websocket message/frame when the compression extension is enabled. 0 means the maximum size is not limited.

      Note: This setting has no effect unless compress() is enabled.

      Returns:
      the configured maximum allowed size of the decompression buffer, in bytes
      Since:
      1.0.53