ldaptor.protocols.ldap.ldifprotocol.LDIF

Package ldaptor :: Package protocols :: Package ldap :: Module ldifprotocol :: Class LDIF

[show private | hide private]

Type LDIF

BaseProtocol --+        
               |        
        Protocol --+    
                   |    
 _PauseableMixin --+    
                   |    
        LineReceiver --+
                       |
              object --+
                       |
                      LDIF

Known Subclasses:: InMemoryLDIFProtocol, LDIFDelta, LDIFDriver, StoreParsedLDIF

Method Summary
	`connectionLost(self, reason)` Called when the connection is shut down.
	`gotEntry(self, obj)`
	`lineReceived(self, line)` Override this for when each line is received.
	`logicalLineReceived(self, line)`
	`parseValue(self, val)`
	`state_HEADER(self, line)`
	`state_IN_ENTRY(self, line)`
	`state_WAIT_FOR_DN(self, line)`
Inherited from object
	`__init__(...)` x.__init__(...) initializes x; see x.__class__.__doc__ for signature
	`__delattr__(...)` x.__delattr__('name') <==> del x.name
	`__getattribute__(...)` x.__getattribute__('name') <==> x.name
	`__hash__(x)` x.__hash__() <==> hash(x)
	`__new__(T, S, ...)` T.__new__(S, ...) -> a new object with type S, a subtype of T
	`__reduce__(...)` helper for pickle
	`__reduce_ex__(...)` helper for pickle
	`__repr__(x)` x.__repr__() <==> repr(x)
	`__setattr__(...)` x.__setattr__('name', value) <==> x.name = value
	`__str__(x)` x.__str__() <==> str(x)
Inherited from LineReceiver
	`clearLineBuffer(self)` Clear buffered data.
	`dataReceived(self, data)` Protocol.dataReceived.
	`lineLengthExceeded(self, line)` Called when the maximum line length has been reached.
	`rawDataReceived(self, data)` Override this for when raw data is received.
	`sendLine(self, line)` Sends a line to the other end of the connection.
	`setLineMode(self, extra)` Sets the line-mode of this receiver.
	`setRawMode(self)` Sets the raw mode of this receiver.

Class Variable Summary
`NoneType`	`data` = None
`str`	`delimiter`: The line-ending delimiter to use.
`NoneType`	`dn` = None
`NoneType`	`lastLine` = None
`str`	`mode` = `'HEADER'`
`NoneType`	`version` = None
Inherited from LineReceiver
`int`	`line_mode` = 1
`int`	`MAX_LENGTH`: The maximum length of a line to allow (If a sent line is longer than this, the connection is dropped).
Inherited from Protocol
`Implements`	`__implemented__` = `<implementedBy twisted.internet.protoc...`
`ClassProvides`	`__provides__` = `<zope.interface.declarations.ClassProvide...`

Method Details

connectionLost(self, reason=<twisted.python.failure.Failure twisted.internet.error.Co...)

Called when the connection is shut down.

Clear any circular references here, and any external references to this Protocol. The connection has been closed.

Parameters:: reason
(type=twisted.python.failure.Failure)

Overrides:: twisted.internet.protocol.Protocol.connectionLost (inherited documentation)

lineReceived(self, line)

Override this for when each line is received.

Overrides:: twisted.protocols.basic.LineReceiver.lineReceived (inherited documentation)

Class Variable Details

data

Type:: NoneType
Value:: None

delimiter

The line-ending delimiter to use. By default this is '\r\n'.

Type:: str
Value:: ''' '''

dn

Type:: NoneType
Value:: None

lastLine

Type:: NoneType
Value:: None

mode

Type:: str
Value:: 'HEADER'

version

Type:: NoneType
Value:: None

Generated by Epydoc 2.1 on Sun Oct 1 10:49:45 2006

http://epydoc.sf.net