1 /** @addtogroup MCD_MCDIMPL_DAEMON_DEV
2  * @{
3  * @file
4  *
5  * MobiCore Notification Queue handling.
6  *
7  * <!-- Copyright Giesecke & Devrient GmbH 2009 - 2012 -->
8  *
9  * Redistribution and use in source and binary forms, with or without
10  * modification, are permitted provided that the following conditions
11  * are met:
12  * 1. Redistributions of source code must retain the above copyright
13  *    notice, this list of conditions and the following disclaimer.
14  * 2. Redistributions in binary form must reproduce the above copyright
15  *    notice, this list of conditions and the following disclaimer in the
16  *    documentation and/or other materials provided with the distribution.
17  * 3. The name of the author may not be used to endorse or promote
18  *    products derived from this software without specific prior
19  *    written permission.
20  *
21  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS
22  * OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
23  * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
24  * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY
25  * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
26  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE
27  * GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
28  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
29  * WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
30  * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
31  * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
32  */
33 #ifndef NOTIFICATIONQUEUE_H_
34 #define NOTIFICATIONQUEUE_H_
35 
36 #include <inttypes.h> //C99 data
37 #include "Mci/mcinq.h"
38 #include "CMutex.h"
39 
40 
41 class NotificationQueue
42 {
43 
44 public:
45 
46     /** NQ Constructor, initializes the NQ component.
47      *
48      * makes the given queue object usable with the queue<Command> type of functions
49      *
50      * @param in queue to initialize
51      * @param out beginning of queue header
52      * @param queueSize Size of the queue
53      */
54     NotificationQueue(
55         notificationQueue_t *in,
56         notificationQueue_t *out,
57         uint32_t size
58     );
59 
60     /** Places an element to the outgoing queue.
61      *
62      * @param notification Data to be placed in queue.
63      */
64     void putNotification(
65         notification_t *notification
66     );
67 
68     /** Retrieves the first element from the queue.
69      *
70      * @return first notification Queue element.
71      * @return NULL if the queue is empty.
72      */
73     notification_t *getNotification(
74         void
75     );
76 
77 private:
78 
79     notificationQueue_t *in;
80     notificationQueue_t *out;
81     CMutex mutex;
82 
83 };
84 
85 #endif /* NOTIFICATIONQUEUE_H_ */
86 
87 /** @} */
88