t.w.p.m.NotificationFactory(ClientFactory) : class documentation

Part of twisted.words.protocols.msn View Source View In Hierarchy

Factory for the NotificationClient protocol. This is basically responsible for keeping the state of the client and thus should be used in a 1:1 situation with clients.
Instance Variable contacts An MSNContactList instance reflecting the current contact list -- this is generally kept up to date by the default command handlers.
Instance Variable userHandle The client's userHandle, this is expected to be set by the client and is used by the protocol (for logging in etc).
Instance Variable screenName The client's current screen-name -- this is generally kept up to date by the default command handlers.
Instance Variable password The client's password -- this is (obviously) expected to be set by the client.
Instance Variable passportServer This must point to an msn passport server (the whole URL is required)
Instance Variable status The status of the client -- this is generally kept up to date by the default command handlers

Inherited from ClientFactory:

Method startedConnecting Called when a connection has been started.
Method clientConnectionFailed Called when a connection has failed to connect.
Method clientConnectionLost Called when an established connection is lost.

Inherited from Factory (via ClientFactory):

Class Method forProtocol Create a factory for the given protocol.
Method logPrefix Describe this factory for log messages.
Method doStart Make sure startFactory is called.
Method doStop Make sure stopFactory is called.
Method startFactory This will be called before I begin listening on a Port or Connector.
Method stopFactory This will be called before I stop listening on all Ports/Connectors.
Method buildProtocol Create an instance of a subclass of Protocol.
contacts =
An MSNContactList instance reflecting the current contact list -- this is generally kept up to date by the default command handlers.
userHandle =
The client's userHandle, this is expected to be set by the client and is used by the protocol (for logging in etc).
screenName =
The client's current screen-name -- this is generally kept up to date by the default command handlers.
password =
The client's password -- this is (obviously) expected to be set by the client.
passportServer =
This must point to an msn passport server (the whole URL is required)
status =
The status of the client -- this is generally kept up to date by the default command handlers
API Documentation for Twisted, generated by pydoctor at 2013-11-08 22:07:30.