PicoScenes API Docs
 
Loading...
Searching...
No Matches
PicoScenesMessagingService Class Reference

The messaging service for PicoScenes Platform. More...

#include <PicoScenesMessagingService.hxx>

Public Member Functions

void append2MessageQueue (const UniversalMessageType &message)
 
void clearMessageQueue ()
 
void send (const ModularPicoScenesRxFrame &rxFrame, const std::string &destination, const std::string &source, const std::string &description="")
 
void send (const ModularPicoScenesTxFrame &txFrame, const std::string &destination, const std::string &source, const std::string &description="")
 
void send (const std::string &textContent, const std::string &destination, const std::string &source, const std::string &description="")
 
void send (const pt::ptree &ptree, const std::string &destination, const std::string &source, const std::string &description="")
 
void send (const U8Vector &data, const std::string &destination, const std::string &source, const std::string &description="")
 
void send (const uint8_t *data, size_t bufferLength, const std::string &destination, const std::string &source, const std::string &description="")
 
void registerMessageHandler (const std::string &handlerName, std::function< void(const UniversalMessageType &)> handler)
 
void unregisterHandler (const std::string &handlerName)
 

Static Public Member Functions

static std::shared_ptr< PicoScenesMessagingServicegetInstance (const std::string &messagingChannelId="default")
 
static UniversalMessageType makeMessage (const std::any &object, const std::string &destination, const std::string &source, const std::string &description)
 

Detailed Description

The messaging service for PicoScenes Platform.

Definition at line 17 of file PicoScenesMessagingService.hxx.

Member Function Documentation

◆ append2MessageQueue()

void PicoScenesMessagingService::append2MessageQueue ( const UniversalMessageType message)

◆ clearMessageQueue()

void PicoScenesMessagingService::clearMessageQueue ( )

◆ getInstance()

static std::shared_ptr< PicoScenesMessagingService > PicoScenesMessagingService::getInstance ( const std::string &  messagingChannelId = "default")
static

◆ makeMessage()

static UniversalMessageType PicoScenesMessagingService::makeMessage ( const std::any &  object,
const std::string &  destination,
const std::string &  source,
const std::string &  description 
)
static

◆ registerMessageHandler()

void PicoScenesMessagingService::registerMessageHandler ( const std::string &  handlerName,
std::function< void(const UniversalMessageType &)>  handler 
)

◆ send() [1/6]

void PicoScenesMessagingService::send ( const ModularPicoScenesRxFrame &  rxFrame,
const std::string &  destination,
const std::string &  source,
const std::string &  description = "" 
)

◆ send() [2/6]

void PicoScenesMessagingService::send ( const ModularPicoScenesTxFrame &  txFrame,
const std::string &  destination,
const std::string &  source,
const std::string &  description = "" 
)

◆ send() [3/6]

void PicoScenesMessagingService::send ( const pt::ptree &  ptree,
const std::string &  destination,
const std::string &  source,
const std::string &  description = "" 
)

◆ send() [4/6]

void PicoScenesMessagingService::send ( const std::string &  textContent,
const std::string &  destination,
const std::string &  source,
const std::string &  description = "" 
)

◆ send() [5/6]

void PicoScenesMessagingService::send ( const U8Vector &  data,
const std::string &  destination,
const std::string &  source,
const std::string &  description = "" 
)

◆ send() [6/6]

void PicoScenesMessagingService::send ( const uint8_t *  data,
size_t  bufferLength,
const std::string &  destination,
const std::string &  source,
const std::string &  description = "" 
)

◆ unregisterHandler()

void PicoScenesMessagingService::unregisterHandler ( const std::string &  handlerName)

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