Package x2go :: Module forward :: Class X2GoFwServer

[frames] | no frames]

Class X2GoFwServer

                  object --+        
                           |        
gevent.baseserver.BaseServer --+    
                               |    
      gevent.server.StreamServer --+
                                   |
                                  X2GoFwServer

X2GoFwServer implements a gevent's StreamServer based Paramiko/SSH port forwarding server.

An X2GoFwServer class object is used to tunnel graphical trafic through an external proxy command launched by a X2GoProxy* backend.

Instance Methods

__init__(self, listener, remote_host, remote_port, ssh_transport, session_instance=None, session_name=None, subsystem=None, logger=None, loglevel=56)
x.__init__(...) initializes x; see help(type(x)) for signature

source code

start(self)
Start accepting the connections.

source code

x2go_forward_tunnel_handle(self, fw_socket, address)
Handle for SSH/Paramiko forwarding tunnel.

source code

close_channel(self)
Close an open channel again.

source code

close_socket(self)
Close the forwarding tunnel's socket again.

source code

stop(self)
Stop the forwarding tunnel.

source code

Inherited from gevent.server.StreamServer: do_close, do_read, init_socket, set_listener, wrap_socket_and_handle

Inherited from gevent.baseserver.BaseServer: __repr__, __str__, close, do_handle, full, is_fatal_error, serve_forever, set_handle, set_spawn, start_accepting, stop_accepting

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

Class Methods
Inherited from `gevent.server.StreamServer`: `get_listener`

Class Variables

Inherited from gevent.server.StreamServer: backlog, reuse_addr

Inherited from gevent.baseserver.BaseServer: fatal_errors, max_accept, max_delay, min_delay, stop_timeout

Properties

Inherited from gevent.server.StreamServer: ssl_enabled

Inherited from gevent.baseserver.BaseServer: closed, server_host, server_port, started

Inherited from object: __class__

Method Details

init(self, listener, remote_host, remote_port, ssh_transport, session_instance=None, session_name=None, subsystem=None, logger=None, loglevel=56)
(Constructor)

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

Parameters:

listener (tuple) - listen on TCP/IP socket (<IP>, <Port>)
remote_host (str) - hostname or IP of remote host (in case of X2Go mostly 127.0.0.1)
remote_port (int) - port of remote host
ssh_transport (obj) - a valid Paramiko/SSH transport object
session_instance (obj) - the complete X2GoSession instance of the X2Go session this port forwarding server belongs to. Note: for new X2GoSession instances the object has the session name not yet set(!!!)
session_name (str) - the session name of the X2Go session this port forwarding server belongs to
logger (obj) - you can pass an X2GoLogger object to the X2GoFwServer constructor
loglevel (int) - if no X2GoLogger object has been supplied a new one will be constructed with the given loglevel

Overrides: object.__init__

start(self)

Start accepting the connections.

If an address was provided in the constructor, then also create a socket, bind it and put it into the listening mode.

Overrides: gevent.baseserver.BaseServer.start: (inherited documentation)

x2go_forward_tunnel_handle(self, fw_socket, address)

Handle for SSH/Paramiko forwarding tunnel.

Parameters:

fw_socket (obj) - local end of the forwarding tunnel
address (tuple) - unused/ignored

stop(self)

Stop the forwarding tunnel.

Overrides: gevent.baseserver.BaseServer.stop