twisted.application.internet._AbstractClient : API documentation

class documentation

class _AbstractClient(_VolatileDataService): (source)

Known subclasses: twisted.application.internet.SSLClient, twisted.application.internet.TCPClient, twisted.application.internet.UNIXClient, twisted.application.internet.UNIXDatagramClient

View In Hierarchy

Class Variable	`volatile`	list of attribute to remove from pickling.
Instance Variable	`method`	the type of method to call on the reactor, one of TCP, UDP, SSL or UNIX.
Instance Variable	`reactor`	the current running reactor.
Method	`__init__`	Undocumented
Instance Variable	`args`	Undocumented
Instance Variable	`kwargs`	Undocumented
Method	`startService`	Start the service.
Method	`stopService`	Stop the service.
Instance Variable	`_connection`	instance of connection set when the service is started.
Method	`_getConnection`	Wrapper around the appropriate connect method of the reactor.

Inherited from _VolatileDataService:

Method __getstate__ Undocumented

Inherited from Service (via _VolatileDataService):

Instance Variable	`running`	A `boolean` which indicates whether the service is running.
Instance Variable	`name`	A `str` which is the name of the service or `None`.
Instance Variable	`parent`	An `IServiceCollection` which is the parent or `None`.
Method	`setName`	Set the name of the service.
Method	`setServiceParent`	Set the parent of the service. This method is responsible for setting the `parent` attribute on this service (the child service).
Method	`disownServiceParent`	Use this API to remove an `IService` from an `IServiceCollection`.
Method	`privilegedStartService`	Do preparation work for starting the service.

volatile = (source)

overrides twisted.application.internet._VolatileDataService.volatile

list of attribute to remove from pickling.

(type: list)

method = (source)

overridden in twisted.application.internet.SSLClient, twisted.application.internet.TCPClient, twisted.application.internet.UNIXClient, twisted.application.internet.UNIXDatagramClient

the type of method to call on the reactor, one of TCP, UDP, SSL or UNIX.

(type: str)

reactor = (source)

the current running reactor.

(type: a provider of IReactorTCP, IReactorUDP, IReactorSSL or IReactorUnix.)

_connection = (source)

instance of connection set when the service is started.

(type: a provider of twisted.internet.interfaces.IConnector.)

def __init__(self, *args, **kwargs): (source)

Undocumented

args = (source)

Undocumented

kwargs = (source)

Undocumented

def startService(self): (source)

from twisted.application.service.IService

overrides twisted.application.service.Service.startService

Start the service.

def stopService(self): (source)

from twisted.application.service.IService

overrides twisted.application.service.Service.stopService

Stop the service.

Returns a Deferred which is triggered when the service has finished shutting down. If shutting down is immediate, a value can be returned (usually, None). (type: Deferred)

def _getConnection(self): (source)

Wrapper around the appropriate connect method of the reactor.

Returns the port object returned by the connect method. (type: an object providing twisted.internet.interfaces.IConnector.)

API Documentation for Twisted, generated by pydoctor 21.2.0 at 2021-02-28 21:00:42.