Coldwave Documentation

Appearance

class flake::Message ​

#include </Users/ios_developer/workspace/coldwave-os/build/_deps/flake-src/protocol/Message.h>

Inherits from flake::Indication, flake::Confirmation

Public Functions ​

Name
Message *create()
Message *create([const]Message & ref)
Message *create([uint8_t] msgType, [uint8_t] msg, [addr_t] src, [addr_t] dst)
Message &operator=([const]Message & ref)
[void]destroy()
CRCStatuscheckCRC()
[void]serializeHeader([uint8_t] * dst, [size_t] max_size, [size_t] * actual_size)
[bool]getNextSerializedChunk([uint8_t] * dst, [size_t] max_size, [size_t] * actual_size)
[bool]pushNextDeserializationChunk([const][uint8_t] * data, [size_t] length, [size_t] * consumed)
Transport *transport() const
[uint8_t]headerLength() const
[void]setData([const]Property & v)
[void]clearData()
virtual [const]PropArray &getData() const override
virtual [void]ack([int8_t] result, [const]PropArray & va =PropArray()) const override
virtual [bool]acknowledged() const override
[bool]isIndication() const
[bool]isConfirmation() const
[bool]isRequest() const
[bool]isResponse() const
[bool]hasPayload() const
virtual [uint8_t]type() const override
virtual [addr_t]source() const override
virtual [addr_t]destination() const override
virtual [int8_t]result() const override
virtual [Token]token() const override
[uint8_t]crc() const
[void]setClientCount([unsigned] count)
[unsigned]clientCount() const

Public Attributes ​

Name
[PoolAllocator]< Message,(30UL) >pool

Friends ​

Name
[class]Transport(Transport )
[class]PoolAllocator< Message,(30UL) >([PoolAllocator]< Message,(30UL) > )

Additional inherited members ​

Public Functions inherited from flake::Indication

Name
virtual~Indication() =default

Public Functions inherited from flake::Confirmation

Name
virtual~Confirmation() =default

Public Functions Documentation ​

function create ​

cpp
static Message * create()

function create ​

cpp
static Message * create(
    constMessage & ref
)

function create ​

cpp
static Message * create(
    uint8_t msgType,
    uint8_t msg,
    addr_t src,
    addr_t dst
)

function operator= ​

cpp
Message & operator=(
    constMessage & ref
)

function destroy ​

cpp
void destroy()

function checkCRC ​

cpp
CRCStatus checkCRC()

function serializeHeader ​

cpp
void serializeHeader(
    uint8_t * dst,
    size_t max_size,
    size_t * actual_size
)

function getNextSerializedChunk ​

cpp
bool getNextSerializedChunk(
    uint8_t * dst,
    size_t max_size,
    size_t * actual_size
)

function pushNextDeserializationChunk ​

cpp
bool pushNextDeserializationChunk(
    constuint8_t * data,
    size_t length,
    size_t * consumed
)

function transport ​

cpp
Transport * transport() const

function headerLength ​

cpp
uint8_t headerLength() const

function setData ​

cpp
void setData(
    constProperty & v
)

function clearData ​

cpp
void clearData()

function getData ​

cpp
virtual constPropArray & getData() const override

Return:

Reimplements: flake::Indication::getData

function ack ​

cpp
virtual void ack(
    int8_t result,
    constPropArray & va =PropArray()
) const override

Parameters:

  • result
  • va

Reimplements: flake::Indication::ack

function acknowledged ​

cpp
virtual bool acknowledged() const override

Return:

Reimplements: flake::Indication::acknowledged

function isIndication ​

cpp
inline bool isIndication() const

function isConfirmation ​

cpp
inline bool isConfirmation() const

function isRequest ​

cpp
inline bool isRequest() const

function isResponse ​

cpp
inline bool isResponse() const

function hasPayload ​

cpp
inline bool hasPayload() const

function type ​

cpp
inline virtual uint8_t type() const override

Return:

Reimplements: flake::Indication::type

function source ​

cpp
inline virtual addr_t source() const override

Return:

Reimplements: flake::Indication::source

function destination ​

cpp
inline virtual addr_t destination() const override

Return:

Reimplements: flake::Indication::destination

function result ​

cpp
inline virtual int8_t result() const override

Return:

Reimplements: flake::Confirmation::result

function token ​

cpp
inline virtual Token token() const override

Return:

Reimplements: flake::Confirmation::token

function crc ​

cpp
inline uint8_t crc() const

function setClientCount ​

cpp
void setClientCount(
    unsigned count
)

function clientCount ​

cpp
unsigned clientCount() const

Public Attributes Documentation ​

variable pool ​

cpp
static PoolAllocator< Message, MAX_MESSAGE_POOL > flake::Message::pool

Friends ​

friend Transport ​

cpp
friend class Transport(
    Transport 
);

friend PoolAllocator< Message,(30UL) > ​

cpp
friend class PoolAllocator< Message,(30UL) >(
    PoolAllocator< Message,(30UL) > 
);