blob: ac9166a29c5ecda1713672b2e1f4e8b3cfd8ef71 (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
|
/*------------------------------------------------------------------------------------------------*/
/* UNICENS V2.1.0-3491 */
/* Copyright (c) 2017 Microchip Technology Germany II GmbH & Co. KG. */
/* */
/* This program is free software: you can redistribute it and/or modify */
/* it under the terms of the GNU General Public License as published by */
/* the Free Software Foundation, either version 2 of the License, or */
/* (at your option) any later version. */
/* */
/* This program is distributed in the hope that it will be useful, */
/* but WITHOUT ANY WARRANTY; without even the implied warranty of */
/* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the */
/* GNU General Public License for more details. */
/* */
/* You should have received a copy of the GNU General Public License */
/* along with this program. If not, see <http://www.gnu.org/licenses/>. */
/* */
/* You may also obtain this software under a propriety license from Microchip. */
/* Please contact Microchip for further information. */
/*------------------------------------------------------------------------------------------------*/
/*!
* \file
* \brief Declaration of message pool class
*
* \cond UCS_INTERNAL_DOC
* \addtogroup G_POOL
* @{
*/
#ifndef UCS_POOL_H
#define UCS_POOL_H
/*------------------------------------------------------------------------------------------------*/
/* Includes */
/*------------------------------------------------------------------------------------------------*/
#include "ucs_message.h"
#include "ucs_dl.h"
#ifdef __cplusplus
extern "C"
{
#endif
/*------------------------------------------------------------------------------------------------*/
/* Class CPool */
/*------------------------------------------------------------------------------------------------*/
/*! \brief Class CMessage
* \details Common internal message class which embeds a list of MOST telegrams
*/
typedef struct CPool_
{
uint16_t initial_size; /*! \brief The size of a provided message array */
CMessage *messages; /*! \brief Reference to a message array provided by another module */
CDlList message_list; /*! \brief Doubly linked list required providing available messages */
void *ucs_user_ptr; /*!< \brief User reference that needs to be passed in every callback function */
} CPool;
/*------------------------------------------------------------------------------------------------*/
/* Methods */
/*------------------------------------------------------------------------------------------------*/
extern void Pool_Ctor(CPool *self, CMessage messages[], uint16_t size, void *ucs_user_ptr);
extern CMessage* Pool_GetMsg(CPool *self);
extern void Pool_ReturnMsg(CMessage *msg_ptr);
extern uint16_t Pool_GetCurrentSize(CPool *self);
#ifdef __cplusplus
} /* extern "C" */
#endif
#endif /* #ifndef UCS_POOL_H */
/*!
* @}
* \endcond
*/
/*------------------------------------------------------------------------------------------------*/
/* End of file */
/*------------------------------------------------------------------------------------------------*/
|
