WildFly 37 Model Reference

If websockets are enabled for this container

Provided capabilities(1)

Name Dynamic Other provider points
org.wildfly.undertow.servlet-container.websocket true

none

Attributes (5)

  • buffer-pool The buffer pool to use for websocket deployments
    • Attribute Value
    Default Value default
    Capability reference
    Type STRING
    Nillable true
    Expressions Allowed false
    Storage configuration
    Access Type read-write
    Restart Required all-services
    Stability default
  • deflater-level Configures the level of compression of the DEFLATE algorithm
    • Attribute Value
    Default Value 0
    Type INT
    Nillable true
    Expressions Allowed true
    Min 0
    Max 9
    Storage configuration
    Access Type read-write
    Restart Required all-services
    Stability default
  • dispatch-to-worker If callbacks should be dispatched to a worker thread. If this is false then they will be run in the IO thread, which is faster however care must be taken not to perform blocking operations.
    • Attribute Value
    Default Value true
    Type BOOLEAN
    Nillable true
    Expressions Allowed true
    Storage configuration
    Access Type read-write
    Restart Required all-services
    Stability default
  • per-message-deflate Enables websocket's per-message compression extension, RFC-7692
    • Attribute Value
    Default Value false
    Type BOOLEAN
    Nillable true
    Expressions Allowed true
    Storage configuration
    Access Type read-write
    Restart Required all-services
    Stability default
  • worker The worker to use for websocket deployments
    • Attribute Value
    Default Value default
    Capability reference
    Type STRING
    Nillable true
    Expressions Allowed false
    Storage configuration
    Access Type read-write
    Restart Required all-services
    Stability default

Operations (2)

  • add Adds websockets support
    Request Parameter Type Required Expressions Allowed Default value Description
    buffer-pool STRING false false default The buffer pool to use for websocket deployments
    deflater-level INT false true 0 Configures the level of compression of the DEFLATE algorithm
    dispatch-to-worker BOOLEAN false true true If callbacks should be dispatched to a worker thread. If this is false then they will be run in the IO thread, which is faster however care must be taken not to perform blocking operations.
    per-message-deflate BOOLEAN false true false Enables websocket's per-message compression extension, RFC-7692
    worker STRING false false default The worker to use for websocket deployments
  • remove Removes websockets support