unreal4u\MQTT\Application\Message

Complexity

Total Complexity

14

Size/Duplication

Total Lines	146
Duplicated Lines	0 %

Test Coverage

Coverage

93.94%

Importance

Changes

0

9 Methods

Rating	Name	Duplication	Size	Complexity
A	setTopic()	0	4	1
A	setPayload()	0	4	1
A	getQoSLevel()	0	3	1
A	getTopicName()	0	7	2
A	setRetainFlag()	0	4	1
A	setQoSLevel()	0	9	3
A	getPayload()	0	3	1
A	validateMessage()	0	13	3
A	isRetained()	0	3	1

<?php

declare(strict_types=1);

namespace unreal4u\MQTT\Application;

use unreal4u\MQTT\Exceptions\InvalidQoSLevel;
use unreal4u\MQTT\Exceptions\MessageTooBig;
use unreal4u\MQTT\Exceptions\MissingTopicName;
use unreal4u\MQTT\Internals\ProtocolBase;

final class Message extends ProtocolBase
{
    /**
     * This field indicates the level of assurance for delivery of an Application Message. Can be 0, 1 or 2
     *
     * 0: At most once delivery (default)
     * 1: At least once delivery
     * 2: Exactly once delivery
     *
     * @var int
     */
    private $qosLevel = 0;

    /**
     * @var string
     */
    private $payload;

    /**
     * If the RETAIN flag is set to 1, in a PUBLISH Packet sent by a Client to a Server, the Server MUST store the
     * Application Message and its QoS, so that it can be delivered to future subscribers whose subscriptions match its
     * topic name
     * @var bool
     */
    private $isRetained = false;

    /**
     * The Topic Name identifies the information channel to which payload data is published
     * @var Topic
     */
    private $topic;

    /**
     * Will perform validation on the message before sending it to the MQTT broker
     *
     * @return Message
     * @throws \unreal4u\MQTT\Exceptions\MissingTopicName
     * @throws \unreal4u\MQTT\Exceptions\MessageTooBig
     */
    public function validateMessage(): Message
    {
        if ($this->getTopicName() === '') {
            $this->logger->error('Topic name is empty, probably not filled in beforehand');
            throw new MissingTopicName('Topic name can\'t be empty, please provide one');
        }

        if (mb_strlen($this->payload) > 65535) {
            $this->logger->error('Message payload exceeds 65535 bytes');
            throw new MessageTooBig('Message payload can not exceed 65535 bytes!');
        }

        return $this;
    }

    /**
     * Sets the actual payload to be sent to the message broker
     *
     * @param string $payload
     * @return Message
     */
    public function setPayload(string $payload): Message
    {
        $this->payload = $payload;
        return $this;
    }

    public function getPayload(): string
    {
        return $this->payload;
    }

    /**
     * Sets the QoS level to the indicated value. Must be 0, 1 or 2.
     *
     * @param int $level
     * @return Message
     * @throws \unreal4u\MQTT\Exceptions\InvalidQoSLevel
     */
    public function setQoSLevel(int $level): Message
    {
        if ($level > 2 || $level < 0) {
            $this->logger->error('Invalid QoS level detected, must be 0, 1 or 2');
            throw new InvalidQoSLevel('The QoS level must be 0, 1 or 2');
        }

        $this->qosLevel = $level;
        return $this;
    }

    /**
     * Sets the retain flag to the given value
     *
     * @param bool $flag Set to true if message should be retained, false otherwise (default)
     * @return Message
     */
    public function setRetainFlag(bool $flag): Message
    {
        $this->isRetained = $flag;
        return $this;
    }

    /**
     * Sets the topic name to the given value
     *
     * @param Topic $topic
     * @return Message
     */
    public function setTopic(Topic $topic): Message
    {
        $this->topic = $topic;
        return $this;
    }

    /**
     * Gets the topic name
     *
     * @return string
     * @throws \unreal4u\MQTT\Exceptions\MissingTopicName
     */
    public function getTopicName(): string
    {
        if ($this->topic === null) {
            throw new MissingTopicName('A topic must be set before calling getTopicName()');
        }

        return $this->topic->getTopicName();
    }

    /**
     * Gets the current QoS level
     *
     * @return int
     */
    public function getQoSLevel(): int
    {
        return $this->qosLevel;
    }

    /**
     * Gets the set retain flag
     *
     * @return bool
     */
    public function isRetained(): bool
    {
        return $this->isRetained;
    }
}