src/core/sipe-schedule.h

   1 /**
   2  * @file sipe-schedule.h
   3  *
   4  * pidgin-sipe
   5  *
   6  * Copyright (C) 2010 SIPE Project <http://sipe.sourceforge.net/>
   7  *
   8  * This program is free software; you can redistribute it and/or modify
   9  * it under the terms of the GNU General Public License as published by
  10  * the Free Software Foundation; either version 2 of the License, or
  11  * (at your option) any later version.
  12  *
  13  * This program is distributed in the hope that it will be useful,
  14  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  15  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  16  * GNU General Public License for more details.
  17  *
  18  * You should have received a copy of the GNU General Public License
  19  * along with this program; if not, write to the Free Software
  20  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
  21  */
  22
  23 /* Forward declarations */
  24 struct sipe_core_private;
  25
  26 typedef void (*sipe_schedule_action)(struct sipe_core_private *sipe_private,
  27                                      gpointer data);
  28
  29 /**
  30   * Do schedule action for execution in the future.
  31   * Non repetitive execution.
  32   *
  33   * @param sipe_core_private
  34   * @param name of action (will be copied)
  35   * @param timeout in seconds or milliseconds
  36   * @param action  callback function
  37   * @param destroy payload destroy function
  38   * @param payload callback data (can be NULL, otherwise caller must allocate memory)
  39   */
  40 void sipe_schedule_seconds(struct sipe_core_private *sipe_private,
  41                            const gchar *name,
  42                            gpointer payload,
  43                            guint seconds,
  44                            sipe_schedule_action action,
  45                            GDestroyNotify destroy);
  46 void sipe_schedule_mseconds(struct sipe_core_private *sipe_private,
  47                             const gchar *name,
  48                             gpointer payload,
  49                             guint milliseconds,
  50                             sipe_schedule_action action,
  51                             GDestroyNotify destroy);
  52 void sipe_schedule_cancel(struct sipe_core_private *sipe_private,
  53                           const gchar *name);
  54 void sipe_schedule_cancel_all(struct sipe_core_private *sipe_private);
  55
  56 /*
  57   Local Variables:
  58   mode: c
  59   c-file-style: "bsd"
  60   indent-tabs-mode: t
  61   tab-width: 8
  62   End:
  63 */