twisted.web.proxy.ProxyClient : API documentation

class documentation

class twisted.web.proxy.ProxyClient(HTTPClient): (source)

Used by ProxyClientFactory to implement a simple web proxy.

Method	__init__	Undocumented
Instance Variable	father	Undocumented
Instance Variable	command	Undocumented
Instance Variable	rest	Undocumented
Instance Variable	headers	Undocumented
Instance Variable	data	Undocumented
Method	connectionMade	Called when a connection is made.
Method	handleStatus	Called when the status-line is received.
Method	handleHeader	Called every time a header is received.
Method	handleResponsePart	Undocumented
Method	handleResponseEnd	Finish the original request, indicating that the response has been completely written to it, and disconnect the outgoing transport.
Instance Variable	_finished	A flag which indicates whether or not the original request has been finished yet.

Inherited from HTTPClient:

Instance Variable	length	The length of the request body in bytes.
Instance Variable	firstLine	Are we waiting for the first header line?
Method	sendCommand	Undocumented
Method	sendHeader	Undocumented
Method	endHeaders	Undocumented
Method	extractHeader	Given a complete HTTP header, extract the field name and value and process the header.
Method	lineReceived	Parse the status line and headers for an HTTP request.
Method	connectionLost	Called when the connection is shut down.
Method	handleEndHeaders	Called when all headers have been received.
Method	rawDataReceived	Override this for when raw data is received.
Instance Variable	__buffer	The buffer that stores the response to the HTTP request.
Instance Variable	_header	Part or all of an HTTP request header.

Inherited from LineReceiver (via HTTPClient):

Class Variable	delimiter	The line-ending delimiter to use. By default this is `b'\r\n'`.
Class Variable	MAX_LENGTH	The maximum length of a line to allow (If a sent line is longer than this, the connection is dropped). Default is 16384.
Instance Variable	line_mode	Undocumented
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.
Instance Variable	_buffer	Undocumented
Instance Variable	_busyReceiving	Undocumented

Inherited from Protocol (via HTTPClient, LineReceiver):

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 HTTPClient, LineReceiver, Protocol):

Instance Variable	connected	Undocumented
Instance Variable	transport	Undocumented
Method	makeConnection	Make a connection to a transport and a server.

Inherited from _PauseableMixin (via HTTPClient, LineReceiver):

Instance Variable	paused	Undocumented
Method	pauseProducing	Undocumented
Method	resumeProducing	Undocumented
Method	stopProducing	Undocumented

_finished = (source)

A flag which indicates whether or not the original request has been finished yet.

(type: bool)

def __init__(self, command, rest, version, headers, data, father): (source)

Undocumented

father = (source)

Undocumented

command = (source)

Undocumented

rest = (source)

Undocumented

headers = (source)

Undocumented

data = (source)

Undocumented

def connectionMade(self): (source)

from twisted.internet.interfaces.IProtocol

overrides twisted.web.http.HTTPClient.connectionMade

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.

def handleStatus(self, version, code, message): (source)

overrides twisted.web.http.HTTPClient.handleStatus

Called when the status-line is received.

Parameters	version	e.g. 'HTTP/1.0'
	code	Undocumented
	message	e.g. 'OK'
	status	e.g. '200' (type: `bytes`)

def handleHeader(self, key, value): (source)

overrides twisted.web.http.HTTPClient.handleHeader

Called every time a header is received.

def handleResponsePart(self, buffer): (source)

overrides twisted.web.http.HTTPClient.handleResponsePart

Undocumented

def handleResponseEnd(self): (source)

overrides twisted.web.http.HTTPClient.handleResponseEnd

Finish the original request, indicating that the response has been completely written to it, and disconnect the outgoing transport.

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