twisted.application.app.ApplicationRunner(object) class documentation

Part of twisted.application.app View Source (View In Hierarchy)

Known subclasses: twisted.scripts._twistd_unix.UnixApplicationRunner, twisted.scripts._twistw.WindowsApplicationRunner

An object which helps running an application based on a config object.

Subclass me and implement preApplication and postApplication methods. postApplication generally will want to run the reactor after starting the application.

Instance Variable config The config object, which provides a dict-like interface.
Instance Variable application Available in postApplication, but not preApplication. This is the application object.
Instance Variable profilerFactory Factory for creating a profiler object, able to profile the application if options are set accordingly.
Instance Variable profiler Instance provided by profilerFactory.
Instance Variable loggerFactory Factory for creating object responsible for logging.
Instance Variable logger Instance provided by loggerFactory.
Method __init__ Undocumented
Method run Run the application.
Method startReactor Run the reactor with the given configuration. Subclasses should probably call this from postApplication.
Method preApplication Override in subclass.
Method postApplication Override in subclass.
Method createOrGetApplication Create or load an Application based on the parameters found in the given ServerOptions instance.
config =
The config object, which provides a dict-like interface.
application =
Available in postApplication, but not preApplication. This is the application object.
profilerFactory =
Factory for creating a profiler object, able to profile the application if options are set accordingly.
profiler =
Instance provided by profilerFactory.
loggerFactory =
Factory for creating object responsible for logging.
logger =
Instance provided by loggerFactory.
def __init__(self, config): (source)
Undocumented
def run(self): (source)

Run the application.

def startReactor(self, reactor, oldstdout, oldstderr): (source)

Run the reactor with the given configuration. Subclasses should probably call this from postApplication.

See AlsorunReactorWithLogging
def preApplication(self): (source)
overridden in twisted.scripts._twistd_unix.UnixApplicationRunner, twisted.scripts._twistw.WindowsApplicationRunner

Override in subclass.

This should set up any state necessary before loading and running the Application.

def postApplication(self): (source)
overridden in twisted.scripts._twistd_unix.UnixApplicationRunner, twisted.scripts._twistw.WindowsApplicationRunner

Override in subclass.

This will be called after the application has been loaded (so the application attribute will be set). Generally this should start the application and run the reactor.

def createOrGetApplication(self): (source)

Create or load an Application based on the parameters found in the given ServerOptions instance.

If a subcommand was used, the service.IServiceMaker that it represents will be used to construct a service to be added to a newly-created Application.

Otherwise, an application will be loaded based on parameters in the config.

API Documentation for Twisted, generated by pydoctor at 2017-06-11 10:59:01.