SatCat5
Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
satcat5::freertos::MessageCopy Class Referencefinal

Detailed Description

Copy data from a Readable source to a FreeRTOS MessageBuffer.

Definition at line 23 of file message_buffer.h.

#include <message_buffer.h>

Inheritance diagram for satcat5::freertos::MessageCopy:
[legend]
Collaboration diagram for satcat5::freertos::MessageCopy:
[legend]

Public Member Functions

 MessageCopy (satcat5::io::Readable *src, MessageBufferHandle_t *msg_buff_handle, SemaphoreHandle_t *msg_buff_semphr)
 

Protected Member Functions

void data_rcvd (satcat5::io::Readable *src) override
 The data_rcvd() callback is polled whenever data is available. More...
 
void data_unlink (satcat5::io::Readable *src) override
 Unlink this EventListener from the designated source, because the designated Readable object is being destroyed. More...
 

Protected Attributes

satcat5::io::Readable * m_src
 
MessageBufferHandle_t *const m_handle
 
SemaphoreHandle_t *const m_mutex
 

Member Function Documentation

◆ data_rcvd()

void MessageCopy::data_rcvd ( satcat5::io::Readable *  src)
overrideprotectedvirtual

The data_rcvd() callback is polled whenever data is available.

A pointer is provided to assist handlers with multiple sources. Child objects of io::EventListener MUST override this method.

Implements satcat5::io::EventListener.

Definition at line 48 of file message_buffer.cc.

◆ data_unlink()

void MessageCopy::data_unlink ( satcat5::io::Readable *  src)
overrideprotectedvirtual

Unlink this EventListener from the designated source, because the designated Readable object is being destroyed.

Child objects of io::EventListener MAY override this method if action is required.

Reimplemented from satcat5::io::EventListener.

Definition at line 44 of file message_buffer.cc.

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