WildFly Full 19 Model Reference

  1. home
  2. subsystem=remoting

The configuration of the Remoting subsystem.

Children (6)

Provided capabilities(2)

Name Dynamic Other provider points
org.wildfly.remoting.endpoint false

none
org.wildfly.remoting.http-listener-registry false

none

Attributes (24)

  • auth-realm The authentication realm to use if no authentication CallbackHandler is specified.
    • Attribute Value
    Type STRING
    Nillable true
    Expressions Allowed true
    Storage configuration
    Access Type read-write
    Restart Required all-services
  • authentication-retries Specify the number of times a client is allowed to retry authentication before closing the connection.
    • Attribute Value
    Default Value 3
    Type INT
    Nillable true
    Expressions Allowed true
    Storage configuration
    Access Type read-write
    Restart Required all-services
  • authorize-id The SASL authorization ID. Used as authentication user name to use if no authentication CallbackHandler is specified and the selected SASL mechanism demands a user name.
    • Attribute Value
    Type STRING
    Nillable true
    Expressions Allowed true
    Storage configuration
    Access Type read-write
    Restart Required all-services
  • buffer-region-size The size of allocated buffer regions.
    • Attribute Value
    Type INT
    Nillable true
    Expressions Allowed true
    Storage configuration
    Access Type read-write
    Restart Required all-services
  • heartbeat-interval The interval to use for connection heartbeat, in milliseconds. If the connection is idle in the outbound direction for this amount of time, a ping message will be sent, which will trigger a corresponding reply message.
    • Attribute Value
    Default Value 60000
    Type INT
    Nillable true
    Expressions Allowed true
    Storage configuration
    Access Type read-write
    Restart Required all-services
  • max-inbound-channels The maximum number of inbound channels to support for a connection.
    • Attribute Value
    Default Value 40
    Type INT
    Nillable true
    Expressions Allowed true
    Storage configuration
    Access Type read-write
    Restart Required all-services
  • max-inbound-message-size The maximum inbound message size to be allowed. Messages exceeding this size will cause an exception to be thrown on the reading side as well as the writing side.
    • Attribute Value
    Default Value 9223372036854775807
    Type LONG
    Nillable true
    Expressions Allowed true
    Storage configuration
    Access Type read-write
    Restart Required all-services
  • max-inbound-messages The maximum number of concurrent inbound messages on a channel.
    • Attribute Value
    Default Value 80
    Type INT
    Nillable true
    Expressions Allowed true
    Storage configuration
    Access Type read-write
    Restart Required all-services
  • max-outbound-channels The maximum number of outbound channels to support for a connection.
    • Attribute Value
    Default Value 40
    Type INT
    Nillable true
    Expressions Allowed true
    Storage configuration
    Access Type read-write
    Restart Required all-services
  • max-outbound-message-size The maximum outbound message size to send. No messages larger than this well be transmitted; attempting to do so will cause an exception on the writing side.
    • Attribute Value
    Default Value 9223372036854775807
    Type LONG
    Nillable true
    Expressions Allowed true
    Storage configuration
    Access Type read-write
    Restart Required all-services
  • max-outbound-messages The maximum number of concurrent outbound messages on a channel.
    • Attribute Value
    Default Value 65535
    Type INT
    Nillable true
    Expressions Allowed true
    Storage configuration
    Access Type read-write
    Restart Required all-services
  • receive-buffer-size The size of the largest buffer that this endpoint will accept over a connection.
    • Attribute Value
    Default Value 8192
    Type INT
    Nillable true
    Expressions Allowed true
    Storage configuration
    Access Type read-write
    Restart Required all-services
  • receive-window-size The maximum window size of the receive direction for connection channels, in bytes.
    • Attribute Value
    Default Value 131072
    Type INT
    Nillable true
    Expressions Allowed true
    Storage configuration
    Access Type read-write
    Restart Required all-services
  • sasl-protocol Where a SaslServer or SaslClient are created by default the protocol specified it 'remoting', this can be used to override this.
    • Attribute Value
    Default Value remote
    Type STRING
    Nillable true
    Expressions Allowed true
    Storage configuration
    Access Type read-write
    Restart Required all-services
  • send-buffer-size The size of the largest buffer that this endpoint will transmit over a connection.
    • Attribute Value
    Default Value 8192
    Type INT
    Nillable true
    Expressions Allowed true
    Storage configuration
    Access Type read-write
    Restart Required all-services
  • server-name The server side of the connection passes it's name to the client in the initial greeting, by default the name is automatically discovered from the local address of the connection or it can be overridden using this.
    • Attribute Value
    Type STRING
    Nillable true
    Expressions Allowed true
    Storage configuration
    Access Type read-write
    Restart Required all-services
  • transmit-window-size The maximum window size of the transmit direction for connection channels, in bytes.
    • Attribute Value
    Default Value 131072
    Type INT
    Nillable true
    Expressions Allowed true
    Storage configuration
    Access Type read-write
    Restart Required all-services
  • worker Worker to use
    • Attribute Value
    Default Value default
    Capability reference
    Type STRING
    Nillable true
    Expressions Allowed false
    Storage configuration
    Access Type read-write
    Restart Required all-services
  • worker-read-threads The number of read threads to create for the remoting worker.
    • Deprecated Since 2.0.0
    Use IO subsystem worker configuration
    Attribute Value
    Type INT
    Nillable true
    Expressions Allowed true
    Storage configuration
    Access Type read-write
    Restart Required no-services
  • worker-task-core-threads The number of core threads for the remoting worker task thread pool.
    • Deprecated Since 2.0.0
    Use IO subsystem worker configuration
    Attribute Value
    Type INT
    Nillable true
    Expressions Allowed true
    Storage configuration
    Access Type read-write
    Restart Required no-services
  • worker-task-keepalive The number of milliseconds to keep non-core remoting worker task threads alive.
    • Deprecated Since 2.0.0
    Use IO subsystem worker configuration
    Attribute Value
    Type INT
    Nillable true
    Expressions Allowed true
    Storage configuration
    Access Type read-write
    Restart Required no-services
  • worker-task-limit The maximum number of remoting worker tasks to allow before rejecting.
    • Deprecated Since 2.0.0
    Use IO subsystem worker configuration
    Attribute Value
    Type INT
    Nillable true
    Expressions Allowed true
    Storage configuration
    Access Type read-write
    Restart Required no-services
  • worker-task-max-threads The maximum number of threads for the remoting worker task thread pool.
    • Deprecated Since 2.0.0
    Use IO subsystem worker configuration
    Attribute Value
    Type INT
    Nillable true
    Expressions Allowed true
    Storage configuration
    Access Type read-write
    Restart Required no-services
  • worker-write-threads The number of write threads to create for the remoting worker.
    • Deprecated Since 2.0.0
    Use IO subsystem worker configuration
    Attribute Value
    Type INT
    Nillable true
    Expressions Allowed true
    Storage configuration
    Access Type read-write
    Restart Required no-services

Operations (2)

  • add Adds the Remoting subsystem.
    Request Parameter Type Required Expressions Allowed Default value Description
    worker-read-threads INT false true The number of read threads to create for the remoting worker.
    worker-task-core-threads INT false true The number of core threads for the remoting worker task thread pool.
    worker-task-keepalive INT false true The number of milliseconds to keep non-core remoting worker task threads alive.
    worker-task-limit INT false true The maximum number of remoting worker tasks to allow before rejecting.
    worker-task-max-threads INT false true The maximum number of threads for the remoting worker task thread pool.
    worker-write-threads INT false true The number of write threads to create for the remoting worker.
    auth-realm STRING false true The authentication realm to use if no authentication CallbackHandler is specified.
    authentication-retries INT false true 3 Specify the number of times a client is allowed to retry authentication before closing the connection.
    authorize-id STRING false true The SASL authorization ID. Used as authentication user name to use if no authentication CallbackHandler is specified and the selected SASL mechanism demands a user name.
    buffer-region-size INT false true The size of allocated buffer regions.
    heartbeat-interval INT false true 60000 The interval to use for connection heartbeat, in milliseconds. If the connection is idle in the outbound direction for this amount of time, a ping message will be sent, which will trigger a corresponding reply message.
    max-inbound-channels INT false true 40 The maximum number of inbound channels to support for a connection.
    max-inbound-message-size LONG false true 9223372036854775807 The maximum inbound message size to be allowed. Messages exceeding this size will cause an exception to be thrown on the reading side as well as the writing side.
    max-inbound-messages INT false true 80 The maximum number of concurrent inbound messages on a channel.
    max-outbound-channels INT false true 40 The maximum number of outbound channels to support for a connection.
    max-outbound-message-size LONG false true 9223372036854775807 The maximum outbound message size to send. No messages larger than this well be transmitted; attempting to do so will cause an exception on the writing side.
    max-outbound-messages INT false true 65535 The maximum number of concurrent outbound messages on a channel.
    receive-buffer-size INT false true 8192 The size of the largest buffer that this endpoint will accept over a connection.
    receive-window-size INT false true 131072 The maximum window size of the receive direction for connection channels, in bytes.
    sasl-protocol STRING false true remote Where a SaslServer or SaslClient are created by default the protocol specified it 'remoting', this can be used to override this.
    send-buffer-size INT false true 8192 The size of the largest buffer that this endpoint will transmit over a connection.
    server-name STRING false true The server side of the connection passes it's name to the client in the initial greeting, by default the name is automatically discovered from the local address of the connection or it can be overridden using this.
    transmit-window-size INT false true 131072 The maximum window size of the transmit direction for connection channels, in bytes.
    worker STRING false false default Worker to use
  • remove Removes the Remoting subsystem.