Session.h

Go to the documentation of this file.

//
// Copyright 2016 - 2026 (C). Alex Robenko. All rights reserved.
//
// SPDX-License-Identifier: MPL-2.0
//
// This Source Code Form is subject to the terms of the Mozilla Public
// License, v. 2.0. If a copy of the MPL was not distributed with this
// file, You can obtain one at http://mozilla.org/MPL/2.0/.
 
 
#pragma once
 
#include <memory>
#include <functional>
#include <cstdint>
#include <vector>
#include <string>
#include <utility>
 
namespace cc_mqttsn_gateway
{
 
class SessionImpl;
 
class Session
{
public:
 
    using BinaryData = std::vector<std::uint8_t>;
 
    using AuthInfo = std::pair<std::string, BinaryData>;
 
    using NextTickProgramReqCb = std::function<void (unsigned value)>;
 
    using CancelTickWaitReqCb = std::function<unsigned ()>;
 
    using ClientSendDataReqCb = std::function<void (const std::uint8_t* buf, std::size_t bufSize, unsigned broadcastRadius)>;
 
    using BrokerSendDataReqCb = std::function<void (const std::uint8_t* buf, std::size_t bufSize)>;
 
    using TerminationReqCb = std::function<void ()>;
 
    using BrokerReconnectReqCb = std::function<void ()>;
 
    using ClientConnectedReportCb = std::function<void (const std::string& clientId)>;
 
    using AuthInfoReqCb = std::function<AuthInfo (const std::string& clientId)>;
 
    using ErrorReportCb = std::function<void (const char* msg)>;
 
    using FwdEncSessionCreatedReportCb = std::function<bool (Session* session)>;
 
    using FwdEncSessionDeletedReportCb = std::function<void (Session* session)>;
 
    Session();
 
    ~Session();
 
    void setNextTickProgramReqCb(NextTickProgramReqCb&& func);
 
    void setCancelTickWaitReqCb(CancelTickWaitReqCb&& func);
 
    void setSendDataClientReqCb(ClientSendDataReqCb&& func);
 
    void setSendDataBrokerReqCb(BrokerSendDataReqCb&& func);
 
    void setTerminationReqCb(TerminationReqCb&& func);
 
    void setBrokerReconnectReqCb(BrokerReconnectReqCb&& func);
 
    void setClientConnectedReportCb(ClientConnectedReportCb&& func);
 
    void setAuthInfoReqCb(AuthInfoReqCb&& func);
 
    void setErrorReportCb(ErrorReportCb&& func);
 
    void setFwdEncSessionCreatedReportCb(FwdEncSessionCreatedReportCb&& func);
 
    void setFwdEncSessionDeletedReportCb(FwdEncSessionDeletedReportCb&& func);
 
    void setGatewayId(std::uint8_t value);
 
    std::uint8_t getGatewayId() const;
 
    void setRetryPeriod(unsigned value);
 
    unsigned getRetryPeriod() const;
 
    void setRetryCount(unsigned value);
 
    unsigned getRetryCount() const;
 
    void setSleepingClientMsgLimit(std::size_t value);
 
    std::size_t getSleepingClientMsgLimit() const;
 
    void setDefaultClientId(const std::string& value);
 
    const std::string& getDefaultClientId() const;
 
    void setPubOnlyKeepAlive(std::uint16_t value);
 
    std::uint16_t getPubOnlyKeepAlive() const;
 
    bool start();
 
    void stop();
 
    bool isRunning() const;
 
    void tick();
 
    std::size_t dataFromClient(const std::uint8_t* buf, std::size_t len);
 
    std::size_t dataFromBroker(const std::uint8_t* buf, std::size_t len);
 
    void setBrokerConnected(bool connected);
 
    bool getBrokerConnected() const;
 
    bool addPredefinedTopic(const std::string& topic, std::uint16_t topicId);
 
    bool setTopicIdAllocationRange(std::uint16_t minVal, std::uint16_t maxVal);
 
private:
    std::unique_ptr<SessionImpl> m_pImpl;
};
 
}  // namespace cc_mqttsn_gateway