Package ClusterShell :: Package Worker :: Module Pdsh :: Class WorkerPdsh

Class WorkerPdsh


ClusterShell pdsh-based worker Class.

Remote Shell (pdsh) usage example:
    worker = WorkerPdsh(nodeset, handler=MyEventHandler(),
                    timeout=30, command="/bin/hostname")
Remote Copy (pdcp) usage example: 
    worker = WorkerPdsh(nodeset, handler=MyEventHandler(),
                    timeout=30, source="/etc/my.conf",
                    dest="/etc/my.conf")
    ...
    task.schedule(worker)   # schedule worker for execution
    ...
    task.resume()           # run

Known Limitations:
    * write() is not supported by WorkerPdsh
    * return codes == 0 are not garanteed when a timeout is used (rc > 0
      are fine)

Instance Methods

[hide private]

__init__(self, nodes, handler, timeout, **kwargs)
Initialize Pdsh worker instance.

source code

_engine_clients(self)
Return a list of underlying engine clients.

source code

_start(self)
Start worker, initialize buffers, prepare command.

source code

_read(self, size=-1)
Read data from process.

source code

_readerr(self, size=-1)
Read error from process.

source code

write(self, buf)
Write data to process.

source code

_close(self, force, timeout)
Close worker.

source code

_parse_line(self, line, stderr)
Parse Pdsh line syntax.

source code

_handle_read(self)
Engine is telling us a read is available.

source code

_handle_error(self)
Engine is telling us an error read is available.

source code

_on_node_rc(self, node, rc)
Return code received from a node, update last* stuffs.

source code

Inherited from EngineClient.EngineClient: error_fileno, reader_fileno, writer_fileno

Inherited from EngineClient.EngineClient (private): _close_writer, _exec_nonblock, _fire, _handle_write, _readerrlines, _readlines, _set_reading, _set_reading_error, _set_write_eof, _set_writing, _write

Inherited from Engine.Engine.EngineBaseTimer: invalidate, is_valid, set_nextfire

Inherited from Engine.Engine.EngineBaseTimer (private): _set_engine

Inherited from Worker.DistantWorker: iter_buffers, iter_errors, iter_keys_timeout, iter_node_buffers, iter_node_errors, iter_node_retcodes, iter_retcodes, last_error, last_node, last_read, last_retcode, node_buffer, node_error_buffer, node_rc, num_timeout

Inherited from Worker.DistantWorker (private): _on_node_errline, _on_node_msgline, _on_node_timeout, _on_start

Inherited from Worker.Worker: did_timeout

Inherited from Worker.Worker (private): _invoke, _set_task, _task_bound_check

Inherited from object: __delattr__, __format__, __getattribute__, __hash__, __new__, __reduce__, __reduce_ex__, __repr__, __setattr__, __sizeof__, __str__, __subclasshook__