D-Bus  1.8.16
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 
30 
36 /* Public methods on DBusTimeout are in dbus-connection.h */
37 
39 
41 typedef dbus_bool_t (* DBusTimeoutHandler) (void *data);
42 
43 DBusTimeout* _dbus_timeout_new (int interval,
44  DBusTimeoutHandler handler,
45  void *data,
46  DBusFreeFunction free_data_function);
48 void _dbus_timeout_unref (DBusTimeout *timeout);
50  int interval);
52  dbus_bool_t enabled);
53 
55 void _dbus_timeout_list_free (DBusTimeoutList *timeout_list);
57  DBusAddTimeoutFunction add_function,
58  DBusRemoveTimeoutFunction remove_function,
59  DBusTimeoutToggledFunction toggled_function,
60  void *data,
61  DBusFreeFunction free_data_function);
63  DBusTimeout *timeout);
65  DBusTimeout *timeout);
67  DBusTimeout *timeout,
68  dbus_bool_t enabled);
69 
70 
74 
75 #endif /* DBUS_TIMEOUT_H */
Internals of DBusTimeout.
Definition: dbus-timeout.c:40
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:63
void(* DBusFreeFunction)(void *memory)
The type of a function which frees a block of memory.
Definition: dbus-memory.h:64
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:239
#define DBUS_BEGIN_DECLS
Macro used prior to declaring functions in the D-Bus header files.
DBusTimeout * _dbus_timeout_ref(DBusTimeout *timeout)
Increments the reference count of a DBusTimeout object.
Definition: dbus-timeout.c:93
void _dbus_timeout_set_interval(DBusTimeout *timeout, int interval)
Changes the timeout interval.
Definition: dbus-timeout.c:134
void _dbus_timeout_list_free(DBusTimeoutList *timeout_list)
Frees a DBusTimeoutList.
Definition: dbus-timeout.c:211
DBusTimeoutList * _dbus_timeout_list_new(void)
Creates a new timeout list.
Definition: dbus-timeout.c:194
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:107
void(* DBusRemoveTimeoutFunction)(DBusTimeout *timeout, void *data)
Called when libdbus no longer needs a timeout to be monitored by the main loop.
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:310
dbus_uint32_t dbus_bool_t
A boolean, valid values are TRUE and FALSE.
Definition: dbus-types.h:35
dbus_bool_t(* DBusAddTimeoutFunction)(DBusTimeout *timeout, void *data)
Called when libdbus needs a new timeout to be monitored by the main loop.
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:362
void(* DBusTimeoutToggledFunction)(DBusTimeout *timeout, void *data)
Called when dbus_timeout_get_enabled() may return a different value than it did before.
void _dbus_timeout_set_enabled(DBusTimeout *timeout, dbus_bool_t enabled)
Changes the timeout's enabled-ness.
Definition: dbus-timeout.c:153
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:340
DBusTimeoutList implementation details.
Definition: dbus-timeout.c:176
dbus_bool_t(* DBusTimeoutHandler)(void *data)
function to run when the timeout is handled
Definition: dbus-timeout.h:41
#define DBUS_END_DECLS
Macro used after declaring functions in the D-Bus header files.