diff options
Diffstat (limited to 'mnsl/mns_pool.h')
| -rw-r--r-- | mnsl/mns_pool.h | 82 |
1 files changed, 82 insertions, 0 deletions
diff --git a/mnsl/mns_pool.h b/mnsl/mns_pool.h new file mode 100644 index 0000000..c9b6edd --- /dev/null +++ b/mnsl/mns_pool.h @@ -0,0 +1,82 @@ +/* + * 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 Declaration of message pool class + * + * \cond MNS_INTERNAL_DOC + * \addtogroup G_POOL + * @{ + */ +#ifndef MNS_POOL_H +#define MNS_POOL_H + +/*------------------------------------------------------------------------------------------------*/ +/* Includes */ +/*------------------------------------------------------------------------------------------------*/ +#include "mns_message.h" +#include "mns_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 */ + uint8_t mns_inst_id; /*! \brief MOST NetServices instance ID */ + +} CPool; + +/*------------------------------------------------------------------------------------------------*/ +/* Methods */ +/*------------------------------------------------------------------------------------------------*/ +extern void Pool_Ctor(CPool *self, CMessage messages[], uint16_t size, uint8_t mns_inst_id); +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 MNS_POOL_H */ + +/*! + * @} + * \endcond + */ + +/*------------------------------------------------------------------------------------------------*/ +/* End of file */ +/*------------------------------------------------------------------------------------------------*/ + |