qhttpmultipart.h

Go to the documentation of this file.

/****************************************************************************
**
** Copyright (C) 2016 The Qt Company Ltd.
** Contact: https://www.qt.io/licensing/
**
** This file is part of the QtNetwork module of the Qt Toolkit.
**
** $QT_BEGIN_LICENSE:LGPL$
** Commercial License Usage
** Licensees holding valid commercial Qt licenses may use this file in
** accordance with the commercial license agreement provided with the
** Software or, alternatively, in accordance with the terms contained in
** a written agreement between you and The Qt Company. For licensing terms
** and conditions see https://www.qt.io/terms-conditions. For further
** information use the contact form at https://www.qt.io/contact-us.
**
** GNU Lesser General Public License Usage
** Alternatively, this file may be used under the terms of the GNU Lesser
** General Public License version 3 as published by the Free Software
** Foundation and appearing in the file LICENSE.LGPL3 included in the
** packaging of this file. Please review the following information to
** ensure the GNU Lesser General Public License version 3 requirements
** will be met: https://www.gnu.org/licenses/lgpl-3.0.html.
**
** GNU General Public License Usage
** Alternatively, this file may be used under the terms of the GNU
** General Public License version 2.0 or (at your option) the GNU General
** Public license version 3 or any later version approved by the KDE Free
** Qt Foundation. The licenses are as published by the Free Software
** Foundation and appearing in the file LICENSE.GPL2 and LICENSE.GPL3
** included in the packaging of this file. Please review the following
** information to ensure the GNU General Public License requirements will
** be met: https://www.gnu.org/licenses/gpl-2.0.html and
** https://www.gnu.org/licenses/gpl-3.0.html.
**
** $QT_END_LICENSE$
**
****************************************************************************/
 
#ifndef QHTTPMULTIPART_H
#define QHTTPMULTIPART_H
 
#include <QtNetwork/qtnetworkglobal.h>
#include <QtCore/QSharedDataPointer>
#include <QtCore/QByteArray>
#include <QtCore/QIODevice>
#include <QtNetwork/QNetworkRequest>
 
#ifndef Q_OS_WASM
QT_REQUIRE_CONFIG(http);
#endif
 
QT_BEGIN_NAMESPACE
 
 
class QHttpPartPrivate;
class QHttpMultiPart;
 
class Q_NETWORK_EXPORT QHttpPart
{
public:
    QHttpPart();
    QHttpPart(const QHttpPart &other);
    ~QHttpPart();
    QHttpPart &operator=(QHttpPart &&other) noexcept { swap(other); return *this; }
    QHttpPart &operator=(const QHttpPart &other);
 
    void swap(QHttpPart &other) noexcept { d.swap(other.d); }
 
    bool operator==(const QHttpPart &other) const;
    inline bool operator!=(const QHttpPart &other) const
    { return !operator==(other); }
 
    void setHeader(QNetworkRequest::KnownHeaders header, const QVariant &value);
    void setRawHeader(const QByteArray &headerName, const QByteArray &headerValue);
 
    void setBody(const QByteArray &body);
    void setBodyDevice(QIODevice *device);
 
private:
    QSharedDataPointer<QHttpPartPrivate> d;
 
    friend class QHttpMultiPartIODevice;
};
 
Q_DECLARE_SHARED(QHttpPart)
 
class QHttpMultiPartPrivate;
 
class Q_NETWORK_EXPORT QHttpMultiPart : public QObject
{
    Q_OBJECT
 
public:
 
    enum ContentType {
        MixedType,
        RelatedType,
        FormDataType,
        AlternativeType
    };
 
    explicit QHttpMultiPart(QObject *parent = nullptr);
    explicit QHttpMultiPart(ContentType contentType, QObject *parent = nullptr);
    ~QHttpMultiPart();
 
    void append(const QHttpPart &httpPart);
 
    void setContentType(ContentType contentType);
 
    QByteArray boundary() const;
    void setBoundary(const QByteArray &boundary);
 
private:
    Q_DECLARE_PRIVATE(QHttpMultiPart)
    Q_DISABLE_COPY(QHttpMultiPart)
 
    friend class QNetworkAccessManager;
    friend class QNetworkAccessManagerPrivate;
};
 
QT_END_NAMESPACE
 
#endif // QHTTPMULTIPART_H