t.w.c.h.HTTPClientProtocol(LineReceiver, TimeoutMixin, object) : class documentation

Part of twisted.web2.client.http View Source View In Hierarchy

A HTTP 1.1 Client with request pipelining support.
Method __init__
Method lineReceived Override this for when each line is received.
Method rawDataReceived Override this for when raw data is received.
Method submitRequest
Method requestWriteFinished Undocumented
Method requestReadFinished Undocumented
Method setReadPersistent Undocumented
Method connectionLost Called when the connection is shut down.

Inherited from LineReceiver:

Method clearLineBuffer Clear buffered data.
Method dataReceived Protocol.dataReceived. Translates bytes into lines, and calls lineReceived (or rawDataReceived, depending on mode.)
Method setLineMode Sets the line-mode of this receiver.
Method setRawMode Sets the raw mode of this receiver. Further data received will be sent to rawDataReceived rather than lineReceived.
Method sendLine Sends a line to the other end of the connection.
Method lineLengthExceeded Called when the maximum line length has been reached. Override if it needs to be dealt with in some special way.

Inherited from BaseProtocol (via LineReceiver, Protocol):

Method makeConnection Make a connection to a transport and a server.
Method connectionMade Called when a connection is made.

Inherited from _PauseableMixin (via LineReceiver):

Method pauseProducing Undocumented
Method resumeProducing Undocumented
Method stopProducing Undocumented

Inherited from TimeoutMixin:

Method callLater Undocumented
Method resetTimeout Reset the timeout count down
Method setTimeout Change the timeout period
Method timeoutConnection Called when the connection times out. Override to define behavior other than dropping the connection.
Method __timedOut Undocumented
def __init__(self, manager=None): (source)
ParametersmanagerThe object this client reports it state to. (type: IHTTPClientManager )
def lineReceived(self, line): (source)
Override this for when each line is received.
def rawDataReceived(self, data): (source)
Override this for when raw data is received.
def submitRequest(self, request, closeAfter=True): (source)
ParametersrequestThe request to send to a remote server. (type: ClientRequest )
closeAfterIf True the 'Connection: close' header will be sent, otherwise 'Connection: keep-alive' (type: bool )
ReturnsA Deferred which will be called back with the twisted.web2.http.Response from the server. (type: twisted.internet.defer.Deferred )
def requestWriteFinished(self, request): (source)
def requestReadFinished(self, request): (source)
def setReadPersistent(self, persist): (source)
def connectionLost(self, reason): (source)

Called when the connection is shut down.

Clear any circular references here, and any external references to this Protocol. The connection has been closed.
Parametersreason (type: twisted.python.failure.Failure )
API Documentation for Twisted, generated by pydoctor at 2011-10-27 15:57:47.