LoomSubscribePlat class

Abstract subscribe platform module.

Reference

All SubscribePlat modules inherit from this class.

Base classes

class LoomModule: Abstract root of Loom component modules inheritance hierarchy.

Derived classes

class Loom_MaxSub: Module for receiving data from Max.

Protected variables

LoomInternetPlat* m_internet: Pointer to internet platform to use to publish.
const LoomModule::Type internet_type: Type of internet platform used to publish.
StaticJsonDocument<1000> messageJson: Subscribe Platforms need their own JsonDocument because an incoming message can only be deserialized into JsonDocuments, not JsonObjects.

CONSTRUCTORS / DESTRUCTOR

Document to read incoming data into

LoomSubscribePlat(LoomManager* manager, const char* module_name, const LoomModule::Type module_type, const LoomModule::Type internet_type): Constructor.
~LoomSubscribePlat() defaulted virtual: Destructor.
void second_stage_ctor() override: Grab the internet platform specified by the ctor parameters.

OPERATION

auto subscribe(JsonObject json) -> bool pure virtual: Request / try to receive data from platform subscribed to.
auto subscribe() -> bool: Version of log for use with LoomManager.

PRINT INFORMATION

void print_config() const override: Display the configuration settings of the module.
void print_state() const override: Display current state of the module.

Function documentation

LoomSubscribePlat::LoomSubscribePlat(LoomManager* manager, const char* module_name, const LoomModule::Type module_type, const LoomModule::Type internet_type)

Constructor.

Parameters
manager
module_name in	String \| <"Internet-Plat"> \| null \| Publish platform module name
module_type in	Type of the module (provided by derived classes)
internet_type in	Set(LoomModule::Type) \| <7001> \| {7001("Ethernet"), 7002("WiFi")} \| Code of the desired internet platform.

bool LoomSubscribePlat::subscribe(JsonObject json) pure virtual

Request / try to receive data from platform subscribed to.

Parameters
json out	Received data
Returns	True if received anything

bool LoomSubscribePlat::subscribe()

Version of log for use with LoomManager.

Returns	True if received anything

Accesses Json from LoomManager

Variable documentation

const LoomModule::Type LoomSubscribePlat::internet_type protected

Type of internet platform used to publish.

Needed because finding the module for m_internet happens in second_stage_ctor(), rather than the regular constructor.

StaticJsonDocument<1000> LoomSubscribePlat::messageJson protected

Subscribe Platforms need their own JsonDocument because an incoming message can only be deserialized into JsonDocuments, not JsonObjects.

And it seemed bad design to pass around references to the LoomManager's internal JsonDocument. Also as the LoomManager is intended to be non-mandatory for usage of Loom