t.a.s.IServiceMaker(Interface) : interface documentation

Part of twisted.application.service View Source View In Hierarchy

Known implementations: twisted.application.service.ServiceMaker

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.

Attribute	tapname	A short string naming this Twisted plugin, for example 'web' or 'pencil'. This name will be used as the subcommand of 'twistd'.
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.
Method	makeService	Create and return an object providing `twisted.application.service.IService`.

tapname =

A short string naming this Twisted plugin, for example 'web' or 'pencil'. This name will be used as the subcommand of 'twistd'.

description =

A brief summary of the features provided by this Twisted application plugin.

options =

A twisted.python.usage.Options subclass defining the configuration options for this application.

def makeService(options): (source)

Create and return an object providing twisted.application.service.IService.

Parameters options A mapping (typically a dict or twisted.python.usage.Options instance) of configuration options to desired configuration values.

API Documentation for Twisted, generated by pydoctor at 2012-06-04 17:20:01.