class documentation

class twisted.web.http.HTTPClient(basic.LineReceiver): (source)

Known subclasses: twisted.protocols.shoutcast.ShoutcastClient, twisted.web.client.HTTPPageGetter, twisted.web.proxy.ProxyClient, twisted.web.xmlrpc.QueryProtocol

View In Hierarchy

A client for HTTP 1.0.

Notes: You probably want to send a 'Host' header with the name of the site you're connecting to, in order to not break name based virtual hosting.

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 handleResponseEnd The response has been completely received.
Method handleResponsePart 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 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:

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 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 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 LineReceiver):

Instance Variable paused Undocumented
Method pauseProducing Undocumented
Method resumeProducing Undocumented
Method stopProducing Undocumented
length = (source)
The length of the request body in bytes.
(type: int)
firstLine = (source)
Are we waiting for the first header line?
(type: bool)
__buffer = (source)
The buffer that stores the response to the HTTP request.
(type: A BytesIO object.)
_header = (source)
Part or all of an HTTP request header.
(type: bytes)
def sendCommand(self, command, path): (source)

Undocumented

def sendHeader(self, name, value): (source)

Undocumented

def endHeaders(self): (source)

Undocumented

def extractHeader(self, header): (source)

Given a complete HTTP header, extract the field name and value and process the header.

Parametersheadera complete HTTP request header of the form 'field-name: value'. (type: bytes)
def lineReceived(self, line): (source)

Parse the status line and headers for an HTTP request.

ParameterslinePart of an HTTP request header. Request bodies are parsed in HTTPClient.rawDataReceived. (type: bytes)
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.

ParametersreasonUndocumented (type: twisted.python.failure.Failure)
def handleResponseEnd(self): (source)

The response has been completely received.

This callback may be invoked more than once per request.

def handleResponsePart(self, data): (source)
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 handleStatus(self, version, status, message): (source)

Called when the status-line is received.

Parametersversione.g. 'HTTP/1.0'
statuse.g. '200' (type: bytes)
messagee.g. 'OK'
def handleHeader(self, key, val): (source)
def handleEndHeaders(self): (source)

Called when all headers have been received.

def rawDataReceived(self, data): (source)

Override this for when raw data is received.

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