Package org.eclipse.jetty.websocket.api.annotations

Annotation Type WebSocket

@Documented @Retention(RUNTIME) @Target(TYPE) public @interface WebSocket
Tags a POJO as being a WebSocket class.

  • Optional Element Summary

    Optional Elements
    Modifier and Type
    Optional Element
    Description
    BatchMode
    batchMode
    The output frame buffering mode.
    int
    idleTimeout
    The time in ms (milliseconds) that a websocket may be idle before closing.
    int
    inputBufferSize
    The size of the buffer (in bytes) used to read from the network layer.
    int
    maxBinaryMessageSize
    The maximum size of a binary message (in bytes) during parsing/generating.
    int
    maxTextMessageSize
    The maximum size of a text message during parsing/generating.

  • Element Details

    • inputBufferSize

      int inputBufferSize
      The size of the buffer (in bytes) used to read from the network layer.
      Default:
      -1

    • maxBinaryMessageSize

      int maxBinaryMessageSize
      The maximum size of a binary message (in bytes) during parsing/generating.

      Binary messages over this maximum will result in a close code 1009 StatusCode.MESSAGE_TOO_LARGE

      Default:
      -1

    • idleTimeout

      int idleTimeout
      The time in ms (milliseconds) that a websocket may be idle before closing.
      Default:
      -1

    • maxTextMessageSize

      int maxTextMessageSize
      The maximum size of a text message during parsing/generating.

      Text messages over this maximum will result in a close code 1009 StatusCode.MESSAGE_TOO_LARGE

      Default:
      -1

    • batchMode

      BatchMode batchMode
      The output frame buffering mode.

      Default: BatchMode.AUTO

      Default:
      AUTO