WebKit.AppServer | index /usr/local/share/webware/WebKit/AppServer.py

`The AppServer singleton.
The `AppServer` singleton is the controlling object/process/thread.
`AppServer` receives requests and dispatches them to `Application`
(via `Application.dispatchRawRequest`).
There is only one instance of AppServer, `globalAppServer` contains
that instance. Use it like:
from WebKit.AppServer import globalAppServer
`ThreadedAppServer` completes the implementation, dispatching
these requests to separate threads. `AppServer`, at least in the
abstract, could support different execution models and environments,
but that support is not yet realized (Will it ever be realized?).
The distinction between `AppServer` and `Application` is somewhat
vague -- both are global singletons and both handle dispatching requests.
`AppServer` works on a lower level, handling sockets and threads.`

Modules
`` |  |
WebKit.Profiler WebUtils | os sys | time |

Classes
`` |  | WebKit.ConfigurableForServerSidePath.ConfigurableForServerSidePath(MiscUtils.Configurable.Configurable) AppServer(WebKit.ConfigurableForServerSidePath.ConfigurableForServerSidePath, WebKit.Object.Object) WebKit.Object.Object(__builtin__.object, MiscUtils.NamedValueAccess.NamedValueAccess) AppServer(WebKit.ConfigurableForServerSidePath.ConfigurableForServerSidePath, WebKit.Object.Object)
class AppServer(WebKit.ConfigurableForServerSidePath.ConfigurableForServerSidePath, WebKit.Object.Object)
`` | `The AppServer singleton. Purpose and usage are explained in the module docstring.`
| Method resolution order: AppServer WebKit.ConfigurableForServerSidePath.ConfigurableForServerSidePath MiscUtils.Configurable.Configurable WebKit.Object.Object __builtin__.object MiscUtils.NamedValueAccess.NamedValueAccess Methods defined here: __init__(self, path=None) `Sets up and starts the `AppServer`. `path` is the working directory for the AppServer (directory in which AppServer is contained, by default) This method loads plugins, creates the Application object, and starts the request handling loop.` application(self) `Return the Application singleton.` checkForInstall(self) `Check whether Webware was installed. Exits with an error message if Webware was not installed. Called from `__init__`.` closeThread(self) `This method is called when the shutdown sequence is initiated.` configFilename(self) `Return the name of the AppServer configuration file.` configReplacementValues(self) `Get config values that need to be escaped.` createApplication(self) `Create and return an application object. Invoked by __init__.` defaultConfig(self) `The default AppServer.config.` initiateShutdown(self) `Ask the master thread to begin the shutdown.` isPersistent(self) `Check whether the AppServer is persistent. When using ``OneShot``, the AppServer will exist only for a single request, otherwise it will stay around indefinitely.` loadPlugIn(self, path) `Load and return the given plug-in. May return None if loading was unsuccessful (in which case this method prints a message saying so). Used by `loadPlugIns` (note the **s**).` loadPlugIns(self) `Load all plug-ins. A plug-in allows you to extend the functionality of WebKit without necessarily having to modify its source. Plug-ins are loaded by AppServer at startup time, just before listening for requests. See the docs in `WebKit.PlugIn` for more info.` numRequests(self) `Return the number of requests. Returns the number of requests received by this app server since it was launched.` plugIn(self, name, default=<class MiscUtils.NoDefault at 0x4842f9bc>) `Return the plug-in with the given name.` plugIns(self) `Return a list of the plug-ins loaded by the app server. Each plug-in is a Python package.` printStartUpMessage(self) `Invoked by __init__, prints a little intro.` readyForRequests(self) `Declare ready for getting requests. Should be invoked by subclasses when they are finally ready to accept requests. Records some stats and prints a message.` recordPID(self) `Save the pid of the AppServer to a file.` serverSidePath(self, path=None) `Return the absolute server-side path of the WebKit app server. If the optional path is passed in, then it is joined with the server side directory to form a path relative to the app server.` shutDown(self) `Shut down the AppServer. Subclasses may override and normally follow this sequence: 1. set self._running = 1 (request to shut down) 2. class specific statements for shutting down 3. Invoke super's shutDown() e.g., ``AppServer.shutDown(self)`` 4. set self._running = 0 (server is completely down)` startTime(self) `Return the time the app server was started. The time is given as seconds, like time().` version(self) `Return WebKit version.` webKitPath(self) `Return teh WebKit path.` webwarePath(self) `Return the Webware path.` Methods inherited from WebKit.ConfigurableForServerSidePath.ConfigurableForServerSidePath: setting(self, name, default=<class MiscUtils.NoDefault at 0x4842f9bc>) `Returns the setting, filtered by serverSidePath(), if the name ends with ``Filename`` or ``Dir``.` Methods inherited from MiscUtils.Configurable.Configurable: commandLineConfig(self) `Return the settings that came from the command-line. These settings come via addCommandLineSetting().` config(self) `Return the configuration of the object as a dictionary. This is a combination of defaultConfig() and userConfig(). This method caches the config.` configName(self) `Return the name of the configuration file without the extension. This is the portion of the config file name before the '.config'. This is used on the command-line.` hasSetting(self, name) `Check whether a configuration setting has been changed.` printConfig(self, dest=None) `Print the configuration to the given destination. The default destionation is stdout. A fixed with font is assumed for aligning the values to start at the same column.` setSetting(self, name, value) `Set a particular configuration setting.` userConfig(self) `Return the user config overrides. These settings can be found in the optional config file. Returns {} if there is no such file. The config filename is taken from configFilename().` Methods inherited from WebKit.Object.Object: deprecated(self, method) `Output a deprecation warning. The implementation of WebKit sometimes invokes this method which prints a warning that the method you are using has been deprecated. This method expects that deprecated methods say so at the beginning of their doc string and terminate that msg with @. For example: DEPRECATED: Class.foo() on 01/24/01 in ver 0.5. Use Class.bar() instead. @ Putting this information in the doc string is important for accuracy in the generated docs. Example call: deprecated(self.foo)` Data descriptors inherited from WebKit.Object.Object: __dict__ `dictionary for instance variables (if defined)` __weakref__ `list of weak references to the object (if defined)` Methods inherited from MiscUtils.NamedValueAccess.NamedValueAccess: handleUnknownSetKey(self, key) hasValueForKey(self, key) `Check whether key is available. Returns true if the key is available, although that does not guarantee that there will not be errors caused by retrieving the key.` hasValueForName(self, keysString) `Check whether name is available.` resetKeyBindings(self) `Rest all key bindings, releasing alreaedy referenced values.` setValueForKey(self, key, value) `Set value for a given key. Suppose key is 'foo'. This method sets the value with the following precedence: 1. Public attributes before private attributes 2. Methods before non-methods More specifically, this method then uses one of the following: @@ 2000-03-04 ce: fill in ... or invokes handleUnknownSetKey().` valueForKey(self, key, default=<class MiscUtils.NoDefault at 0x4842f9bc>) `Get value for given key. Suppose key is 'foo'. This method returns the value with the following precedence: 1. Methods before non-methods 2. Public attributes before private attributes More specifically, this method then returns one of the following: * foo() * _foo() * self.foo * self._foo ... or default, if it was specified, otherwise invokes and returns result of valueForUnknownKey(). Note that valueForUnknownKey() normally returns an exception. See valueForName() which is a more advanced version of this method that allows multiple, qualified keys.` valueForKeySequence(self, listOfKeys, default=None) `Get the value for the given list of keys.` valueForName(self, keysString, default=None) `Get the value for the given keysString. This is the more advanced version of valueForKey(), which can only handle single names. This method can handle 'foo', 'foo1.foo2', 'a.b.c.d', etc. It will traverse dictionaries if needed.` valueForUnknownKey(self, key, default) valuesForNames(self, keys, default=None, defaults=None, forgive=0, includeNames=0) `Get all values for given names. Returns a list of values that match the given keys, each of which is passed through valueForName() and so could be of the form 'a.b.c'. keys and defaults are sequences. default is any kind of object. forgive and includeNames are flags. If default is not None, then it is substituted when a key is not found. Otherwise, if defaults is not None, then it's corresponding/parallel value for the current key is substituted when a key is not found. Otherwise, if forgive is true, then unknown keys simply don't produce any values. Otherwise, if default and defaults are None, and forgive is false, then the unknown keys will probably raise an exception through valueForUnknownKey() although that method can always return a final, default value. if keys is None, then None is returned. If keys is an empty list, then None is returned. Often these last four arguments are specified by key. Examples: names = ['origin.x', 'origin.y', 'size.width', 'size.height'] obj.valuesForNames(names) obj.valuesForNames(names, default=0.0) obj.valuesForNames(names, defaults=[0.0, 0.0, 100.0, 100.0]) obj.valuesForNames(names, forgive=0) @@ 2000-03-04 ce: includeNames is only supported when forgive=1. It should be supported for the other cases. It should be documented. It should be included in the test cases.`

Functions
`` |  | StringIO(...) `StringIO([s]) -- Return a StringIO-like stream for reading or writing` kill(pid) `Kill a process.` main() `Start the Appserver.` stop(*args, **kw) `Stop the AppServer (which may be in a different process).`

Data
`` |  | defaultConfig = {'CheckInterval': 100, 'PidFile': 'appserver.pid', 'PlugInDirs': [], 'PlugIns': [], 'PrintConfigAtStartUp': True, 'Verbose': True} globalAppServer = None