Package twisted :: Package web :: Module http :: Class HTTPChannel
[show private | hide private]
[frames | no frames]

Class HTTPChannel

BaseProtocol --+        
               |        
        Protocol --+    
                   |    
 _PauseableMixin --+    
                   |    
        LineReceiver --+
                       |
        TimeoutMixin --+
                       |
                      HTTPChannel

Known Subclasses:
RTSPChannel

A receiver for HTTP requests.
Method Summary
  __init__(self)
  allContentReceived(self)
  allHeadersReceived(self)
  checkPersistence(self, request, version)
Check if the channel should close or not.
  connectionLost(self, reason)
  connectionMade(self)
Called when a connection is made.
  headerReceived(self, line)
Do pre-processing (for content-length) and store this header away.
  lineReceived(self, line)
Override this for when each line is received.
  rawDataReceived(self, data)
Override this for when raw data is received.
  requestDone(self, request)
Called by first request in queue when it is done.
  timeoutConnection(self)
Called when the connection times out.
    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.
  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.
    Inherited from TimeoutMixin
  callLater(self, period, func)
  resetTimeout(self)
Reset the timeout count down
  setTimeout(self, period)
Change the timeout period

Class Variable Summary
int length = 0                                                                     
int maxHeaders = 500                                                                   
int persistent = 1                                                                     
classobj requestFactory = twisted.web.http.Request
    Inherited from LineReceiver
str delimiter: The line-ending delimiter to use.
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...
    Inherited from TimeoutMixin
NoneType timeOut: The number of seconds after which to timeout the connection.

Method Details

checkPersistence(self, request, version)

Check if the channel should close or not.

connectionMade(self)

Called when a connection is made.

This may be considered the initializer of the protocol, because it is called when the connection is completed. For clients, this is called once the connection to the server has been established; for servers, this is called after an accept() call stops blocking and a socket has been received. If you need to send any greeting or initial message, do it here.
Overrides:
twisted.internet.protocol.BaseProtocol.connectionMade (inherited documentation)

headerReceived(self, line)

Do pre-processing (for content-length) and store this header away.

lineReceived(self, line)

Override this for when each line is received.
Overrides:
twisted.protocols.basic.LineReceiver.lineReceived (inherited documentation)

rawDataReceived(self, data)

Override this for when raw data is received.
Overrides:
twisted.protocols.basic.LineReceiver.rawDataReceived (inherited documentation)

requestDone(self, request)

Called by first request in queue when it is done.

timeoutConnection(self)

Called when the connection times out. Override to define behavior other than dropping the connection.
Overrides:
twisted.protocols.policies.TimeoutMixin.timeoutConnection (inherited documentation)

Class Variable Details

length

Type:
int
Value:
0                                                                     

maxHeaders

Type:
int
Value:
500                                                                   

persistent

Type:
int
Value:
1                                                                     

Generated by Epydoc 2.1 on Sun Oct 26 16:38:51 2008 http://epydoc.sf.net