Coin: sched.h Source File

| Coin3D is Free Software, published under the BSD 3-clause license. | https://coin3d.github.io https://www.kongsberg.com/en/kogt/

sched.h
1#ifndef CC_SCHED_H
2#define CC_SCHED_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_sched */
38
39/* ********************************************************************** */
40
41/* Implementation note: it is important that this header file can be
42 included even when Coin was built with no threads support.
43
44 (This simplifies client code, as we get away with far less #ifdef
45 HAVE_THREADS wrapping.) */
46
47/* ********************************************************************** */
48
49#ifdef __cplusplus
50extern "C" {
51#endif /* __cplusplus */
52
53typedef void cc_sched_f(void * closure);
54
55/* ********************************************************************** */
56
57 COIN_DLL_API cc_sched * cc_sched_construct(int numthreads);
58 COIN_DLL_API void cc_sched_destruct(cc_sched * sched);
59 COIN_DLL_API void cc_sched_set_num_threads(cc_sched * sched, int num);
60 COIN_DLL_API int cc_sched_get_num_threads(cc_sched * sched);
61
62 COIN_DLL_API uint32_t cc_sched_schedule(cc_sched * sched,
63 cc_sched_f * workfunc,
64 void * closure,
65 float priority);
66 COIN_DLL_API SbBool cc_sched_unschedule(cc_sched * sched,
67 uint32_t schedid);
68 COIN_DLL_API void cc_sched_wait_all(cc_sched * sched);
69 COIN_DLL_API int cc_sched_get_num_remaining(cc_sched * sched);
70 COIN_DLL_API void cc_sched_set_num_allowed(cc_sched * sched, int num);
71 COIN_DLL_API void cc_sched_change_priority(cc_sched * sched,
72 uint32_t schedid,
73 float priority);
74
75/* ********************************************************************** */
76
77#ifdef __cplusplus
78} /* extern "C" */
79#endif /* __cplusplus */
80
81#endif /* ! CC_SCHED_H */