Chapter 3. The Asynchronous API

3.1. The Asynchronous API

In addition to synchronous API methods, Red Hat JBoss Data Grid also offers an asynchronous API that provides the same functionality in a non-blocking fashion.

The asynchronous method naming convention is similar to their synchronous counterparts, with Async appended to each method name. Asynchronous methods return a Future that contains the result of the operation.

For example, in a cache parameterized as Cache<String, String>, Cache.put(String key, String value) returns a String, while Cache.putAsync(String key, String value) returns a FutureString.

3.2. Asynchronous API Benefits

The asynchronous API does not block, which provides multiple benefits, such as:

  • The guarantee of synchronous communication, with the added ability to handle failures and exceptions.
  • Not being required to block a thread’s operations until the call completes.

These benefits allow you to better harness the parallelism in your system, for example:

Using the Asynchronous API

Set<Future<?>> futures = new HashSet<Future<?>>();
futures.add(cache.putAsync("key1", "value1"));
futures.add(cache.putAsync("key2", "value2"));
futures.add(cache.putAsync("key3", "value3"));

In the example, The following lines do not block the thread as they execute:

  • futures.add(cache.putAsync(key1, value1));
  • futures.add(cache.putAsync(key2, value2));
  • futures.add(cache.putAsync(key3, value3));

The remote calls from the three put operations are executed in parallel. This is particularly useful when executed in distributed mode.

3.3. About Asynchronous Processes

For a typical write operation in Red Hat JBoss Data Grid, the following processes fall on the critical path, ordered from most resource-intensive to the least:

  • Network calls
  • Marshalling
  • Writing to a cache store (optional)
  • Locking

In Red Hat JBoss Data Grid, using asynchronous methods removes network calls and marshalling from the critical path.

3.4. Return Values and the Asynchronous API

When the asynchronous API is used in Red Hat JBoss Data Grid, the client code requires the asynchronous operation to return either the Future or the CompletableFuture in order to query the previous value.

Call the following operation to obtain the result of an asynchronous operation. This operation blocks threads when called.

Future.get()