PyZMQ Documentation

Table Of Contents

Previous topic

log.handlers

Next topic

ssh.tunnel

This Page

ssh.forward

Module: ssh.forward

Sample script showing how to do local port forwarding over paramiko.

This script connects to the requested SSH server and sets up local port forwarding (the openssh -L option) from a local port through a tunneled connection to a destination reachable from the SSH server machine.

Classes

ForwardServer

class zmq.ssh.forward.ForwardServer(server_address, RequestHandlerClass, bind_and_activate=True)
close_request(request)

Called to clean up an individual request.

fileno()

Return socket file number.

Interface required by select().

finish_request(request, client_address)

Finish one request by instantiating RequestHandlerClass.

get_request()

Get the request and client address from the socket.

May be overridden.

handle_error(request, client_address)

Handle an error gracefully. May be overridden.

The default is to print a traceback and continue.

handle_request()

Handle one request, possibly blocking.

Respects self.timeout.

handle_timeout()

Called if no new request arrives within self.timeout.

Overridden by ForkingMixIn.

process_request(request, client_address)

Start a new thread to process the request.

process_request_thread(request, client_address)

Same as in BaseServer but as a thread.

In addition, exception handling is done here.

serve_forever(poll_interval=0.5)

Handle one request at a time until shutdown.

Polls for shutdown every poll_interval seconds. Ignores self.timeout. If you need to do periodic tasks, do them in another thread.

server_activate()

Called by constructor to activate the server.

May be overridden.

server_bind()

Called by constructor to bind the socket.

May be overridden.

server_close()

Called to clean-up the server.

May be overridden.

shutdown()

Stops the serve_forever loop.

Blocks until the loop has finished. This must be called while serve_forever() is running in another thread, or it will deadlock.

verify_request(request, client_address)

Verify the request. May be overridden.

Return True if we should proceed with this request.

Handler

class zmq.ssh.forward.Handler(request, client_address, server)
finish()
handle()
setup()

Function

zmq.ssh.forward.forward_tunnel(local_port, remote_host, remote_port, transport)