Class passed to the communication link implement to provide callback for received messages over a channel.
More...
#include <uORBCommunicator.hpp>
Class passed to the communication link implement to provide callback for received messages over a channel.
§ process_add_subscription()
| virtual int16_t uORBCommunicator::IChannelRxHandler::process_add_subscription |
( |
const char * |
messageName, |
|
|
int32_t |
msgRateInHz |
|
) |
| |
|
pure virtual |
Interface to process a received AddSubscription from remote.
- Parameters
-
| messageName | This represents the uORB message Name; This message Name should be globally unique. |
| msgRate | The max rate at which the subscriber can accept the messages. |
- Returns
- 0 = success; This means the messages is successfully handled in the handler. otherwise = failure.
§ process_received_message()
| virtual int16_t uORBCommunicator::IChannelRxHandler::process_received_message |
( |
const char * |
messageName, |
|
|
int32_t |
length, |
|
|
uint8_t * |
data |
|
) |
| |
|
pure virtual |
Interface to process the received data message.
- Parameters
-
| messageName | This represents the uORB message Name; This message Name should be globally unique. |
| length | The length of the data buffer to be sent. |
| data | The actual data to be sent. |
- Returns
- 0 = success; This means the messages is successfully handled in the handler. otherwise = failure.
§ process_remote_topic()
| virtual int16_t uORBCommunicator::IChannelRxHandler::process_remote_topic |
( |
const char * |
topic_name, |
|
|
bool |
isAdvertisement |
|
) |
| |
|
pure virtual |
Interface to process a received topic from remote.
- Parameters
-
| topic_name | This represents the uORB message Name (topic); This message Name should be globally unique. |
| isAdvertisement | Represents if the topic has been advertised or is no longer avialable. |
- Returns
- 0 = success; This means the messages is successfully handled in the handler. otherwise = failure.
§ process_remove_subscription()
| virtual int16_t uORBCommunicator::IChannelRxHandler::process_remove_subscription |
( |
const char * |
messageName | ) |
|
|
pure virtual |
Interface to process a received control msg to remove subscription.
- Parameters
-
| messageName | This represents the uORB message Name; This message Name should be globally unique. |
- Returns
- 0 = success; This means the messages is successfully handled in the handler. otherwise = failure.
The documentation for this class was generated from the following file:
