Package twisted :: Package internet :: Module protocol :: Class Factory
[frames | no frames]

Class Factory

Known Subclasses:
ClientFactory

This is a factory which produces protocols.

By default, buildProtocol will create a protocol of the class given in self.protocol.
Method Summary
  buildProtocol(self, addr)
Create an instance of a subclass of Protocol.
  doStart(self)
Make sure startFactory is called.
  doStop(self)
Make sure stopFactory is called.
  startFactory(self)
This will be called before I begin listening on a Port or Connector.
  stopFactory(self)
This will be called before I stop listening on all Ports/Connectors.

Class Variable Summary
Implements __implemented__ = <implementedBy twisted.internet.protoc...
ClassProvides __providedBy__ = <zope.interface.declarations.ClassProvi...
ClassProvides __provides__ = <zope.interface.declarations.ClassProvide...
bool noisy = True
int numPorts = 0                                                                     
NoneType protocol = None                                                                  

Method Details

buildProtocol(self, addr)

Create an instance of a subclass of Protocol.

The returned instance will handle input on an incoming server connection, and an attribute "factory" pointing to the creating factory.

Override this method to alter how Protocol instances get created.
Parameters:
addr - an object implementing twisted.internet.interfaces.IAddress

doStart(self)

Make sure startFactory is called.

Users should not call this function themselves!

doStop(self)

Make sure stopFactory is called.

Users should not call this function themselves!

startFactory(self)

This will be called before I begin listening on a Port or Connector.

It will only be called once, even if the factory is connected to multiple ports.

This can be used to perform 'unserialization' tasks that are best put off until things are actually running, such as connecting to a database, opening files, etcetera.

stopFactory(self)

This will be called before I stop listening on all Ports/Connectors.

This can be overridden to perform 'shutdown' tasks such as disconnecting database connections, closing files, etc.

It will be called, for example, before an application shuts down, if it was connected to a port. User code should not call this function directly.

Class Variable Details

__implemented__

Type:
Implements
Value:
<implementedBy twisted.internet.protocol.Factory>                      

__providedBy__

Type:
ClassProvides
Value:
<zope.interface.declarations.ClassProvides object at 0x404d5ccc>       

__provides__

Type:
ClassProvides
Value:
<zope.interface.declarations.ClassProvides object at 0x404d5ccc>       

noisy

Type:
bool
Value:
True                                                                   

numPorts

Type:
int
Value:
0                                                                     

protocol

Type:
NoneType
Value:
None                                                                  

Generated by Epydoc 2.1 on Sun Dec 10 22:04:44 2006 http://epydoc.sf.net