index.html
Main Page
|
modules.html
Modules
|
namespaces.html
Namespace List
|
hierarchy.html
Class Hierarchy
|
annotated.html
Data Structures
|
dirs.html
Directories
|
files.html
File List
|
namespacemembers.html
Namespace Members
|
functions.html
Data Fields
|
pages.html
Related Pages
DBusTimeout implementation details
[
group__DBusInternals.html
D-BUS internal implementation details
]
implementation details for
structDBusTimeout.html
DBusTimeout
#_details
More...
Data Structures
struct
structDBusTimeout.html
DBusTimeout
Internals of DBusTimeout.
structDBusTimeout.html#_details
More...
struct
structDBusTimeoutList.html
DBusTimeoutList
DBusTimeoutList implementation details.
structDBusTimeoutList.html#_details
More...
Typedefs
typedef
structDBusTimeoutList.html
DBusTimeoutList
group__DBusTimeoutInternals.html#ga11
DBusTimeoutList
Opaque data type representing a list of timeouts and a set of DBusAddTimeoutFunction/DBusRemoveTimeoutFunction.
#ga11
Functions
structDBusTimeout.html
DBusTimeout
*
group__DBusTimeoutInternals.html#ga0
_dbus_timeout_new
(int interval, DBusTimeoutHandler handler, void *data,
group__DBusMemory.html#ga8
DBusFreeFunction
free_data_function)
Creates a new
structDBusTimeout.html
DBusTimeout
, enabled by default.
#ga0
structDBusTimeout.html
DBusTimeout
*
group__DBusTimeoutInternals.html#ga1
_dbus_timeout_ref
(
structDBusTimeout.html
DBusTimeout
*timeout)
Increments the reference count of a
structDBusTimeout.html
DBusTimeout
object.
#ga1
void
group__DBusTimeoutInternals.html#ga2
_dbus_timeout_unref
(
structDBusTimeout.html
DBusTimeout
*timeout)
Decrements the reference count of a
structDBusTimeout.html
DBusTimeout
object and finalizes the object if the count reaches zero.
#ga2
void
group__DBusTimeoutInternals.html#ga3
_dbus_timeout_set_interval
(
structDBusTimeout.html
DBusTimeout
*timeout, int interval)
Changes the timeout interval.
#ga3
void
group__DBusTimeoutInternals.html#ga4
_dbus_timeout_set_enabled
(
structDBusTimeout.html
DBusTimeout
*timeout,
group__DBusTypes.html#ga2
dbus_bool_t
enabled)
Changes the timeout's enabled-ness.
#ga4
structDBusTimeoutList.html
DBusTimeoutList
*
group__DBusTimeoutInternals.html#ga5
_dbus_timeout_list_new
(void)
Creates a new timeout list.
#ga5
void
group__DBusTimeoutInternals.html#ga6
_dbus_timeout_list_free
(
structDBusTimeoutList.html
DBusTimeoutList
*timeout_list)
Frees a
structDBusTimeoutList.html
DBusTimeoutList
.
#ga6
group__DBusTypes.html#ga2
dbus_bool_t
group__DBusTimeoutInternals.html#ga7
_dbus_timeout_list_set_functions
(
structDBusTimeoutList.html
DBusTimeoutList
*timeout_list, DBusAddTimeoutFunction add_function, DBusRemoveTimeoutFunction remove_function, DBusTimeoutToggledFunction toggled_function, void *data,
group__DBusMemory.html#ga8
DBusFreeFunction
free_data_function)
Sets the timeout functions.
#ga7
group__DBusTypes.html#ga2
dbus_bool_t
group__DBusTimeoutInternals.html#ga8
_dbus_timeout_list_add_timeout
(
structDBusTimeoutList.html
DBusTimeoutList
*timeout_list,
structDBusTimeout.html
DBusTimeout
*timeout)
Adds a new timeout to the timeout list, invoking the application DBusAddTimeoutFunction if appropriate.
#ga8
void
group__DBusTimeoutInternals.html#ga9
_dbus_timeout_list_remove_timeout
(
structDBusTimeoutList.html
DBusTimeoutList
*timeout_list,
structDBusTimeout.html
DBusTimeout
*timeout)
Removes a timeout from the timeout list, invoking the application's DBusRemoveTimeoutFunction if appropriate.
#ga9
void
group__DBusTimeoutInternals.html#ga10
_dbus_timeout_list_toggle_timeout
(
structDBusTimeoutList.html
DBusTimeoutList
*timeout_list,
structDBusTimeout.html
DBusTimeout
*timeout,
group__DBusTypes.html#ga2
dbus_bool_t
enabled)
Sets a timeout to the given enabled state, invoking the application's DBusTimeoutToggledFunction if appropriate.
#ga10
Detailed Description
implementation details for
structDBusTimeout.html
DBusTimeout
Typedef Documentation
structDBusTimeoutList.html
DBusTimeoutList
Opaque data type representing a list of timeouts and a set of DBusAddTimeoutFunction/DBusRemoveTimeoutFunction.
Automatically handles removing/re-adding timeouts when the DBusAddTimeoutFunction is updated or changed. Holds a reference count to each timeout.
Definition at line
dbus-timeout_8h-source.html#l00031
31
of file
dbus-timeout_8h-source.html
dbus-timeout.h
.
Function Documentation
group__DBusTypes.html#ga2
dbus_bool_t
_dbus_timeout_list_add_timeout
(
structDBusTimeoutList.html
DBusTimeoutList
*
timeout_list
,
structDBusTimeout.html
DBusTimeout
*
timeout
)
Adds a new timeout to the timeout list, invoking the application DBusAddTimeoutFunction if appropriate.
Parameters:
timeout_list
the timeout list.
timeout
the timeout to add.
Returns:
group__DBusMacros.html#ga2
TRUE
on success,
group__DBusMacros.html#ga3
FALSE
If no memory.
Definition at line
dbus-timeout_8c-source.html#l00309
309
of file
dbus-timeout_8c-source.html
dbus-timeout.c
.
References
dbus-list_8c-source.html#l00249
_dbus_list_append()
,
dbus-list_8c-source.html#l00460
_dbus_list_remove_last()
,
dbus-timeout_8c-source.html#l00092
_dbus_timeout_ref()
,
dbus-timeout_8c-source.html#l00106
_dbus_timeout_unref()
,
dbus-timeout_8c-source.html#l00179
DBusTimeoutList::add_timeout_function
,
group__DBusMacros.html#ga3
FALSE
,
group__DBusMacros.html#ga4
NULL
,
dbus-timeout_8c-source.html#l00182
DBusTimeoutList::timeout_data
,
dbus-timeout_8c-source.html#l00177
DBusTimeoutList::timeouts
, and
group__DBusMacros.html#ga2
TRUE
.
Referenced by
dbus-connection_8c-source.html#l00719
_dbus_connection_add_timeout()
, and
dbus-server_8c-source.html#l00403
_dbus_server_add_timeout()
.
void _dbus_timeout_list_free
(
structDBusTimeoutList.html
DBusTimeoutList
*
timeout_list
)
Frees a
structDBusTimeoutList.html
DBusTimeoutList
.
Parameters:
timeout_list
the timeout list.
Definition at line
dbus-timeout_8c-source.html#l00210
210
of file
dbus-timeout_8c-source.html
dbus-timeout.c
.
References
dbus-list_8c-source.html#l00556
_dbus_list_clear()
,
dbus-list_8c-source.html#l00796
_dbus_list_foreach()
,
dbus-timeout_8c-source.html#l00238
_dbus_timeout_list_set_functions()
,
dbus-timeout_8c-source.html#l00106
_dbus_timeout_unref()
,
dbus-memory_8c-source.html#l00612
dbus_free()
,
group__DBusMacros.html#ga4
NULL
, and
dbus-timeout_8c-source.html#l00177
DBusTimeoutList::timeouts
.
Referenced by
dbus-connection_8c-source.html#l01070
_dbus_connection_new_for_transport()
,
dbus-server_8c-source.html#l00195
_dbus_server_finalize_base()
, and
dbus-server_8c-source.html#l00114
_dbus_server_init_base()
.
structDBusTimeoutList.html
DBusTimeoutList
* _dbus_timeout_list_new
(
void
)
Creates a new timeout list.
Returns
group__DBusMacros.html#ga4
NULL
if insufficient memory exists.
Returns:
the new timeout list, or
group__DBusMacros.html#ga4
NULL
on failure.
Definition at line
dbus-timeout_8c-source.html#l00193
193
of file
dbus-timeout_8c-source.html
dbus-timeout.c
.
References
dbus-memory_8h-source.html#l00042
dbus_new0
, and
group__DBusMacros.html#ga4
NULL
.
Referenced by
dbus-connection_8c-source.html#l01070
_dbus_connection_new_for_transport()
, and
dbus-server_8c-source.html#l00114
_dbus_server_init_base()
.
void _dbus_timeout_list_remove_timeout
(
structDBusTimeoutList.html
DBusTimeoutList
*
timeout_list
,
structDBusTimeout.html
DBusTimeout
*
timeout
)
Removes a timeout from the timeout list, invoking the application's DBusRemoveTimeoutFunction if appropriate.
Parameters:
timeout_list
the timeout list.
timeout
the timeout to remove.
Definition at line
dbus-timeout_8c-source.html#l00339
339
of file
dbus-timeout_8c-source.html
dbus-timeout.c
.
References
dbus-internals_8h-source.html#l00112
_dbus_assert_not_reached
,
dbus-list_8c-source.html#l00429
_dbus_list_remove()
,
dbus-timeout_8c-source.html#l00106
_dbus_timeout_unref()
,
group__DBusMacros.html#ga4
NULL
,
dbus-timeout_8c-source.html#l00180
DBusTimeoutList::remove_timeout_function
,
dbus-timeout_8c-source.html#l00182
DBusTimeoutList::timeout_data
, and
dbus-timeout_8c-source.html#l00177
DBusTimeoutList::timeouts
.
Referenced by
dbus-connection_8c-source.html#l00736
_dbus_connection_remove_timeout()
, and
dbus-server_8c-source.html#l00418
_dbus_server_remove_timeout()
.
group__DBusTypes.html#ga2
dbus_bool_t
_dbus_timeout_list_set_functions
(
structDBusTimeoutList.html
DBusTimeoutList
*
timeout_list
,
DBusAddTimeoutFunction
add_function
,
DBusRemoveTimeoutFunction
remove_function
,
DBusTimeoutToggledFunction
toggled_function
,
void *
data
,
group__DBusMemory.html#ga8
DBusFreeFunction
free_data_function
)
Sets the timeout functions.
This function is the "backend" for
group__DBusConnection.html#ga42
dbus_connection_set_timeout_functions()
.
Parameters:
timeout_list
the timeout list
add_function
the add timeout function.
remove_function
the remove timeout function.
toggled_function
toggle notify function, or
group__DBusMacros.html#ga4
NULL
data
the data for those functions.
free_data_function
the function to free the data.
Returns:
group__DBusMacros.html#ga3
FALSE
if no memory
Definition at line
dbus-timeout_8c-source.html#l00238
238
of file
dbus-timeout_8c-source.html
dbus-timeout.c
.
References
dbus-list_8c-source.html#l00796
_dbus_list_foreach()
,
dbus-list_8c-source.html#l00581
_dbus_list_get_first_link()
,
dbus-list_8h-source.html#l00094
_dbus_list_get_next_link
,
dbus-timeout_8c-source.html#l00179
DBusTimeoutList::add_timeout_function
,
dbus-list_8h-source.html#l00039
DBusList::data
,
group__DBusMacros.html#ga3
FALSE
,
group__DBusMacros.html#ga4
NULL
,
dbus-timeout_8c-source.html#l00180
DBusTimeoutList::remove_timeout_function
,
dbus-timeout_8c-source.html#l00182
DBusTimeoutList::timeout_data
,
dbus-timeout_8c-source.html#l00183
DBusTimeoutList::timeout_free_data_function
,
dbus-timeout_8c-source.html#l00181
DBusTimeoutList::timeout_toggled_function
,
dbus-timeout_8c-source.html#l00177
DBusTimeoutList::timeouts
, and
group__DBusMacros.html#ga2
TRUE
.
Referenced by
dbus-timeout_8c-source.html#l00210
_dbus_timeout_list_free()
,
dbus-connection_8c-source.html#l03867
dbus_connection_set_timeout_functions()
, and
dbus-server_8c-source.html#l00967
dbus_server_set_timeout_functions()
.
void _dbus_timeout_list_toggle_timeout
(
structDBusTimeoutList.html
DBusTimeoutList
*
timeout_list
,
structDBusTimeout.html
DBusTimeout
*
timeout
,
group__DBusTypes.html#ga2
dbus_bool_t
enabled
)
Sets a timeout to the given enabled state, invoking the application's DBusTimeoutToggledFunction if appropriate.
Parameters:
timeout_list
the timeout list.
timeout
the timeout to toggle.
enabled
group__DBusMacros.html#ga2
TRUE
to enable
Definition at line
dbus-timeout_8c-source.html#l00361
361
of file
dbus-timeout_8c-source.html
dbus-timeout.c
.
References
dbus-timeout_8c-source.html#l00050
DBusTimeout::enabled
,
group__DBusMacros.html#ga4
NULL
,
dbus-timeout_8c-source.html#l00182
DBusTimeoutList::timeout_data
, and
dbus-timeout_8c-source.html#l00181
DBusTimeoutList::timeout_toggled_function
.
Referenced by
dbus-connection_8c-source.html#l00755
_dbus_connection_toggle_timeout()
, and
dbus-server_8c-source.html#l00437
_dbus_server_toggle_timeout()
.
structDBusTimeout.html
DBusTimeout
* _dbus_timeout_new
(
int
interval
,
DBusTimeoutHandler
handler
,
void *
data
,
group__DBusMemory.html#ga8
DBusFreeFunction
free_data_function
)
Creates a new
structDBusTimeout.html
DBusTimeout
, enabled by default.
Parameters:
interval
the timeout interval in milliseconds.
handler
function to call when the timeout occurs.
data
data to pass to the handler
free_data_function
function to be called to free the data.
Returns:
the new
structDBusTimeout.html
DBusTimeout
object,
Definition at line
dbus-timeout_8c-source.html#l00062
62
of file
dbus-timeout_8c-source.html
dbus-timeout.c
.
References
dbus-memory_8h-source.html#l00042
dbus_new0
,
dbus-timeout_8c-source.html#l00050
DBusTimeout::enabled
,
dbus-timeout_8c-source.html#l00046
DBusTimeout::free_handler_data_function
,
dbus-timeout_8c-source.html#l00044
DBusTimeout::handler
,
dbus-timeout_8c-source.html#l00045
DBusTimeout::handler_data
,
dbus-timeout_8c-source.html#l00042
DBusTimeout::interval
,
group__DBusMacros.html#ga4
NULL
,
dbus-timeout_8c-source.html#l00041
DBusTimeout::refcount
, and
group__DBusMacros.html#ga2
TRUE
.
Referenced by
dbus-pending-call_8c-source.html#l00052
_dbus_pending_call_new()
.
structDBusTimeout.html
DBusTimeout
* _dbus_timeout_ref
(
structDBusTimeout.html
DBusTimeout
*
timeout
)
Increments the reference count of a
structDBusTimeout.html
DBusTimeout
object.
Parameters:
timeout
the timeout object.
Returns:
the timeout object.
Definition at line
dbus-timeout_8c-source.html#l00092
92
of file
dbus-timeout_8c-source.html
dbus-timeout.c
.
References
dbus-timeout_8c-source.html#l00041
DBusTimeout::refcount
.
Referenced by
dbus-timeout_8c-source.html#l00309
_dbus_timeout_list_add_timeout()
.
void _dbus_timeout_set_enabled
(
structDBusTimeout.html
DBusTimeout
*
timeout
,
group__DBusTypes.html#ga2
dbus_bool_t
enabled
)
Changes the timeout's enabled-ness.
Note that you should use
group__DBusConnectionInternals.html#ga32
_dbus_connection_toggle_timeout()
etc. instead, if the timeout is passed out to an application main loop. i.e. you can't use this function in the D-BUS library, it's only used in the message bus daemon implementation.
Parameters:
timeout
the timeout
enabled
group__DBusMacros.html#ga2
TRUE
if timeout should be enabled.
Definition at line
dbus-timeout_8c-source.html#l00152
152
of file
dbus-timeout_8c-source.html
dbus-timeout.c
.
References
dbus-timeout_8c-source.html#l00050
DBusTimeout::enabled
, and
group__DBusMacros.html#ga3
FALSE
.
void _dbus_timeout_set_interval
(
structDBusTimeout.html
DBusTimeout
*
timeout
,
int
interval
)
Changes the timeout interval.
Note that you have to disable and re-enable the timeout using the timeout toggle function (
group__DBusConnectionInternals.html#ga32
_dbus_connection_toggle_timeout()
etc.) to notify the application of this change.
Parameters:
timeout
the timeout
interval
the new interval
Definition at line
dbus-timeout_8c-source.html#l00133
133
of file
dbus-timeout_8c-source.html
dbus-timeout.c
.
References
dbus-internals_8h-source.html#l00100
_dbus_assert
, and
dbus-timeout_8c-source.html#l00042
DBusTimeout::interval
.
void _dbus_timeout_unref
(
structDBusTimeout.html
DBusTimeout
*
timeout
)
Decrements the reference count of a
structDBusTimeout.html
DBusTimeout
object and finalizes the object if the count reaches zero.
Parameters:
timeout
the timeout object.
Definition at line
dbus-timeout_8c-source.html#l00106
106
of file
dbus-timeout_8c-source.html
dbus-timeout.c
.
References
dbus-internals_8h-source.html#l00100
_dbus_assert
,
dbus-memory_8c-source.html#l00612
dbus_free()
,
dbus-timeout_8c-source.html#l00442
dbus_timeout_set_data()
,
dbus-timeout_8c-source.html#l00046
DBusTimeout::free_handler_data_function
,
dbus-timeout_8c-source.html#l00045
DBusTimeout::handler_data
,
group__DBusMacros.html#ga4
NULL
, and
dbus-timeout_8c-source.html#l00041
DBusTimeout::refcount
.
Referenced by
dbus-timeout_8c-source.html#l00309
_dbus_timeout_list_add_timeout()
,
dbus-timeout_8c-source.html#l00210
_dbus_timeout_list_free()
,
dbus-timeout_8c-source.html#l00339
_dbus_timeout_list_remove_timeout()
, and
dbus-pending-call_8c-source.html#l00170
dbus_pending_call_unref()
.
Generated on Tue Sep 13 01:28:09 2005 for D-BUS by
http://www.doxygen.org/index.html
doxygen
1.4.4
