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
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
|
/*
* Copyright (C) 2014 Aaron Seigo <aseigo@kde.org>
*
* This library is free software; you can redistribute it and/or
* modify it under the terms of the GNU Lesser General Public
* License as published by the Free Software Foundation; either
* version 2.1 of the License, or (at your option) version 3, or any
* later version accepted by the membership of KDE e.V. (or its
* successor approved by the membership of KDE e.V.), which shall
* act as a proxy defined in Section 6 of version 3 of the license.
*
* This library is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
* Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public
* License along with this library. If not, see <http://www.gnu.org/licenses/>.
*/
#pragma once
#include "sink_export.h"
#include <QLocalSocket>
#include <QObject>
#include <QTimer>
#include <KAsync/Async>
#include <flatbuffers/flatbuffers.h>
#include "notification.h"
#include "flush.h"
#include "query.h"
#include "log.h"
namespace Sink {
struct QueuedCommand;
class SINK_EXPORT ResourceAccessInterface : public QObject
{
Q_OBJECT
public:
typedef QSharedPointer<ResourceAccessInterface> Ptr;
ResourceAccessInterface()
{
}
virtual ~ResourceAccessInterface()
{
}
virtual KAsync::Job<void> sendCommand(int commandId) = 0;
virtual KAsync::Job<void> sendCommand(int commandId, flatbuffers::FlatBufferBuilder &fbb) = 0;
virtual KAsync::Job<void> synchronizeResource(const Sink::QueryBase &filter) = 0;
virtual KAsync::Job<void> sendCreateCommand(const QByteArray &uid, const QByteArray &resourceBufferType, const QByteArray &buffer)
{
return KAsync::null<void>();
};
virtual KAsync::Job<void> sendModifyCommand(const QByteArray &uid, qint64 revision, const QByteArray &resourceBufferType, const QByteArrayList &deletedProperties, const QByteArray &buffer, const QByteArrayList &changedProperties, const QByteArray &newResource, bool remove)
{
return KAsync::null<void>();
};
virtual KAsync::Job<void> sendDeleteCommand(const QByteArray &uid, qint64 revision, const QByteArray &resourceBufferType)
{
return KAsync::null<void>();
};
virtual KAsync::Job<void> sendRevisionReplayedCommand(qint64 revision)
{
return KAsync::null<void>();
};
virtual KAsync::Job<void>
sendInspectionCommand(int inspectionType, const QByteArray &inspectionId, const QByteArray &domainType, const QByteArray &entityId, const QByteArray &property, const QVariant &expecedValue)
{
return KAsync::null<void>();
};
virtual KAsync::Job<void> sendFlushCommand(int flushType, const QByteArray &flushId)
{
return KAsync::null<void>();
}
int getResourceStatus() const
{
return mResourceStatus;
}
signals:
void ready(bool isReady);
void revisionChanged(qint64 revision);
void notification(Notification notification);
public slots:
virtual void open() = 0;
virtual void close() = 0;
protected:
int mResourceStatus;
};
class SINK_EXPORT ResourceAccess : public ResourceAccessInterface
{
Q_OBJECT
SINK_DEBUG_AREA("communication")
public:
typedef QSharedPointer<ResourceAccess> Ptr;
ResourceAccess(const QByteArray &resourceInstanceIdentifier, const QByteArray &resourceType);
~ResourceAccess();
QByteArray resourceName() const;
bool isReady() const;
KAsync::Job<void> sendCommand(int commandId) Q_DECL_OVERRIDE;
KAsync::Job<void> sendCommand(int commandId, flatbuffers::FlatBufferBuilder &fbb) Q_DECL_OVERRIDE;
KAsync::Job<void> synchronizeResource(const Sink::QueryBase &filter) Q_DECL_OVERRIDE;
KAsync::Job<void> sendCreateCommand(const QByteArray &uid, const QByteArray &resourceBufferType, const QByteArray &buffer) Q_DECL_OVERRIDE;
KAsync::Job<void>
sendModifyCommand(const QByteArray &uid, qint64 revision, const QByteArray &resourceBufferType, const QByteArrayList &deletedProperties, const QByteArray &buffer, const QByteArrayList &changedProperties, const QByteArray &newResource, bool remove) Q_DECL_OVERRIDE;
KAsync::Job<void> sendDeleteCommand(const QByteArray &uid, qint64 revision, const QByteArray &resourceBufferType) Q_DECL_OVERRIDE;
KAsync::Job<void> sendRevisionReplayedCommand(qint64 revision) Q_DECL_OVERRIDE;
KAsync::Job<void>
sendInspectionCommand(int inspectionType,const QByteArray &inspectionId, const QByteArray &domainType, const QByteArray &entityId, const QByteArray &property, const QVariant &expecedValue) Q_DECL_OVERRIDE;
KAsync::Job<void> sendFlushCommand(int flushType, const QByteArray &flushId) Q_DECL_OVERRIDE;
/**
* Tries to connect to server, and returns a connected socket on success.
*/
static KAsync::Job<QSharedPointer<QLocalSocket>> connectToServer(const QByteArray &identifier);
public slots:
void open() Q_DECL_OVERRIDE;
void close() Q_DECL_OVERRIDE;
private slots:
// TODO: move these to the Private class
void disconnected();
void connectionError(QLocalSocket::LocalSocketError error);
void readResourceMessage();
bool processMessageBuffer();
private:
void connected();
void registerCallback(uint messageId, const std::function<void(int error, const QString &)> &callback);
void sendCommand(const QSharedPointer<QueuedCommand> &command);
void processCommandQueue();
void processPendingCommandQueue();
void enqueueCommand(const QSharedPointer<QueuedCommand> &command);
class Private;
Private *const d;
};
/**
* A factory for resource access instances that caches the instance for some time.
*
* This avoids constantly recreating connections, and should allow a single process to have one connection per resource.
*/
class SINK_EXPORT ResourceAccessFactory
{
SINK_DEBUG_AREA("ResourceAccessFactory")
public:
static ResourceAccessFactory &instance();
Sink::ResourceAccess::Ptr getAccess(const QByteArray &instanceIdentifier, const QByteArray resourceType);
QHash<QByteArray, QWeakPointer<Sink::ResourceAccess>> mWeakCache;
QHash<QByteArray, Sink::ResourceAccess::Ptr> mCache;
QHash<QByteArray, QTimer *> mTimer;
};
}
|
