WildFly Full 23 Model Reference

  1. home
  2. subsystem=undertow
  3. byte-buffer-pool

A byte buffer pool used for IO operations, this provides the same capabilities as the buffer pool from the IO subsystem, so they can be used interchangeably and must have a unique name. This buffer pool allows for more precise configuration of the total amount of retained memory than the IO subsystem.

Provided capabilities(1)

Name Dynamic Other provider points
org.wildfly.undertow.byte-buffer-pool true /subsystem=io/buffer-pool=*

Attributes (5)

  • buffer-size The size of the buffer
    • Attribute Value
    Type INT
    Nillable true
    Expressions Allowed true
    Min 0
    Max 2,147,483,647
    Storage configuration
    Access Type read-write
    Restart Required all-services
  • direct If this is true the buffer pool will use direct buffers, this is recommended for best performance
    • Attribute Value
    Type BOOLEAN
    Nillable true
    Expressions Allowed true
    Storage configuration
    Access Type read-write
    Restart Required all-services
  • leak-detection-percent The percentage of buffers that will be allocated with a leak detector. This should only be larger than zero if you are experiencing issues with buffers leaking.
    • Attribute Value
    Default Value 0
    Type INT
    Nillable true
    Expressions Allowed true
    Min 0
    Max 2,147,483,647
    Storage configuration
    Access Type read-write
    Restart Required all-services
  • max-pool-size The maximum amount of buffers to keep in the pool. If more buffers are required at runtime they will be allocated dynamically. Setting this to zero effectively disables pooling.
    • Attribute Value
    Type INT
    Nillable true
    Expressions Allowed true
    Min 0
    Max 2,147,483,647
    Storage configuration
    Access Type read-write
    Restart Required all-services
  • thread-local-cache-size The maximum number of buffers to cache on each thread. The actual number may be lower depending on the calculated usage pattern.
    • Attribute Value
    Default Value 12
    Type INT
    Nillable true
    Expressions Allowed true
    Min 0
    Max 2,147,483,647
    Storage configuration
    Access Type read-write
    Restart Required all-services

Operations (2)

  • add Adds a new byte buffer pool
    Request Parameter Type Required Expressions Allowed Default value Description
    buffer-size INT false true The size of the buffer
    direct BOOLEAN false true If this is true the buffer pool will use direct buffers, this is recommended for best performance
    leak-detection-percent INT false true 0 The percentage of buffers that will be allocated with a leak detector. This should only be larger than zero if you are experiencing issues with buffers leaking.
    max-pool-size INT false true The maximum amount of buffers to keep in the pool. If more buffers are required at runtime they will be allocated dynamically. Setting this to zero effectively disables pooling.
    thread-local-cache-size INT false true 12 The maximum number of buffers to cache on each thread. The actual number may be lower depending on the calculated usage pattern.
  • remove Removes a byte buffer pool