1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66
|
/*
Copyright (C) 2006 Adam Charrett
This program is free software; you can redistribute it and/or
modify it under the terms of the GNU General Public License
as published by the Free Software Foundation; either version 2
of the License, or (at your option) any later version.
This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU General Public License for more details.
You should have received a copy of the GNU General Public License
along with this program; if not, write to the Free Software
Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA
deferredproc.h
Deferred Processing.
*/
#ifndef _DVBSTREAMER_DEFERREDPROC_H
#define _DVBSTREAMER_DEFERREDPROC_H
#include "types.h"
/**
* @defgroup DeferredProc Deferred Processing
*@{
*/
/**
* Function pointer to a function to be called by the deferred processing thread.
*/
typedef void (*DeferredProcessor_t)(void*);
/**
* Initialise the deferred processing module.
* @return 0 on success.
*/
int DeferredProcessingInit(void);
/**
* Deinitialise the deferred processing module. Any job waiting to be processed
* will be dropped.
*/
void DeferredProcessingDeinit(void);
/**
* Add a job to the queue of jobs to be executed in the deferred processing thread.
* The function pointed to by processor will be called at an indeterminate time
* with the argument specified by arg.
* @param processor Function pointer to function to call in the deferred processing thread.
* @param arg Argument to be passed to processor when called. This must have
* been allocated using the Object memory system as the reference count will be
* incremented on adding to the queue and decremented if the job is still on the
* queue when the module is deinitialised.
*/
void DeferredProcessingAddJob(DeferredProcessor_t processor, void *arg);
/** @} */
#endif
|