D-Bus: dbus-timeout.h Source File

D-Bus 1.14.10

dbus-timeout.h
1/* -*- mode: C; c-file-style: "gnu"; indent-tabs-mode: nil; -*- */
2/* dbus-timeout.h DBusTimeout internal interfaces
3 *
4 * Copyright (C) 2003 CodeFactory AB
5 *
6 * Licensed under the Academic Free License version 2.1
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., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
21 *
22 */
23#ifndef DBUS_TIMEOUT_H
24#define DBUS_TIMEOUT_H
25
26#include <dbus/dbus-connection.h>
27#include <dbus/dbus-internals.h>
28
29 DBUS_BEGIN_DECLS
30
36/* Public methods on DBusTimeout are in dbus-connection.h */
37
38 typedef struct DBusTimeoutList DBusTimeoutList;
39
41 typedef dbus_bool_t (* DBusTimeoutHandler) (void *data);
42
43DBUS_PRIVATE_EXPORT
44 DBusTimeout* _dbus_timeout_new (int interval,
45 DBusTimeoutHandler handler,
46 void *data,
47 DBusFreeFunction free_data_function);
48 DBusTimeout* _dbus_timeout_ref (DBusTimeout *timeout);
49DBUS_PRIVATE_EXPORT
50void _dbus_timeout_unref (DBusTimeout *timeout);
51DBUS_PRIVATE_EXPORT
52void _dbus_timeout_restart (DBusTimeout *timeout,
53 int interval);
54DBUS_PRIVATE_EXPORT
55void _dbus_timeout_disable (DBusTimeout *timeout);
56
57 DBusTimeoutList *_dbus_timeout_list_new (void);
58void _dbus_timeout_list_free (DBusTimeoutList *timeout_list);
59dbus_bool_t _dbus_timeout_list_set_functions (DBusTimeoutList *timeout_list,
60 DBusAddTimeoutFunction add_function,
61 DBusRemoveTimeoutFunction remove_function,
62 DBusTimeoutToggledFunction toggled_function,
63 void *data,
64 DBusFreeFunction free_data_function);
65dbus_bool_t _dbus_timeout_list_add_timeout (DBusTimeoutList *timeout_list,
66 DBusTimeout *timeout);
67void _dbus_timeout_list_remove_timeout (DBusTimeoutList *timeout_list,
68 DBusTimeout *timeout);
69void _dbus_timeout_list_toggle_timeout (DBusTimeoutList *timeout_list,
70 DBusTimeout *timeout,
71 dbus_bool_t enabled);
72
73DBUS_PRIVATE_EXPORT
74dbus_bool_t _dbus_timeout_needs_restart (DBusTimeout *timeout);
75DBUS_PRIVATE_EXPORT
76void _dbus_timeout_restarted (DBusTimeout *timeout);
77
80 DBUS_END_DECLS
81
82#endif /* DBUS_TIMEOUT_H */
DBusTimeoutToggledFunction
void(* DBusTimeoutToggledFunction)(DBusTimeout *timeout, void *data)
Called when dbus_timeout_get_enabled() may return a different value than it did before.
Definition dbus-connection.h:118
DBusAddTimeoutFunction
dbus_bool_t(* DBusAddTimeoutFunction)(DBusTimeout *timeout, void *data)
Called when libdbus needs a new timeout to be monitored by the main loop.
Definition dbus-connection.h:111
DBusRemoveTimeoutFunction
void(* DBusRemoveTimeoutFunction)(DBusTimeout *timeout, void *data)
Called when libdbus no longer needs a timeout to be monitored by the main loop.
Definition dbus-connection.h:124
DBUS_BEGIN_DECLS
#define DBUS_BEGIN_DECLS
Macro used prior to declaring functions in the D-Bus header files.
Definition dbus-macros.h:34
DBUS_END_DECLS
#define DBUS_END_DECLS
Macro used after declaring functions in the D-Bus header files.
Definition dbus-macros.h:35
DBusFreeFunction
void(* DBusFreeFunction)(void *memory)
The type of a function which frees a block of memory.
Definition dbus-memory.h:63
_dbus_timeout_list_add_timeout
dbus_bool_t _dbus_timeout_list_add_timeout(DBusTimeoutList *timeout_list, DBusTimeout *timeout)
Adds a new timeout to the timeout list, invoking the application DBusAddTimeoutFunction if appropriat...
Definition dbus-timeout.c:312
_dbus_timeout_list_free
void _dbus_timeout_list_free(DBusTimeoutList *timeout_list)
Frees a DBusTimeoutList.
Definition dbus-timeout.c:215
_dbus_timeout_list_toggle_timeout
void _dbus_timeout_list_toggle_timeout(DBusTimeoutList *timeout_list, DBusTimeout *timeout, dbus_bool_t enabled)
Sets a timeout to the given enabled state, invoking the application's DBusTimeoutToggledFunction if a...
Definition dbus-timeout.c:364
_dbus_timeout_list_new
DBusTimeoutList * _dbus_timeout_list_new(void)
Creates a new timeout list.
Definition dbus-timeout.c:198
_dbus_timeout_unref
void _dbus_timeout_unref(DBusTimeout *timeout)
Decrements the reference count of a DBusTimeout object and finalizes the object if the count reaches ...
Definition dbus-timeout.c:109
_dbus_timeout_list_set_functions
dbus_bool_t _dbus_timeout_list_set_functions(DBusTimeoutList *timeout_list, DBusAddTimeoutFunction add_function, DBusRemoveTimeoutFunction remove_function, DBusTimeoutToggledFunction toggled_function, void *data, DBusFreeFunction free_data_function)
Sets the timeout functions.
Definition dbus-timeout.c:241
_dbus_timeout_disable
void _dbus_timeout_disable(DBusTimeout *timeout)
Disable the timeout.
Definition dbus-timeout.c:159
_dbus_timeout_new
DBusTimeout * _dbus_timeout_new(int interval, DBusTimeoutHandler handler, void *data, DBusFreeFunction free_data_function)
Creates a new DBusTimeout, enabled by default.
Definition dbus-timeout.c:64
_dbus_timeout_restart
void _dbus_timeout_restart(DBusTimeout *timeout, int interval)
Change the timeout interval to be interval milliseconds from now (forgetting when the timeout was ini...
Definition dbus-timeout.c:138
DBusTimeoutHandler
dbus_bool_t(* DBusTimeoutHandler)(void *data)
function to run when the timeout is handled
Definition dbus-timeout.h:41
_dbus_timeout_ref
DBusTimeout * _dbus_timeout_ref(DBusTimeout *timeout)
Increments the reference count of a DBusTimeout object.
Definition dbus-timeout.c:95
_dbus_timeout_restarted
void _dbus_timeout_restarted(DBusTimeout *timeout)
Mark timeout as restarted (setting timestamps is responsibility of the event loop).
Definition dbus-timeout.c:399
_dbus_timeout_list_remove_timeout
void _dbus_timeout_list_remove_timeout(DBusTimeoutList *timeout_list, DBusTimeout *timeout)
Removes a timeout from the timeout list, invoking the application's DBusRemoveTimeoutFunction if appr...
Definition dbus-timeout.c:342
_dbus_timeout_needs_restart
dbus_bool_t _dbus_timeout_needs_restart(DBusTimeout *timeout)
Returns whether a timeout needs restart time counting in the event loop.
Definition dbus-timeout.c:387
DBusTimeoutList
DBusTimeoutList implementation details.
Definition dbus-timeout.c:181
DBusTimeout
Internals of DBusTimeout.
Definition dbus-timeout.c:41