Package io.atomix.cluster.messaging.impl

Class NettyMessagingService

java.lang.Object

io.atomix.cluster.messaging.impl.NettyMessagingService

All Implemented Interfaces:

ManagedMessagingService, MessagingService, Managed<MessagingService>, AutoCloseable

public final class NettyMessagingService
extends Object
implements ManagedMessagingService

Netty based MessagingService.

Constructor Summary

Constructors

Constructor	Description
NettyMessagingService(String cluster, Address advertisedAddress, MessagingConfig config)
NettyMessagingService(String cluster, Address advertisedAddress, MessagingConfig config, String actorSchedulerName)

Method Summary

Modifier and Type	Method	Description
Address	address()	Returns the local messaging service address.
Collection<Address>	bindingAddresses()	Returns the interfaces to which the local messaging service is bind.
io.atomix.cluster.messaging.impl.ChannelPool	getChannelPool()
boolean	isRunning()	Returns a boolean value indicating whether the managed object is running.
void	registerHandler(String type, BiConsumer<Address,byte[]> handler, Executor executor)	Registers a new message handler for message type.
void	registerHandler(String type, BiFunction<Address,byte[],byte[]> handler, Executor executor)	Registers a new message handler for message type.
void	registerHandler(String type, BiFunction<Address,byte[],CompletableFuture<byte[]>> handler)	Registers a new message handler for message type.
CompletableFuture<byte[]>	sendAndReceive(Address address, String type, byte[] payload, boolean keepAlive)	Sends a message asynchronously and expects a response.
CompletableFuture<byte[]>	sendAndReceive(Address address, String type, byte[] payload, boolean keepAlive, Duration timeout)	Sends a message asynchronously and expects a response.
CompletableFuture<byte[]>	sendAndReceive(Address address, String type, byte[] payload, boolean keepAlive, Duration timeout, Executor executor)	Sends a message synchronously and expects a response.
CompletableFuture<byte[]>	sendAndReceive(Address address, String type, byte[] payload, boolean keepAlive, Executor executor)	Sends a message synchronously and expects a response.
CompletableFuture<Void>	sendAsync(Address address, String type, byte[] payload, boolean keepAlive)	Sends a message asynchronously to the specified communication address.
CompletableFuture<MessagingService>	start()
CompletableFuture<Void>	stop()
void	unregisterHandler(String type)	Unregister current handler, if one exists for message type.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface io.atomix.utils.Managed

close

Methods inherited from interface io.atomix.cluster.messaging.MessagingService

sendAndReceive, sendAndReceive, sendAndReceive, sendAsync

Constructor Details

NettyMessagingService

public NettyMessagingService(String cluster,
 Address advertisedAddress,
 MessagingConfig config)

NettyMessagingService

public NettyMessagingService(String cluster,
 Address advertisedAddress,
 MessagingConfig config,
 String actorSchedulerName)

Method Details

getChannelPool

@VisibleForTesting
public io.atomix.cluster.messaging.impl.ChannelPool getChannelPool()

address

public Address address()

Description copied from interface: MessagingService

Returns the local messaging service address. This is the address used by other nodes to communicate to this service.

Specified by:

address in interface MessagingService

Returns:

the address remote nodes use to communicate to this node

bindingAddresses

public Collection<Address> bindingAddresses()

Description copied from interface: MessagingService

Returns the interfaces to which the local messaging service is bind.

Specified by:

bindingAddresses in interface MessagingService

Returns:

the address the messaging service is bound to

sendAsync

public CompletableFuture<Void> sendAsync(Address address,
 String type,
 byte[] payload,
 boolean keepAlive)

Description copied from interface: MessagingService

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

Specified by:

sendAsync in interface MessagingService

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

public CompletableFuture<byte[]> sendAndReceive(Address address,
 String type,
 byte[] payload,
 boolean keepAlive)

Description copied from interface: MessagingService

Sends a message asynchronously and expects a response.

If keepAlive is false, a new, transient connection is set up and created. If true, it will reuse an existing connection (if any), or create a new one that will be kept in a pool for future reuse for this address and type pair.

The future may be completed exceptionally with one of:

• IllegalStateException - the underlying service cannot send the given request (e.g. the service is not running)
• ConnectException - indicates the recipient is unreachable
• TimeoutException - indicates no response came back after the default timeout
• MessagingException.ProtocolException - indicates the recipient failed to parse the incoming message
• MessagingException.NoRemoteHandler - indicates the recipient received the message, but was no expecting to
• MessagingException.RemoteHandlerFailure - indicates the recipient parsed and expected the message, but it failed unexpectedly to process it

Specified by:

sendAndReceive in interface MessagingService

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

public CompletableFuture<byte[]> sendAndReceive(Address address,
 String type,
 byte[] payload,
 boolean keepAlive,
 Executor executor)

Description copied from interface: MessagingService

Sends a message synchronously and expects a response.

If keepAlive is false, a new, transient connection is set up and created. If true, it will reuse an existing connection (if any), or create a new one that will be kept in a pool for future reuse for this address and type pair.

The future may be completed exceptionally with one of:

• IllegalStateException - the underlying service cannot send the given request (e.g. the service is not running)
• ConnectException - indicates the recipient is unreachable
• TimeoutException - indicates no response came back after the default timeout
• MessagingException.ProtocolException - indicates the recipient failed to parse the incoming message
• MessagingException.NoRemoteHandler - indicates the recipient received the message, but was no expecting to
• MessagingException.RemoteHandlerFailure - indicates the recipient parsed and expected the message, but it failed unexpectedly to process it

Specified by:

sendAndReceive in interface MessagingService

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

public CompletableFuture<byte[]> sendAndReceive(Address address,
 String type,
 byte[] payload,
 boolean keepAlive,
 Duration timeout)

Description copied from interface: MessagingService

Sends a message asynchronously and expects a response.

If keepAlive is false, a new, transient connection is set up and created. If true, it will reuse an existing connection (if any), or create a new one that will be kept in a pool for future reuse for this address and type pair.

The future may be completed exceptionally with one of:

• IllegalStateException - the underlying service cannot send the given request (e.g. the service is not running)
• ConnectException - indicates the recipient is unreachable
• TimeoutException - indicates no response came back within the given timeout
• MessagingException.ProtocolException - indicates the recipient failed to parse the incoming message
• MessagingException.NoRemoteHandler - indicates the recipient received the message, but was no expecting to
• MessagingException.RemoteHandlerFailure - indicates the recipient parsed and expected the message, but it failed unexpectedly to process it

Specified by:

sendAndReceive in interface MessagingService

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

public CompletableFuture<byte[]> sendAndReceive(Address address,
 String type,
 byte[] payload,
 boolean keepAlive,
 Duration timeout,
 Executor executor)

Description copied from interface: MessagingService

Sends a message synchronously and expects a response.

If keepAlive is false, a new, transient connection is set up and created. If true, it will reuse an existing connection (if any), or create a new one that will be kept in a pool for future reuse for this address and type pair.

The future may be completed exceptionally with one of:

• IllegalStateException - the underlying service cannot send the given request (e.g. the service is not running)
• ConnectException - indicates the recipient is unreachable
• TimeoutException - indicates no response came back within the given timeout
• MessagingException.ProtocolException - indicates the recipient failed to parse the incoming message
• MessagingException.NoRemoteHandler - indicates the recipient received the message, but was no expecting to
• MessagingException.RemoteHandlerFailure - indicates the recipient parsed and expected the message, but it failed unexpectedly to process it

Specified by:

sendAndReceive in interface MessagingService

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

public void registerHandler(String type,
 BiConsumer<Address,byte[]> handler,
 Executor executor)

Description copied from interface: MessagingService

Registers a new message handler for message type.

Specified by:

registerHandler in interface MessagingService

Parameters:

type - message type.

handler - message handler

executor - executor to use for running message handler logic.

registerHandler

public void registerHandler(String type,
 BiFunction<Address,byte[],byte[]> handler,
 Executor executor)

Description copied from interface: MessagingService

Registers a new message handler for message type.

Specified by:

registerHandler in interface MessagingService

Parameters:

type - message type.

handler - message handler

executor - executor to use for running message handler logic.

registerHandler

public void registerHandler(String type,
 BiFunction<Address,byte[],CompletableFuture<byte[]>> handler)

Description copied from interface: MessagingService

Registers a new message handler for message type.

Specified by:

registerHandler in interface MessagingService

Parameters:

type - message type.

handler - message handler

unregisterHandler

public void unregisterHandler(String type)

Description copied from interface: MessagingService

Unregister current handler, if one exists for message type.

Specified by:

unregisterHandler in interface MessagingService

Parameters:

type - message type

isRunning

public boolean isRunning()

Description copied from interface: MessagingService

Returns a boolean value indicating whether the managed object is running.

Specified by:

isRunning in interface Managed<MessagingService>

Specified by:

isRunning in interface MessagingService

Returns:

Indicates whether the managed object is running.

start

public CompletableFuture<MessagingService> start()

Specified by:

start in interface Managed<MessagingService>

stop

public CompletableFuture<Void> stop()

Specified by:

stop in interface Managed<MessagingService>