twisted.web.client._ReadBodyProtocol : API documentation

class documentation

class twisted.web.client._ReadBodyProtocol(protocol.Protocol): (source)

Protocol that collects data sent to it.

This is a helper for IResponse.deliverBody, which collects the body and fires a deferred with it.

Instance Variable	deferred	See `__init__`.
Instance Variable	status	See `__init__`.
Instance Variable	message	See `__init__`.
Instance Variable	dataBuffer	list of byte-strings received
Method	__init__
Method	dataReceived	Accumulate some more bytes from the response.
Method	connectionLost	Deliver the accumulated response bytes to the waiting `Deferred`, if the response body has been completely received without error.

Inherited from Protocol:

Class Variable	factory	Undocumented
Method	logPrefix	Return a prefix matching the class name, to identify log messages related to this protocol instance.

Inherited from BaseProtocol (via Protocol):

Instance Variable	connected	Undocumented
Instance Variable	transport	Undocumented
Method	makeConnection	Make a connection to a transport and a server.
Method	connectionMade	Called when a connection is made.

deferred = (source)

dataBuffer = (source)

list of byte-strings received

(type: list of bytes)

def __init__(self, status, message, deferred): (source)

Parameters	status	Status of `IResponse`
	message	Message of `IResponse` (type: `bytes`)
	deferred	deferred to fire when response is complete (type: `Deferred` firing with `bytes`)

def dataReceived(self, data): (source)

Accumulate some more bytes from the response.

def connectionLost(self, reason): (source)

Deliver the accumulated response bytes to the waiting Deferred, if the response body has been completely received without error.

API Documentation for Twisted, generated by pydoctor 20.12.1 at 2021-02-28 19:53:36.