Package ClusterShell :: Package Engine :: Module Engine :: Class Engine

[frames] | no frames]

Class Engine

source code

Interface for ClusterShell engine. Subclasses have to implement a runloop listening for client events.

Instance Methods

[hide private]

__init__(self, info)
Initialize base class.

source code

clients(self)
Get a copy of clients set.

source code

add(self, client)
Add a client to engine.

source code

remove(self, client, did_timeout=False)
Remove a client from engine.

source code

clear(self, did_timeout=False)
Remove all clients.

source code

unregister_writer(self, client)

source code

unregister(self, client)
Unregister a client.

source code

modify(self, client, set, clear)
Modify the next loop interest events bitset for a client.

source code

set_events(self, client, new_events)
Set the active interest events bitset for a client.

source code

add_timer(self, timer)
Add engine timer.

source code

remove_timer(self, timer)
Remove engine timer.

source code

fire_timers(self)
Fire expired timers for processing.

source code

start_all(self)
Start and register all possible clients, in respect of task fanout.

source code

run(self, timeout)
Run engine in calling thread.

source code

runloop(self, timeout)
Engine specific run loop.

source code

abort(self, kill)
Abort runloop.

source code

join(self)
Block calling thread until runloop has finished.

source code

_debug(self, s)

source code

Class Variables

[hide private]

E_READABLE = 1

E_WRITABLE = 2

E_ANY = 3

Method Details

[hide private]

add(self, client)

source code

Add a client to engine. Subclasses that override this method should call base class method.

remove(self, client, did_timeout=False)

source code

Remove a client from engine. Subclasses that override this method should call base class method.

clear(self, did_timeout=False)

source code

Remove all clients. Subclasses that override this method should call base class method.

register(self, client)

source code

unregister(self, client)

source code

Unregister a client. Subclasses that override this method should call base class method.

runloop(self, timeout)

source code

Engine specific run loop. Derived classes must implement.