Home       Trees       Indices       Help   
Python X2go
Package x2go :: Module guardian :: Class X2goSessionGuardian
[frames] | no frames]

Class X2goSessionGuardian

source code

        object --+        
                 |        
threading._Verbose --+    
                     |    
      threading.Thread --+
                         |
                        X2goSessionGuardian

X2goSessionGuardian thread controls X2go session threads and their sub-threads (like reverse forwarding tunnels, Paramiko transport threads, etc.). Its main function is to tidy up once a session gets interrupted (SIGTERM, SIGINT).

There is one X2goSessionGuardian for each X2goClient instance (thus: for normal setups there should be _one_ X2goClient and _one_ X2goSessionGuardian in use).

Instance Methods
 
__init__(self, client_instance, auto_update_listsessions_cache=False, auto_update_listdesktops_cache=False, auto_update_sessionregistry=False, auto_register_sessions=False, refresh_interval=5, logger=None, loglevel=56)
x.__init__(...) initializes x; see help(type(x)) for signature		 source code
 
guardian(self)
The handler of this X2goSessionGuardian thread.		 source code
 
stop_thread(self)
Stop this X2goSessionGuardian thread.		 source code

Inherited from threading.Thread: __repr__, getName, isAlive, isDaemon, is_alive, join, run, setDaemon, setName, start

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

Properties

Inherited from threading.Thread: daemon, ident, name

Inherited from object: __class__

Method Details

__init__(self, client_instance, auto_update_listsessions_cache=False, auto_update_listdesktops_cache=False, auto_update_sessionregistry=False, auto_register_sessions=False, refresh_interval=5, logger=None, loglevel=56)
(Constructor)

source code 

x.__init__(...) initializes x; see help(type(x)) for signature

Parameters:
  • auto_update_listsessions_cache (bool) - let X2goSessionGuardian refresh the session list cache for all X2goSession objects
  • auto_update_listdesktops_cache (bool) - let X2goSessionGuardian refresh desktop lists in the session list cache for all X2goSession objects
  • auto_update_sessionregistry (bool) - if set to True the session status will be updated in regular intervals
  • auto_register_sessions (bool) - register new sessions automatically once they appear in the X2go session (e.g. instantiated by another client that is connected to the same X2go server under same user ID)
  • refresh_interval (int) - refresh cache and session registry every <refresh_interval> seconds
  • logger (instance) - you can pass an X2goLogger object to the X2goSessionGuardian constructor
  • loglevel (int) - if no X2goLogger object has been supplied a new one will be constructed with the given loglevel
Overrides: object.__init__

   Home       Trees       Indices       Help   
Python X2go
Generated by Epydoc 3.0.1 on Mon Dec 12 09:31:12 2011 http://epydoc.sourceforge.net