Coin Logo Coin3D is Free Software,
published under the BSD 3-clause license. 		https://bitbucket.org/Coin3D/
http://www.kongsberg.com/kogt/
fifo.h
Go to the documentation of this file.
1 #ifndef CC_FIFO_H
2 #define CC_FIFO_H
3 
4 /**************************************************************************\
5  * Copyright (c) Kongsberg Oil & Gas Technologies AS
6  * All rights reserved.
7  *
8  * Redistribution and use in source and binary forms, with or without
9  * modification, are permitted provided that the following conditions are
10  * met:
11  *
12  * Redistributions of source code must retain the above copyright notice,
13  * this list of conditions and the following disclaimer.
14  *
15  * Redistributions in binary form must reproduce the above copyright
16  * notice, this list of conditions and the following disclaimer in the
17  * documentation and/or other materials provided with the distribution.
18  *
19  * Neither the name of the copyright holder nor the names of its
20  * contributors may be used to endorse or promote products derived from
21  * this software without specific prior written permission.
22  *
23  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
24  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
25  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
26  * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
27  * HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
28  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
29  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
30  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
31  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
32  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
33  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
34 \**************************************************************************/
35 
36 #include <Inventor/C/basic.h> /* COIN_DLL_API */
37 #include <Inventor/C/threads/common.h> /* cc_fifo */
38 
39 #ifdef __cplusplus
40 extern "C" {
41 #endif /* __cplusplus */
42 
43 /* ********************************************************************** */
44 
45 COIN_DLL_API cc_fifo * cc_fifo_new(void);
46 COIN_DLL_API void cc_fifo_delete(cc_fifo * fifo);
47 
48 COIN_DLL_API void cc_fifo_assign(cc_fifo * fifo, void * ptr, uint32_t type);
49 COIN_DLL_API void cc_fifo_retrieve(cc_fifo * fifo, void ** ptr, uint32_t * type);
50 COIN_DLL_API SbBool cc_fifo_try_retrieve(cc_fifo * fifo, void ** ptr, uint32_t * type);
51 
52 COIN_DLL_API unsigned int cc_fifo_size(cc_fifo * fifo);
53 
54 COIN_DLL_API void cc_fifo_lock(cc_fifo * fifo);
55 COIN_DLL_API void cc_fifo_unlock(cc_fifo * fifo);
56 
57 COIN_DLL_API SbBool cc_fifo_peek(cc_fifo * fifo, void ** item, uint32_t * type);
58 COIN_DLL_API SbBool cc_fifo_contains(cc_fifo * fifo, void * item);
59 COIN_DLL_API SbBool cc_fifo_reclaim(cc_fifo * fifo, void * item);
60 
61 /* ********************************************************************** */
62 
63 #ifdef __cplusplus
64 } /* extern "C" */
65 #endif /* __cplusplus */
66 
67 #endif /* ! CC_FIFO_H */
cc_fifo_try_retrieve
SbBool cc_fifo_try_retrieve(cc_fifo *fifo, void **ptr, uint32_t *type)
Definition: fifo.cpp:177
cc_fifo_retrieve
void cc_fifo_retrieve(cc_fifo *fifo, void **ptr, uint32_t *type)
Definition: fifo.cpp:153
cc_fifo_size
unsigned int cc_fifo_size(cc_fifo *fifo)
Definition: fifo.cpp:202
cc_fifo_lock
void cc_fifo_lock(cc_fifo *fifo)
Definition: fifo.cpp:233
cc_fifo
struct cc_fifo cc_fifo
The type definition for the first-in, first-out queue structure.
Definition: common.h:62
cc_fifo_unlock
void cc_fifo_unlock(cc_fifo *fifo)
Definition: fifo.cpp:248
cc_fifo_delete
void cc_fifo_delete(cc_fifo *fifo)
Definition: fifo.cpp:126
cc_fifo_new
cc_fifo * cc_fifo_new(void)
Definition: fifo.cpp:116
cc_fifo_peek
SbBool cc_fifo_peek(cc_fifo *fifo, void **item, uint32_t *type)
Definition: fifo.cpp:258
cc_fifo_assign
void cc_fifo_assign(cc_fifo *fifo, void *ptr, uint32_t type)
Definition: fifo.cpp:137
cc_fifo_reclaim
SbBool cc_fifo_reclaim(cc_fifo *fifo, void *item)
Definition: fifo.cpp:283
cc_fifo_contains
SbBool cc_fifo_contains(cc_fifo *fifo, void *item)
Definition: fifo.cpp:269