Package twisted :: Package coil :: Module app :: Class ConnectorCollection
[frames | no frames]

Class ConnectorCollection

Collection --+        
             |        
   Constrained --+    
                 |    
  ConfigCollection --+
                     |
                    ConnectorCollection


Method Summary
  __init__(self, app)
  __repr__(self)
  __str__(self)
  _getHostPortFromName(self, name)
  _getIndexFromName(self, name)
  delEntity(self, name)
Remove a static reference for 'name'.
  getEntityType(self)
  getStaticEntity(self, name)
Get an entity that was added to me using putEntity.
  nameConstraint(self, name)
A method that determines whether an entity may be added to me with a given name.
  reallyPutEntity(self, name, connector)
Adds a Connector to the Application.
    Inherited from ConfigCollection
  entityConstraint(self, entity)
A method that determines whether an entity may be added to me.
  getNameType(self)
    Inherited from Constrained
  putEntity(self, name, entity)
Store an entity if it meets both constraints.
    Inherited from Collection
  getDynamicEntity(self, name, request)
Subclass this to generate an entity on demand.
  getEntity(self, name, request)
Retrieve an entity from me.
  listDynamicEntities(self, request)
A list of all name, entity that I can generate on demand.
  listDynamicNames(self)
Retrieve a list of the names of entities that I store references to.
  listEntities(self, request)
Retrieve a list of all name, entity pairs I contain.
  listNames(self, request)
Retrieve a list of all names for entities that I contain.
  listStaticEntities(self)
Retrieve a list of all name, entity pairs that I store references to.
  listStaticNames(self)
Retrieve a list of the names of entities that I store references to.
  removeEntity(self, name, request)
Remove an entity for 'name', based on the content of 'request'.
  storeEntity(self, name, request)
Store an entity for 'name', based on the content of 'request'.

Class Variable Summary
class entityType = twisted.internet.interfaces.IConnector

Method Details

delEntity(self, name)

Remove a static reference for 'name'.

Raises a KeyError if the operation fails.
Overrides:
twisted.python.roots.Collection.delEntity (inherited documentation)

getStaticEntity(self, name)

Get an entity that was added to me using putEntity.

This method will return 'None' if it fails.
Overrides:
twisted.python.roots.Collection.getStaticEntity (inherited documentation)

nameConstraint(self, name)

A method that determines whether an entity may be added to me with a given name.

If the constraint is satisfied, return 1; if the constraint is not satisfied, either return 0 or raise a descriptive ConstraintViolation.
Overrides:
twisted.python.roots.Constrained.nameConstraint (inherited documentation)

reallyPutEntity(self, name, connector)

Adds a Connector to the Application.
Overrides:
twisted.python.roots.Constrained.reallyPutEntity

Generated by Epydoc 2.0 on Sat Sep 13 04:20:48 2003 http://epydoc.sf.net