Loom_MaxSub class

Module for receiving data from Max.

Reference

Base classes

class LoomSubscribePlat: Abstract subscribe platform module.

Protected variables

uint16_t UDP_port: Which UDP port to receive on.
bool auto_dispatch: True to immediately call LoomManager::dispatch() when packet received.
LoomInternetPlat::UDPPtr UDP_Inst: Pointer to UDP object.

CONSTRUCTORS / DESTRUCTOR

Loom_MaxSub(LoomManager* manager, const LoomModule::Type internet_type, const bool auto_dispatch): Constructor.
Loom_MaxSub(LoomManager* manager, JsonArrayConst p): Constructor that takes Json Array, extracts args and delegates to regular constructor.
void second_stage_ctor() override: Second stage construction.
~Loom_MaxSub(): Destructor.

OPERATION

void package(JsonObject json) override: No package necessary for subscribe platforms.
auto subscribe(JsonObject json) -> bool override: Request / try to receive data from platform subscribed to.

PRINT INFORMATION

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

GETTERS

auto get_port() const -> uint16_t: Get the UDP port currently receiving on.
auto get_remote_IP() const -> IPAddress: Get the last IP address received from.

SETTERS

void set_port(const uint16_t port): Set the UDP port to receive on.

Function documentation

Loom_MaxSub::Loom_MaxSub(LoomManager* manager, const LoomModule::Type internet_type, const bool auto_dispatch)

Constructor.

Parameters
manager
internet_type in	Set(LoomModule::Type) \| <7001> \| {7001("Ethernet"), 7002("WiFi")} \| Code of the desired internet platform.
auto_dispatch in	True to immediately call LoomManager::dispatch() when packet received

Loom_MaxSub::Loom_MaxSub(LoomManager* manager, JsonArrayConst p)

Constructor that takes Json Array, extracts args and delegates to regular constructor.

Parameters
manager
p in	The array of constuctor args to expand

void Loom_MaxSub::second_stage_ctor() override

Second stage construction.

Perform any actions that need all of the devices to be initized beforehand - such as looking up an internet platform This function is guranteed to be called AFTER all modules have been constructed.

void Loom_MaxSub::package(JsonObject json) override

No package necessary for subscribe platforms.

Implement with empty body.

bool Loom_MaxSub::subscribe(JsonObject json) override

Request / try to receive data from platform subscribed to.

Parameters
json out	Received data
Returns	True if received anything

uint16_t Loom_MaxSub::get_port() const

Get the UDP port currently receiving on.

Returns	UDP port being used

IPAddress Loom_MaxSub::get_remote_IP() const

Get the last IP address received from.

Returns	Last IP address

void Loom_MaxSub::set_port(const uint16_t port)

Set the UDP port to receive on.

Parameters
port in	Port to set to

Changing the port from automatic port setting (based on instance number) may make the device stop receiving from Max MSP