WildFly Full 25 Model Reference

UDP

Runtime only resource This resource is runtime only and doesn't have any persistent configuration.

Attributes (89)

after_creation_hook Fully qualified name of a class implementing ProtocolHook, will be called after creation of the protocol (before init())

Attribute	Value
Type	STRING
Nillable	true
Expressions Allowed	false
Storage	runtime
Access Type	metric

avg_batch_size Returns the average batch size of received batches

Attribute	Value
Type	STRING
Nillable	true
Expressions Allowed	false
Storage	runtime
Access Type	metric

bind_addr The bind address which should be used by this transport. The following special values are also recognized: GLOBAL, SITE_LOCAL, LINK_LOCAL, NON_LOOPBACK, match-interface, match-host, match-address

Attribute	Value
Type	STRING
Nillable	true
Expressions Allowed	false
Storage	runtime
Access Type	metric

bind_port The port to which the transport binds. Default of 0 binds to any (ephemeral) port. See also port_range

Attribute	Value
Type	INT
Nillable	true
Expressions Allowed	false
Storage	runtime
Access Type	metric

bundler_buffer_size

Attribute	Value
Type	INT
Nillable	true
Expressions Allowed	false
Storage	runtime
Access Type	metric

bundler_capacity The max number of elements in a bundler if the bundler supports size limitations

Attribute	Value
Type	INT
Nillable	true
Expressions Allowed	false
Storage	runtime
Access Type	metric

bundler_class Fully qualified classname of bundler

Attribute	Value
Type	STRING
Nillable	true
Expressions Allowed	false
Storage	runtime
Access Type	metric

bundler_num_spins Number of spins before a real lock is acquired

Attribute	Value
Type	INT
Nillable	true
Expressions Allowed	false
Storage	runtime
Access Type	metric

bundler_stats Returns stats about the current bundler

Attribute	Value
Type	STRING
Nillable	true
Expressions Allowed	false
Storage	runtime
Access Type	metric

bundler_type The type of bundler used ("ring-buffer", "transfer-queue" (default), "sender-sends" or "no-bundler") or the fully qualified classname of a Bundler implementation

Attribute	Value
Type	STRING
Nillable	true
Expressions Allowed	false
Storage	runtime
Access Type	metric

bundler_wait_strategy The wait strategy for a RingBuffer

Attribute	Value
Type	STRING
Nillable	true
Expressions Allowed	false
Storage	runtime
Access Type	metric

cluster_name Name of the cluster to which this transport is connected

Attribute	Value
Type	STRING
Nillable	true
Expressions Allowed	false
Storage	runtime
Access Type	metric

diag_enable_tcp Use a TCP socket to listen for probe requests (ignored if enable_diagnostics is false)

Attribute	Value
Type	BOOLEAN
Nillable	true
Expressions Allowed	false
Storage	runtime
Access Type	metric

diag_enable_udp Use a multicast socket to listen for probe requests (ignored if enable_diagnostics is false)

Attribute	Value
Type	BOOLEAN
Nillable	true
Expressions Allowed	false
Storage	runtime
Access Type	metric

diagnostics_addr Multicast address for diagnostic probing. Used when diag_enable_udp is true

Attribute	Value
Type	STRING
Nillable	true
Expressions Allowed	false
Storage	runtime
Access Type	metric

diagnostics_bind_addr Bind address for diagnostic probing. Used when diag_enable_tcp is true

Attribute	Value
Type	STRING
Nillable	true
Expressions Allowed	false
Storage	runtime
Access Type	metric

diagnostics_bind_interfaces Comma delimited list of interfaces (IP addresses or interface names) that the diagnostics multicast socket should bind to

Attribute	Value
Type	STRING
Nillable	true
Expressions Allowed	false
Storage	runtime
Access Type	metric

diagnostics_passcode Authorization passcode for diagnostics. If specified every probe query will be authorized

Attribute	Value
Type	STRING
Nillable	true
Expressions Allowed	false
Storage	runtime
Access Type	metric

diagnostics_port Port for diagnostic probing. Default is 7500

Attribute	Value
Type	INT
Nillable	true
Expressions Allowed	false
Storage	runtime
Access Type	metric

diagnostics_port_range The number of ports to be probed for an available port (TCP)

Attribute	Value
Type	INT
Nillable	true
Expressions Allowed	false
Storage	runtime
Access Type	metric

diagnostics_running Whether the diagnostics handler is running or not

Attribute	Value
Type	BOOLEAN
Nillable	true
Expressions Allowed	false
Storage	runtime
Access Type	metric

diagnostics_ttl TTL of the diagnostics multicast socket

Attribute	Value
Type	INT
Nillable	true
Expressions Allowed	false
Storage	runtime
Access Type	metric

different_cluster_messages Number of messages from members in a different cluster

Attribute	Value
Type	INT
Nillable	true
Expressions Allowed	false
Storage	runtime
Access Type	metric

different_version_messages Number of messages from members with a different JGroups version

Attribute	Value
Type	INT
Nillable	true
Expressions Allowed	false
Storage	runtime
Access Type	metric

disable_loopback If true, disables IP_MULTICAST_LOOP on the MulticastSocket (for sending and receiving of multicast packets). IP multicast packets send on a host P will therefore not be received by anyone on P. Use with caution.

Attribute	Value
Type	BOOLEAN
Nillable	true
Expressions Allowed	false
Storage	runtime
Access Type	metric

dropped_messages Number of messages dropped when sending because of insufficient buffer space

Attribute	Value
Type	INT
Nillable	true
Expressions Allowed	false
Storage	runtime
Access Type	metric

enable_diagnostics Switch to enable diagnostic probing. Default is true

Attribute	Value
Type	BOOLEAN
Nillable	true
Expressions Allowed	false
Storage	runtime
Access Type	metric

ergonomics Enables ergonomics: dynamically find the best values for properties at runtime

Attribute	Value
Type	BOOLEAN
Nillable	true
Expressions Allowed	false
Storage	runtime
Access Type	metric

external_addr Use "external_addr" if you have hosts on different networks, behind firewalls. On each firewall, set up a port forwarding rule (sometimes called "virtual server") to the local IP (e.g. 192.168.1.100) of the host then on each host, set "external_addr" TCP transport parameter to the external (public IP) address of the firewall.

Attribute	Value
Type	STRING
Nillable	true
Expressions Allowed	false
Storage	runtime
Access Type	metric

external_port Used to map the internal port (bind_port) to an external port. Only used if > 0

Attribute	Value
Type	INT
Nillable	true
Expressions Allowed	false
Storage	runtime
Access Type	metric

id Give the protocol a different ID if needed so we can have multiple instances of it in the same stack

Attribute	Value
Type	INT
Nillable	true
Expressions Allowed	false
Storage	runtime
Access Type	metric

internal_thread_pool_size Current number of threads in the internal thread pool

Attribute	Value
Type	INT
Nillable	true
Expressions Allowed	false
Storage	runtime
Access Type	metric

internal_thread_pool_size_largest Largest number of threads in the internal thread pool

Attribute	Value
Type	INT
Nillable	true
Expressions Allowed	false
Storage	runtime
Access Type	metric

ip_mcast Multicast toggle. If false multiple unicast datagrams are sent instead of one multicast. Default is true

Attribute	Value
Type	BOOLEAN
Nillable	true
Expressions Allowed	false
Storage	runtime
Access Type	metric

ip_ttl The time-to-live (TTL) for multicast datagram packets. Default is 8

Attribute	Value
Type	INT
Nillable	true
Expressions Allowed	false
Storage	runtime
Access Type	metric

is_trace tracing is enabled or disabled for the given log

Attribute	Value
Type	BOOLEAN
Nillable	true
Expressions Allowed	false
Storage	runtime
Access Type	metric

level logger level (see javadocs)

Attribute	Value
Type	STRING
Nillable	true
Expressions Allowed	false
Storage	runtime
Access Type	metric

local_address The address of the channel

Attribute	Value
Type	STRING
Nillable	true
Expressions Allowed	false
Storage	runtime
Access Type	metric

local_physical_address The physical address of the channel

Attribute	Value
Type	STRING
Nillable	true
Expressions Allowed	false
Storage	runtime
Access Type	metric

log_discard_msgs whether or not warnings about messages from different groups are logged

Attribute	Value
Type	BOOLEAN
Nillable	true
Expressions Allowed	false
Storage	runtime
Access Type	metric

log_discard_msgs_version whether or not warnings about messages from members with a different version are discarded

Attribute	Value
Type	BOOLEAN
Nillable	true
Expressions Allowed	false
Storage	runtime
Access Type	metric

logger_type Type of logger used

Attribute	Value
Type	STRING
Nillable	true
Expressions Allowed	false
Storage	runtime
Access Type	metric

logical_addr_cache_expiration Time (in ms) after which entries in the logical address cache marked as removable can be removed. 0 never removes any entries (not recommended)

Attribute	Value
Type	LONG
Nillable	true
Expressions Allowed	false
Storage	runtime
Access Type	metric

logical_addr_cache_max_size Max number of elements in the logical address cache before eviction starts

Attribute	Value
Type	INT
Nillable	true
Expressions Allowed	false
Storage	runtime
Access Type	metric

logical_addr_cache_reaper_interval Interval (in ms) at which the reaper task scans logical_addr_cache and removes entries marked as removable. 0 disables reaping.

Attribute	Value
Type	LONG
Nillable	true
Expressions Allowed	false
Storage	runtime
Access Type	metric

logical_address_cache_reaper_running Is the logical_addr_cache reaper task running

Attribute	Value
Type	BOOLEAN
Nillable	true
Expressions Allowed	false
Storage	runtime
Access Type	metric

loopback_copy Whether or not to make a copy of a message before looping it back up. Don't use this; might get removed without warning

Attribute	Value
Type	BOOLEAN
Nillable	true
Expressions Allowed	false
Storage	runtime
Access Type	metric

loopback_separate_thread Loop back the message on a separate thread or use the current thread. Don't use this; might get removed without warning

Attribute	Value
Type	BOOLEAN
Nillable	true
Expressions Allowed	false
Storage	runtime
Access Type	metric

max_bundle_size Maximum number of bytes for messages to be queued until they are sent

Attribute	Value
Type	INT
Nillable	true
Expressions Allowed	false
Storage	runtime
Access Type	metric

mcast_addr The multicast address used for sending and receiving packets

Attribute	Value
Type	STRING
Nillable	true
Expressions Allowed	false
Storage	runtime
Access Type	metric

mcast_port The multicast port used for sending and receiving packets. Default is 7600

Attribute	Value
Type	INT
Nillable	true
Expressions Allowed	false
Storage	runtime
Access Type	metric

mcast_receiver_threads Number of multicast receiver threads, all reading from the same MulticastSocket. If de-serialization is slow, increasing the number of receiver threads might yield better performance.

Attribute	Value
Type	INT
Nillable	true
Expressions Allowed	false
Storage	runtime
Access Type	metric

mcast_recv_buf_size Receive buffer size of the multicast datagram socket

Attribute	Value
Type	INT
Nillable	true
Expressions Allowed	false
Storage	runtime
Access Type	metric

mcast_send_buf_size Send buffer size of the multicast datagram socket

Attribute	Value
Type	INT
Nillable	true
Expressions Allowed	false
Storage	runtime
Access Type	metric

message_processing_policy The fully qualified name of a class implementing MessageProcessingPolicy

Attribute	Value
Type	STRING
Nillable	true
Expressions Allowed	false
Storage	runtime
Access Type	metric

message_processing_policy-max_buffer_size Max number of messages buffered for consumption of the delivery thread in MaxOneThreadPerSender. 0 creates an unbounded buffer

Attribute	Value
Type	INT
Nillable	true
Expressions Allowed	false
Storage	runtime
Access Type	metric

num_threads Returns the number of live threads in the JVM

Attribute	Value
Type	INT
Nillable	true
Expressions Allowed	false
Storage	runtime
Access Type	metric

number_of_thread_dumps Number of thread dumps

Attribute	Value
Type	INT
Nillable	true
Expressions Allowed	false
Storage	runtime
Access Type	metric

port_range The range of valid ports: [bind_port .. bind_port+port_range ]. 0 only binds to bind_port and fails if taken

Attribute	Value
Type	INT
Nillable	true
Expressions Allowed	false
Storage	runtime
Access Type	metric

receive_interfaces Comma delimited list of interfaces (IP addresses or interface names) to receive multicasts on

Attribute	Value
Type	STRING
Nillable	true
Expressions Allowed	false
Storage	runtime
Access Type	metric

receive_on_all_interfaces If true, the transport should use all available interfaces to receive multicast messages

Attribute	Value
Type	BOOLEAN
Nillable	true
Expressions Allowed	false
Storage	runtime
Access Type	metric

spawn_thread_on_full_pool When an internal message cannot be processed because of a full internal pool, a new thread is created to process the message. Setting this value to false disables this, and the message will be discarded (like regular messages)

Attribute	Value
Type	BOOLEAN
Nillable	true
Expressions Allowed	false
Storage	runtime
Access Type	metric

stats Determines whether to collect statistics (and expose them via JMX). Default is true

Attribute	Value
Type	BOOLEAN
Nillable	true
Expressions Allowed	false
Storage	runtime
Access Type	metric

suppress_time_different_cluster_warnings Time during which identical warnings about messages from a member from a different cluster will be suppressed. 0 disables this (every warning will be logged). Setting the log level to ERROR also disables this.

Attribute	Value
Type	LONG
Nillable	true
Expressions Allowed	false
Storage	runtime
Access Type	metric

suppress_time_different_version_warnings Time during which identical warnings about messages from a member with a different version will be suppressed. 0 disables this (every warning will be logged). Setting the log level to ERROR also disables this.

Attribute	Value
Type	LONG
Nillable	true
Expressions Allowed	false
Storage	runtime
Access Type	metric

suppress_time_out_of_buffer_space Suppresses warnings on Mac OS (for now) about not enough buffer space when sending a datagram packet

Attribute	Value
Type	LONG
Nillable	true
Expressions Allowed	false
Storage	runtime
Access Type	metric

thread_dumps_threshold The number of times a thread pool needs to be full before a thread dump is logged

Attribute	Value
Type	INT
Nillable	true
Expressions Allowed	false
Storage	runtime
Access Type	metric

thread_naming_pattern Thread naming pattern for threads in this channel. Valid values are "pcl": "p": includes the thread name, e.g. "Incoming thread-1", "UDP ucast receiver", "c": includes the cluster name, e.g. "MyCluster", "l": includes the local address of the current member, e.g. "192.168.5.1:5678"

Attribute	Value
Type	STRING
Nillable	true
Expressions Allowed	false
Storage	runtime
Access Type	metric

thread_pool-enabled Enable or disable the thread pool

Attribute	Value
Type	BOOLEAN
Nillable	true
Expressions Allowed	false
Storage	runtime
Access Type	metric

thread_pool-keep_alive_time Timeout in milliseconds to remove idle threads from pool

Attribute	Value
Type	LONG
Nillable	true
Expressions Allowed	false
Storage	runtime
Access Type	metric

thread_pool-max_threads Maximum thread pool size for the thread pool

Attribute	Value
Type	INT
Nillable	true
Expressions Allowed	false
Storage	runtime
Access Type	metric

thread_pool-min_threads Minimum thread pool size for the thread pool

Attribute	Value
Type	INT
Nillable	true
Expressions Allowed	false
Storage	runtime
Access Type	metric

thread_pool-use_common_fork_join_pool If true, the common fork-join pool will be used; otherwise a custom ForkJoinPool will be created

Attribute	Value
Type	BOOLEAN
Nillable	true
Expressions Allowed	false
Storage	runtime
Access Type	metric

thread_pool-use_fork_join_pool If enabled, a ForkJoinPool will be used rather than a ThreadPoolExecutor

Attribute	Value
Type	BOOLEAN
Nillable	true
Expressions Allowed	false
Storage	runtime
Access Type	metric

thread_pool_size Current number of threads in the thread pool

Attribute	Value
Type	INT
Nillable	true
Expressions Allowed	false
Storage	runtime
Access Type	metric

thread_pool_size_active Current number of active threads in the thread pool

Attribute	Value
Type	INT
Nillable	true
Expressions Allowed	false
Storage	runtime
Access Type	metric

thread_pool_size_largest Largest number of threads in the thread pool

Attribute	Value
Type	INT
Nillable	true
Expressions Allowed	false
Storage	runtime
Access Type	metric

time_service_interval Interval (in ms) at which the time service updates its timestamp. 0 disables the time service

Attribute	Value
Type	LONG
Nillable	true
Expressions Allowed	false
Storage	runtime
Access Type	metric

timer_class Class of the timer implementation

Attribute	Value
Type	STRING
Nillable	true
Expressions Allowed	false
Storage	runtime
Access Type	metric

timer_handle_non_blocking_tasks If enabled, the timer will run non-blocking tasks on its own (runner) thread, and not submit them to the thread pool. Otherwise, all tasks are submitted to the thread pool. This attribute is experimental and may be removed without notice.

Attribute	Value
Type	BOOLEAN
Nillable	true
Expressions Allowed	false
Storage	runtime
Access Type	metric

timer_tasks Number of timer tasks queued up for execution

Attribute	Value
Type	INT
Nillable	true
Expressions Allowed	false
Storage	runtime
Access Type	metric

timer_threads Number of threads currently in the pool

Attribute	Value
Type	INT
Nillable	true
Expressions Allowed	false
Storage	runtime
Access Type	metric

tos Traffic class for sending unicast and multicast datagrams. Default is 0

Attribute	Value
Type	INT
Nillable	true
Expressions Allowed	false
Storage	runtime
Access Type	metric

ucast_receiver_threads Number of unicast receiver threads, all reading from the same DatagramSocket. If de-serialization is slow, increasing the number of receiver threads might yield better performance.

Attribute	Value
Type	INT
Nillable	true
Expressions Allowed	false
Storage	runtime
Access Type	metric

ucast_recv_buf_size Receive buffer size of the unicast datagram socket

Attribute	Value
Type	INT
Nillable	true
Expressions Allowed	false
Storage	runtime
Access Type	metric

ucast_send_buf_size Send buffer size of the unicast datagram socket

Attribute	Value
Type	INT
Nillable	true
Expressions Allowed	false
Storage	runtime
Access Type	metric

use_fibers Create fibers (if true) or regular threads (if false). This requires Java 15/Loom. If not present, use_fibers will be set to false and regular threads will be created. Note that the ThreadFactoryneeds to support this (DefaultThreadFactory does)

Attribute	Value
Type	BOOLEAN
Nillable	true
Expressions Allowed	false
Storage	runtime
Access Type	metric

use_ip_addrs Use IP addresses (IpAddressUUID) instead of UUIDs as addresses. This is currently not compatible with RELAY2: disable if RELAY2 is used.

Attribute	Value
Type	BOOLEAN
Nillable	true
Expressions Allowed	false
Storage	runtime
Access Type	metric

who_has_cache_timeout Timeout (in ms) to determine how long to wait until a request to fetch the physical address for a given logical address will be sent again. Subsequent requests for the same physical address will therefore be spaced at least who_has_cache_timeout ms apart

Attribute	Value
Type	LONG
Nillable	true
Expressions Allowed	false
Storage	runtime
Access Type	metric