baseshare.h File Reference

Headers for a base class for type-safe, thread-safe task data exchange classes. More...

#include <Arduino.h>

Include dependency graph for baseshare.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Classes
class	BaseShare
	Base class for classes that share data in a thread-safe manner between tasks. More...

Functions
void	print_all_shares (Print &printer)
	Start the printout showing the status of all shared data items. More...

Detailed Description

Headers for a base class for type-safe, thread-safe task data exchange classes.

This file contains a base class for classes which exchange data between tasks. Inter-task data must be exchanged in a thread-safe manner, so the classes which share the data use mutexes or mutual exclusion mechanisms to prevent corruption of data. A linked list of all inter-task data items is kept by this system, and this base class contains members that handle that linked list.

Date

2014-Oct-18 JRR Created file

2020-Oct-19 JRR Modified for use with Arduino/FreeRTOS platform

License: This file is copyright 2014 - 2020 by JR Ridgely and released under the Lesser GNU Public License, version 2. It intended for educational use only, but its use is not limited thereto.

Function Documentation

print_all_shares()

void print_all_shares

(

Print &

printer

)

Start the printout showing the status of all shared data items.

This method begins printing out the status of all items in the system's linked list of shared data items (queues, task shares, and so on). The most recently created share's status is printed first, followed by the status of other shares in reverse order of creation.

Parameters

printer

Pointer to a serial device on which to print