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

#include <qhttp.h>

Inheritance diagram for QHttpHeader:

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 QString &str=QString())

	QHttpHeader (QHttpHeaderPrivate &dd, const QHttpHeader &header)

void	setValid (bool)

Protected Attributes
QScopedPointer < QHttpHeaderPrivate >	d_ptr

Detailed Description

The QHttpHeader class contains header information for HTTP.

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 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.

See also: QHttpRequestHeader QHttpResponseHeader

Constructor & Destructor Documentation

QHttpHeader::QHttpHeader ( )

Constructs an empty HTTP header.

References d.

QHttpHeader::QHttpHeader ( const QHttpHeader & header )

Constructs a copy of header.

References d, 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, and parse().

QHttpHeader::~QHttpHeader ( )

virtualdefault

Destructor.

QHttpHeader::QHttpHeader	(	QHttpHeaderPrivate &	dd,
		const QString &	str = `QString()`
	)

protected

References d, and parse().

QHttpHeader::QHttpHeader	(	QHttpHeaderPrivate &	dd,
		const QHttpHeader &	header
	)

protected

References d, and values().

Member Function Documentation

void QHttpHeader::addValue	(	const QString &	key,
		const QString &	value
	)

Adds a new entry with the key and value.

References d.

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.

uint QHttpHeader::contentLength ( ) const

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

See also: setContentLength() hasContentLength()

References value().

Referenced by QHttpPrivate::_q_slotClosed(), and QHttpPrivate::_q_slotReadyRead().

QString QHttpHeader::contentType ( ) const

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

See also: setContentType() hasContentType()

References KviRuntimeInfo::type(), and value().

bool QHttpHeader::hasContentLength ( ) const

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

See also: contentLength() setContentLength()

References hasKey().

Referenced by QHttpPrivate::_q_slotReadyRead().

bool QHttpHeader::hasContentType ( ) const

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

See also: contentType() setContentType()

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.

See also: value() setValue() keys()

References d.

Referenced by QHttpPrivate::_q_slotClosed(), QHttpPrivate::_q_slotReadyRead(), 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.

Referenced by QHttpPrivate::_q_slotReadyRead(), and toString().

QStringList QHttpHeader::keys ( ) const

Returns a list of the keys in the HTTP header.

See also: hasKey()

References d.

int QHttpHeader::majorVersion ( ) const

pure virtual

Returns the major protocol-version of the HTTP header.

Implemented in QHttpRequestHeader, and QHttpResponseHeader.

int QHttpHeader::minorVersion ( ) const

pure virtual

Returns the minor protocol-version of the HTTP header.

Implemented in QHttpRequestHeader, and QHttpResponseHeader.

QHttpHeader & QHttpHeader::operator= ( const QHttpHeader & h )

Assigns h and returns a reference to this http header.

References d, and values().

Referenced by QHttpResponseHeader::operator=(), and QHttpRequestHeader::operator=().

bool QHttpHeader::parse ( const QString & str )

protected

References d, and parseLine().

Referenced by QHttpHeader(), QHttpRequestHeader::QHttpRequestHeader(), and QHttpResponseHeader::QHttpResponseHeader().

bool QHttpHeader::parseLine	(	const QString &	line,
		int	number
	)

protectedvirtual

Reimplemented in QHttpRequestHeader, and QHttpResponseHeader.

References addValue(), and i.

Referenced by parse(), QHttpResponseHeader::parseLine(), and QHttpRequestHeader::parseLine().

void QHttpHeader::removeAllValues ( const QString & key )

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

References d.

void QHttpHeader::removeValue ( const QString & key )

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

See also: value() setValue()

References d.

void QHttpHeader::setContentLength ( int len )

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

See also: contentLength() hasContentLength()

References setValue().

void QHttpHeader::setContentType ( const QString & type )

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

See also: contentType() hasContentType()

References setValue().

void QHttpHeader::setValid ( bool v )

protected

References d, 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.