Container.h File Reference

Intrusive Container Documentation and Base Class. More...

#include <FreeRTOS.h>
#include <task.h>

Include dependency graph for Container.h:

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

Go to the source code of this file.

Classes
class	Container< s >
	Base Container Class. More...
class	ContainerNode< s >
	Base Container Node Class. More...

Macros
#define	CONTAINER_OS   CONTINER_OS_FREERTOS
	OS Selection for Thread Safety Selection.
#define	CONTAINER_OS_CMSIS   2
	CMSIS based Safety layer.
#define	CONTAINER_OS_CMSIS2   3
	CMSIS version 2 based Safety layer.
#define	CONTAINER_OS_FREERTOS   1
	FreeRTOS based Safety layer.
#define	CONTAINER_OS_USER   0
	User Defined Safety Layer.
#define	CONTAINER_VERSION_BUILD   0
#define	CONTAINER_VERSION_MAJOR   1
#define	CONTAINER_VERSION_MINOR   0
#define	CONTAINER_VERSION_NUMBER   0x10000
#define	CONTAINER_VERSION_STRING   "1.0.0"

Enumerations
enum	ContainerThreadSafety {   ContainerNoSafety , ContainerReadWrite , ContainerMutexSafe , ContainerTaskOnly ,   ContainerTaskSafe , ContainerISRSafe }
	Thread Safety selection for container. More...

Detailed Description

Intrusive Container Documentation and Base Class.

A File with some general documentation information for the various container classes, no code here.

Warning

Most of the use of this library has been with ContainerNoSafety, so there may be errors in the other versions.

Copyright

(c) 2014-2024 Richard Damon

MIT License:

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

Macro Definition Documentation

CONTAINER_VERSION_BUILD

#define CONTAINER_VERSION_BUILD   0

CONTAINER_VERSION_MAJOR

#define CONTAINER_VERSION_MAJOR   1

CONTAINER_VERSION_MINOR

#define CONTAINER_VERSION_MINOR   0

CONTAINER_VERSION_NUMBER

#define CONTAINER_VERSION_NUMBER   0x10000

CONTAINER_VERSION_STRING

#define CONTAINER_VERSION_STRING   "1.0.0"