OpenNI 1.5.7
XnScheduler.h
Go to the documentation of this file.
1 /*****************************************************************************
2 * *
3 * OpenNI 1.x Alpha *
4 * Copyright (C) 2012 PrimeSense Ltd. *
5 * *
6 * This file is part of OpenNI. *
7 * *
8 * Licensed under the Apache License, Version 2.0 (the "License"); *
9 * you may not use this file except in compliance with the License. *
10 * You may obtain a copy of the License at *
11 * *
12 * http://www.apache.org/licenses/LICENSE-2.0 *
13 * *
14 * Unless required by applicable law or agreed to in writing, software *
15 * distributed under the License is distributed on an "AS IS" BASIS, *
16 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. *
17 * See the License for the specific language governing permissions and *
18 * limitations under the License. *
19 * *
20 *****************************************************************************/
21 #ifndef _XN_SCHEDULER_H_
22 #define _XN_SCHEDULER_H_
23 
24 //---------------------------------------------------------------------------
25 // Includes
26 //---------------------------------------------------------------------------
27 #include <XnOS.h>
28 
29 //---------------------------------------------------------------------------
30 // Defines
31 //---------------------------------------------------------------------------
32 #define XN_MASK_SCHEDULER "Scheduler"
33 
34 //---------------------------------------------------------------------------
35 // Types
36 //---------------------------------------------------------------------------
37 struct XnScheduler; // forward declaration
38 typedef struct XnScheduler XnScheduler;
39 
40 struct XnScheduledTask; // forward declaration
42 
43 typedef void (XN_CALLBACK_TYPE* XnTaskCallbackFuncPtr)(void* pCallbackArg);
44 
45 //---------------------------------------------------------------------------
46 // Exported Function Declaration
47 //---------------------------------------------------------------------------
48 
54 XN_C_API XnStatus XN_C_DECL xnSchedulerStart(XnScheduler** ppScheduler);
55 
61 XN_C_API XnStatus XN_C_DECL xnSchedulerShutdown(XnScheduler** ppScheduler);
62 
72 XN_C_API XnStatus XN_C_DECL xnSchedulerAddTask(XnScheduler* pScheduler, XnUInt64 nInterval, XnTaskCallbackFuncPtr pCallback, void* pCallbackArg, XnScheduledTask** ppTask);
73 
80 XN_C_API XnStatus XN_C_DECL xnSchedulerRemoveTask(XnScheduler* pScheduler, XnScheduledTask** ppTask);
81 
89 XN_C_API XnStatus XN_C_DECL xnSchedulerRescheduleTask(XnScheduler* pScheduler, XnScheduledTask* pTask, XnUInt64 nInterval);
90 
91 #endif //_XN_SCHEDULER_H_
XN_C_API XnStatus XN_C_DECL xnSchedulerRemoveTask(XnScheduler *pScheduler, XnScheduledTask **ppTask)
XN_C_API XnStatus XN_C_DECL xnSchedulerRescheduleTask(XnScheduler *pScheduler, XnScheduledTask *pTask, XnUInt64 nInterval)
XnUInt32 XnStatus
Definition: XnStatus.h:33
#define XN_C_API
Definition: XnPlatform.h:123
struct XnScheduler XnScheduler
Definition: XnScheduler.h:38
void(* XnTaskCallbackFuncPtr)(void *pCallbackArg)
Definition: XnScheduler.h:43
XN_C_API XnStatus XN_C_DECL xnSchedulerShutdown(XnScheduler **ppScheduler)
XN_C_API XnStatus XN_C_DECL xnSchedulerAddTask(XnScheduler *pScheduler, XnUInt64 nInterval, XnTaskCallbackFuncPtr pCallback, void *pCallbackArg, XnScheduledTask **ppTask)
struct XnScheduledTask XnScheduledTask
Definition: XnScheduler.h:41
XN_C_API XnStatus XN_C_DECL xnSchedulerStart(XnScheduler **ppScheduler)