1// Copyright (C) 2017 The Qt Company Ltd.
2// SPDX-License-Identifier: LicenseRef-Qt-Commercial OR LGPL-3.0-only OR GPL-2.0-only OR GPL-3.0-only
3
4#ifndef QMODBUSCLIENT_P_H
5#define QMODBUSCLIENT_P_H
6
7#include <QtCore/qtimer.h>
8#include <QtSerialBus/qmodbusclient.h>
9#include <QtSerialBus/qmodbuspdu.h>
10
11#include <private/qmodbusdevice_p.h>
12
13#include <QtCore/qpointer.h>
14
15#include <limits.h>
16
17//
18// W A R N I N G
19// -------------
20//
21// This file is not part of the Qt API. It exists purely as an
22// implementation detail. This header file may change from version to
23// version without notice, or even be removed.
24//
25// We mean it.
26//
27
28QT_BEGIN_NAMESPACE
29
30class Q_AUTOTEST_EXPORT QModbusClientPrivate : public QModbusDevicePrivate
31{
32 Q_DECLARE_PUBLIC(QModbusClient)
33
34public:
35 QModbusReply *sendRequest(const QModbusRequest &request, int serverAddress,
36 const QModbusDataUnit *const unit);
37 QModbusRequest createReadRequest(const QModbusDataUnit &data) const;
38 QModbusRequest createWriteRequest(const QModbusDataUnit &data) const;
39 QModbusRequest createRWRequest(const QModbusDataUnit &read, const QModbusDataUnit &write) const;
40
41 bool processResponse(const QModbusResponse &response, QModbusDataUnit *data);
42
43 bool processReadCoilsResponse(const QModbusResponse &response, QModbusDataUnit *data);
44 bool processReadDiscreteInputsResponse(const QModbusResponse &response, QModbusDataUnit *data);
45 bool collateBits(const QModbusPdu &pdu, QModbusDataUnit::RegisterType type, QModbusDataUnit *data);
46
47 bool processReadHoldingRegistersResponse(const QModbusResponse &response, QModbusDataUnit *data);
48 bool processReadInputRegistersResponse(const QModbusResponse &response, QModbusDataUnit *data);
49 bool collateBytes(const QModbusPdu &pdu, QModbusDataUnit::RegisterType type, QModbusDataUnit *data);
50
51 bool processWriteSingleCoilResponse(const QModbusResponse &response, QModbusDataUnit *data);
52 bool processWriteSingleRegisterResponse(const QModbusResponse &response,
53 QModbusDataUnit *data);
54 bool collateSingleValue(const QModbusPdu &pdu, QModbusDataUnit::RegisterType type,
55 QModbusDataUnit *data);
56
57 bool processWriteMultipleCoilsResponse(const QModbusResponse &response, QModbusDataUnit *data);
58 bool processWriteMultipleRegistersResponse(const QModbusResponse &response,
59 QModbusDataUnit *data);
60 bool collateMultipleValues(const QModbusPdu &pdu, QModbusDataUnit::RegisterType type,
61 QModbusDataUnit *data);
62
63 bool processReadWriteMultipleRegistersResponse(const QModbusResponse &response,
64 QModbusDataUnit *data);
65
66 virtual QModbusReply *enqueueRequest(const QModbusRequest &, int, const QModbusDataUnit &,
67 QModbusReply::ReplyType) {
68 return nullptr;
69 }
70 // TODO: Review once we have a transport layer in place.
71 virtual bool isOpen() const { return false; }
72
73 int m_numberOfRetries = 3;
74 int m_responseTimeoutDuration = 1000;
75
76 struct QueueElement {
77 QueueElement() = default;
78 QueueElement(QModbusReply *r, const QModbusRequest &req, const QModbusDataUnit &u, int num,
79 int timeout = -1)
80 : reply(r), requestPdu(req), unit(u), numberOfRetries(num)
81 {
82 if (timeout >= 0) {
83 // always the case for TCP
84 timer = QSharedPointer<QTimer>::create();
85 timer->setSingleShot(true);
86 timer->setInterval(timeout);
87 }
88 }
89 bool operator==(const QueueElement &other) const {
90 return reply == other.reply;
91 }
92
93 QPointer<QModbusReply> reply;
94 QModbusRequest requestPdu;
95 QModbusDataUnit unit;
96 int numberOfRetries;
97 QSharedPointer<QTimer> timer;
98 QByteArray adu;
99 qint64 bytesWritten = 0;
100 qint32 m_timerId = INT_MIN;
101 };
102 void processQueueElement(const QModbusResponse &pdu, const QueueElement &element);
103};
104
105QT_END_NAMESPACE
106
107#endif // QMODBUSCLIENT_P_H
108
109

source code of qtserialbus/src/serialbus/qmodbusclient_p.h