ControlPacketFactory.cpp

Go to the documentation of this file.

/*
 * SNode.C - A Slim Toolkit for Network Communication
 * Copyright (C) Volker Christian <me@vchrist.at>
 *               2020, 2021, 2022, 2023, 2024, 2025
 *
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Lesser General Public License as published
 * by the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
 * GNU Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public License
 * along with this program. If not, see <http://www.gnu.org/licenses/>.
 */
 
/*
 * MIT License
 *
 * Permission is hereby granted, free of charge, to any person obtaining a copy
 * of this software and associated documentation files (the "Software"), to deal
 * in the Software without restriction, including without limitation the rights
 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 * copies of the Software, and to permit persons to whom the Software is
 * furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in
 * all copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
 * THE SOFTWARE.
 */
 
#include "iot/mqtt-fast/ControlPacketFactory.h"
 
#ifndef DOXYGEN_SHOULD_SKIP_THIS
 
#include <vector>
 
#endif // DOXYGEN_SHOULD_SKIP_THIS
 
namespace iot::mqtt_fast {
 
    ControlPacketFactory::ControlPacketFactory(core::socket::SocketContext* socketContext)
        : typeFlags(socketContext)
        , remainingLength(socketContext)
        , data(socketContext) {
    }
 
    std::size_t ControlPacketFactory::construct() {
        std::size_t consumed = 0;
 
        switch (state) {
            case 0: // Type - Flags
                consumed = typeFlags.construct();
                if (typeFlags.isComplete()) {
                    state++;
                } else {
                    error = typeFlags.isError();
                }
                break;
            case 1: // Remaining length
                consumed = remainingLength.construct();
                if (remainingLength.isComplete()) {
                    data.setLength(remainingLength.getValue());
                    completed = remainingLength.getValue() == 0;
                    state++;
                } else {
                    error = remainingLength.isError();
                }
                break;
            case 2: // Var-Header + Payload
                consumed = data.construct();
                if (data.isComplete()) {
                    completed = true;
                    state++;
                } else {
                    error = data.isError();
                }
                break;
        }
 
        return consumed;
    }
 
    bool ControlPacketFactory::isComplete() const {
        return completed;
    }
 
    bool ControlPacketFactory::isError() const {
        return error;
    }
 
    iot::mqtt_fast::types::Binary& ControlPacketFactory::getPacket() {
        return data;
    }
 
    uint8_t ControlPacketFactory::getPacketType() {
        return static_cast<uint8_t>(typeFlags.getValue() >> 0x04);
    }
 
    uint8_t ControlPacketFactory::getPacketFlags() {
        return static_cast<uint8_t>(typeFlags.getValue() & 0x0F);
    }
 
    uint64_t ControlPacketFactory::getRemainingLength() {
        return data.getValue().size();
    }
 
    void ControlPacketFactory::reset() {
        completed = false;
        error = false;
        state = 0;
 
        typeFlags.reset();
        remainingLength.reset();
        data.reset();
    }
 
} // namespace iot::mqtt_fast