org.wildfly.clustering.dispatcher

Interface CommandDispatcher<C>

Type Parameters:

C - the command context type

All Superinterfaces:

AutoCloseable

public interface CommandDispatcher<C>
extends AutoCloseable

A dispatcher for remote invocation of commands.

Author:

Paul Ferraro

Method Summary

Modifier and Type	Method and Description
void	close() Closes any resources used by this dispatcher.
<R> Map<Node,CommandResponse<R>>	executeOnCluster(Command<R,? super C> command, Node... excludedNodes) Execute the specified command on all nodes in the group, excluding the specified nodes
<R> CommandResponse<R>	executeOnNode(Command<R,? super C> command, Node node) Execute the specified command on the specified node.
<R> Map<Node,Future<R>>	submitOnCluster(Command<R,? super C> command, Node... excludedNodes) Submits the specified command on all nodes in the group, excluding the specified nodes.
<R> Future<R>	submitOnNode(Command<R,? super C> command, Node node) Submits the specified command on the specified node for execution.

Method Detail

executeOnNode

<R> CommandResponse<R> executeOnNode(Command<R,? super C> command,
                                     Node node)
                              throws CommandDispatcherException

Execute the specified command on the specified node.

Type Parameters:

R - the return value type

Parameters:

command - the command to execute

node - the node to execute the command on

Returns:

the result of the command execution

Throws:

CommandDispatcherException - if the command could not be sent

executeOnCluster

<R> Map<Node,CommandResponse<R>> executeOnCluster(Command<R,? super C> command,
                                                  Node... excludedNodes)
                                           throws CommandDispatcherException

Execute the specified command on all nodes in the group, excluding the specified nodes

Type Parameters:

R - the return value type

Parameters:

command - the command to execute

excludedNodes - the set of nodes to exclude

Returns:

a map of command execution results per node

Throws:

CommandDispatcherException - if the command could not be broadcast

submitOnNode

<R> Future<R> submitOnNode(Command<R,? super C> command,
                           Node node)
                    throws CommandDispatcherException

Submits the specified command on the specified node for execution.

Type Parameters:

R - the return value type

Parameters:

command - the command to execute

node - the node to execute the command on

Returns:

the result of the command execution

Throws:

CommandDispatcherException - if the command could not be sent

submitOnCluster

<R> Map<Node,Future<R>> submitOnCluster(Command<R,? super C> command,
                                        Node... excludedNodes)
                                 throws CommandDispatcherException

Submits the specified command on all nodes in the group, excluding the specified nodes.

Type Parameters:

R - the return value type

Parameters:

command - the command to execute

excludedNodes - the set of nodes to exclude

Returns:

a map of command execution results per node.

Throws:

CommandDispatcherException - if the command could not be broadcast

close

void close()

Closes any resources used by this dispatcher. Once closed, a dispatcher can no longer execute commands.

Specified by:

close in interface AutoCloseable