Package com.qfs.websocket

Interface IWebSocketEngineConfig

public interface IWebSocketEngineConfig
Interface for configuring a websocket engine.
Author:
ActiveViam

  • Method Summary

    Modifier and Type
    Method
    Description
    long
    getHeartBeatPeriod()
    Returns the number of milliseconds between heartbeats.
    int
    getMaxBinaryMessageBufferSize()
    The maximum length of incoming binary messages that this Session can buffer.
    long
    getMaxIdleTimeout()
    Returns the number of milliseconds before this conversation may be closed by the container if it is inactive, i.e.
    int
    getMaxTextMessageBufferSize()
    The maximum length of incoming text messages that this Session can buffer.

  • Method Details

    • getMaxIdleTimeout

      long getMaxIdleTimeout()
      Returns the number of milliseconds before this conversation may be closed by the container if it is inactive, i.e. no messages are either sent or received in that time.
      Returns:
      the timeout in milliseconds. Return 0 to take the default value of the web-server.

    • getHeartBeatPeriod

      long getHeartBeatPeriod()
      Returns the number of milliseconds between heartbeats. Zero or a negative value means no heartbeat will ever be sent.
      Returns:
      the number of milliseconds between heartbeats

    • getMaxTextMessageBufferSize

      int getMaxTextMessageBufferSize()
      The maximum length of incoming text messages that this Session can buffer. If the implementation receives a text message that it cannot buffer because it is too large, it must close the session with a close code of CloseReason.CloseCodes.TOO_BIG.
      Returns:
      the maximum text message size that can be buffered. Return 0 to take the default value of the web-server.

    • getMaxBinaryMessageBufferSize

      int getMaxBinaryMessageBufferSize()
      The maximum length of incoming binary messages that this Session can buffer. If the implementation receives a binary message that it cannot buffer because it is too large, it must close the session with a close code of CloseReason.CloseCodes.TOO_BIG.
      Returns:
      the maximum binary message size that can be buffered. Return 0 to take the default value of the web-server.