class documentation

class Twist:

View In Hierarchy

Run a Twisted application.

Class Method main Executable entry point for Twist. Processes options and run a twisted reactor with a service.
Static Method options Parse command line options.
Static Method run Run the application service.
Static Method service Create the application service.
Static Method startService Start the application service.
@classmethod
def main(cls, argv: Sequence[str] = sys.argv):

Executable entry point for Twist. Processes options and run a twisted reactor with a service.

Parameters
argv:listCommand line arguments.
@staticmethod
def options(argv: Sequence[str]) -> TwistOptions:

Parse command line options.

Parameters
argv:Sequence[str]Command line arguments.
Returns
TwistOptionsThe parsed options.
@staticmethod
def run(twistOptions: TwistOptions):

Run the application service.

Parameters
twistOptions:TwistOptionsCommand line options to convert to runner arguments.
@staticmethod
def service(plugin: IServiceMaker, options: Options) -> IService:

Create the application service.

Parameters
plugin:IServiceMakerThe name of the plugin that implements the service application to run.
options:OptionsOptions to pass to the application.
Returns
IServiceThe created application service.
@staticmethod
def startService(reactor: IReactorCore, service: IService):

Start the application service.

Parameters
reactor:IReactorCoreThe reactor to run the service with.
service:IServiceThe application service to run.