agt_timer.h

Go to the documentation of this file.

/*
 * Copyright (c) 2008 - 2012, Andy Bierman, All Rights Reserved.
 * Copyright (c) 2012 - 2021, YumaWorks, Inc., All Rights Reserved.
 *
 * Unless required by applicable law or agreed to in writing,
 * software distributed under the License is distributed on an
 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
 * KIND, either express or implied.  See the License for the
 * specific language governing permissions and limitations
 * under the License.
 */
#ifndef _H_agt_timer
#define _H_agt_timer
 
/*  FILE: agt_timer.h
*********************************************************************
*                                   *
*            P U R P O S E                  *
*                                   *
*********************************************************************/
 
/*********************************************************************
*                                   *
*          C H A N G E   H I S T O R Y              *
*                                   *
*********************************************************************
 
date         init     comment
----------------------------------------------------------------------
23-jan-07    abb      Begun
 
*/
 
#include <time.h>
 
#ifndef _H_dlq
#include "dlq.h"
#endif
 
#ifndef _H_status
#include "status.h"
#endif
 
#ifdef __cplusplus
extern "C" {
#endif
 
 
/********************************************************************
*                                   *
*                T Y P E S                  *
*                                   *
*********************************************************************/
 
typedef int (*agt_timer_fn_t) (uint32  timer_id,
                   void *cookie);
 
 
typedef struct agt_timer_cb_t_ {
    dlq_hdr_t       qhdr;
 
    boolean         timer_periodic;
 
    uint32          timer_id;
 
    agt_timer_fn_t  timer_cbfn;
 
    time_t          timer_start_time;
 
    uint32          timer_duration;
 
    void           *timer_cookie;
} agt_timer_cb_t;
 
 
/********************************************************************
*                                   *
*           F U N C T I O N S               *
*                                   *
*********************************************************************/
 
 
extern void
    agt_timer_init (void);
 
 
extern void
    agt_timer_cleanup (void);
 
 
extern void
    agt_timer_handler (void);
 
 
extern status_t
    agt_timer_create (uint32   seconds,
                      boolean is_periodic,
                      agt_timer_fn_t  timer_fn,
                      void *cookie,
                      uint32 *ret_timer_id);
 
 
extern status_t
    agt_timer_restart (uint32 timer_id,
                       uint32 seconds);
 
 
extern void
    agt_timer_delete (uint32  timer_id);
 
 
extern void
    agt_timer_get_timenow (time_t *tnow);
 
 
extern void
    agt_timer_get_centi_timenow (uint64 *tnow);
 
 
#ifdef __cplusplus
}  /* end extern 'C' */
#endif
 
#endif      /* _H_agt_timer */