KD SOAP API Documentation  2.1
KDSoapMessage.h
Go to the documentation of this file.
1 /****************************************************************************
2 **
3 ** This file is part of the KD Soap project.
4 **
5 ** SPDX-FileCopyrightText: 2010-2022 Klarälvdalens Datakonsult AB, a KDAB Group company <info@kdab.com>
6 **
7 ** SPDX-License-Identifier: MIT
8 **
9 ****************************************************************************/
10 #ifndef KDSOAPMESSAGE_H
11 #define KDSOAPMESSAGE_H
12 
13 #include <QtCore/QSharedDataPointer>
14 #include <QtCore/QVariant>
15 
17 #include "KDSoapValue.h"
18 
19 QT_BEGIN_NAMESPACE
20 class QString;
21 QT_END_NAMESPACE
22 class KDSoapMessageData;
23 class KDSoapHeaders;
24 
29 {
30 public:
34  KDSoapMessage();
38  ~KDSoapMessage();
39 
43  KDSoapMessage(const KDSoapMessage &other);
47  KDSoapMessage &operator=(const KDSoapMessage &other);
48 
52  KDSoapMessage &operator=(const KDSoapValue &other);
53 
57  bool operator==(const KDSoapMessage &other) const;
58 
62  bool operator!=(const KDSoapMessage &other) const;
63 
68  void setUse(Use use);
72  Use use() const;
73 
90  void addArgument(const QString &argumentName, const QVariant &argumentValue, const QString &typeNameSpace = QString(),
91  const QString &typeName = QString());
92 
108  void addArgument(const QString &argumentName, const KDSoapValueList &argumentValueList, const QString &typeNameSpace = QString(),
109  const QString &typeName = QString());
110 
115  KDSoapValueList &arguments();
116 
121  const KDSoapValueList &arguments() const;
122 
130  bool isFault() const;
131 
135  QString faultAsString() const;
136 
141  void setFault(bool fault);
142 
149  void createFaultMessage(const QString &faultCode, const QString &faultText, KDSoap::SoapVersion soapVersion);
150 
157  void setMessageAddressingProperties(const KDSoapMessageAddressingProperties &map);
158 
164  bool hasMessageAddressingProperties() const;
165 
171  KDSoapMessageAddressingProperties messageAddressingProperties() const;
172 
173 private:
174  bool isNull() const;
175  friend class KDSoapPendingCall;
176  friend class KDSoapServerSocket;
177  friend class KDSoapMessageWriter;
178  QSharedDataPointer<KDSoapMessageData> d;
179 };
180 
185 class KDSOAP_EXPORT KDSoapHeaders : public QList<KDSoapMessage> // krazy:exclude=dpointer
186 {
187 public:
191  KDSoapMessage header(const QString &name) const;
192 
196  KDSoapMessage header(const QString &name, const QString &namespaceUri) const;
197 };
198 
202 KDSOAP_EXPORT QDebug operator<<(QDebug dbg, const KDSoapMessage &msg);
203 
204 Q_DECLARE_METATYPE(KDSoapMessage)
205 Q_DECLARE_METATYPE(KDSoapHeaders)
206 
207 #endif // KDSOAPMESSAGE_H
#define KDSOAP_EXPORT
Definition: KDSoapGlobal.h:22
KDSOAP_EXPORT QDebug operator<<(QDebug dbg, const KDSoapMessage &msg)
bool operator==(const KDSoapValue &other) const
bool isNull() const
Definition: KDSoapValue.cpp:79
KDSoapValue & operator=(const KDSoapValue &other)
Definition: KDSoapValue.h:100
bool operator!=(const KDSoapValue &other) const

© 2010-2022 Klarälvdalens Datakonsult AB (KDAB)
"The Qt, C++ and OpenGL Experts"
https://www.kdab.com/
https://www.kdab.com/development-resources/qt-tools/kd-soap/
Generated on Tue Jun 13 2023 12:18:34 for KD SOAP API Documentation by doxygen 1.9.1