class documentation

class ProxyClient(HTTPClient): (source)

View In Hierarchy

Used by ProxyClientFactory to implement a simple web proxy.
Method __init__ Undocumented
Method connection​Made Called when a connection is made.
Method handle​Header Called every time a header is received.
Method handle​Response​End Finish the original request, indicating that the response has been completely written to it, and disconnect the outgoing transport.
Method handle​Response​Part Undocumented
Method handle​Status Called when the status-line is received.
Instance Variable command Undocumented
Instance Variable data Undocumented
Instance Variable father Undocumented
Instance Variable headers Undocumented
Instance Variable rest Undocumented
Instance Variable _finished A flag which indicates whether or not the original request has been finished yet.

Inherited from HTTPClient:

Method connection​Lost Called when the connection is shut down.
Method end​Headers Undocumented
Method extract​Header Given a complete HTTP header, extract the field name and value and process the header.
Method handle​End​Headers Called when all headers have been received.
Method line​Received Parse the status line and headers for an HTTP request.
Method raw​Data​Received Override this for when raw data is received.
Method send​Command Undocumented
Method send​Header Undocumented
Instance Variable first​Line Are we waiting for the first header line?
Instance Variable length The length of the request body in bytes.
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):

Method clear​Line​Buffer Clear buffered data.
Method data​Received Protocol.dataReceived. Translates bytes into lines, and calls lineReceived (or rawDataReceived, depending on mode.)
Method line​Length​Exceeded Called when the maximum line length has been reached. Override if it needs to be dealt with in some special way.
Method send​Line Sends a line to the other end of the connection.
Method set​Line​Mode Sets the line-mode of this receiver.
Method set​Raw​Mode Sets the raw mode of this receiver. Further data received will be sent to rawDataReceived rather than lineReceived.
Constant 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.
Class Variable delimiter The line-ending delimiter to use. By default this is b'\r\n'.
Instance Variable line​_mode Undocumented
Instance Variable _buffer Undocumented
Instance Variable _busy​Receiving Undocumented

Inherited from Protocol (via HTTPClient, LineReceiver):

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

Inherited from BaseProtocol (via HTTPClient, LineReceiver, Protocol):

Method make​Connection Make a connection to a transport and a server.
Instance Variable connected Undocumented
Instance Variable transport Undocumented

Inherited from _PauseableMixin (via HTTPClient, LineReceiver):

Method pause​Producing Undocumented
Method resume​Producing Undocumented
Method stop​Producing Undocumented
Instance Variable paused Undocumented
def __init__(self, command, rest, version, headers, data, father): (source)

Undocumented

def connectionMade(self): (source)

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 handleHeader(self, key, value): (source)
Called every time a header is received.
def handleResponseEnd(self): (source)
Finish the original request, indicating that the response has been completely written to it, and disconnect the outgoing transport.
def handleResponsePart(self, buffer): (source)
def handleStatus(self, version, code, message): (source)
Called when the status-line is received.
Parameters
versione.g. 'HTTP/1.0'
codeUndocumented
messagee.g. 'OK'
status:bytese.g. '200'
command = (source)

Undocumented

data = (source)

Undocumented

father = (source)

Undocumented

headers = (source)

Undocumented

rest = (source)

Undocumented

_finished: bool = (source)
A flag which indicates whether or not the original request has been finished yet.