SNode.C
Loading...
Searching...
No Matches
Pingreq.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/*
21 * MIT License
22 *
23 * Permission is hereby granted, free of charge, to any person obtaining a copy
24 * of this software and associated documentation files (the "Software"), to deal
25 * in the Software without restriction, including without limitation the rights
26 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
27 * copies of the Software, and to permit persons to whom the Software is
28 * furnished to do so, subject to the following conditions:
29 *
30 * The above copyright notice and this permission notice shall be included in
31 * all copies or substantial portions of the Software.
32 *
33 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
34 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
35 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
36 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
37 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
38 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
39 * THE SOFTWARE.
40 */
41
42#ifndef IOT_MQTT_PACKETS_PINGREQ_H
43#define IOT_MQTT_PACKETS_PINGREQ_H
44
45#include "iot/mqtt/ControlPacket.h" // IWYU pragma: export
46
47#ifndef DOXYGEN_SHOULD_SKIP_THIS
48
49#endif // DOXYGEN_SHOULD_SKIP_THIS
50
51namespace iot::mqtt::packets {
52
53 class Pingreq : public iot::mqtt::ControlPacket {
54 public:
55 Pingreq();
56
57 private:
58 std::vector<char> serializeVP() const override;
59 };
60
61} // namespace iot::mqtt::packets
62
63#endif // IOT_MQTT_PACKETS_PINGREQ_H
void cancel()
Definition Timer.cpp:84
Timer & operator=(Timer &&timer) noexcept=default
static Timer intervalTimer(const std::function< void()> &dispatcher, const utils::Timeval &timeout)
Definition Timer.cpp:65
uint8_t getType() const
uint32_t getRemainingLength() const
uint8_t getFlags() const
virtual void end(bool fatal=false)=0
MqttContext * mqttContext
Definition Mqtt.h:158
virtual void onPublish(const iot::mqtt::packets::Publish &publish)
Definition Mqtt.cpp:253
std::string connectionName
Definition Mqtt.h:142
Mqtt(const std::string &connectionName, const std::string &clientId)
Definition Mqtt.cpp:73
uint16_t getPacketIdentifier()
Definition Mqtt.cpp:398
bool _onPublish(const iot::mqtt::packets::Publish &publish)
Definition Mqtt.cpp:268
void send(const iot::mqtt::ControlPacket &controlPacket) const
Definition Mqtt.cpp:205
std::string clientId
Definition Mqtt.h:143
void initSession(Session *session, utils::Timeval keepAlive)
Definition Mqtt.cpp:174
virtual nlohmann::json toJson() const
Definition Session.cpp:59
void fromJson(const nlohmann::json &json)
Definition Session.cpp:89
virtual void deliverPacket(iot::mqtt::client::Mqtt *mqtt)=0
void _onPublish(const iot::mqtt::client::packets::Publish &publish)
Definition Mqtt.cpp:213
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:261
iot::mqtt::Session session
Definition Mqtt.h:141
std::string sessionStoreFileName
Definition Mqtt.h:140
Mqtt(const std::string &connectionName, const std::string &clientId, const std::string &sessionStoreFileName)
Definition Mqtt.cpp:78
void _onPingresp(const iot::mqtt::client::packets::Pingresp &pingresp)
Definition Mqtt.cpp:257
virtual void onConnack(const iot::mqtt::packets::Connack &connack)
Definition Mqtt.cpp:181
virtual void onPingresp(const iot::mqtt::packets::Pingresp &pingresp)
Definition Mqtt.cpp:190
void sendSubscribe(const std::list< Topic > &topics)
Definition Mqtt.cpp:281
iot::mqtt::ControlPacketDeserializer * createControlPacketDeserializer(iot::mqtt::FixedHeader &fixedHeader) final
Definition Mqtt.cpp:134
void _onSuback(const iot::mqtt::client::packets::Suback &suback)
Definition Mqtt.cpp:219
virtual void onUnsuback(const iot::mqtt::packets::Unsuback &unsuback)
Definition Mqtt.cpp:187
void _onConnack(const iot::mqtt::client::packets::Connack &connack)
Definition Mqtt.cpp:193
void _onUnsuback(const iot::mqtt::client::packets::Unsuback &unsuback)
Definition Mqtt.cpp:245
void sendUnsubscribe(const std::list< std::string > &topics)
Definition Mqtt.cpp:285
bool onSignal(int sig) override
Definition Mqtt.cpp:177
virtual void onSuback(const iot::mqtt::packets::Suback &suback)
Definition Mqtt.cpp:184
void deliverPacket(iot::mqtt::ControlPacketDeserializer *controlPacketDeserializer) override
Definition Mqtt.cpp:173
void sendPingreq() const
Definition Mqtt.cpp:289
void sendDisconnect() const
Definition Mqtt.cpp:293
core::timer::Timer pingTimer
Definition Mqtt.h:143
Connack(uint32_t remainingLength, uint8_t flags)
Definition Connack.cpp:52
Pingresp(uint32_t remainingLength, uint8_t flags)
Definition Pingresp.cpp:52
Puback(uint32_t remainingLength, uint8_t flags)
Definition Puback.cpp:52
Pubcomp(uint32_t remainingLength, uint8_t flags)
Definition Pubcomp.cpp:52
Publish(uint32_t remainingLength, uint8_t flags)
Definition Publish.cpp:52
Pubrec(uint32_t remainingLength, uint8_t flags)
Definition Pubrec.cpp:52
Pubrel(uint32_t remainingLength, uint8_t flags)
Definition Pubrel.cpp:52
Suback(uint32_t remainingLength, uint8_t flags)
Definition Suback.cpp:54
Unsuback(uint32_t remainingLength, uint8_t flags)
Definition Unsuback.cpp:52
uint8_t getReturnCode() const
Definition Connack.cpp:76
bool getSessionPresent() const
Definition Connack.cpp:80
uint8_t getAcknowledgeFlags() const
Definition Connack.cpp:72
iot::mqtt::types::String willMessage
Definition Connect.h:108
uint8_t getLevel() const
Definition Connect.cpp:124
iot::mqtt::types::String protocol
Definition Connect.h:102
Connect(const std::string &clientId, uint16_t keepAlive, 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)
Definition Connect.cpp:56
uint8_t getWillQoS() const
Definition Connect.cpp:152
std::string getClientId() const
Definition Connect.cpp:136
std::string getWillTopic() const
Definition Connect.cpp:168
uint16_t getKeepAlive() const
Definition Connect.cpp:132
iot::mqtt::types::String willTopic
Definition Connect.h:107
std::vector< char > serializeVP() const override
Definition Connect.cpp:86
std::string getUsername() const
Definition Connect.cpp:176
uint8_t getConnectFlags() const
Definition Connect.cpp:128
iot::mqtt::types::UInt8 connectFlags
Definition Connect.h:104
std::string getPassword() const
Definition Connect.cpp:180
iot::mqtt::types::String username
Definition Connect.h:109
iot::mqtt::types::UInt8 level
Definition Connect.h:103
std::string getWillMessage() const
Definition Connect.cpp:172
iot::mqtt::types::String clientId
Definition Connect.h:106
iot::mqtt::types::String password
Definition Connect.h:110
std::string getProtocol() const
Definition Connect.cpp:120
iot::mqtt::types::UInt16 keepAlive
Definition Connect.h:105
std::vector< char > serializeVP() const override
std::vector< char > serializeVP() const override
Definition Pingreq.cpp:57
uint16_t getPacketIdentifier() const
Definition Suback.cpp:71
const std::list< uint8_t > & getReturnCodes() const
Definition Suback.cpp:75
Subscribe(uint16_t packetIdentifier, const std::list< iot::mqtt::Topic > &topics)
Definition Subscribe.cpp:60
uint16_t getPacketIdentifier() const
Definition Unsuback.cpp:66
Unsubscribe(uint16_t packetIdentifier, const std::list< std::string > &topics)
#define MQTT_CONNACK
Definition Connack.h:57
#define MQTT_CONNACK_ACCEPT
Definition Connack.h:59
#define MQTT_PINGRESP
Definition Pingresp.h:55
#define MQTT_PUBACK
Definition Puback.h:57
#define MQTT_PUBCOMP
Definition Pubcomp.h:57
#define MQTT_PUBLISH
Definition Publish.h:58
#define MQTT_PUBREC
Definition Pubrec.h:57
#define MQTT_PUBREL
Definition Pubrel.h:57
#define MQTT_SUBACK
Definition Suback.h:58
#define MQTT_UNSUBACK
Definition Unsuback.h:57
Definition Timer.h:59