io.atomix.cluster.messaging

Interface MessagingService

All Known Subinterfaces:

ManagedMessagingService

public interface MessagingService

Interface for low level messaging primitives.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	MessagingService.Builder Messaging service builder.

Method Summary

Modifier and Type	Method and Description
Address	address() Returns the local messaging service address.
void	registerHandler(java.lang.String type, java.util.function.BiConsumer<Address,byte[]> handler, java.util.concurrent.Executor executor) Registers a new message handler for message type.
void	registerHandler(java.lang.String type, java.util.function.BiFunction<Address,byte[],byte[]> handler, java.util.concurrent.Executor executor) Registers a new message handler for message type.
void	registerHandler(java.lang.String type, java.util.function.BiFunction<Address,byte[],java.util.concurrent.CompletableFuture<byte[]>> handler) Registers a new message handler for message type.
default java.util.concurrent.CompletableFuture<byte[]>	sendAndReceive(Address address, java.lang.String type, byte[] payload) Sends a message asynchronously and expects a response.
java.util.concurrent.CompletableFuture<byte[]>	sendAndReceive(Address address, java.lang.String type, byte[] payload, boolean keepAlive) Sends a message asynchronously and expects a response.
java.util.concurrent.CompletableFuture<byte[]>	sendAndReceive(Address address, java.lang.String type, byte[] payload, boolean keepAlive, java.time.Duration timeout) Sends a message asynchronously and expects a response.
java.util.concurrent.CompletableFuture<byte[]>	sendAndReceive(Address address, java.lang.String type, byte[] payload, boolean keepAlive, java.time.Duration timeout, java.util.concurrent.Executor executor) Sends a message synchronously and expects a response.
java.util.concurrent.CompletableFuture<byte[]>	sendAndReceive(Address address, java.lang.String type, byte[] payload, boolean keepAlive, java.util.concurrent.Executor executor) Sends a message synchronously and expects a response.
default java.util.concurrent.CompletableFuture<byte[]>	sendAndReceive(Address address, java.lang.String type, byte[] payload, java.time.Duration timeout) Sends a message asynchronously and expects a response.
default java.util.concurrent.CompletableFuture<byte[]>	sendAndReceive(Address address, java.lang.String type, byte[] payload, java.time.Duration timeout, java.util.concurrent.Executor executor) Sends a message synchronously and expects a response.
default java.util.concurrent.CompletableFuture<byte[]>	sendAndReceive(Address address, java.lang.String type, byte[] payload, java.util.concurrent.Executor executor) Sends a message synchronously and expects a response.
default java.util.concurrent.CompletableFuture<java.lang.Void>	sendAsync(Address address, java.lang.String type, byte[] payload) Sends a message asynchronously to the specified communication address.
java.util.concurrent.CompletableFuture<java.lang.Void>	sendAsync(Address address, java.lang.String type, byte[] payload, boolean keepAlive) Sends a message asynchronously to the specified communication address.
void	unregisterHandler(java.lang.String type) Unregister current handler, if one exists for message type.

Method Detail

address

Address address()

Returns the local messaging service address.

Returns:

the local address

sendAsync

default java.util.concurrent.CompletableFuture<java.lang.Void> sendAsync(Address address,
                                                                         java.lang.String type,
                                                                         byte[] payload)

Sends a message asynchronously to the specified communication address. The message is specified using the type and payload.

Parameters:

address - address to send the message to.

type - type of message.

payload - message payload bytes.

Returns:

future that is completed when the message is sent

sendAsync

java.util.concurrent.CompletableFuture<java.lang.Void> sendAsync(Address address,
                                                                 java.lang.String type,
                                                                 byte[] payload,
                                                                 boolean keepAlive)

Sends a message asynchronously to the specified communication address. The message is specified using the type and payload.

Parameters:

address - address to send the message to.

type - type of message.

payload - message payload bytes.

keepAlive - whether to keep the connection alive after usage

Returns:

future that is completed when the message is sent

sendAndReceive

default java.util.concurrent.CompletableFuture<byte[]> sendAndReceive(Address address,
                                                                      java.lang.String type,
                                                                      byte[] payload)

Sends a message asynchronously and expects a response.

Parameters:

address - address to send the message to.

type - type of message.

payload - message payload.

Returns:

a response future

sendAndReceive

java.util.concurrent.CompletableFuture<byte[]> sendAndReceive(Address address,
                                                              java.lang.String type,
                                                              byte[] payload,
                                                              boolean keepAlive)

Sends a message asynchronously and expects a response.

Parameters:

address - address to send the message to.

type - type of message.

payload - message payload.

keepAlive - whether to keep the connection alive after usage

Returns:

a response future

sendAndReceive

default java.util.concurrent.CompletableFuture<byte[]> sendAndReceive(Address address,
                                                                      java.lang.String type,
                                                                      byte[] payload,
                                                                      java.util.concurrent.Executor executor)

Sends a message synchronously and expects a response.

Parameters:

address - address to send the message to.

type - type of message.

payload - message payload.

executor - executor over which any follow up actions after completion will be executed.

Returns:

a response future

sendAndReceive

java.util.concurrent.CompletableFuture<byte[]> sendAndReceive(Address address,
                                                              java.lang.String type,
                                                              byte[] payload,
                                                              boolean keepAlive,
                                                              java.util.concurrent.Executor executor)

Sends a message synchronously and expects a response.

Parameters:

address - address to send the message to.

type - type of message.

payload - message payload.

keepAlive - whether to keep the connection alive after usage

executor - executor over which any follow up actions after completion will be executed.

Returns:

a response future

sendAndReceive

default java.util.concurrent.CompletableFuture<byte[]> sendAndReceive(Address address,
                                                                      java.lang.String type,
                                                                      byte[] payload,
                                                                      java.time.Duration timeout)

Sends a message asynchronously and expects a response.

Parameters:

address - address to send the message to.

type - type of message.

payload - message payload.

timeout - response timeout

Returns:

a response future

sendAndReceive

java.util.concurrent.CompletableFuture<byte[]> sendAndReceive(Address address,
                                                              java.lang.String type,
                                                              byte[] payload,
                                                              boolean keepAlive,
                                                              java.time.Duration timeout)

Sends a message asynchronously and expects a response.

Parameters:

address - address to send the message to.

type - type of message.

payload - message payload.

keepAlive - whether to keep the connection alive after usage

timeout - response timeout

Returns:

a response future

sendAndReceive

default java.util.concurrent.CompletableFuture<byte[]> sendAndReceive(Address address,
                                                                      java.lang.String type,
                                                                      byte[] payload,
                                                                      java.time.Duration timeout,
                                                                      java.util.concurrent.Executor executor)

Sends a message synchronously and expects a response.

Parameters:

address - address to send the message to.

type - type of message.

payload - message payload.

timeout - response timeout

executor - executor over which any follow up actions after completion will be executed.

Returns:

a response future

sendAndReceive

java.util.concurrent.CompletableFuture<byte[]> sendAndReceive(Address address,
                                                              java.lang.String type,
                                                              byte[] payload,
                                                              boolean keepAlive,
                                                              java.time.Duration timeout,
                                                              java.util.concurrent.Executor executor)

Sends a message synchronously and expects a response.

Parameters:

address - address to send the message to.

type - type of message.

payload - message payload.

keepAlive - whether to keep the connection alive after usage

timeout - response timeout

executor - executor over which any follow up actions after completion will be executed.

Returns:

a response future

registerHandler

void registerHandler(java.lang.String type,
                     java.util.function.BiConsumer<Address,byte[]> handler,
                     java.util.concurrent.Executor executor)

Registers a new message handler for message type.

Parameters:

type - message type.

handler - message handler

executor - executor to use for running message handler logic.

registerHandler

void registerHandler(java.lang.String type,
                     java.util.function.BiFunction<Address,byte[],byte[]> handler,
                     java.util.concurrent.Executor executor)

Registers a new message handler for message type.

Parameters:

type - message type.

handler - message handler

executor - executor to use for running message handler logic.

registerHandler

void registerHandler(java.lang.String type,
                     java.util.function.BiFunction<Address,byte[],java.util.concurrent.CompletableFuture<byte[]>> handler)

Registers a new message handler for message type.

Parameters:

type - message type.

handler - message handler

unregisterHandler

void unregisterHandler(java.lang.String type)

Unregister current handler, if one exists for message type.

Parameters:

type - message type