1 /****************************************************************************
2 **
3 ** Copyright (C) 2013 BlackBerry Limited. All rights reserved.
4 ** Contact: https://www.qt.io/licensing/
5 **
6 ** This file is part of the QtCore module of the Qt Toolkit.
7 **
8 ** $QT_BEGIN_LICENSE:LGPL$
9 ** Commercial License Usage
10 ** Licensees holding valid commercial Qt licenses may use this file in
11 ** accordance with the commercial license agreement provided with the
12 ** Software or, alternatively, in accordance with the terms contained in
13 ** a written agreement between you and The Qt Company. For licensing terms
14 ** and conditions see https://www.qt.io/terms-conditions. For further
15 ** information use the contact form at https://www.qt.io/contact-us.
16 **
17 ** GNU Lesser General Public License Usage
18 ** Alternatively, this file may be used under the terms of the GNU Lesser
19 ** General Public License version 3 as published by the Free Software
20 ** Foundation and appearing in the file LICENSE.LGPL3 included in the
21 ** packaging of this file. Please review the following information to
22 ** ensure the GNU Lesser General Public License version 3 requirements
23 ** will be met: https://www.gnu.org/licenses/lgpl-3.0.html.
24 **
25 ** GNU General Public License Usage
26 ** Alternatively, this file may be used under the terms of the GNU
27 ** General Public License version 2.0 or (at your option) the GNU General
28 ** Public license version 3 or any later version approved by the KDE Free
29 ** Qt Foundation. The licenses are as published by the Free Software
30 ** Foundation and appearing in the file LICENSE.GPL2 and LICENSE.GPL3
31 ** included in the packaging of this file. Please review the following
32 ** information to ensure the GNU General Public License requirements will
33 ** be met: https://www.gnu.org/licenses/gpl-2.0.html and
34 ** https://www.gnu.org/licenses/gpl-3.0.html.
35 **
36 ** $QT_END_LICENSE$
37 **
38 ****************************************************************************/
39 
40 #ifndef QPPSOBJECT_P_H
41 #define QPPSOBJECT_P_H
42 
43 //
44 //  W A R N I N G
45 //  -------------
46 //
47 // This file is not part of the Qt API.  It exists purely as an
48 // implementation detail.  This header file may change from version to
49 // version without notice, or even be removed.
50 //
51 // We mean it.
52 //
53 
54 #include "qppsattribute_p.h"
55 
56 #include <QMap>
57 #include <QObject>
58 #include <QVariantMap>
59 
60 QT_BEGIN_NAMESPACE
61 
62 class QPpsObjectPrivate;
63 
64 class Q_CORE_EXPORT QPpsObject : public QObject
65 {
66     Q_OBJECT
67 
68 public:
69     enum OpenMode {
70         Publish = 1,
71         Subscribe = 2,
72         PublishSubscribe = Publish | Subscribe,
73         Create = 4,
74         DeleteContents = 8
75     };
76     Q_DECLARE_FLAGS(OpenModes, OpenMode)
77 
78     explicit QPpsObject(const QString &path, QObject *parent = 0);
79     virtual ~QPpsObject();
80 
81     int error() const;
82     QString errorString() const;
83 
84     bool isReadyReadEnabled() const;
85     bool isBlocking() const;
86     bool setBlocking(bool enable);
87     bool isOpen() const;
88 
89     bool open(QPpsObject::OpenModes mode = QPpsObject::PublishSubscribe);
90     bool close();
91     bool remove();
92 
93     QByteArray read(bool *ok = 0);
94     bool write(const QByteArray &byteArray);
95 
96     int writeMessage(const QString &msg, const QVariantMap &dat);
97     int writeMessage(const QString &msg, const QString &id, const QVariantMap &dat);
98 
99     static QVariantMap decode(const QByteArray &rawData, bool *ok = 0);
100     static QPpsAttributeMap decodeWithFlags(const QByteArray &rawData, bool *ok = 0);
101     static QPpsAttributeMap decodeWithFlags(const QByteArray &rawData,
102                                             QPpsAttribute *objectAttribute, bool *ok = 0);
103 
104     static QByteArray encode(const QVariantMap &ppsData, bool *ok = 0);
105     static QByteArray encodeMessage(const QString &msg, const QVariantMap &dat, bool *ok = 0);
106     static QByteArray encodeMessage(const QString &msg, const QString &id, const QVariantMap &dat,
107                                     bool *ok = 0);
108 
109     static int sendMessage(const QString &path, const QString &message);
110     static int sendMessage(const QString &path, const QVariantMap &message);
111     static int sendMessage(const QString &path, const QString &msg, const QVariantMap &dat);
112     static int sendMessage(const QString &path, const QByteArray &ppsData);
113 
114 public Q_SLOTS:
115     void setReadyReadEnabled(bool enable);
116 
117 Q_SIGNALS:
118     void readyRead();
119 
120 private:
121     Q_DECLARE_PRIVATE(QPpsObject)
122     Q_DISABLE_COPY_MOVE(QPpsObject)
123 };
124 
125 QT_END_NAMESPACE
126 
127 #endif // QPPSOBJECT_P_H
128