![]() |
KVIrc 5.2.6
Developer APIs
|
The QHttpHeader class contains header information for HTTP. More...
#include <qhttp.h>
Public Member Functions | |
void | addValue (const QString &key, const QString &value) |
QStringList | allValues (const QString &key) const |
uint | contentLength () const |
QString | contentType () const |
bool | hasContentLength () const |
bool | hasContentType () const |
bool | hasKey (const QString &key) const |
bool | isValid () const |
QStringList | keys () const |
virtual int | majorVersion () const =0 |
virtual int | minorVersion () const =0 |
QHttpHeader & | operator= (const QHttpHeader &h) |
QHttpHeader () | |
QHttpHeader (const QHttpHeader &header) | |
QHttpHeader (const QString &str) | |
void | removeAllValues (const QString &key) |
void | removeValue (const QString &key) |
void | setContentLength (int len) |
void | setContentType (const QString &type) |
void | setValue (const QString &key, const QString &value) |
void | setValues (const QList< QPair< QString, QString > > &values) |
virtual QString | toString () const |
QString | value (const QString &key) const |
QList< QPair< QString, QString > > | values () const |
virtual | ~QHttpHeader () |
Protected Member Functions | |
bool | parse (const QString &str) |
virtual bool | parseLine (const QString &line, int number) |
QHttpHeader (QHttpHeaderPrivate &dd, const QHttpHeader &header) | |
QHttpHeader (QHttpHeaderPrivate &dd, const QString &str=QString()) | |
void | setValid (bool) |
Protected Attributes | |
QScopedPointer< QHttpHeaderPrivate > | d_ptr |
The QHttpHeader class contains header information for HTTP.
\obsolete
\inmodule QtNetwork
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:
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.
Some fields are so common that getters and setters are provided for them as a convenient alternative to using \l value() and \l 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.
QHttpHeader::QHttpHeader | ( | ) |
Constructs an empty HTTP header.
References d, d_ptr, and QHttpHeader().
Referenced by addValue(), allValues(), hasKey(), isValid(), keys(), minorVersion(), operator=(), parse(), QHttpHeader(), QHttpHeader(), QHttpHeader(), QHttpHeader(), QHttpHeader(), QHttpRequestHeader::QHttpRequestHeader(), QHttpRequestHeader::QHttpRequestHeader(), QHttpRequestHeader::QHttpRequestHeader(), QHttpRequestHeader::QHttpRequestHeader(), QHttpResponseHeader::QHttpResponseHeader(), QHttpResponseHeader::QHttpResponseHeader(), QHttpResponseHeader::QHttpResponseHeader(), QHttpResponseHeader::QHttpResponseHeader(), removeAllValues(), removeValue(), setValid(), setValue(), setValues(), toString(), value(), values(), and ~QHttpHeader().
QHttpHeader::QHttpHeader | ( | const QHttpHeader & | header | ) |
Constructs a copy of header.
References d, d_ptr, QHttpHeader(), and values().
QHttpHeader::QHttpHeader | ( | const QString & | str | ) |
Constructs a HTTP header for str.
This constructor parses the string str for header fields and adds this information. The str should consist of one or more "\r\n" delimited lines; each of these lines should have the format key, colon, space, value.
References d, d_ptr, parse(), and QHttpHeader().
|
virtualdefault |
Destructor.
References h, QHttpHeader(), value(), and values().
|
protected |
References d, d_ptr, parse(), and QHttpHeader().
|
protected |
References d, d_ptr, QHttpHeader(), and values().
void QHttpHeader::addValue | ( | const QString & | key, |
const QString & | value ) |
Adds a new entry with the key and value.
References d, QHttpHeader(), and value().
Referenced by parseLine(), and setValue().
QStringList QHttpHeader::allValues | ( | const QString & | key | ) | const |
Returns all the entries with the given key. If no entry has this key, an empty string list is returned.
References d, and QHttpHeader().
uint QHttpHeader::contentLength | ( | ) | const |
Returns the value of the special HTTP header field content-length
.
References value().
QString QHttpHeader::contentType | ( | ) | const |
Returns the value of the special HTTP header field content-type
.
References value().
bool QHttpHeader::hasContentLength | ( | ) | const |
Returns true if the header has an entry for the special HTTP header field content-length
; otherwise returns false.
References hasKey().
bool QHttpHeader::hasContentType | ( | ) | const |
Returns true if the header has an entry for the special HTTP header field content-type
; otherwise returns false.
References hasKey().
bool QHttpHeader::hasKey | ( | const QString & | key | ) | const |
Returns true if the HTTP header has an entry with the given key; otherwise returns false.
References d, and QHttpHeader().
Referenced by hasContentLength(), and hasContentType().
bool QHttpHeader::isValid | ( | ) | const |
Returns true if the HTTP header is valid; otherwise returns false.
A QHttpHeader is invalid if it was created by parsing a malformed string.
References d, and QHttpHeader().
Referenced by toString().
QStringList QHttpHeader::keys | ( | ) | const |
|
pure virtual |
Returns the major protocol-version of the HTTP header.
Implemented in QHttpRequestHeader, and QHttpResponseHeader.
|
pure virtual |
Returns the minor protocol-version of the HTTP header.
Implemented in QHttpRequestHeader, and QHttpResponseHeader.
References QHttpHeader().
QHttpHeader & QHttpHeader::operator= | ( | const QHttpHeader & | h | ) |
Assigns h and returns a reference to this http header.
References d, h, and QHttpHeader().
Referenced by QHttpRequestHeader::operator=(), and QHttpResponseHeader::operator=().
|
protected |
References d, parseLine(), and QHttpHeader().
Referenced by QHttpHeader(), QHttpHeader(), QHttpRequestHeader::QHttpRequestHeader(), and QHttpResponseHeader::QHttpResponseHeader().
|
protectedvirtual |
Reimplemented in QHttpRequestHeader, and QHttpResponseHeader.
References addValue(), and i.
Referenced by parse(), QHttpRequestHeader::parseLine(), and QHttpResponseHeader::parseLine().
void QHttpHeader::removeAllValues | ( | const QString & | key | ) |
Removes all the entries with the key key from the HTTP header.
References d, and QHttpHeader().
void QHttpHeader::removeValue | ( | const QString & | key | ) |
Removes the entry with the key key from the HTTP header.
References d, and QHttpHeader().
void QHttpHeader::setContentLength | ( | int | len | ) |
Sets the value of the special HTTP header field content-length
to len.
References setValue().
void QHttpHeader::setContentType | ( | const QString & | type | ) |
Sets the value of the special HTTP header field content-type
to type.
References setValue().
|
protected |
References d, QHttpHeader(), and v.
Referenced by QHttpRequestHeader::QHttpRequestHeader(), QHttpResponseHeader::QHttpResponseHeader(), QHttpRequestHeader::setRequest(), and QHttpResponseHeader::setStatusLine().
void QHttpHeader::setValue | ( | const QString & | key, |
const QString & | value ) |
Sets the value of the entry with the key to value.
If no entry with key exists, a new entry with the given key and value is created. If an entry with the key already exists, the first value is discarded and replaced with the given value.
References addValue(), d, QHttpHeader(), and value().
Referenced by QHttp::get(), QHttp::head(), QHttp::post(), QHttp::post(), setContentLength(), and setContentType().
void QHttpHeader::setValues | ( | const QList< QPair< QString, QString > > & | values | ) |
Sets the header entries to be the list of key value pairs in values.
References d, QHttpHeader(), and values().
|
virtual |
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".
Reimplemented in QHttpRequestHeader, and QHttpResponseHeader.
References d, isValid(), and QHttpHeader().
Referenced by QHttpRequestHeader::toString(), and QHttpResponseHeader::toString().
QString QHttpHeader::value | ( | const QString & | key | ) | const |
Returns the first value for the entry with the given key. If no entry has this key, an empty string is returned.
References d, and QHttpHeader().
Referenced by addValue(), contentLength(), contentType(), setValue(), and ~QHttpHeader().
QList< QPair< QString, QString > > QHttpHeader::values | ( | ) | const |
Returns all the entries in the header.
References d, and QHttpHeader().
Referenced by QHttpAuthenticatorPrivate::parseHttpResponse(), QHttpHeader(), QHttpHeader(), setValues(), and ~QHttpHeader().
|
protected |
Referenced by QHttpHeader(), QHttpHeader(), QHttpHeader(), QHttpHeader(), and QHttpHeader().