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

Class EngineClient

source code

Abstract class EngineClient.

Instance Methods [hide private]
 
__init__(self, worker, timeout, autoclose)
Initializer.		 source code
 
_fire(self)
Fire timeout timer.		 source code
 
_start(self)
Starts client and returns client instance as a convenience.		 source code
 
reader_fileno(self)
Returns the reader file descriptor as an integer.		 source code
 
writer_fileno(self)
Returns the writer file descriptor as an integer.		 source code
 
abort(self)
Stop this client.		 source code
 
_close(self, force, timeout)
Close client.		 source code
 
_set_reading(self)
Set reading state.		 source code
 
_set_writing(self)
Set writing state.		 source code
 
_handle_read(self)
Handle a read notification.		 source code
 
_handle_write(self)
Handle a write notification.		 source code
 
_exec_nonblock(self, commandlist)
Utility method to launch a command with stdin/stdout file descriptors configured in non-blocking mode.		 source code
 
_readlines(self)
Utility method to read client lines		 source code
 
_write(self, buf)
Add some data to be written to the client.		 source code
 
_set_write_eof(self) source code
 
_close_writer(self) source code

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

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

Method Details [hide private]

__init__(self, worker, timeout, autoclose)
(Constructor)

source code 

Initializer. Should be called from derived classes.

Overrides: Engine.Engine.EngineBaseTimer.__init__

_fire(self)

source code 

Fire timeout timer.

Overrides: Engine.Engine.EngineBaseTimer._fire

_start(self)

source code 

Starts client and returns client instance as a convenience. Derived classes must implement.

_close(self, force, timeout)

source code 

Close client. Called by the engine after client has been unregistered. This method should handle all termination types (normal, forced or on timeout). Derived classes must implement.

_handle_read(self)

source code 

Handle a read notification. Called by the engine as the result of an event indicating that a read is available.

_handle_write(self)

source code 

Handle a write notification. Called by the engine as the result of an event indicating that a write can be performed now.


   Trees       Indices       Help   
ClusterShell
Generated by Epydoc 3.0.1 on Wed Nov 4 13:58:05 2009 http://epydoc.sourceforge.net