ClusterCommunicationService (Atomix API Reference (3.1.0))

All Known Subinterfaces:

ManagedClusterCommunicationService
```
public interface ClusterCommunicationService
```
High-level MemberId based intra-cluster messaging service.
The cluster communication service is used for high-level communication between cluster members. Messages are sent and received based on arbitrary String message subjects. Direct messages are sent using the MemberId to which to send the message. This API supports several types of messaging:
- broadcast(String, Object) broadcasts a message to all cluster members
- multicast(String, Object, Set) sends the message to all provided members
- unicast(String, Object, MemberId) sends a unicast message directly to the given member
- send(String, Object, MemberId) sends a message directly to the given member and awaits a reply
To register to listen for messages, use one of the subscribe(String, Consumer, Executor) methods:
```
   
   atomix.getCommunicationService().subscribe("test", message -> {
     System.out.println("Received message");
   }, executor);
   
 
```

Method Summary

All Methods Instance Methods Abstract Methods Default Methods
Modifier and Type	Method and Description
`default <M> void`	`broadcast(java.lang.String subject, M message)` Broadcasts a message to all members.
`default <M> void`	`broadcast(java.lang.String subject, M message, boolean reliable)` Broadcasts a message to all members.
`default <M> void`	`broadcast(java.lang.String subject, M message, java.util.function.Function<M,byte[]> encoder)` Broadcasts a message to all members.
`<M> void`	`broadcast(java.lang.String subject, M message, java.util.function.Function<M,byte[]> encoder, boolean reliable)` Broadcasts a message to all members.
`default <M> void`	`broadcastIncludeSelf(java.lang.String subject, M message)` Broadcasts a message to all members over TCP including self.
`default <M> void`	`broadcastIncludeSelf(java.lang.String subject, M message, boolean reliable)` Broadcasts a message to all members including self.
`default <M> void`	`broadcastIncludeSelf(java.lang.String subject, M message, java.util.function.Function<M,byte[]> encoder)` Broadcasts a message to all members over TCP including self.
`<M> void`	`broadcastIncludeSelf(java.lang.String subject, M message, java.util.function.Function<M,byte[]> encoder, boolean reliable)` Broadcasts a message to all members including self.
`default <M> void`	`multicast(java.lang.String subject, M message, java.util.function.Function<M,byte[]> encoder, java.util.Set<MemberId> memberIds)` Multicasts a message to a set of members over TCP.
`<M> void`	`multicast(java.lang.String subject, M message, java.util.function.Function<M,byte[]> encoder, java.util.Set<MemberId> memberIds, boolean reliable)` Multicasts a message to a set of members.
`default <M> void`	`multicast(java.lang.String subject, M message, java.util.Set<MemberId> memberIds)` Multicasts a message to a set of members over TCP.
`default <M> void`	`multicast(java.lang.String subject, M message, java.util.Set<MemberId> memberIds, boolean reliable)` Multicasts a message to a set of members.
`default <M,R> java.util.concurrent.CompletableFuture<R>`	`send(java.lang.String subject, M message, java.util.function.Function<M,byte[]> encoder, java.util.function.Function<byte[],R> decoder, MemberId toMemberId)` Sends a message and expects a reply.
`<M,R> java.util.concurrent.CompletableFuture<R>`	`send(java.lang.String subject, M message, java.util.function.Function<M,byte[]> encoder, java.util.function.Function<byte[],R> decoder, MemberId toMemberId, java.time.Duration timeout)` Sends a message and expects a reply.
`default <M,R> java.util.concurrent.CompletableFuture<R>`	`send(java.lang.String subject, M message, MemberId toMemberId)` Sends a message and expects a reply.
`default <M,R> java.util.concurrent.CompletableFuture<R>`	`send(java.lang.String subject, M message, MemberId toMemberId, java.time.Duration timeout)` Sends a message and expects a reply.
`default <M> java.util.concurrent.CompletableFuture<java.lang.Void>`	`subscribe(java.lang.String subject, java.util.function.BiConsumer<MemberId,M> handler, java.util.concurrent.Executor executor)` Adds a new subscriber for the specified message subject.
`default <M> java.util.concurrent.CompletableFuture<java.lang.Void>`	`subscribe(java.lang.String subject, java.util.function.Consumer<M> handler, java.util.concurrent.Executor executor)` Adds a new subscriber for the specified message subject.
`<M> java.util.concurrent.CompletableFuture<java.lang.Void>`	`subscribe(java.lang.String subject, java.util.function.Function<byte[],M> decoder, java.util.function.BiConsumer<MemberId,M> handler, java.util.concurrent.Executor executor)` Adds a new subscriber for the specified message subject.
`<M> java.util.concurrent.CompletableFuture<java.lang.Void>`	`subscribe(java.lang.String subject, java.util.function.Function<byte[],M> decoder, java.util.function.Consumer<M> handler, java.util.concurrent.Executor executor)` Adds a new subscriber for the specified message subject.
`<M,R> java.util.concurrent.CompletableFuture<java.lang.Void>`	`subscribe(java.lang.String subject, java.util.function.Function<byte[],M> decoder, java.util.function.Function<M,java.util.concurrent.CompletableFuture<R>> handler, java.util.function.Function<R,byte[]> encoder)` Adds a new subscriber for the specified message subject.
`<M,R> java.util.concurrent.CompletableFuture<java.lang.Void>`	`subscribe(java.lang.String subject, java.util.function.Function<byte[],M> decoder, java.util.function.Function<M,R> handler, java.util.function.Function<R,byte[]> encoder, java.util.concurrent.Executor executor)` Adds a new subscriber for the specified message subject.
`default <M,R> java.util.concurrent.CompletableFuture<java.lang.Void>`	`subscribe(java.lang.String subject, java.util.function.Function<M,java.util.concurrent.CompletableFuture<R>> handler)` Adds a new subscriber for the specified message subject.
`default <M,R> java.util.concurrent.CompletableFuture<java.lang.Void>`	`subscribe(java.lang.String subject, java.util.function.Function<M,R> handler, java.util.concurrent.Executor executor)` Adds a new subscriber for the specified message subject.
`default <M> java.util.concurrent.CompletableFuture<java.lang.Void>`	`unicast(java.lang.String subject, M message, java.util.function.Function<M,byte[]> encoder, MemberId toMemberId)` Sends a message to the specified member over TCP.
`<M> java.util.concurrent.CompletableFuture<java.lang.Void>`	`unicast(java.lang.String subject, M message, java.util.function.Function<M,byte[]> encoder, MemberId toMemberId, boolean reliable)` Sends a message to the specified member.
`default <M> java.util.concurrent.CompletableFuture<java.lang.Void>`	`unicast(java.lang.String subject, M message, MemberId toMemberId)` Sends a message to the specified member over TCP.
`default <M> java.util.concurrent.CompletableFuture<java.lang.Void>`	`unicast(java.lang.String subject, M message, MemberId toMemberId, boolean reliable)` Sends a message to the specified member.
`void`	`unsubscribe(java.lang.String subject)` Removes a subscriber for the specified message subject.

Method Detail

broadcast
```
default <M> void broadcast(java.lang.String subject,
                           M message)
```
Broadcasts a message to all members.

Type Parameters:

M - message type

Parameters:

subject - message subject

message - message to send

broadcast
```
default <M> void broadcast(java.lang.String subject,
                           M message,
                           boolean reliable)
```
Broadcasts a message to all members.

Type Parameters:

M - message type

Parameters:

subject - message subject

message - message to send

reliable - whether to perform a reliable (TCP) unicast

broadcast
```
default <M> void broadcast(java.lang.String subject,
                           M message,
                           java.util.function.Function<M,byte[]> encoder)
```
Broadcasts a message to all members.

Type Parameters:

M - message type

Parameters:

subject - message subject

message - message to send

encoder - function for encoding message to byte[]

broadcast
```
<M> void broadcast(java.lang.String subject,
                   M message,
                   java.util.function.Function<M,byte[]> encoder,
                   boolean reliable)
```
Broadcasts a message to all members.

Type Parameters:

M - message type

Parameters:

subject - message subject

message - message to send

encoder - function for encoding message to byte[]

reliable - whether to perform a reliable (TCP) unicast

broadcastIncludeSelf
```
default <M> void broadcastIncludeSelf(java.lang.String subject,
                                      M message)
```
Broadcasts a message to all members over TCP including self.

Type Parameters:

M - message type

Parameters:

subject - message subject

message - message to send

broadcastIncludeSelf
```
default <M> void broadcastIncludeSelf(java.lang.String subject,
                                      M message,
                                      boolean reliable)
```
Broadcasts a message to all members including self.

Type Parameters:

M - message type

Parameters:

subject - message subject

message - message to send

reliable - whether to perform a reliable (TCP) unicast

broadcastIncludeSelf
```
default <M> void broadcastIncludeSelf(java.lang.String subject,
                                      M message,
                                      java.util.function.Function<M,byte[]> encoder)
```
Broadcasts a message to all members over TCP including self.

Type Parameters:

M - message type

Parameters:

subject - message subject

message - message to send

encoder - function for encoding message to byte[]

broadcastIncludeSelf
```
<M> void broadcastIncludeSelf(java.lang.String subject,
                              M message,
                              java.util.function.Function<M,byte[]> encoder,
                              boolean reliable)
```
Broadcasts a message to all members including self.

Type Parameters:

M - message type

Parameters:

subject - message subject

message - message to send

encoder - function for encoding message to byte[]

reliable - whether to perform a reliable (TCP) unicast

unicast

default <M> java.util.concurrent.CompletableFuture<java.lang.Void> unicast(java.lang.String subject,
                                                                           M message,
                                                                           MemberId toMemberId)

Sends a message to the specified member over TCP.

Type Parameters:: M - message type
Parameters:: subject - message subject; message - message to send; toMemberId - destination node identifier
Returns:: future that is completed when the message is sent

unicast

default <M> java.util.concurrent.CompletableFuture<java.lang.Void> unicast(java.lang.String subject,
                                                                           M message,
                                                                           MemberId toMemberId,
                                                                           boolean reliable)

Sends a message to the specified member.

Type Parameters:: M - message type
Parameters:: subject - message subject; message - message to send; toMemberId - destination node identifier; reliable - whether to perform a reliable (TCP) unicast
Returns:: future that is completed when the message is sent

unicast

default <M> java.util.concurrent.CompletableFuture<java.lang.Void> unicast(java.lang.String subject,
                                                                           M message,
                                                                           java.util.function.Function<M,byte[]> encoder,
                                                                           MemberId toMemberId)

Sends a message to the specified member over TCP.

Type Parameters:: M - message type
Parameters:: subject - message subject; message - message to send; encoder - function for encoding message to byte[]; toMemberId - destination node identifier
Returns:: future that is completed when the message is sent

unicast

<M> java.util.concurrent.CompletableFuture<java.lang.Void> unicast(java.lang.String subject,
                                                                   M message,
                                                                   java.util.function.Function<M,byte[]> encoder,
                                                                   MemberId toMemberId,
                                                                   boolean reliable)

Sends a message to the specified member.

Type Parameters:: M - message type
Parameters:: subject - message subject; message - message to send; encoder - function for encoding message to byte[]; toMemberId - destination node identifier; reliable - whether to perform a reliable (TCP) unicast
Returns:: future that is completed when the message is sent

multicast
```
default <M> void multicast(java.lang.String subject,
                           M message,
                           java.util.Set<MemberId> memberIds)
```
Multicasts a message to a set of members over TCP.

Type Parameters:

M - message type

Parameters:

subject - message subject

message - message to send

memberIds - recipient node identifiers

multicast
```
default <M> void multicast(java.lang.String subject,
                           M message,
                           java.util.Set<MemberId> memberIds,
                           boolean reliable)
```
Multicasts a message to a set of members.

Type Parameters:

M - message type

Parameters:

subject - message subject

message - message to send

memberIds - recipient node identifiers

reliable - whether to perform a reliable (TCP) unicast

multicast
```
default <M> void multicast(java.lang.String subject,
                           M message,
                           java.util.function.Function<M,byte[]> encoder,
                           java.util.Set<MemberId> memberIds)
```
Multicasts a message to a set of members over TCP.

Type Parameters:

M - message type

Parameters:

subject - message subject

message - message to send

encoder - function for encoding message to byte[]

memberIds - recipient node identifiers

multicast
```
<M> void multicast(java.lang.String subject,
                   M message,
                   java.util.function.Function<M,byte[]> encoder,
                   java.util.Set<MemberId> memberIds,
                   boolean reliable)
```
Multicasts a message to a set of members.

Type Parameters:

M - message type

Parameters:

subject - message subject

message - message to send

encoder - function for encoding message to byte[]

memberIds - recipient node identifiers

reliable - whether to perform a reliable (TCP) unicast

send

default <M,R> java.util.concurrent.CompletableFuture<R> send(java.lang.String subject,
                                                             M message,
                                                             MemberId toMemberId)

Sends a message and expects a reply.

Type Parameters:: M - request type; R - reply type
Parameters:: subject - message subject; message - message to send; toMemberId - recipient node identifier
Returns:: reply future

send

default <M,R> java.util.concurrent.CompletableFuture<R> send(java.lang.String subject,
                                                             M message,
                                                             MemberId toMemberId,
                                                             java.time.Duration timeout)

Sends a message and expects a reply.

Type Parameters:: M - request type; R - reply type
Parameters:: subject - message subject; message - message to send; toMemberId - recipient node identifier; timeout - response timeout
Returns:: reply future

send

default <M,R> java.util.concurrent.CompletableFuture<R> send(java.lang.String subject,
                                                             M message,
                                                             java.util.function.Function<M,byte[]> encoder,
                                                             java.util.function.Function<byte[],R> decoder,
                                                             MemberId toMemberId)

Sends a message and expects a reply.

Type Parameters:: M - request type; R - reply type
Parameters:: subject - message subject; message - message to send; encoder - function for encoding request to byte[]; decoder - function for decoding response from byte[]; toMemberId - recipient node identifier
Returns:: reply future

send

<M,R> java.util.concurrent.CompletableFuture<R> send(java.lang.String subject,
                                                     M message,
                                                     java.util.function.Function<M,byte[]> encoder,
                                                     java.util.function.Function<byte[],R> decoder,
                                                     MemberId toMemberId,
                                                     java.time.Duration timeout)

Sends a message and expects a reply.

Type Parameters:: M - request type; R - reply type
Parameters:: subject - message subject; message - message to send; encoder - function for encoding request to byte[]; decoder - function for decoding response from byte[]; toMemberId - recipient node identifier; timeout - response timeout
Returns:: reply future

subscribe
```
default <M,R> java.util.concurrent.CompletableFuture<java.lang.Void> subscribe(java.lang.String subject,
                                                                               java.util.function.Function<M,R> handler,
                                                                               java.util.concurrent.Executor executor)
```
Adds a new subscriber for the specified message subject.

Type Parameters:

M - incoming message type

R - reply message type

Parameters:

subject - message subject

handler - handler function that processes the incoming message and produces a reply

executor - executor to run this handler on

Returns:

future to be completed once the subscription has been propagated

<M,R> java.util.concurrent.CompletableFuture<java.lang.Void> subscribe(java.lang.String subject,
                                                                       java.util.function.Function<byte[],M> decoder,
                                                                       java.util.function.Function<M,R> handler,
                                                                       java.util.function.Function<R,byte[]> encoder,
                                                                       java.util.concurrent.Executor executor)