summaryrefslogtreecommitdiffstats
path: root/Src/SafeVector.h
blob: 97a4882e7db36cb544e7ca311daecfa4046822c8 (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
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
/*
 * Video On Demand Samples
 *
 * 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  This file contains the CSafeVector class.
 */
/*----------------------------------------------------------*/

#ifndef SAFE_VECTOR_H
#define SAFE_VECTOR_H

#include <stdbool.h>
#include <stdint.h>
#include <stddef.h>
#include <semaphore.h>
#include <vector>
#include "SafeVector.h"

using namespace std;

/*----------------------------------------------------------*/
/*! \brief Thread safe vector class.
 */
/*----------------------------------------------------------*/
template<typename T>
class CSafeVector
{
private:
    bool initialized;
    std::vector<T> vec;
    sem_t sem;
public:
	/*----------------------------------------------------------*/
    /*! \brief Default constructor of CSafeVector.
     */
    /*----------------------------------------------------------*/
    CSafeVector() : initialized(false) 
    { 
        sem_init( &sem, 0, 1 ); //Mutex, initialized to 1 => sem_wait will block at 2nd call
    }
    
	/*----------------------------------------------------------*/
    /*! \brief Default destructor of CSafeVector.
     */
    /*----------------------------------------------------------*/
    ~CSafeVector()
    {
        vec.empty();
        sem_destroy( &sem);
    }
    
	/*----------------------------------------------------------*/
    /*! \brief Stores the given object into the last postion of the vector.
     */
    /*----------------------------------------------------------*/
    void PushBack(T obj)
    {
        if( NULL == obj )
            return;
        sem_wait( &sem );
        vec.push_back( obj );
        initialized = true;
        sem_post( &sem );
    }
	
	/*----------------------------------------------------------*/
    /*! \brief Gets the first element from the vector and dequeue it.
     *  \return The first object if exists, otherwise NULL,
     */
    /*----------------------------------------------------------*/
    T PopFront()
    {
        T obj = NULL;
        sem_wait( &sem );
        if (vec.size() >= 1)
        {
            obj = vec[0];
            vec.erase( vec.begin() );
        }
        sem_post( &sem );
        return obj;
    }
    
	/*----------------------------------------------------------*/
    /*! \brief Gets the first element from the vector and dequeue it.
     *  \return The first object if exists, otherwise NULL,
     */
    /*----------------------------------------------------------*/
    T operator[](uint32_t p)
    {
        if( !initialized )
            return NULL;
        T obj = NULL;
        sem_wait( &sem );
        uint32_t s = vec.size();
        if (0 != s && p < s)
        {
            obj = vec[p];
        }
        sem_post( &sem );
        return obj;
    }
    
	/*----------------------------------------------------------*/
    /*! \brief Gets the amount of objects stored in the vector.
     *  \return The amount of objects available.
     */
    /*----------------------------------------------------------*/
    uint32_t Size()
    {
        uint32_t s;
        if( !initialized )
            return 0;
        
        sem_wait( &sem );
        s = vec.size();
        sem_post( &sem );
        return s;
    }
    
	/*----------------------------------------------------------*/
    /*! \brief Safley removes the given object from the vector.
     *  \note If not found, it will be silently ignored.
	 *  \note The memory of the object will NOT be freed!
     */
    /*----------------------------------------------------------*/
    void Remove(T obj)
    {
        int32_t deleteIndex = -1;
        if( !initialized || NULL == obj )
            return;

        sem_wait( &sem );
        for( uint32_t i = 0; i < vec.size(); i++ )
        {
            if( obj == vec[i] )
            {
                deleteIndex = i;
                break;
            }
        }
        if( -1 != deleteIndex )
        {
            vec.erase( vec.begin() + deleteIndex );
        }
        sem_post( &sem );
    }
    
	
	/*----------------------------------------------------------*/
    /*! \brief Safley removes the given object from the vector.
     *  \note If not found, it will be silently ignored.
	 *  \param destroy - if set to true, the memory will be freed for each deleted object.
     */
    /*----------------------------------------------------------*/
    void RemoveAll(bool destroy)
    {
        if( !initialized )
            return;
        sem_wait( &sem );
        for( uint32_t i = 0; destroy && i < vec.size(); i++ )
        {
            T obj = vec[i];
            delete obj;
        }
        vec.clear();
        sem_post( &sem );
    }
};

#endif //SAFE_VECTOR_H