Coldwave Documentation

Appearance

class flake::Indication ​

Represents an incoming indication (server → client notification). More...

#include <platform/flake/Object.h>

Public Functions ​

Name
Indication() =default
virtual~Indication() =default
virtual uint8_ttype() const =0
Message type identifier (one of the MessageType constants).
virtual addr_tsource() const =0
Source address of the indication.
virtual addr_tdestination() const =0
Destination address of the indication.
virtual constPropArray &getData() const =0
Payload data accompanying the indication.
virtual voidack(int8_t result, constPropArray & va =PropArray()) const =0
Acknowledge the indication with a result code and optional response data.
virtual boolacknowledged() const =0
Check whether this indication has already been acknowledged.

Detailed Description ​

cpp
class flake::Indication;

Represents an incoming indication (server → client notification).

Note: Non-copyable, non-movable.

Indications are delivered through IndicationSink::onIndication() or through a subscription callback registered via Object::subscribe().

Call ack() to acknowledge an indication that expects a response.

Public Functions Documentation ​

function Indication ​

cpp
Indication() =default

function ~Indication ​

cpp
virtual ~Indication() =default

function type ​

cpp
virtual uint8_t type() const =0

Message type identifier (one of the MessageType constants).

Return: The raw message-type byte.

function source ​

cpp
virtual addr_t source() const =0

Source address of the indication.

Return: The address of the originating object.

function destination ​

cpp
virtual addr_t destination() const =0

Destination address of the indication.

Return: The address this indication was sent to (may be a group / broadcast address).

function getData ​

cpp
virtual constPropArray & getData() const =0

Payload data accompanying the indication.

Return: Const reference to the property array payload.

function ack ​

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

Acknowledge the indication with a result code and optional response data.

Parameters:

  • result Application-defined result code (0 = success).
  • va Optional response properties.

function acknowledged ​

cpp
virtual bool acknowledged() const =0

Check whether this indication has already been acknowledged.

Return: true if ack() was called, false otherwise.