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
|
/*
* Copyright (c) 2013 TRUSTONIC LIMITED
* All rights reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are met:
*
* 1. Redistributions of source code must retain the above copyright notice,
* this list of conditions and the following disclaimer.
*
* 2. Redistributions in binary form must reproduce the above copyright
* notice, this list of conditions and the following disclaimer in the
* documentation and/or other materials provided with the distribution.
*
* 3. Neither the name of the TRUSTONIC LIMITED nor the names of its
* contributors may be used to endorse or promote products derived from
* this software without specific prior written permission.
*
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
* "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
* TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
* PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR
* CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
* EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
* PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS;
* OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
* WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR
* OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
* ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*/
/**
* MobiCore Notification Queue handling.
*/
#ifndef NOTIFICATIONQUEUE_H_
#define NOTIFICATIONQUEUE_H_
#include <inttypes.h> //C99 data
#include "Mci/mcinq.h"
#include "CMutex.h"
class NotificationQueue
{
public:
/** NQ Constructor, initializes the NQ component.
*
* makes the given queue object usable with the queue<Command> type of functions
*
* @param in queue to initialize
* @param out beginning of queue header
* @param queueSize Size of the queue
*/
NotificationQueue(
notificationQueue_t *in,
notificationQueue_t *out,
uint32_t size
);
/** Places an element to the outgoing queue.
*
* @param notification Data to be placed in queue.
*/
void putNotification(
notification_t *notification
);
/** Retrieves the first element from the queue.
*
* @return first notification Queue element.
* @return NULL if the queue is empty.
*/
notification_t *getNotification(
void
);
private:
notificationQueue_t *in;
notificationQueue_t *out;
CMutex mutex;
};
#endif /* NOTIFICATIONQUEUE_H_ */
|