Qt 4.8
Public Functions | Properties | Friends | List of all members
QHttpPart Class Reference

The QHttpPart class holds a body part to be used inside a HTTP multipart MIME message. More...

#include <qhttpmultipart.h>

Public Functions

bool operator!= (const QHttpPart &other) const
 Returns true if this object is not the same as other. More...
 
QHttpPartoperator= (const QHttpPart &other)
 Creates a copy of other. More...
 
bool operator== (const QHttpPart &other) const
 Returns true if this object is the same as other (i.e., if they have the same headers and body). More...
 
 QHttpPart ()
 Constructs an empty QHttpPart object. More...
 
 QHttpPart (const QHttpPart &other)
 Creates a copy of other. More...
 
void setBody (const QByteArray &body)
 Sets the body of this MIME part to body. More...
 
void setBodyDevice (QIODevice *device)
 Sets the device to read the content from to device. More...
 
void setHeader (QNetworkRequest::KnownHeaders header, const QVariant &value)
 Sets the value of the known header header to be value, overriding any previously set headers. More...
 
void setRawHeader (const QByteArray &headerName, const QByteArray &headerValue)
 Sets the header headerName to be of value headerValue. More...
 
 ~QHttpPart ()
 Destroys this QHttpPart. More...
 

Properties

QSharedDataPointer< QHttpPartPrivated
 

Friends

class QHttpMultiPartIODevice
 

Detailed Description

The QHttpPart class holds a body part to be used inside a HTTP multipart MIME message.

Since
4.8
Attention
Module: QtNetwork

The QHttpPart class holds a body part to be used inside a HTTP multipart MIME message (which is represented by the QHttpMultiPart class). A QHttpPart consists of a header block and a data block, which are separated by each other by two consecutive new lines. An example for one part would be:

Content-Type: text/plain
Content-Disposition: form-data; name="text"
here goes the body

For setting headers, use setHeader() and setRawHeader(), which behave exactly like QNetworkRequest::setHeader() and QNetworkRequest::setRawHeader().

For reading small pieces of data, use setBody(); for larger data blocks like e.g. images, use setBodyDevice(). The latter method saves memory by not copying the data internally, but reading directly from the device. This means that the device must be opened and readable at the moment when the multipart message containing the body part is sent on the network via QNetworkAccessManager::post().

To construct a QHttpPart with a small body, consider the following snippet (this produces the data shown in the example above):

QHttpPart textPart;
textPart.setHeader(QNetworkRequest::ContentDispositionHeader, QVariant("form-data; name=\"text\""));
textPart.setBody("here goes the body");

To construct a QHttpPart reading from a device (e.g. a file), the following can be applied:

QHttpPart imagePart;
imagePart.setHeader(QNetworkRequest::ContentDispositionHeader, QVariant("form-data; name=\"image\""));
imagePart.setRawHeader("Content-ID", "my@content.id"); // add any headers you like via setRawHeader()
QFile *file = new QFile("image.jpg");
imagePart.setBodyDevice(file);

Be aware that QHttpPart does not take ownership of the device when set, so it is the developer's responsibility to destroy it when it is not needed anymore. A good idea might be to set the multipart message as parent object for the device, as documented at the documentation for QHttpMultiPart.

See also
QHttpMultiPart, QNetworkAccessManager

Definition at line 58 of file qhttpmultipart.h.

Constructors and Destructors

◆ QHttpPart() [1/2]

QHttpPart::QHttpPart ( )

Constructs an empty QHttpPart object.

Definition at line 102 of file qhttpmultipart.cpp.

102  : d(new QHttpPartPrivate)
103 {
104 }
QSharedDataPointer< QHttpPartPrivate > d

◆ QHttpPart() [2/2]

QHttpPart::QHttpPart ( const QHttpPart other)

Creates a copy of other.

Definition at line 109 of file qhttpmultipart.cpp.

109  : d(other.d)
110 {
111 }
QSharedDataPointer< QHttpPartPrivate > d

◆ ~QHttpPart()

QHttpPart::~QHttpPart ( )

Destroys this QHttpPart.

Definition at line 116 of file qhttpmultipart.cpp.

117 {
118  d = 0;
119 }
QSharedDataPointer< QHttpPartPrivate > d

Functions

◆ operator!=()

bool QHttpPart::operator!= ( const QHttpPart other) const
inline

Returns true if this object is not the same as other.

See also
operator==()

Definition at line 66 of file qhttpmultipart.h.

67  { return !operator==(other); }
bool operator==(const QHttpPart &other) const
Returns true if this object is the same as other (i.e., if they have the same headers and body)...

◆ operator=()

QHttpPart & QHttpPart::operator= ( const QHttpPart other)

Creates a copy of other.

Definition at line 124 of file qhttpmultipart.cpp.

125 {
126  d = other.d;
127  return *this;
128 }
QSharedDataPointer< QHttpPartPrivate > d

◆ operator==()

bool QHttpPart::operator== ( const QHttpPart other) const

Returns true if this object is the same as other (i.e., if they have the same headers and body).

See also
operator!=()

Definition at line 136 of file qhttpmultipart.cpp.

137 {
138  return d == other.d || *d == *other.d;
139 }
QSharedDataPointer< QHttpPartPrivate > d

◆ setBody()

void QHttpPart::setBody ( const QByteArray body)

Sets the body of this MIME part to body.

The body set with this method will be used unless the device is set via setBodyDevice(). For a large amount of data (e.g. an image), use setBodyDevice(), which will not copy the data internally.

See also
setBodyDevice()

Definition at line 189 of file qhttpmultipart.cpp.

190 {
191  d->setBody(body);
192 }
void setBody(const QByteArray &newBody)
QSharedDataPointer< QHttpPartPrivate > d

◆ setBodyDevice()

void QHttpPart::setBodyDevice ( QIODevice device)

Sets the device to read the content from to device.

For large amounts of data this method should be preferred over setBody(), because the content is not copied when using this method, but read directly from the device. device must be open and readable. QHttpPart does not take ownership of device, i.e. the device must be closed and destroyed if necessary. if device is sequential (e.g. sockets, but not files), QNetworkAccessManager::post() should be called after device has emitted finished(). For unsetting the device and using data set via setBody(), use "setBodyDevice(0)".

See also
setBody(), QNetworkAccessManager::post()

Definition at line 209 of file qhttpmultipart.cpp.

210 {
211  d->setBodyDevice(device);
212 }
QSharedDataPointer< QHttpPartPrivate > d
void setBodyDevice(QIODevice *device)

◆ setHeader()

void QHttpPart::setHeader ( QNetworkRequest::KnownHeaders  header,
const QVariant value 
)

Sets the value of the known header header to be value, overriding any previously set headers.

See also
QNetworkRequest::KnownHeaders, setRawHeader(), QNetworkRequest::setHeader()

Definition at line 158 of file qhttpmultipart.cpp.

159 {
160  d->setCookedHeader(header, value);
161 }
QSharedDataPointer< QHttpPartPrivate > d
void setCookedHeader(QNetworkRequest::KnownHeaders header, const QVariant &value)

◆ setRawHeader()

void QHttpPart::setRawHeader ( const QByteArray headerName,
const QByteArray headerValue 
)

Sets the header headerName to be of value headerValue.

If headerName corresponds to a known header (see QNetworkRequest::KnownHeaders), the raw format will be parsed and the corresponding "cooked" header will be set as well.

Note: setting the same header twice overrides the previous setting. To accomplish the behaviour of multiple HTTP headers of the same name, you should concatenate the two values, separating them with a comma (",") and set one single raw header.

See also
QNetworkRequest::KnownHeaders, setHeader(), QNetworkRequest::setRawHeader()

Definition at line 176 of file qhttpmultipart.cpp.

177 {
178  d->setRawHeader(headerName, headerValue);
179 }
void setRawHeader(const QByteArray &key, const QByteArray &value)
QSharedDataPointer< QHttpPartPrivate > d

Friends and Related Functions

◆ QHttpMultiPartIODevice

Definition at line 78 of file qhttpmultipart.h.

Properties

◆ d

QSharedDataPointer<QHttpPartPrivate> QHttpPart::d
private

The documentation for this class was generated from the following files: