my_timer.h

Go to the documentation of this file.

/* Copyright (c) 2014, 2024, Oracle and/or its affiliates.
 
   This program is free software; you can redistribute it and/or modify
   it under the terms of the GNU General Public License, version 2.0,
   as published by the Free Software Foundation.
 
   This program is designed to work with certain software (including
   but not limited to OpenSSL) that is licensed under separate terms,
   as designated in a particular file or component or in included license
   documentation.  The authors of MySQL hereby grant you an additional
   permission to link the program and your derivative works with the
   separately licensed software that they have either included with
   the program or referenced in the documentation.
 
   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, version 2.0, 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 St, Fifth Floor, Boston, MA 02110-1301  USA */
 
#ifndef MY_TIMER_H
#define MY_TIMER_H
 
/**
  @file include/my_timer.h
*/
 
#include "my_config.h"
 
/* POSIX timers API. */
#ifdef HAVE_POSIX_TIMERS
#include <time.h> /* timer_t */
 
typedef timer_t os_timer_t;
#elif defined(HAVE_KQUEUE_TIMERS)
#include <sys/types.h> /* uintptr_t */
 
typedef uintptr_t os_timer_t;
#elif defined(_WIN32)
struct os_timer_t {
  HANDLE timer_handle;
  bool timer_state;
};
#endif
 
/* Non-copyable timer object. */
struct my_timer_t {
  /* Timer ID used to identify the timer in timer requests. */
  os_timer_t id;
 
  /** Timer expiration notification function. */
  void (*notify_function)(my_timer_t *);
};
 
/* Initialize internal components. */
int my_timer_initialize();
 
/* Release any resources acquired. */
void my_timer_deinitialize();
 
/**
  Create a timer object.
 
  @param  timer   Location where the timer ID is returned.
 
  @return On success, 0.
          On error, -1 is returned, and errno is set to indicate the error.
*/
int my_timer_create(my_timer_t *timer);
 
/* Set the time (in milliseconds) until the next expiration of the timer. */
int my_timer_set(my_timer_t *timer, unsigned long time);
 
/* Cancel the timer */
int my_timer_cancel(my_timer_t *timer, int *state);
 
/* Delete a timer object. */
void my_timer_delete(my_timer_t *timer);
 
#endif /* MY_TIMER_H */