Home       Trees       Indices       Help   
ClusterShell
Package ClusterShell :: Package Worker :: Module EngineClient :: Class EngineClientStreamDict
[hide private]
[frames] | no frames]

Class EngineClientStreamDict

source code

EngineClient's named stream dictionary.

Instance Methods [hide private]
 
set_stream(self, sname, sfile=None, evmask=0, retain=True, closefd=True)
Set stream based on file object or file descriptor.		 source code
 
set_reader(self, sname, sfile=None, retain=True, closefd=True)
Set readable stream based on file object or file descriptor.		 source code
 
set_writer(self, sname, sfile=None, retain=True, closefd=True)
Set writable stream based on file object or file descriptor.		 source code
 
destroy(self, key)
Close file object and remove it from this pool.		 source code
 
__delitem__(self, key)
del x[y]		 source code
None
clear(self)
Clear File Pool		 source code
 
active_readers(self)
Get an iterator on readable streams (with fd set).		 source code
 
readers(self)
Get an iterator on all streams setup as readable.		 source code
 
active_writers(self)
Get an iterator on writable streams (with fd set).		 source code
 
writers(self)
Get an iterator on all streams setup as writable.		 source code
 
retained(self)
Check whether this set of streams is retained.		 source code

Inherited from dict: __cmp__, __contains__, __eq__, __ge__, __getattribute__, __getitem__, __gt__, __init__, __iter__, __le__, __len__, __lt__, __ne__, __new__, __repr__, __setitem__, __sizeof__, copy, fromkeys, get, has_key, items, iteritems, iterkeys, itervalues, keys, pop, popitem, setdefault, update, values, viewitems, viewkeys, viewvalues

Inherited from object: __delattr__, __format__, __reduce__, __reduce_ex__, __setattr__, __str__, __subclasshook__

Class Variables [hide private]

Inherited from dict: __hash__

Properties [hide private]

Inherited from object: __class__

Method Details [hide private]

set_stream(self, sname, sfile=None, evmask=0, retain=True, closefd=True)

source code 

Set stream based on file object or file descriptor.

This method can be used to add a stream or update its parameters.

__delitem__(self, key)
(Index deletion operator)

source code 

del x[y]

Overrides: dict.__delitem__
(inherited documentation)

clear(self)

source code 

Clear File Pool

Returns: None
Overrides: dict.clear

retained(self)

source code  
Check whether this set of streams is retained.

Note on retain: an active stream with retain=True keeps the
engine client alive. When only streams with retain=False
remain, the engine client terminates.

Return:
    True -- when at least one stream is retained
    False -- when no retainable stream remain

   Home       Trees       Indices       Help   
ClusterShell
Generated by Epydoc 3.0.1 on Wed Dec 21 14:07:55 2016 http://epydoc.sourceforge.net