summaryrefslogtreecommitdiffstats
path: root/mnsl/mns_telqueue.h
blob: 2a863871287d3d86d138c48fb83950fbc4ee2fdc (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
81
82
83
84
85
86
87
88
89
90
91
92
93
/*
 * 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 class CTelQueue
 *
 * \cond MNS_INTERNAL_DOC
 * \addtogroup  G_MSG_QUEUE
 * @{
 */

#ifndef MNS_MSGQUEUE_H
#define MNS_MSGQUEUE_H

/*------------------------------------------------------------------------------------------------*/
/* Includes                                                                                       */
/*------------------------------------------------------------------------------------------------*/
#include "mns_message.h"
#include "mns_dl.h"

#ifdef __cplusplus
extern "C"
{
#endif

/*------------------------------------------------------------------------------------------------*/
/* Types                                                                                          */
/*------------------------------------------------------------------------------------------------*/


/*------------------------------------------------------------------------------------------------*/
/* Macros                                                                                         */
/*------------------------------------------------------------------------------------------------*/

/*------------------------------------------------------------------------------------------------*/
/* Class CTelQueue                                                                                */
/*------------------------------------------------------------------------------------------------*/
/*! \brief   Class CTelQueue 
 *  \details Internal class to queue MOST telegrams
 */
typedef struct CTelQueue_
{
    CDlList     list;           /*! \brief  Doubly linked list */
    uint8_t     mns_inst_id;    /*! \brief  MOST NetServices instance ID */

} CTelQueue;


/*------------------------------------------------------------------------------------------------*/
/* Methods                                                                                        */
/*------------------------------------------------------------------------------------------------*/
extern void Telq_Ctor(CTelQueue *self, uint8_t mns_inst_id);
extern Msg_MostTel_t* Telq_Dequeue(CTelQueue *self);
extern Msg_MostTel_t* Telq_Peek(CTelQueue *self);
extern void Telq_Enqueue(CTelQueue *self, Msg_MostTel_t *tel_ptr);
extern uint8_t Telq_GetSize(CTelQueue *self);

#ifdef __cplusplus
}                                                   /* extern "C" */
#endif

#endif /* #ifndef MNS_MSGQUEUE_H */

/*!
 * @}
 * \endcond
 */

/*------------------------------------------------------------------------------------------------*/
/* End of file                                                                                    */
/*------------------------------------------------------------------------------------------------*/