1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
|
<?xml version="1.0"?>
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
"http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd">
<refentry id="rhythmbox-rb-async-queue-watch">
<refmeta>
<refentrytitle role="top_of_page" id="rhythmbox-rb-async-queue-watch.top_of_page">rb-async-queue-watch</refentrytitle>
<manvolnum>3</manvolnum>
<refmiscinfo>RHYTHMBOX Library</refmiscinfo>
</refmeta>
<refnamediv>
<refname>rb-async-queue-watch</refname>
<refpurpose>GSource for watching a GAsyncQueue in the main loop</refpurpose>
<!--[<xref linkend="desc" endterm="desc.title"/>]-->
</refnamediv>
<refsynopsisdiv id="rhythmbox-rb-async-queue-watch.synopsis" role="synopsis">
<title role="synopsis.title">Synopsis</title>
<synopsis>
<link linkend="void">void</link> (<link linkend="RBAsyncQueueWatchFunc">*RBAsyncQueueWatchFunc</link>) (<link linkend="gpointer">gpointer</link> item,
<link linkend="gpointer">gpointer</link> data);
<link linkend="guint">guint</link> <link linkend="rb-async-queue-watch-new">rb_async_queue_watch_new</link> (<link linkend="GAsyncQueue">GAsyncQueue</link> *queue,
<link linkend="gint">gint</link> priority,
<link linkend="RBAsyncQueueWatchFunc">RBAsyncQueueWatchFunc</link> callback,
<link linkend="gpointer">gpointer</link> user_data,
<link linkend="GDestroyNotify">GDestroyNotify</link> notify,
<link linkend="GMainContext">GMainContext</link> *context);
</synopsis>
</refsynopsisdiv>
<refsect1 id="rhythmbox-rb-async-queue-watch.description" role="desc">
<title role="desc.title">Description</title>
<para>
</para>
<para>
</para>
</refsect1>
<refsect1 id="rhythmbox-rb-async-queue-watch.details" role="details">
<title role="details.title">Details</title>
<refsect2 id="RBAsyncQueueWatchFunc" role="function">
<title>RBAsyncQueueWatchFunc ()</title>
<indexterm zone="RBAsyncQueueWatchFunc"><primary>RBAsyncQueueWatchFunc</primary></indexterm><programlisting><link linkend="void">void</link> (*RBAsyncQueueWatchFunc) (<link linkend="gpointer">gpointer</link> item,
<link linkend="gpointer">gpointer</link> data);</programlisting>
<para>
Callback to call when an item is found in the queue.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>item</parameter> :</term>
<listitem><simpara> the item found in the queue
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>data</parameter> :</term>
<listitem><simpara> user data specified when creating the watch
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="rb-async-queue-watch-new" role="function">
<title>rb_async_queue_watch_new ()</title>
<indexterm zone="rb-async-queue-watch-new"><primary>rb_async_queue_watch_new</primary></indexterm><programlisting><link linkend="guint">guint</link> rb_async_queue_watch_new (<link linkend="GAsyncQueue">GAsyncQueue</link> *queue,
<link linkend="gint">gint</link> priority,
<link linkend="RBAsyncQueueWatchFunc">RBAsyncQueueWatchFunc</link> callback,
<link linkend="gpointer">gpointer</link> user_data,
<link linkend="GDestroyNotify">GDestroyNotify</link> notify,
<link linkend="GMainContext">GMainContext</link> *context);</programlisting>
<para>
Creates a new <link linkend="GSource"><type>GSource</type></link> that triggers when the <link linkend="GAsyncQueue"><type>GAsyncQueue</type></link> is
non-empty. This is used in rhythmbox to process queues within
<link linkend="RhythmDB"><type>RhythmDB</type></link> in the main thread without polling.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>queue</parameter> :</term>
<listitem><simpara> the <link linkend="GAsyncQueue"><type>GAsyncQueue</type></link> to watch
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>priority</parameter> :</term>
<listitem><simpara> priority value for the <link linkend="GSource"><type>GSource</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>callback</parameter> :</term>
<listitem><simpara> callback to invoke when the queue is non-empty
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>user_data</parameter> :</term>
<listitem><simpara> user data to pass to the callback
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>notify</parameter> :</term>
<listitem><simpara> function to call to clean up the user data for the callback
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>context</parameter> :</term>
<listitem><simpara> the <link linkend="GMainContext"><type>GMainContext</type></link> to attach the source to
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> the ID of the new <link linkend="GSource"><type>GSource</type></link>
</simpara></listitem></varlistentry>
</variablelist></refsect2>
</refsect1>
</refentry>
|
