SNode.C
Loading...
Searching...
No Matches
FixedHeader.h
Go to the documentation of this file.
1/*
2 * SNode.C - a slim toolkit for network communication
3 * Copyright (C) Volker Christian <me@vchrist.at>
4 * 2020, 2021, 2022, 2023, 2024, 2025
5 *
6 * This program is free software: you can redistribute it and/or modify
7 * it under the terms of the GNU Lesser General Public License as published
8 * by the Free Software Foundation, either version 3 of the License, or
9 * (at your option) any later version.
10 *
11 * This program is distributed in the hope that it will be useful,
12 * but WITHOUT ANY WARRANTY; without even the implied warranty of
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 * GNU Lesser General Public License for more details.
15 *
16 * You should have received a copy of the GNU Lesser General Public License
17 * along with this program. If not, see <http://www.gnu.org/licenses/>.
18 */
19
20#ifndef IOT_MQTT_FIXEDHEADER_H
21#define IOT_MQTT_FIXEDHEADER_H
22
23#include "iot/mqtt/types/UInt8.h"
24#include "iot/mqtt/types/UIntV.h"
25
26namespace iot::mqtt {
27 class MqttContext;
28}
29
30#ifndef DOXYGEN_SHOULD_SKIP_THIS
31
32#include <cstddef>
33#include <cstdint>
34#include <vector>
35
36#endif // DOXYGEN_SHOULD_SKIP_THIS
37
38namespace iot::mqtt {
39
41 public:
43 FixedHeader(uint8_t type, uint8_t flags, uint32_t remainingLength = 0);
44
45 ~FixedHeader();
46
47 std::size_t deserialize(iot::mqtt::MqttContext* mqttContext);
48 std::vector<char> serialize() const;
49
50 uint8_t getType() const;
51 uint8_t getFlags() const;
52
53 void setRemainingLength(uint32_t remainingLength);
54 uint32_t getRemainingLength() const;
55
56 bool isComplete() const;
57 bool isError() const;
58
59 void reset();
60
61 private:
64
65 bool complete = false;
66 bool error = false;
67
68 int state = 0;
69 };
70
71} // namespace iot::mqtt
72
73#endif // IOT_MQTT_FIXEDHEADER_H
std::size_t deserialize(iot::mqtt::MqttContext *mqttContext)
virtual std::size_t deserializeVP(iot::mqtt::MqttContext *mqttContext)=0
ControlPacketDeserializer & operator=(const ControlPacketDeserializer &)=default
ControlPacketDeserializer(uint32_t remainingLength, uint8_t flags, uint8_t mustFlags)
uint8_t getType() const
FixedHeader(uint8_t type, uint8_t flags, uint32_t remainingLength=0)
uint32_t getRemainingLength() const
uint8_t getFlags() const
void setRemainingLength(uint32_t remainingLength)
std::vector< char > serialize() const
std::size_t deserialize(iot::mqtt::MqttContext *mqttContext)
types::UInt8 typeFlags
Definition FixedHeader.h:62
types::UIntV remainingLength
Definition FixedHeader.h:63
MqttContext * mqttContext
Definition Mqtt.h:136
const std::string & getConnectionName() const
Definition Mqtt.cpp:148
virtual void onConnected()
Definition Mqtt.cpp:73
static std::string toHexString(const std::vector< char > &data)
Definition Mqtt.cpp:367
virtual void onPubcomp(const iot::mqtt::packets::Pubcomp &pubcomp)
Definition Mqtt.cpp:243
virtual void onPublish(const iot::mqtt::packets::Publish &publish)
Definition Mqtt.cpp:231
core::timer::Timer keepAliveTimer
Definition Mqtt.h:129
iot::mqtt::FixedHeader fixedHeader
Definition Mqtt.h:124
const MqttContext * getMqttContext() const
Definition Mqtt.cpp:69
std::size_t onReceivedFromPeer()
Definition Mqtt.cpp:77
virtual void onDisconnected()
Definition Mqtt.cpp:144
void send(const std::vector< char > &data) const
Definition Mqtt.cpp:189
void setMqttContext(MqttContext *mqttContext)
Definition Mqtt.cpp:65
void sendPuback(uint16_t packetIdentifier) const
Definition Mqtt.cpp:215
virtual void onPuback(const iot::mqtt::packets::Puback &puback)
Definition Mqtt.cpp:234
std::string connectionName
Definition Mqtt.h:120
void _onPubrec(const iot::mqtt::packets::Pubrec &pubrec)
Definition Mqtt.cpp:298
virtual void deliverPacket(iot::mqtt::ControlPacketDeserializer *controlPacketDeserializer)=0
Mqtt(const std::string &connectionName, const std::string &clientId)
Definition Mqtt.cpp:51
void sendPubrel(uint16_t packetIdentifier) const
Definition Mqtt.cpp:223
uint16_t getPacketIdentifier()
Definition Mqtt.cpp:376
bool _onPublish(const iot::mqtt::packets::Publish &publish)
Definition Mqtt.cpp:246
virtual iot::mqtt::ControlPacketDeserializer * createControlPacketDeserializer(iot::mqtt::FixedHeader &staticHeader)=0
Mqtt & operator=(Mqtt &&)=delete
void sendPublish(const std::string &topic, const std::string &message, uint8_t qoS, bool retain)
Definition Mqtt.cpp:195
virtual ~Mqtt()
Definition Mqtt.cpp:56
void printFixedHeader(const iot::mqtt::FixedHeader &fixedHeader) const
Definition Mqtt.cpp:355
uint16_t _packetIdentifier
Definition Mqtt.h:127
Mqtt(const Mqtt &)=delete
Session * session
Definition Mqtt.h:133
void _onPubrel(const iot::mqtt::packets::Pubrel &pubrel)
Definition Mqtt.cpp:315
virtual void onPubrec(const iot::mqtt::packets::Pubrec &pubrec)
Definition Mqtt.cpp:237
virtual void onPubrel(const iot::mqtt::packets::Pubrel &pubrel)
Definition Mqtt.cpp:240
void send(const iot::mqtt::ControlPacket &controlPacket) const
Definition Mqtt.cpp:183
virtual bool onSignal(int sig)=0
std::string clientId
Definition Mqtt.h:121
Mqtt(const std::string &connectionName)
Definition Mqtt.cpp:47
void initSession(Session *session, utils::Timeval keepAlive)
Definition Mqtt.cpp:152
Mqtt & operator=(const Mqtt &)=delete
void printVP(const iot::mqtt::ControlPacket &packet) const
Definition Mqtt.cpp:346
Mqtt(Mqtt &&)=delete
iot::mqtt::ControlPacketDeserializer * controlPacketDeserializer
Definition Mqtt.h:125
void sendPubcomp(uint16_t packetIdentifier) const
Definition Mqtt.cpp:227
void sendPubrec(uint16_t packetIdentifier) const
Definition Mqtt.cpp:219
void _onPubcomp(const iot::mqtt::packets::Pubcomp &pubcomp)
Definition Mqtt.cpp:331
void _onPuback(const iot::mqtt::packets::Puback &puback)
Definition Mqtt.cpp:286
virtual void deliverPacket(iot::mqtt::client::Mqtt *mqtt)=0
void _onPublish(const iot::mqtt::client::packets::Publish &publish)
Definition Mqtt.cpp:192
void sendConnect(uint16_t keepAlive, const std::string &clientId, bool cleanSession, const std::string &willTopic, const std::string &willMessage, uint8_t willQoS, bool willRetain, const std::string &username, const std::string &password, bool loopPrevention=false)
Definition Mqtt.cpp:240
iot::mqtt::Session session
Definition Mqtt.h:119
std::string sessionStoreFileName
Definition Mqtt.h:118
void _onPingresp(const iot::mqtt::client::packets::Pingresp &pingresp)
Definition Mqtt.cpp:236
virtual void onConnack(const iot::mqtt::packets::Connack &connack)
Definition Mqtt.cpp:160
virtual void onPingresp(const iot::mqtt::packets::Pingresp &pingresp)
Definition Mqtt.cpp:169
void sendSubscribe(const std::list< Topic > &topics)
Definition Mqtt.cpp:260
iot::mqtt::ControlPacketDeserializer * createControlPacketDeserializer(iot::mqtt::FixedHeader &fixedHeader) final
Definition Mqtt.cpp:113
void _onSuback(const iot::mqtt::client::packets::Suback &suback)
Definition Mqtt.cpp:198
virtual void onUnsuback(const iot::mqtt::packets::Unsuback &unsuback)
Definition Mqtt.cpp:166
void _onConnack(const iot::mqtt::client::packets::Connack &connack)
Definition Mqtt.cpp:172
void _onUnsuback(const iot::mqtt::client::packets::Unsuback &unsuback)
Definition Mqtt.cpp:224
void sendUnsubscribe(const std::list< std::string > &topics)
Definition Mqtt.cpp:264
bool onSignal(int sig) override
Definition Mqtt.cpp:156
virtual void onSuback(const iot::mqtt::packets::Suback &suback)
Definition Mqtt.cpp:163
void deliverPacket(iot::mqtt::ControlPacketDeserializer *controlPacketDeserializer) override
Definition Mqtt.cpp:152
void sendPingreq() const
Definition Mqtt.cpp:268
void sendDisconnect() const
Definition Mqtt.cpp:272
Mqtt(const std::string &connectionName, const std::string &clientId)
Definition Mqtt.cpp:57
core::timer::Timer pingTimer
Definition Mqtt.h:121
std::size_t deserializeVP(iot::mqtt::MqttContext *mqttContext) override
Definition Connack.cpp:35
Connack(uint32_t remainingLength, uint8_t flags)
Definition Connack.cpp:30
void deliverPacket(iot::mqtt::client::Mqtt *mqtt) override
Definition Connack.cpp:65
uint8_t getReturnCode() const
Definition Connack.cpp:54
std::vector< char > serializeVP() const override
Definition Connack.cpp:41
Connack(uint8_t returncode, uint8_t acknowledgeFlags)
Definition Connack.cpp:35
iot::mqtt::types::UInt8 acknowledgeFlags
Definition Connack.h:59
bool getSessionPresent() const
Definition Connack.cpp:58
uint8_t getAcknowledgeFlags() const
Definition Connack.cpp:50
iot::mqtt::types::UInt8 returnCode
Definition Connack.h:60
UInt8 & operator=(const uint8_t &newValue)
Definition UInt8.cpp:35
UInt8(UInt8 &&) noexcept=default
UInt8 & operator=(UInt8 &&) noexcept=default
UInt8 & operator=(const UInt8 &)=default
UInt8(const UInt8 &)=default
#define MQTT_CONNACK_FLAGS
Definition Timer.h:37