flup.server.ajp_fork - ajp - an AJP 1.3/WSGI gateway (forking)

ajp - an AJP 1.3/WSGI gateway.

copyright:

Copyright (c) 2005, 2006 Allan Saddi <allan@saddi.com> All rights reserved.

license:

Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:

  1. Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
  2. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.

THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS AS IS AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

For more information about AJP and AJP connectors for your web server, see http://jakarta.apache.org/tomcat/connectors-doc/.

For more information about the Web Server Gateway Interface, see http://www.python.org/peps/pep-0333.html.

Example usage:

#!/usr/bin/env python import sys from myapplication import app # Assume app is your WSGI application object from ajp import WSGIServer ret = WSGIServer(app).run() sys.exit(ret and 42 or 0)

See the documentation for WSGIServer for more information.

About the bit of logic at the end: Upon receiving SIGHUP, the python script will exit with status code 42. This can be used by a wrapper script to determine if the python script should be re-run. When a SIGINT or SIGTERM is received, the script exits with status code 0, possibly indicating a normal exit.

Example wrapper script:

1
2
3
4
5
6
#!/bin/sh
STATUS=42
while test $STATUS -eq 42; do
  python "$@" that_script_above.py
  STATUS=$?
done

Example workers.properties (for mod_jk):

worker.list=foo
worker.foo.port=8009
worker.foo.host=localhost
worker.foo.type=ajp13

Example httpd.conf (for mod_jk):

JkWorkersFile /path/to/workers.properties
JkMount /* foo

Note that if you mount your ajp application anywhere but the root (“/”), you SHOULD specifiy scriptName to the WSGIServer constructor. This will ensure that SCRIPT_NAME/PATH_INFO are correctly deduced.

class flup.server.ajp_fork.WSGIServer(application, scriptName='', environ=None, bindAddress=('localhost', 8009), allowedServers=None, loggingLevel=20, debug=False, timeout=None, **kw)

AJP1.3/WSGI server. Runs your WSGI application as a persistant program that understands AJP1.3. Opens up a TCP socket, binds it, and then waits for forwarded requests from your webserver.

Why AJP? Two good reasons are that AJP provides load-balancing and fail-over support. Personally, I just wanted something new to implement. :)

Of course you will need an AJP1.3 connector for your webserver (e.g. mod_jk) - see http://jakarta.apache.org/tomcat/connectors-doc/.

error(request)

Override to provide custom error handling. Ideally, however, all errors should be caught at the application level.

handler(request)

WSGI handler. Sets up WSGI environment, calls the application, and sends the application’s response.

inputStreamShrinkThreshold = 94208
requestClass

alias of Request

run()

Main loop. Call this after instantiating WSGIServer. SIGHUP, SIGINT, SIGQUIT, SIGTERM cause it to cleanup and return. (If a SIGHUP is caught, this method returns True. Returns False otherwise.)

Previous topic

flup.server.ajp - ajp - an AJP 1.3/WSGI gateway (threaded)

Next topic

flup.server.cgi

This Page