iot::mqtt::FixedHeader Class Reference

#include <FixedHeader.h>

Collaboration diagram for iot::mqtt::FixedHeader:

Public Member Functions
	FixedHeader ()
	FixedHeader (uint8_t type, uint8_t flags, uint32_t remainingLength=0)
	~FixedHeader ()
std::size_t	deserialize (iot::mqtt::MqttContext *mqttContext)
std::vector< char >	serialize () const
uint8_t	getType () const
uint8_t	getFlags () const
void	setRemainingLength (uint32_t remainingLength)
uint32_t	getRemainingLength () const
bool	isComplete () const
bool	isError () const
void	reset ()

Private Attributes
types::UInt8	typeFlags
types::UIntV	remainingLength
bool	complete = false
bool	error = false
int	state = 0

Detailed Description

Definition at line 40 of file FixedHeader.h.

Constructor & Destructor Documentation

FixedHeader() [1/2]

iot::mqtt::FixedHeader::FixedHeader

(

)

Definition at line 28 of file FixedHeader.cpp.

                             {
    }

FixedHeader() [2/2]

iot::mqtt::FixedHeader::FixedHeader	(	uint8_t	type,
		uint8_t	flags,
		uint32_t	remainingLength = 0 )

Definition at line 31 of file FixedHeader.cpp.

                                                                                  {
        this->typeFlags = static_cast<uint8_t>((type << 4) | (flags & 0x0F));
        this->remainingLength = remainingLength;
    }

~FixedHeader()

iot::mqtt::FixedHeader::~FixedHeader

(

)

Definition at line 36 of file FixedHeader.cpp.

                              {
    }

Member Function Documentation

deserialize()

std::size_t iot::mqtt::FixedHeader::deserialize

(

iot::mqtt::MqttContext *

mqttContext

)

Definition at line 39 of file FixedHeader.cpp.

                                                               {
        std::size_t consumed = 0;
 
        switch (state) {
            case 0:
                consumed += typeFlags.deserialize(mqttContext);
 
                if (!typeFlags.isComplete()) {
                    break;
                }
                state++;
                [[fallthrough]];
            case 1:
                consumed += remainingLength.deserialize(mqttContext);
 
                complete = remainingLength.isComplete();
                error = remainingLength.isError();
 
                break;
        }
 
        return consumed;
    }

References state.

getFlags()

uint8_t iot::mqtt::FixedHeader::getFlags

(

)

const

Definition at line 67 of file FixedHeader.cpp.

                                        {
        return static_cast<uint8_t>(typeFlags & 0x0F);
    }

getRemainingLength()

uint32_t iot::mqtt::FixedHeader::getRemainingLength

(

)

const

Definition at line 75 of file FixedHeader.cpp.

                                                   {
        return remainingLength;
    }

getType()

uint8_t iot::mqtt::FixedHeader::getType

(

)

const

Definition at line 63 of file FixedHeader.cpp.

                                       {
        return static_cast<uint8_t>(typeFlags >> 0x04);
    }

isComplete()

bool iot::mqtt::FixedHeader::isComplete

(

)

const

Definition at line 79 of file FixedHeader.cpp.

                                       {
        return complete;
    }

References complete.

isError()

bool iot::mqtt::FixedHeader::isError

(

)

const

Definition at line 83 of file FixedHeader.cpp.

                                    {
        return error;
    }

References error.

reset()

void iot::mqtt::FixedHeader::reset

(

)

Definition at line 96 of file FixedHeader.cpp.

                            {
        typeFlags.reset();
        remainingLength.reset();
 
        complete = false;
        error = false;
 
        state = 0;
    }

References complete, error, and state.

serialize()

std::vector< char > iot::mqtt::FixedHeader::serialize

(

)

const

Definition at line 87 of file FixedHeader.cpp.

                                                 {
        std::vector<char> packet = typeFlags.serialize();
 
        std::vector<char> tmpVector = remainingLength.serialize();
        packet.insert(packet.end(), tmpVector.begin(), tmpVector.end());
 
        return packet;
    }

setRemainingLength()

void iot::mqtt::FixedHeader::setRemainingLength

(

uint32_t

remainingLength

)

Definition at line 71 of file FixedHeader.cpp.

                                                                 {
        this->remainingLength = remainingLength;
    }

Member Data Documentation

complete

bool iot::mqtt::FixedHeader::complete = false

private

Definition at line 65 of file FixedHeader.h.

Referenced by isComplete(), and reset().

error

bool iot::mqtt::FixedHeader::error = false

private

Definition at line 66 of file FixedHeader.h.

Referenced by isError(), and reset().

remainingLength

types::UIntV iot::mqtt::FixedHeader::remainingLength

private

Definition at line 63 of file FixedHeader.h.

state

int iot::mqtt::FixedHeader::state = 0

private

Definition at line 68 of file FixedHeader.h.

Referenced by deserialize(), and reset().

typeFlags

types::UInt8 iot::mqtt::FixedHeader::typeFlags

private

Definition at line 62 of file FixedHeader.h.

---

The documentation for this class was generated from the following files:

• iot/mqtt/FixedHeader.h
• iot/mqtt/FixedHeader.cpp