Struct TreeWorker 

pub struct TreeWorker { /* private fields */ }

Worker that distributes command execution across a cluster topology.

TreeWorker uses PropagationTreeRouter to determine routing through gateway nodes, and PropagationChannel to communicate with gateways. Nodes directly reachable (same hop as root) are executed via direct workers (SSH or local).

Mirrors ClusterShell’s TreeWorker class.

Implementations

impl TreeWorker

pub fn new(nodes: NodeSet, command: String, config: TreeWorkerConfig) -> Self

Create a new TreeWorker for command execution.

Arguments

• nodes - Target nodes to execute on.
• command - Command to execute on each node.
• config - Tree worker configuration.

pub fn set_router(&mut self, router: PropagationTreeRouter)

Set the topology router for this worker.

Must be called before start(). The router determines how commands are distributed across gateway nodes.

pub fn set_topology( &mut self, root: &str, topology: &TopologyTree, ) -> Result<(), WorkerError>

Create a router from a topology tree.

Arguments

• root - The root node name (typically the local hostname).
• topology - The cluster topology tree.

Errors

Returns WorkerError if the root node is not found in the topology.

pub fn nodes(&self) -> &NodeSet

Get the target nodes.

pub fn command(&self) -> Option<&str>

Get the command being executed.

pub fn state(&self) -> WorkerState

Get the current state.

pub fn retcodes(&self) -> &HashMap<String, i32>

Get collected return codes.

pub fn events(&self) -> &[TreeWorkerEvent]

Get collected events from remote nodes.

pub fn drain_events(&mut self) -> Vec<TreeWorkerEvent>

Drain collected events.

pub fn num_timeout(&self) -> usize

Get the number of timed out nodes.

pub fn timeout_nodes(&self) -> &HashSet<String>

Get timed out nodes.

pub fn has_timeout(&self) -> bool

Whether any node has timed out.

pub fn is_done(&self) -> bool

Check if the worker is done (all targets completed or timed out).

pub fn start(&mut self) -> Result<Vec<(NodeSet, NodeSet)>, WorkerError>

Start the tree worker — distribute work across gateways.

This sets up propagation channels for gateway nodes and prepares direct execution for leaf nodes.

pub fn start_gateway( &mut self, gateway: &str, topology_bytes: &[u8], ) -> Result<(), WorkerError>

Start a gateway’s propagation channel with topology data.

Arguments

• gateway - The gateway node name.
• topology_bytes - Serialized topology data to send to gateway.

pub fn process_result( &mut self, gateway: &str, result: PropagationResult, ) -> Result<bool, WorkerError>

Process a propagation result from a gateway.

Call this when the gateway channel receives results. Returns true if the worker is now complete.

pub fn record_direct_close(&mut self, node: &str, rc: i32)

Record completion of a direct (non-gateway) node.

Called when a direct SSH/local worker reports node completion.

pub fn record_direct_timeout(&mut self, node: &str)

Record a direct node timeout.

pub fn write_remote(&mut self, buf: &[u8])

Write data to all active gateway channels.

pub fn set_write_eof_remote(&mut self)

Send write EOF to all active gateway channels.

pub fn abort(&mut self)

Abort the tree worker.

Marks all remaining gateway targets as failed with EX_PROTOCOL (76).

pub fn active_gateway_count(&self) -> usize

Get the number of active gateways.

pub fn active_gateways(&self) -> Vec<&str>

Get active gateway names.

pub fn num_nodes(&self) -> usize

Get the total number of target nodes.

pub fn worker_id(&self) -> u64

Get the worker ID.