Home · All Classes · Modules

QHttpHeader Class Reference
^{[QtNetwork module]}

The QHttpHeader class contains header information for HTTP. More...

Inherited by QHttpRequestHeader and QHttpResponseHeader.

Methods

• __init__ (self)
• __init__ (self, QHttpHeader header)
• __init__ (self, QString str)
• addValue (self, QString key, QString value)
• QStringList allValues (self, QString key)
• int contentLength (self)
• QString contentType (self)
• bool hasContentLength (self)
• bool hasContentType (self)
• bool hasKey (self, QString key)
• bool isValid (self)
• QStringList keys (self)
• int majorVersion (self)
• int minorVersion (self)
• bool parse (self, QString str)
• bool parseLine (self, QString line, int number)
• removeAllValues (self, QString key)
• removeValue (self, QString key)
• setContentLength (self, int len)
• setContentType (self, QString type)
• setValid (self, bool)
• setValue (self, QString key, QString value)
• setValues (self, unknown-type values)
• QString toString (self)
• QString value (self, QString key)
• unknown-type values (self)

In most cases you should use the more specialized derivatives of this class, QHttpResponseHeader and QHttpRequestHeader, rather than directly using QHttpHeader.

QHttpHeader provides the HTTP header fields. A HTTP header field consists of a name followed by a colon, a single space, and the field value. (See RFC 1945.) Field names are case-insensitive. A typical header field looks like this:

 content-type: text/html

In the API the header field name is called the "key" and the content is called the "value". You can get and set a header field's value by using its key with value() and setValue(), e.g.

 header.setValue("content-type", "text/html");
 QString contentType = header.value("content-type");

Some fields are so common that getters and setters are provided for them as a convenient alternative to using value() and setValue(), e.g. contentLength() and contentType(), setContentLength() and setContentType().

Each header key has a single value associated with it. If you set the value for a key which already exists the previous value will be discarded.

Method Documentation

QHttpHeader.__init__ (self)

Constructs an empty HTTP header.

QHttpHeader.__init__ (self, QHttpHeader header)

Constructs a copy of header.

QHttpHeader.__init__ (self, QString str)

Constructs a HTTP header for str.

QHttpHeader.addValue (self, QString key, QString value)

Adds a new entry with the key and value.

QStringList QHttpHeader.allValues (self, QString key)

Returns all the entries with the given key. If no entry has this key, an empty string list is returned.

int QHttpHeader.contentLength (self)

Returns the value of the special HTTP header field content-length.

See also setContentLength() and hasContentLength().

QString QHttpHeader.contentType (self)

Returns the value of the special HTTP header field content-type.

See also setContentType() and hasContentType().

bool QHttpHeader.hasContentLength (self)

Returns true if the header has an entry for the special HTTP header field content-length; otherwise returns false.

See also contentLength() and setContentLength().

bool QHttpHeader.hasContentType (self)

Returns true if the header has an entry for the special HTTP header field content-type; otherwise returns false.

See also contentType() and setContentType().

bool QHttpHeader.hasKey (self, QString key)

Returns true if the HTTP header has an entry with the given key; otherwise returns false.

See also value(), setValue(), and keys().

bool QHttpHeader.isValid (self)

Returns true if the HTTP header is valid; otherwise returns false.

A QHttpHeader is invalid if it was created by parsing a malformed string.

QStringList QHttpHeader.keys (self)

Returns a list of the keys in the HTTP header.

See also hasKey().

int QHttpHeader.majorVersion (self)

This method is abstract and should be reimplemented in any sub-class.

Returns the major protocol-version of the HTTP header.

int QHttpHeader.minorVersion (self)

This method is abstract and should be reimplemented in any sub-class.

Returns the minor protocol-version of the HTTP header.

bool QHttpHeader.parse (self, QString str)

bool QHttpHeader.parseLine (self, QString line, int number)

QHttpHeader.removeAllValues (self, QString key)

Removes all the entries with the key key from the HTTP header.

QHttpHeader.removeValue (self, QString key)

Removes the entry with the key key from the HTTP header.

See also value() and setValue().

QHttpHeader.setContentLength (self, int len)

Sets the value of the special HTTP header field content-length to len.

See also contentLength() and hasContentLength().

QHttpHeader.setContentType (self, QString type)

Sets the value of the special HTTP header field content-type to type.

See also contentType() and hasContentType().

QHttpHeader.setValid (self, bool)

QHttpHeader.setValue (self, QString key, QString value)

Sets the value of the entry with the key to value.

See also value(), hasKey(), and removeValue().

QHttpHeader.setValues (self, unknown-type values)

Sets the header entries to be the list of key value pairs in values.

See also values().

QString QHttpHeader.toString (self)

Returns a string representation of the HTTP header.

The string is suitable for use by the constructor that takes a QString. It consists of lines with the format: key, colon, space, value, "\r\n".

QString QHttpHeader.value (self, QString key)

Returns the first value for the entry with the given key. If no entry has this key, an empty string is returned.

See also setValue(), removeValue(), hasKey(), and keys().

unknown-type QHttpHeader.values (self)

Returns all the entries in the header.

See also setValues().