twisted.protocols.http.HTTPChannel

Package twisted :: Package protocols :: Module http :: Class HTTPChannel

[show private | hide private]

Class HTTPChannel

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

Known Subclasses:: Proxy, ReverseProxy

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.
	`clearLineBuffer(self)` Clear buffered data. (inherited from `LineReceiver`)
	`connectionFailed(self)` (Deprecated) (inherited from `Protocol`)
	`connectionLost(self, reason)` Called when the connection is shut down.
	`connectionMade(self)` Called when a connection is made.
	`dataReceived(self, data)` Protocol.dataReceived. (inherited from `LineReceiver`)
	`headerReceived(self, line)` Do pre-processing (for content-length) and store this header away.
	`lineLengthExceeded(self, line)` Called when the maximum line length has been reached. (inherited from `LineReceiver`)
	`lineReceived(self, line)` Override this for when each line is received.
	`makeConnection(self, transport)` Make a connection to a transport and a server. (inherited from `BaseProtocol`)
	`rawDataReceived(self, data)` Override this for when raw data is received.
	`requestDone(self, request)` Called by first request in queue when it is done.
	`resetTimeout(self)` Reset the timeout count down (inherited from `TimeoutMixin`)
	`sendLine(self, line)` Sends a line to the other end of the connection. (inherited from `LineReceiver`)
	`setLineMode(self, extra)` Sets the line-mode of this receiver. (inherited from `LineReceiver`)
	`setRawMode(self)` Sets the raw mode of this receiver. (inherited from `LineReceiver`)
	`setTimeout(self, period)` Change the timeout period (inherited from `TimeoutMixin`)
	`timeoutConnection(self)` Called when the connection times out.
	`_TimeoutMixin__timedOut(self)` (inherited from `TimeoutMixin`)

Class Variable Summary
`int`	`length`
`int`	`persistent`
`class`	`Request`
`int`	`timeOut`
`NoneType`	`_HTTPChannel__content`
`int`	`_HTTPChannel__first_line`
`str`	`_HTTPChannel__header`
`NoneType`	`_savedTimeOut`

Method Details

checkPersistence(self, request, version)

Check if the channel should close or not.

connectionLost(self, reason)

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)

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:

persistent

Type:

int

Value:

Request

Request = twisted.protocols.http.Request

timeOut

Type:

int

Value:

_HTTPChannel__content

Type:

NoneType

Value:

None

_HTTPChannel__first_line

Type:

int

Value:

_HTTPChannel__header

Type:

str

Value:

''

_savedTimeOut

Type:

NoneType

Value:

None

Generated by Epydoc 1.1 on Fri Jun 27 03:48:29 2003

http://epydoc.sf.net