Appearance
class flake::Confirmation
Represents the reply (confirmation) to a previously sent request. More...
#include <platform/flake/Object.h>
Public Functions
| Name | |
|---|---|
| Confirmation() =default | |
| virtual | ~Confirmation() =default |
| virtual uint8_t | type() const =0 Message type identifier of the original request. |
| virtual addr_t | source() const =0 Source address (the responder's address). |
| virtual addr_t | destination() const =0 Destination address (the original requester). |
| virtual constPropArray & | getData() const =0 Payload data accompanying the confirmation. |
| virtual int8_t | result() const =0 Result code set by the responder. |
| virtual Token | token() const =0 Token that correlates this confirmation with its request. |
Detailed Description
cpp
class flake::Confirmation;Represents the reply (confirmation) to a previously sent request.
Note: Non-copyable, non-movable.
Confirmations are delivered through ConfirmationSink::onConfirmation().
Public Functions Documentation
function Confirmation
cpp
Confirmation() =defaultfunction ~Confirmation
cpp
virtual ~Confirmation() =defaultfunction type
cpp
virtual uint8_t type() const =0Message type identifier of the original request.
Return: The raw message-type byte.
function source
cpp
virtual addr_t source() const =0Source address (the responder's address).
Return: Address of the object that produced the confirmation.
function destination
cpp
virtual addr_t destination() const =0Destination address (the original requester).
Return: Address the confirmation was sent to.
function getData
cpp
virtual constPropArray & getData() const =0Payload data accompanying the confirmation.
Return: Const reference to the property array payload.
function result
cpp
virtual int8_t result() const =0Result code set by the responder.
Return: Application-defined result (0 = success).
function token
cpp
virtual Token token() const =0Token that correlates this confirmation with its request.
Return: The matching request token.