1// Copyright (C) 2017 Witekio.
2// Copyright (C) 2018 The Qt Company Ltd.
3// SPDX-License-Identifier: LicenseRef-Qt-Commercial OR GPL-3.0-only
4// Qt-Security score:significant reason:default
5
6#ifndef QCOAPPROTOCOL_P_H
7#define QCOAPPROTOCOL_P_H
8
9#include <QtCoap/qcoapglobal.h>
10#include <QtCoap/qcoapreply.h>
11#include <QtCoap/qcoapresource.h>
12#include <QtCore/qlist.h>
13#include <QtCore/qqueue.h>
14#include <QtCore/qpointer.h>
15#include <QtCore/qobject.h>
16#include <private/qobject_p.h>
17
18//
19// W A R N I N G
20// -------------
21//
22// This file is not part of the Qt API. It exists purely as an
23// implementation detail. This header file may change from version to
24// version without notice, or even be removed.
25//
26// We mean it.
27//
28
29QT_BEGIN_NAMESPACE
30
31class QCoapInternalRequest;
32class QCoapInternalReply;
33class QCoapProtocolPrivate;
34class QCoapConnection;
35class Q_AUTOTEST_EXPORT QCoapProtocol : public QObject
36{
37 Q_OBJECT
38public:
39 explicit QCoapProtocol(QObject *parent = nullptr);
40 ~QCoapProtocol();
41
42 uint ackTimeout() const;
43 double ackRandomFactor() const;
44 uint maximumRetransmitCount() const;
45 quint16 blockSize() const;
46 uint maximumTransmitSpan() const;
47 uint maximumTransmitWait() const;
48 uint maximumLatency() const;
49
50 uint minimumTimeout() const;
51 uint maximumTimeout() const;
52
53 uint nonConfirmLifetime() const;
54 uint maximumServerResponseDelay() const;
55
56Q_SIGNALS:
57 void finished(QCoapReply *reply);
58 void responseToMulticastReceived(QCoapReply *reply, const QCoapMessage &message,
59 const QHostAddress &sender);
60 void error(QCoapReply *reply, QtCoap::Error error);
61
62public:
63 Q_INVOKABLE void setAckTimeout(uint ackTimeout);
64 Q_INVOKABLE void setAckRandomFactor(double ackRandomFactor);
65 Q_INVOKABLE void setMaximumRetransmitCount(uint maximumRetransmitCount);
66 Q_INVOKABLE void setBlockSize(quint16 blockSize);
67 Q_INVOKABLE void setMaximumServerResponseDelay(uint responseDelay);
68 Q_INVOKABLE void setMinimumTokenSize(int tokenSize);
69
70private:
71 Q_INVOKABLE void sendRequest(QPointer<QCoapReply> reply, QCoapConnection *connection);
72 Q_INVOKABLE void cancelObserve(QPointer<QCoapReply> reply) const;
73 Q_INVOKABLE void cancelObserve(const QUrl &url) const;
74
75private:
76 Q_DECLARE_PRIVATE(QCoapProtocol)
77
78 friend class QCoapClient;
79 friend class QCoapClientPrivate;
80};
81
82struct CoapExchangeData {
83 QPointer<QCoapReply> userReply;
84 QSharedPointer<QCoapInternalRequest> request;
85 QList<QSharedPointer<QCoapInternalReply> > replies;
86};
87
88typedef QMap<QByteArray, CoapExchangeData> CoapExchangeMap;
89
90class Q_AUTOTEST_EXPORT QCoapProtocolPrivate : public QObjectPrivate
91{
92public:
93 QCoapProtocolPrivate() = default;
94
95 quint16 generateUniqueMessageId() const;
96 QCoapToken generateUniqueToken() const;
97
98 QCoapInternalReply *decode(const QByteArray &data, const QHostAddress &sender);
99
100 void sendAcknowledgment(QCoapInternalRequest *request) const;
101 void sendReset(QCoapInternalRequest *request) const;
102 void sendRequest(QCoapInternalRequest *request, const QString& host = QString()) const;
103
104 void onLastMessageReceived(QCoapInternalRequest *request, const QHostAddress &sender);
105 void onRequestError(QCoapInternalRequest *request, QCoapInternalReply *reply);
106 void onRequestError(QCoapInternalRequest *request, QtCoap::Error error,
107 QCoapInternalReply *reply = nullptr);
108
109 void onRequestTimeout(QCoapInternalRequest *request);
110 void onRequestMaxTransmissionSpanReached(QCoapInternalRequest *request);
111 void onMulticastRequestExpired(QCoapInternalRequest *request);
112 void onFrameReceived(const QByteArray &data, const QHostAddress &sender);
113 void onConnectionError(QAbstractSocket::SocketError error);
114 void onRequestAborted(const QCoapToken &token);
115
116 bool isMessageIdRegistered(quint16 id) const;
117 bool isTokenRegistered(const QCoapToken &token) const;
118 bool isRequestRegistered(const QCoapInternalRequest *request) const;
119
120 QCoapInternalRequest *requestForToken(const QCoapToken &token) const;
121 QPointer<QCoapReply> userReplyForToken(const QCoapToken &token) const;
122 QList<QSharedPointer<QCoapInternalReply>> repliesForToken(const QCoapToken &token) const;
123 QCoapInternalReply *lastReplyForToken(const QCoapToken &token) const;
124 QCoapInternalRequest *findRequestByMessageId(quint16 messageId) const;
125 QCoapInternalRequest *findRequestByUserReply(const QCoapReply *reply) const;
126
127 void registerExchange(const QCoapToken &token, QCoapReply *reply,
128 QSharedPointer<QCoapInternalRequest> request);
129 bool addReply(const QCoapToken &token, QSharedPointer<QCoapInternalReply> reply);
130 bool forgetExchange(const QCoapToken &token);
131 bool forgetExchange(const QCoapInternalRequest *request);
132 bool forgetExchangeReplies(const QCoapToken &token);
133
134 CoapExchangeMap exchangeMap;
135 quint16 blockSize = 0;
136
137 uint maximumRetransmitCount = 4;
138 uint ackTimeout = 2000;
139 uint maximumServerResponseDelay = 250 * 1000;
140 int minimumTokenSize = 4;
141 double ackRandomFactor = 1.5;
142
143 Q_DECLARE_PUBLIC(QCoapProtocol)
144};
145
146QT_END_NAMESPACE
147
148#endif // QCOAPPROTOCOL_P_H
149

source code of qtcoap/src/coap/qcoapprotocol_p.h