129 lines
4.3 KiB
C
129 lines
4.3 KiB
C
/*
|
|
ChibiOS - Copyright (C) 2006..2023 Giovanni Di Sirio
|
|
|
|
Licensed under the Apache License, Version 2.0 (the "License");
|
|
you may not use this file except in compliance with the License.
|
|
You may obtain a copy of the License at
|
|
|
|
http://www.apache.org/licenses/LICENSE-2.0
|
|
|
|
Unless required by applicable law or agreed to in writing, software
|
|
distributed under the License is distributed on an "AS IS" BASIS,
|
|
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
See the License for the specific language governing permissions and
|
|
limitations under the License.
|
|
*/
|
|
|
|
/**
|
|
* @file oop_synchronized_object.h
|
|
* @brief Generated Synchronized Object header.
|
|
* @note This is a generated file, do not edit directly.
|
|
*
|
|
* @addtogroup OOP_SYNCHRONIZED_OBJECT
|
|
* @brief Common ancestor class of all reference-counted, synchronized
|
|
* objects.
|
|
* @{
|
|
*/
|
|
|
|
#ifndef OOP_SYNCHRONIZED_OBJECT_H
|
|
#define OOP_SYNCHRONIZED_OBJECT_H
|
|
|
|
#include "oop_referenced_object.h"
|
|
|
|
/*===========================================================================*/
|
|
/* Module constants. */
|
|
/*===========================================================================*/
|
|
|
|
/*===========================================================================*/
|
|
/* Module pre-compile time settings. */
|
|
/*===========================================================================*/
|
|
|
|
/*===========================================================================*/
|
|
/* Derived constants and error checks. */
|
|
/*===========================================================================*/
|
|
|
|
#if defined(OOP_USE_NOTHING)
|
|
#error "OOP_USE_NOTHING specified, not compatible"
|
|
#endif
|
|
|
|
/*===========================================================================*/
|
|
/* Module macros. */
|
|
/*===========================================================================*/
|
|
|
|
/*===========================================================================*/
|
|
/* Module data structures and types. */
|
|
/*===========================================================================*/
|
|
|
|
/**
|
|
* @class synchronized_object_c
|
|
* @extends base_object_c, referenced_object_c.
|
|
*
|
|
* @brief Common ancestor class of all reference-counted, synchronized
|
|
* objects.
|
|
* @details Base class for objects that require a synchronization
|
|
* mechanism. This class extends @p referenced_object_c class.
|
|
*
|
|
* @name Class @p synchronized_object_c structures
|
|
* @{
|
|
*/
|
|
|
|
/**
|
|
* @brief Type of a synchronized object class.
|
|
*/
|
|
typedef struct synchronized_object synchronized_object_c;
|
|
|
|
/**
|
|
* @brief Class @p synchronized_object_c virtual methods table.
|
|
*/
|
|
struct synchronized_object_vmt {
|
|
/* From base_object_c.*/
|
|
void (*dispose)(void *ip);
|
|
/* From referenced_object_c.*/
|
|
void * (*addref)(void *ip);
|
|
object_references_t (*release)(void *ip);
|
|
/* From synchronized_object_c.*/
|
|
};
|
|
|
|
/**
|
|
* @brief Structure representing a synchronized object class.
|
|
*/
|
|
struct synchronized_object {
|
|
/**
|
|
* @brief Virtual Methods Table.
|
|
*/
|
|
const struct synchronized_object_vmt *vmt;
|
|
/**
|
|
* @brief Number of references to the object.
|
|
*/
|
|
object_references_t references;
|
|
/**
|
|
* @brief Embedded synchronization mutex.
|
|
*/
|
|
mutex_t mutex;
|
|
};
|
|
/** @} */
|
|
|
|
/*===========================================================================*/
|
|
/* External declarations. */
|
|
/*===========================================================================*/
|
|
|
|
#ifdef __cplusplus
|
|
extern "C" {
|
|
#endif
|
|
/* Methods of synchronized_object_c.*/
|
|
void *__so_objinit_impl(void *ip, const void *vmt);
|
|
void __so_dispose_impl(void *ip);
|
|
void soLock(void *ip);
|
|
void soUnlock(void *ip);
|
|
#ifdef __cplusplus
|
|
}
|
|
#endif
|
|
|
|
/*===========================================================================*/
|
|
/* Module inline functions. */
|
|
/*===========================================================================*/
|
|
|
|
#endif /* OOP_SYNCHRONIZED_OBJECT_H */
|
|
|
|
/** @} */
|