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
171
172
173
174
175
176
177
178
179
180
181
182
183
184
|
#pragma once
#include "all_fwd.hpp"
#include <QLatin1String>
#include <QString>
#include <QVersionNumber>
#include <cstddef>
#include <memory>
class QJsonObject;
namespace Epistmool::Server {
// Note: not all message kinds have a corresponding reply format. In such case the Kind enum is prefixed with 'Notification'.
class ProtocolMessage
{
Q_GADGET
public:
struct KindTrait {
bool isC2S;
bool hasReply;
};
enum Kind {
SessionAuth,
SessionDestroy,
WorkspaceCreate,
WorkspaceFetchIndex,
WorkspaceFetchKnowledge,
WorkspaceUpdateKnowledge,
WorkspaceCreateKnowledge,
WorkspaceDeleteKnowledge,
WorkspaceFetchKeyword,
WorkspaceUpdateKeyword,
WorkspaceCreateKeyword,
WorkspaceDeleteKeyword,
NotificationWorkspaceUpdated,
NotificationKnowledgeUpdated,
KindCOUNT,
};
Q_ENUM(Kind)
static std::unique_ptr<ProtocolRequest> createRequest(Kind kind);
static std::unique_ptr<ProtocolReply> createReply(Kind kind);
static const KindTrait& getKindTrait(Kind kind);
enum Variant {
RequestVariant,
ReplyVariant,
};
Q_ENUM(Variant)
public:
Kind kind;
Variant variant;
public:
ProtocolMessage(Kind kind, Variant variant);
virtual ~ProtocolMessage() = default;
protected:
virtual void serializeFields(QJsonObject& object) const = 0;
virtual void deserializeFields(const QJsonObject& object) = 0;
};
class ProtocolRequest : public ProtocolMessage
{
public:
ProtocolRequest(Kind kind);
static QJsonObject serialize(const ProtocolRequest& msg);
static std::unique_ptr<ProtocolRequest> deserialize(const QJsonObject& object);
};
class ProtocolReply : public ProtocolMessage
{
public:
int sequence;
ProtocolReply(Kind kind);
static QJsonObject serialize(const ProtocolReply& msg);
static std::unique_ptr<ProtocolReply> deserialize(const QJsonObject& object);
};
// ===========================
// Individual messages classes
class ProtocolRequest_SessionAuth : public ProtocolRequest
{
public:
int theSession;
bool createIfInvalid;
ProtocolRequest_SessionAuth();
protected:
virtual void serializeFields(QJsonObject& object) const override;
virtual void deserializeFields(const QJsonObject& object) override;
};
class ProtocolReply_SessionAuth : public ProtocolReply
{
public:
/// The same value as provided in the request message.
/// If \l ProcotolCommandSessionAuth::createIfValid is set and the given session is invalid, a new session is created and written here instead of the original value.
int theSession;
ProtocolReply_SessionAuth();
protected:
virtual void serializeFields(QJsonObject& object) const override;
virtual void deserializeFields(const QJsonObject& object) override;
};
class ProtocolRequest_SessionDestroy : public ProtocolRequest
{
public:
// TODO
ProtocolRequest_SessionDestroy();
protected:
virtual void serializeFields(QJsonObject& object) const override;
virtual void deserializeFields(const QJsonObject& object) override;
};
class ProtocolReply_SessionDestroy : public ProtocolReply
{
public:
// TODO
ProtocolReply_SessionDestroy();
protected:
virtual void serializeFields(QJsonObject& object) const override;
virtual void deserializeFields(const QJsonObject& object) override;
};
class ProtocolRequest_WorkspaceFetchIndex : public ProtocolRequest
{
public:
QString knowledgeFilter;
QString keywordFilter;
int knowledgeMaxCount;
int keywordMaxCount;
ProtocolRequest_WorkspaceFetchIndex();
protected:
virtual void serializeFields(QJsonObject& object) const override;
virtual void deserializeFields(const QJsonObject& object) override;
};
class ProtocolReply_WorkspaceFetchIndex : public ProtocolReply
{
public:
// TODO
ProtocolReply_WorkspaceFetchIndex();
protected:
virtual void serializeFields(QJsonObject& object) const override;
virtual void deserializeFields(const QJsonObject& object) override;
};
class ProtocolNotification_WorkspaceUpdate : public ProtocolRequest
{
public:
// TODO
ProtocolNotification_WorkspaceUpdate();
protected:
virtual void serializeFields(QJsonObject& object) const override;
virtual void deserializeFields(const QJsonObject& object) override;
};
} // namespace Epistmool::Server
|
