Red Hat Summit Red Hat SummitSupportConsoleDevelopersStart a trialContact

5.6. Configure Distribution Mode (Library Mode)

In JBoss Data Grid's Library mode, a distributed cache configuration is as follows: 
<clustering mode="dist">
        <sync replTimeout="${TIME}" />
        <stateTransfer chunkSize="${SIZE}"
                       fetchInMemoryState="{true/false}"
                       awaitInitialTransfer="{true/false}"
                       timeout="${TIME}" />
        <transport clusterName="${NAME}"
                            distributedSyncTimeout="${TIME}"
                            strictPeerToPeer="{true/false}"
                            transportClass="${CLASS}" />
</clustering>
Copy to Clipboard Toggle word wrap
The clustering element's mode parameter's value determines the clustering mode selected for the cache.
The sync element's replTimeout parameter specifies the maximum time period for an acknowledgment after a remote call. If the time period ends without any acknowledgment, an exception is thrown.
The stateTransfer element specifies how state is transferred when a node leaves or joins the cluster. It uses the following parameters:
  • The chunkSize parameter specifies the size of cache entry state batches to be transferred. If this value is greater than 0, the value set is the size of chunks sent. If the value is less than 0, all states are transferred at the same time.
  • The fetchMemoryInState parameter when set to true, requests state information from neighboring caches on start up. This impacts the start up time for the cache.
  • The awaitInitialTransfer parameter causes the first call to method CacheManager.getCache() on the joiner node to block and wait until the joining is complete and the cache has finished receiving state from neighboring caches (if fetchInMemoryState is enabled). This option applies to distributed and replicated caches only and is enabled by default.
  • The timeout parameter specifies the maximum time (in milliseconds) the cache waits for responses from neighboring caches with the requested states. If no response is received within the the timeout period, the start up process aborts and an exception is thrown.
The transport element defines the transport configuration for the cache as follows:
  • The clusterName parameter specifies the name of the cluster. Nodes can only connect to clusters that share the same name.
  • The distributedSyncTimeout parameter specifies the time to wait to acquire a lock on the distributed lock. This distributed lock ensures that a single cache can transfer state or rehash state at a time.
  • The strictPeerToPeer parameter, when set to true ensures that replication operations fail if the named cache does not exist. If set to false, the operation completes and logs messages about specific named caches not found and that replication was not performed on the nodes as a result.
  • The transportClass parameter specifies a class that represents a network transport for the cache.
Report a bug
Red Hat logoGithubredditYoutubeTwitter

Learn

Try, buy, & sell

Communities

About Red Hat Documentation

We help Red Hat users innovate and achieve their goals with our products and services with content they can trust. Explore our recent updates.

Making open source more inclusive

Red Hat is committed to replacing problematic language in our code, documentation, and web properties. For more details, see the Red Hat Blog.

About Red Hat

We deliver hardened solutions that make it easier for enterprises to work across platforms and environments, from the core datacenter to the network edge.

Theme

© 2026 Red HatBack to top