doubango/tinySAK/src/tsk_timer.h
c732d49e
 /*
 * Copyright (C) 2017, University of the Basque Country (UPV/EHU)
 * Contact for licensing options: <licensing-mcpttclient(at)mcopenplatform(dot)com>
 *
 * The original file was part of Open Source Doubango Framework
 * Copyright (C) 2010-2011 Mamadou Diop.
 * Copyright (C) 2012 Doubango Telecom <http://doubango.org>
 *
 * This file is part of Open Source Doubango Framework.
 *
 * DOUBANGO 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 3 of the License, or
 * (at your option) any later version.
 *
 * DOUBANGO 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 DOUBANGO.
 *
 */
 
 /**@file tsk_timer.h
  * @brief Timer Manager.
  *
  * @author Mamadou Diop <diopmamadou(at)doubango[dot]org>
  *
 
  */
 #ifndef _TINYSAK_TIMER_H_
 #define _TINYSAK_TIMER_H_
 
 #include "tinysak_config.h"
 
 #include "tsk_object.h"
 
 TSK_BEGIN_DECLS
 
 
 /**@ingroup tsk_timer_group
 * @def TSK_TIMER_CALLBACK
 */
 #define TSK_TIMER_CALLBACK_F(callback)				((tsk_timer_callback_f)callback)
 
 /**@ingroup tsk_timer_group
 * @def TSK_INVALID_TIMER_ID
 */
 /**@ingroup tsk_timer_group
 * @def TSK_TIMER_ID_IS_VALID
 */
 #define TSK_INVALID_TIMER_ID						0
 #define TSK_TIMER_ID_IS_VALID(id)					((id) != TSK_INVALID_TIMER_ID)
 
 /**@ingroup tsk_timer_group
 * @def tsk_timer_manager_handle_t
 */
 /**@ingroup tsk_timer_group
 * @def tsk_timer_id_t
 */
 /**@ingroup tsk_timer_group
 * @def tsk_timer_callback
 */
 typedef void tsk_timer_manager_handle_t;
 typedef long tsk_timer_id_t;
 typedef int (*tsk_timer_callback_f)(const void* arg, tsk_timer_id_t timer_id);
 
 TINYSAK_API tsk_timer_manager_handle_t* tsk_timer_manager_create();
 
 TINYSAK_API int tsk_timer_manager_start(tsk_timer_manager_handle_t *self);
 TINYSAK_API int tsk_timer_manager_stop(tsk_timer_manager_handle_t *self);
 #if defined(DEBUG) || defined(_DEBUG)
 TINYSAK_API void tsk_timer_manager_debug(tsk_timer_manager_handle_t *self);
 #endif
 
 TINYSAK_API tsk_timer_id_t tsk_timer_manager_schedule(tsk_timer_manager_handle_t *self, uint64_t timeout, tsk_timer_callback_f callback, const void *arg);
 TINYSAK_API int tsk_timer_manager_cancel(tsk_timer_manager_handle_t *self, tsk_timer_id_t id);
 TINYSAK_API int tsk_timer_manager_destroy(tsk_timer_manager_handle_t **self);
 
 
 // Global Timer manager
 TINYSAK_API tsk_timer_manager_handle_t* tsk_timer_mgr_global_ref();
 TINYSAK_API int tsk_timer_mgr_global_start();
 TINYSAK_API tsk_timer_id_t tsk_timer_mgr_global_schedule(uint64_t timeout, tsk_timer_callback_f callback, const void *arg);
 TINYSAK_API int tsk_timer_mgr_global_cancel(tsk_timer_id_t id);
 TINYSAK_API int tsk_timer_mgr_global_unref(tsk_timer_manager_handle_t** mgr_global);
 
 
 TINYSAK_GEXTERN const tsk_object_def_t *tsk_timer_def_t;
 TINYSAK_GEXTERN const tsk_object_def_t *tsk_timer_manager_def_t;
 
 TSK_END_DECLS
 
 #endif /* _TINYSAK_TIMER_H_ */