commrat::SubscribeRequestPayload Struct Reference

Request to subscribe to continuous data from a producer module. More...

#include <commrat/messaging/system/subscription_messages.hpp>

Public Attributes
uint32_t	subscriber_base_addr {0}
	Consumer's base address ([type][sys][inst][mbx=0])
uint8_t	mailbox_index {0}
	Which mailbox to send data to (DATA mailbox index)
int64_t	requested_period_ms {0}
	Desired update period in ms (0 = as fast as possible)

Detailed Description

Request to subscribe to continuous data from a producer module.

Consumer sends this to producer to request data stream. Producer will add consumer to its subscriber list.

RACK-style addressing: subscriber_base_addr contains [type][sys][inst][0] mailbox_index specifies which mailbox to send data to (DATA mailbox index)

Definition at line 17 of file subscription_messages.hpp.

Member Data Documentation

mailbox_index

uint8_t commrat::SubscribeRequestPayload::mailbox_index {0}

Which mailbox to send data to (DATA mailbox index)

Definition at line 19 of file subscription_messages.hpp.

Referenced by commrat::SubscriptionProtocol< Registry, has_continuous_input, has_multi_input, InputData, InputTypesTuple, InputCount, OutputData, OutputTypesTuple >::handle_subscribe_request().

requested_period_ms

int64_t commrat::SubscribeRequestPayload::requested_period_ms {0}

Desired update period in ms (0 = as fast as possible)

Definition at line 20 of file subscription_messages.hpp.

subscriber_base_addr

uint32_t commrat::SubscribeRequestPayload::subscriber_base_addr {0}

Consumer's base address ([type][sys][inst][mbx=0])

Definition at line 18 of file subscription_messages.hpp.

Referenced by commrat::SubscriptionProtocol< Registry, has_continuous_input, has_multi_input, InputData, InputTypesTuple, InputCount, OutputData, OutputTypesTuple >::handle_subscribe_request(), and commrat::SubscriptionProtocol< Registry, has_continuous_input, has_multi_input, InputData, InputTypesTuple, InputCount, OutputData, OutputTypesTuple >::subscribe_to_source_impl().

---

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

• commrat/messaging/system/subscription_messages.hpp