diff options
Diffstat (limited to 'mnsl/mns_amspool.h')
| -rw-r--r-- | mnsl/mns_amspool.h | 100 |
1 files changed, 100 insertions, 0 deletions
diff --git a/mnsl/mns_amspool.h b/mnsl/mns_amspool.h new file mode 100644 index 0000000..387dc9b --- /dev/null +++ b/mnsl/mns_amspool.h @@ -0,0 +1,100 @@ +/* + * MOST NetServices "Light" V3.2.7.0.1796 MultiInstance Patch + * + * Copyright (C) 2015 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 3 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 Internal header file of Application Message Pools + * + * \cond MNS_INTERNAL_DOC + * \addtogroup G_AMSPOOL + * @{ + */ + +#ifndef MNS_AMSPOOL_H +#define MNS_AMSPOOL_H + +/*------------------------------------------------------------------------------------------------*/ +/* Includes */ +/*------------------------------------------------------------------------------------------------*/ +#include "mns_ams_pb.h" +#include "mns_amsmessage.h" +#include "mns_obs.h" + +#ifdef __cplusplus +extern "C" +{ +#endif + +/*------------------------------------------------------------------------------------------------*/ +/* Classes */ +/*------------------------------------------------------------------------------------------------*/ +/*! \brief Class members of AMS Pool */ +typedef struct CAmsMsgPool_ +{ + Ams_MemAllocator_t *allocator_ptr; /*!< \brief Interface to memory allocator */ + Mns_AmsRx_Msg_t *rx_rsvd_msg_ptr; /*!< \brief Pre-allocated Rx message or NULL if no + * reserved message is available */ + Mns_AmsRx_Msg_t *rx_rsvd_msg_ref; /*!< \brief Stores the reference of the reserved message + * to identify it and restore the + * \c rx_rsvd_msg_ptr. */ + CSubject tx_freed_subject; /*!< \brief Allows to observe freed Tx message event */ + CSubject rx_freed_subject; /*!< \brief Allows to observe freed Rx message event */ + bool tx_notify_freed; /*!< \brief Is \c true when to notify the next Tx freed object */ + bool rx_notify_freed; /*!< \brief Is \c true when to notify the next Rx freed object */ + bool terminated; /*!< \brief Is \c true if a cleanup was done. Helps to release the + * pre-allocated message after the first cleanup attempt. */ + uint8_t mns_inst_id; /*!< \brief MOST NetServices instance ID */ + +} CAmsMsgPool; + +/*------------------------------------------------------------------------------------------------*/ +/* Class methods */ +/*------------------------------------------------------------------------------------------------*/ +extern void Amsp_Ctor(CAmsMsgPool *self, Ams_MemAllocator_t *mem_allocator_ptr, uint8_t mns_inst_id); +extern void Amsp_Cleanup(CAmsMsgPool *self); +/* Tx */ +extern void Amsp_AssignTxFreedObs(CAmsMsgPool *self, CObserver *observer_ptr); +extern Mns_AmsTx_Msg_t* Amsp_AllocTxObj(CAmsMsgPool *self, uint16_t payload_sz); +/* Rx */ +extern void Amsp_AssignRxFreedObs(CAmsMsgPool *self, CObserver *observer_ptr); +extern Mns_AmsRx_Msg_t* Amsp_AllocRxObj(CAmsMsgPool *self, uint16_t payload_sz); +extern Mns_AmsRx_Msg_t* Amsp_AllocRxRsvd(CAmsMsgPool *self); +extern bool Amsp_AllocRxPayload(CAmsMsgPool *self, uint16_t payload_sz, Mns_AmsRx_Msg_t* msg_ptr); +extern void Amsp_FreeRxObj(CAmsMsgPool *self, Mns_AmsRx_Msg_t* msg_ptr); +extern void Amsp_FreeRxPayload(CAmsMsgPool *self, Mns_AmsRx_Msg_t* msg_ptr); + +#ifdef __cplusplus +} /* extern "C" */ +#endif + +#endif /* MNS_AMSPOOL_H */ + +/*! + * @} + * \endcond + */ + +/*------------------------------------------------------------------------------------------------*/ +/* End of file */ +/*------------------------------------------------------------------------------------------------*/ + |