interface documentation

class IServiceMaker(Interface): (source)

Known implementations: twisted.application.service.ServiceMaker

View In Hierarchy

An object which can be used to construct services in a flexible way.

This interface should most often be implemented along with twisted.plugin.IPlugin, and will most often be used by the 'twistd' command.

Method make​Service Create and return an object providing twisted.application.service.IService.
Attribute description A brief summary of the features provided by this Twisted application plugin.
Attribute options A twisted.python.usage.Options subclass defining the configuration options for this application.
Attribute tapname A short string naming this Twisted plugin, for example 'web' or 'pencil'. This name will be used as the subcommand of 'twistd'.
def makeService(options): (source)
Create and return an object providing twisted.application.service.IService.
Parameters
optionsA mapping (typically a dict or twisted.python.usage.Options instance) of configuration options to desired configuration values.
description = (source)
A brief summary of the features provided by this Twisted application plugin.
options = (source)
A twisted.python.usage.Options subclass defining the configuration options for this application.
tapname = (source)
A short string naming this Twisted plugin, for example 'web' or 'pencil'. This name will be used as the subcommand of 'twistd'.