summaryrefslogtreecommitdiffstats
path: root/src/corelib/kernel/qppsobject_p.h
blob: 1095796a13110700860c33c12766b8360ace0f0e (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
/****************************************************************************
 **
 ** Copyright (C) 2013 BlackBerry Limited. All rights reserved.
 ** Contact: http://www.qt-project.org/legal
 **
 ** This file is part of the QtCore 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 Digia.  For licensing terms and
 ** conditions see http://qt.digia.com/licensing.  For further information
 ** use the contact form at http://qt.digia.com/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 2.1 as published by the Free Software
 ** Foundation and appearing in the file LICENSE.LGPL included in the
 ** packaging of this file.  Please review the following information to
 ** ensure the GNU Lesser General Public License version 2.1 requirements
 ** will be met: http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
 **
 ** In addition, as a special exception, Digia gives you certain additional
 ** rights.  These rights are described in the Digia Qt LGPL Exception
 ** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
 **
 ** GNU General Public License Usage
 ** Alternatively, this file may be used under the terms of the GNU
 ** General Public License version 3.0 as published by the Free Software
 ** Foundation and appearing in the file LICENSE.GPL included in the
 ** packaging of this file.  Please review the following information to
 ** ensure the GNU General Public License version 3.0 requirements will be
 ** met: http://www.gnu.org/copyleft/gpl.html.
 **
 **
 ** $QT_END_LICENSE$
 **
 ****************************************************************************/

#ifndef QPPSOBJECT_P_H
#define QPPSOBJECT_P_H

//
//  W A R N I N G
//  -------------
//
// This file is not part of the Qt API.  It exists purely as an
// implementation detail.  This header file may change from version to
// version without notice, or even be removed.
//
// We mean it.
//

#include "qppsattribute_p.h"

#include <QMap>
#include <QObject>
#include <QVariantMap>

QT_BEGIN_NAMESPACE

class QPpsObjectPrivate;

class Q_CORE_EXPORT QPpsObject : public QObject
{
    Q_OBJECT

public:
    enum OpenMode {
        Publish = 1,
        Subscribe = 2,
        PublishSubscribe = Publish | Subscribe,
        Create = 4,
        DeleteContents = 8
    };
    Q_DECLARE_FLAGS(OpenModes, OpenMode)

    explicit QPpsObject(const QString &path, QObject *parent = 0);
    virtual ~QPpsObject();

    int error() const;
    QString errorString() const;

    bool isReadyReadEnabled() const;
    bool isBlocking() const;
    bool setBlocking(bool enable);
    bool isOpen() const;

    bool open(QPpsObject::OpenModes mode = QPpsObject::PublishSubscribe);
    bool close();
    bool remove();

    QByteArray read(bool *ok = 0);
    bool write(const QByteArray &byteArray);

    int writeMessage(const QString &msg, const QVariantMap &dat);
    int writeMessage(const QString &msg, const QString &id, const QVariantMap &dat);

    static QVariantMap decode(const QByteArray &rawData, bool *ok = 0);
    static QPpsAttributeMap decodeWithFlags(const QByteArray &rawData, bool *ok = 0);
    static QPpsAttributeMap decodeWithFlags(const QByteArray &rawData,
                                            QPpsAttribute *objectAttribute, bool *ok = 0);

    static QByteArray encode(const QVariantMap &ppsData, bool *ok = 0);
    static QByteArray encodeMessage(const QString &msg, const QVariantMap &dat, bool *ok = 0);
    static QByteArray encodeMessage(const QString &msg, const QString &id, const QVariantMap &dat,
                                    bool *ok = 0);

    static int sendMessage(const QString &path, const QString &message);
    static int sendMessage(const QString &path, const QVariantMap &message);
    static int sendMessage(const QString &path, const QString &msg, const QVariantMap &dat);
    static int sendMessage(const QString &path, const QByteArray &ppsData);

public Q_SLOTS:
    void setReadyReadEnabled(bool enable);

Q_SIGNALS:
    void readyRead();

private:
    QScopedPointer<QPpsObjectPrivate> d_ptr;
    Q_DECLARE_PRIVATE(QPpsObject)
    Q_DISABLE_COPY(QPpsObject)
};

QT_END_NAMESPACE

#endif // QPPSOBJECT_P_H