mrpd: comment cleanup
[profile/ivi/OpenAVB.git] / daemons / mrpd / que.h
1 /******************************************************************************
2
3   Copyright (c) 2012, AudioScience, Inc
4   All rights reserved.
5   
6   Redistribution and use in source and binary forms, with or without 
7   modification, are permitted provided that the following conditions are met:
8   
9    1. Redistributions of source code must retain the above copyright notice, 
10       this list of conditions and the following disclaimer.
11   
12    2. Redistributions in binary form must reproduce the above copyright 
13       notice, this list of conditions and the following disclaimer in the 
14       documentation and/or other materials provided with the distribution.
15   
16    3. Neither the name of the Intel Corporation nor the names of its 
17       contributors may be used to endorse or promote products derived from 
18       this software without specific prior written permission.
19   
20   THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
21   AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 
22   IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 
23   ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE 
24   LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR 
25   CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF 
26   SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS 
27   INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN 
28   CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) 
29   ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
30   POSSIBILITY OF SUCH DAMAGE.
31
32 ******************************************************************************/
33
34 /*
35  * Windwos specific - queue messages in a thread safe way between threads.
36  */
37
38 #ifndef _QUE_H_
39 #define _QUE_H_
40
41 #include <stdint.h>             // for uint8_t etc
42 #include <windows.h>
43
44 #ifdef __cplusplus
45 extern "C" {
46 #endif
47
48         struct que_def {
49                 HANDLE space_avail;     // at least one slot empty
50                 HANDLE data_avail;      // at least one slot full
51                 CRITICAL_SECTION mutex; // protect buffer, in_pos, out_pos
52
53                 uint8_t *buffer;
54                 int in_pos;
55                 int out_pos;
56                 int entry_count;
57                 int entry_size;
58         };
59
60         struct que_def *que_new(int count, int entry_size);
61         void que_delete(struct que_def *q);
62         void que_push(struct que_def *q, void *d);
63         void que_pop_nowait(struct que_def *q, void *d);
64         void que_pop_wait(struct que_def *q, void *d);
65         HANDLE que_data_available_object(struct que_def *q);
66
67 #ifdef __cplusplus
68 }
69 #endif
70 #endif