ut_timer.h

Go to the documentation of this file.

#ifndef __ut_timer_h__
#define __ut_timer_h__

#include <glib.h>

#ifdef __cplusplus
extern "C" {
#endif

  typedef struct _ut_Timer ut_Timer;

  // A non-NULL timerError indicates an error.
  // Caller takes ownership of any timerError.
  typedef void (ut_TimerCallback)(void* userdata, GError* timerError);

  ut_Timer* ut_Timer_new(void* userdata, ut_TimerCallback* cb, GError** error);
  
  void ut_Timer_destroy(ut_Timer* self);

  gboolean ut_Timer_set_after(ut_Timer* self, int secs, GError** error);

  void ut_Timer_cancel(ut_Timer* self);

  gboolean ut_Timer_is_active(ut_Timer* self);

#ifdef __cplusplus
} /* extern "C" */
#endif

#endif /* __ut_timer_h__ */

/**

ut_timer.h

Copyright 2009 Helsinki Institute for Information Technology (HIIT)
and the authors. All rights reserved.

Authors: Tero Hasu <tero.hasu@hut.fi>

Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files
(the "Software"), to deal in the Software without restriction,
including without limitation the rights to use, copy, modify, merge,
publish, distribute, sublicense, and/or sell copies of the Software,
and to permit persons to whom the Software is furnished to do so,
subject to the following conditions:

The above copyright notice and this permission notice shall be
included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS
BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN
ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.

 **/