twisted.web.http.HTTPClient : API documentation

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

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. (type: `int`)
Instance Variable	firstLine	Are we waiting for the first header line? (type: `bool`)
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. (type: A `StringIO` object.)
Instance Variable	_header	Part or all of an HTTP request header. (type: `bytes`)

Inherited from _PauseableMixin (via LineReceiver):

Method	pauseProducing	Undocumented
Method	resumeProducing	Undocumented
Method	stopProducing	Undocumented

Inherited from _PauseableMixin (via LineReceiver):

Method	pauseProducing	Undocumented
Method	resumeProducing	Undocumented
Method	stopProducing	Undocumented

Inherited from _PauseableMixin (via LineReceiver):

Method	pauseProducing	Undocumented
Method	resumeProducing	Undocumented
Method	stopProducing	Undocumented

Inherited from _PauseableMixin (via LineReceiver):

Method	pauseProducing	Undocumented
Method	resumeProducing	Undocumented
Method	stopProducing	Undocumented

length =

The length of the request body in bytes. (type: int)

firstLine =

Are we waiting for the first header line? (type: bool)

__buffer =

The buffer that stores the response to the HTTP request. (type: A StringIO object.)

_header =

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.

Parameters header a complete HTTP request header of the form 'field-name: value'. (type: bytes)

def lineReceived(self, line): (source)

overrides twisted.protocols.basic.LineReceiver.lineReceived

overridden in twisted.protocols.shoutcast.ShoutcastClient

Parse the status line and headers for an HTTP request.

Parameters line Part of an HTTP request header. Request bodies are parsed in HTTPClient.rawDataReceived. (type: bytes)

def connectionLost(self, reason): (source)

from twisted.internet.interfaces.IProtocol

overrides twisted.internet.protocol.Protocol.connectionLost

overridden in twisted.web.client.HTTPPageGetter, twisted.web.xmlrpc.QueryProtocol

Called when the connection is shut down.

Clear any circular references here, and any external references to this Protocol. The connection has been closed.

def handleResponseEnd(self): (source)

overridden in twisted.web.client.HTTPPageDownloader, twisted.web.proxy.ProxyClient

The response has been completely received.

This callback may be invoked more than once per request.

def handleResponsePart(self, data): (source)

overridden in twisted.web.client.HTTPPageDownloader, twisted.web.proxy.ProxyClient

Undocumented

def connectionMade(self): (source)

from twisted.internet.interfaces.IProtocol

overrides twisted.internet.protocol.BaseProtocol.connectionMade

overridden in twisted.protocols.shoutcast.ShoutcastClient, twisted.web.client.HTTPPageGetter, twisted.web.proxy.ProxyClient, twisted.web.xmlrpc.QueryProtocol

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)

overridden in twisted.web.client.HTTPPageGetter, twisted.web.proxy.ProxyClient, twisted.web.xmlrpc.QueryProtocol

Called when the status-line is received.

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

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

overridden in twisted.protocols.shoutcast.ShoutcastClient, twisted.web.client.HTTPPageGetter, twisted.web.proxy.ProxyClient

Called every time a header is received.

def handleEndHeaders(self): (source)

overridden in twisted.protocols.shoutcast.ShoutcastClient, twisted.web.client.HTTPPageGetter

Called when all headers have been received.

def rawDataReceived(self, data): (source)

overrides twisted.protocols.basic.LineReceiver.rawDataReceived

Override this for when raw data is received.

API Documentation for Twisted, generated by pydoctor at 2017-06-11 10:59:01.

twisted.web.http.HTTPClient(basic.LineReceiver) class documentation

`twisted.web.http.HTTPClient(basic.LineReceiver)` class documentation