Interface Configuration

All Known Subinterfaces:
CoreSession
All Known Implementing Classes:
Configuration.ConfigurationCustomizer, CoreSession.Empty, JettyWebSocketFrameHandlerMetadata, JettyWebSocketFrameHandlerMetadata, JettyWebSocketFrameHandlerMetadata, WebSocketCoreSession, WebSocketNegotiator.AbstractNegotiator
public interface Configuration

  • Method Details

    • getIdleTimeout

      Duration getIdleTimeout()
      Get the Idle Timeout
      Returns:
      the idle timeout

    • getWriteTimeout

      @Deprecated(since="12.0.21", forRemoval=true) Duration getWriteTimeout()
      Deprecated, for removal: This API element is subject to removal in a future version.
      no replacement, applications should not call this method.
      Get the Write Timeout
      Returns:
      the write timeout

    • setIdleTimeout

      void setIdleTimeout(Duration timeout)
      Set the Idle Timeout.
      Parameters:
      timeout - the timeout duration (timeout <= 0 implies an infinite timeout)

    • setWriteTimeout

      @Deprecated(since="12.0.21", forRemoval=true) void setWriteTimeout(Duration timeout)
      Deprecated, for removal: This API element is subject to removal in a future version.
      no replacement, applications should not call this method.
      Set the Frame Write Timeout.
      Parameters:
      timeout - the timeout duration (timeout <= 0 implies an infinite timeout)

    • isAutoFragment

      boolean isAutoFragment()

    • setAutoFragment

      void setAutoFragment(boolean autoFragment)

    • getMaxFrameSize

      long getMaxFrameSize()

    • setMaxFrameSize

      void setMaxFrameSize(long maxFrameSize)

    • getOutputBufferSize

      int getOutputBufferSize()

    • setOutputBufferSize

      void setOutputBufferSize(int outputBufferSize)

    • getInputBufferSize

      int getInputBufferSize()

    • setInputBufferSize

      void setInputBufferSize(int inputBufferSize)

    • getMaxBinaryMessageSize

      long getMaxBinaryMessageSize()

    • setMaxBinaryMessageSize

      void setMaxBinaryMessageSize(long maxSize)

    • getMaxTextMessageSize

      long getMaxTextMessageSize()

    • setMaxTextMessageSize

      void setMaxTextMessageSize(long maxSize)

    • getMaxOutgoingFrames

      int getMaxOutgoingFrames()
      Get the maximum number of data frames allowed to be waiting to be sent at any one time. The default value is -1, this indicates there is no limit on how many frames can be queued to be sent by the implementation. If the limit is exceeded, subsequent frames sent are failed with a WritePendingException but the connection is not failed and will remain open.
      Returns:
      the max number of frames.

    • setMaxOutgoingFrames

      void setMaxOutgoingFrames(int maxOutgoingFrames)
      Set the maximum number of data frames allowed to be waiting to be sent at any one time. The default value is -1, this indicates there is no limit on how many frames can be queued to be sent by the implementation. If the limit is exceeded, subsequent frames sent are failed with a WritePendingException but the connection is not failed and will remain open.
      Parameters:
      maxOutgoingFrames - the max number of frames.