Package io.hekate.messaging.operation

Interface BroadcastResult<T>

Type Parameters:

T - Base type of broadcast message.

public interface BroadcastResult<T>

Result of a Broadcast operation.

See Also:

MessagingChannel.newBroadcast(Object)

Method Summary

Modifier and Type	Method	Description
default Throwable	errorOf(ClusterNode node)	Returns a communication error for the specified node or null if there was no communication failure with that node.
Map<ClusterNode,Throwable>	errors()	Returns the map of cluster nodes and errors that happened while trying to communicate with these nodes.
default boolean	isSuccess()	Returns true if broadcast completed successfully without any errors.
default boolean	isSuccess(ClusterNode node)	Returns true if there was no communication failure with the specified cluster node..
T	message()	Returns the original message object that was submitted to the cluster.
List<ClusterNode>	nodes()	Returns the broadcast operation participants.

Method Detail

message

T message()

Returns the original message object that was submitted to the cluster.

Returns:

Original message.

nodes

List<ClusterNode> nodes()

Returns the broadcast operation participants. Returns an empty list if there were no suitable nodes in the cluster to perform the operation.

Returns:

Cluster nodes that participated in the broadcast operation or an empty list if there were no suitable nodes in the cluster to perform the operation.

errors

Map<ClusterNode,Throwable> errors()

Returns the map of cluster nodes and errors that happened while trying to communicate with these nodes. Returns an empty map if there were no communication failures.

Returns:

Map of nodes and their corresponding failures. Returns an empty map if there were no communication failures.

See Also:

errorOf(ClusterNode)

isSuccess

default boolean isSuccess()

Returns true if broadcast completed successfully without any errors.

Returns:

true if broadcast completed successfully without any errors.

See Also:

errors()

isSuccess

default boolean isSuccess(ClusterNode node)

Returns true if there was no communication failure with the specified cluster node..

Parameters:

node - Cluster node (must be one of nodes(), otherwise results will be unpredictable).

Returns:

true if there was no communication failure with the specified cluster node.

errorOf

default Throwable errorOf(ClusterNode node)

Returns a communication error for the specified node or null if there was no communication failure with that node.

Parameters:

node - Cluster node (must be one of nodes(), otherwise results will be unpredictable).

Returns:

Error in case of a communication error with the specified node or null.

See Also:

errors()