TimerThread.hpp

Go to the documentation of this file.

#ifndef COMPA_TIMERTHREAD_HPP
#define COMPA_TIMERTHREAD_HPP
/*******************************************************************************
 *
 * Copyright (c) 2000-2003 Intel Corporation
 * All rights reserved.
 * Copyright (C) 2021 GPL 3 and higher by Ingo Höft,  <Ingo@Hoeft-online.de>
 * Redistribution only with this Copyright remark. Last modified: 2025-04-28
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are met:
 *
 * * Redistributions of source code must retain the above copyright notice,
 * this list of conditions and the following disclaimer.
 * * Redistributions in binary form must reproduce the above copyright notice,
 * this list of conditions and the following disclaimer in the documentation
 * and/or other materials provided with the distribution.
 * * Neither name of Intel Corporation nor the names of its contributors
 * may be used to endorse or promote products derived from this software
 * without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL INTEL OR
 * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
 * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
 * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
 * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY
 * OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
 * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
 * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 *
 ******************************************************************************/
#include "ThreadPool.hpp"
 
enum TimeoutType {
    ABS_SEC, 
    REL_SEC  
};
 
struct TimerThread {
    pthread_mutex_t mutex;    
    pthread_cond_t condition; 
    int lastEventId;          
    LinkedList eventQ;        
    int shutdown;             
    FreeList freeEvents;      
    ThreadPool* tp;           
};
 
int TimerThreadInit(
    TimerThread* timer,
    ThreadPool* tp);
 
int TimerThreadSchedule(
    TimerThread* timer,
    time_t timeout,
    TimeoutType type,
    ThreadPoolJob* job,
    Duration duration, 
    int* id);
 
// Don't export function symbol; only used library intern.
int TimerThreadRemove(
    TimerThread* timer,
    int id,
    ThreadPoolJob* out);
 
int TimerThreadShutdown(
    TimerThread* timer);
 
#endif /* COMPA_TIMERTHREAD_HPP */