KDSoapMessage.h

/****************************************************************************
**
** This file is part of the KD Soap library.
**
** SPDX-FileCopyrightText: 2010-2021 Klarälvdalens Datakonsult AB, a KDAB Group company <info@kdab.com>
**
** SPDX-License-Identifier: LGPL-2.1-only OR LGPL-3.0-only OR GPL-2.0-only OR GPL-3.0-only OR LicenseRef-KDAB-KDSoap OR LicenseRef-KDAB-KDSoap-US
**
** Licensees holding valid commercial KD Soap licenses may use this file in
** accordance with the KD Soap Commercial License Agreement provided with
** the Software.
**
** Contact info@kdab.com if any conditions of this licensing are not clear to you.
**
****************************************************************************/
#ifndef KDSOAPMESSAGE_H
#define KDSOAPMESSAGE_H
 
#include <QtCore/QSharedDataPointer>
#include <QtCore/QVariant>
 
#include "KDSoapValue.h"
#include "KDSoapMessageAddressingProperties.h"
 
QT_BEGIN_NAMESPACE
class QString;
QT_END_NAMESPACE
class KDSoapMessageData;
class KDSoapHeaders;
 
class KDSOAP_EXPORT KDSoapMessage : public KDSoapValue
{
public:
    KDSoapMessage();
    ~KDSoapMessage();
 
    KDSoapMessage(const KDSoapMessage &other);
    KDSoapMessage &operator=(const KDSoapMessage &other);
 
    KDSoapMessage &operator=(const KDSoapValue &other);
 
    bool operator==(const KDSoapMessage &other) const;
 
    bool operator!=(const KDSoapMessage &other) const;
 
    void setUse(Use use);
    Use use() const;
 
    void addArgument(const QString &argumentName, const QVariant &argumentValue, const QString &typeNameSpace = QString(),
                     const QString &typeName = QString());
 
    void addArgument(const QString &argumentName, const KDSoapValueList &argumentValueList, const QString &typeNameSpace = QString(),
                     const QString &typeName = QString());
 
    KDSoapValueList &arguments();
 
    const KDSoapValueList &arguments() const;
 
    bool isFault() const;
 
    QString faultAsString() const;
 
    void setFault(bool fault);
 
    void createFaultMessage(const QString &faultCode, const QString &faultText, KDSoap::SoapVersion soapVersion);
 
    void setMessageAddressingProperties(const KDSoapMessageAddressingProperties &map);
 
    bool hasMessageAddressingProperties() const;
 
    KDSoapMessageAddressingProperties messageAddressingProperties() const;
 
private:
    bool isNull() const;
    friend class KDSoapPendingCall;
    friend class KDSoapServerSocket;
    friend class KDSoapMessageWriter;
    QSharedDataPointer<KDSoapMessageData> d;
};
 
class KDSOAP_EXPORT KDSoapHeaders : public QList<KDSoapMessage> // krazy:exclude=dpointer
{
public:
    KDSoapMessage header(const QString &name) const;
 
    KDSoapMessage header(const QString &name, const QString &namespaceUri) const;
};
 
KDSOAP_EXPORT QDebug operator<<(QDebug dbg, const KDSoapMessage &msg);
 
Q_DECLARE_METATYPE(KDSoapMessage)
Q_DECLARE_METATYPE(KDSoapHeaders)
 
#endif // KDSOAPMESSAGE_H