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

`OneShotAppServer
This version of the app server is in support of the OneShot adapter.
This class creates an application that has no session sweeper thread,
and it provides the convenience method dispatchRawRequest().
See also: OneShot.cgi and OneShotAdapter.py.`

Classes

``

WebKit.AppServer.AppServer(WebKit.ConfigurableForServerSidePath.ConfigurableForServerSidePath)
  OneShotAppServer

class OneShotAppServer(WebKit.AppServer.AppServer)

``

Method resolution order:
  OneShotAppServer
  WebKit.AppServer.AppServer
  WebKit.ConfigurableForServerSidePath.ConfigurableForServerSidePath
  MiscUtils.Configurable.Configurable
  __builtin__.object

Methods defined here:

__init__(self, path=None)

createApplication(self)

dispatchRawRequest(self, newRequestDict, strmOut)

isPersistent(self)

recordPID(self)

Methods inherited from WebKit.AppServer.AppServer:

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.`

defaultConfig(self)
  `The default AppServer.config.`

initiateShutdown(self)
  `Ask the master thread to begin the shutdown.`

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'>)
  `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.`

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'>)
  `Return setting, using the server side path when indicated.
  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 destination 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().`

Data descriptors inherited from MiscUtils.Configurable.Configurable:

__dict__
  `dictionary for instance variables (if defined)`

__weakref__
  `list of weak references to the object (if defined)`