← Back to branch summary

~peter-pearse/ubuntu/natty/dbus-glib/prop001

« back to all changes in this revision

Viewing changes to doc/reference/xml/dbus-gconnection.xml

  • Committer: Bazaar Package Importer
  • Author(s): Simon McVittie
  • Date: 2010-08-16 19:52:19 UTC
  • mfrom: (2.2.1 experimental) (2.1.9 squeeze)
  • Revision ID: james.westby@ubuntu.com-20100816195219-ig40gau6zeskqey2
Tags: 0.88-2
Re-upload to unstable, with release team acknowledgement for squeeze

Show diffs side-by-side

added added

removed removed

Lines of Context:
doc/reference/xml/dbus-gconnection.xml
1
 
<?xml version="1.0"?>
2
 
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN" 
3
 
               "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd" [
4
 
<!ENTITY dbus-binding-tool SYSTEM "dbus-binding-tool.xml">
5
 
<!ENTITY version SYSTEM "version.xml">
6
 
]>
7
 
<refentry id="dbus-glib-DBusGConnection">
8
 
<refmeta>
9
 
<refentrytitle role="top_of_page" id="dbus-glib-DBusGConnection.top_of_page">DBusGConnection</refentrytitle>
10
 
<manvolnum>3</manvolnum>
11
 
<refmiscinfo>DBUS-GLIB Library</refmiscinfo>
12
 
</refmeta>
13
 
 
14
 
<refnamediv>
15
 
<refname>DBusGConnection</refname>
16
 
<refpurpose>DBus Connection</refpurpose>
17
 
</refnamediv>
18
 
<refsect1 id="dbus-glib-DBusGConnection.stability-level">
19
 
<title>Stability Level</title>
20
 
Stable, unless otherwise indicated
21
 
</refsect1>
22
 
 
23
 
<refsynopsisdiv id="dbus-glib-DBusGConnection.synopsis" role="synopsis">
24
 
<title role="synopsis.title">Synopsis</title>
25
 
 
26
 
<synopsis>
27
 
                    <link linkend="DBusGConnection">DBusGConnection</link>;
28
 
<link linkend="DBusGConnection">DBusGConnection</link>*    <link linkend="dbus-g-bus-get">dbus_g_bus_get</link>                      (<link linkend="DBusBusType">DBusBusType</link> type,
29
 
                                                         <link linkend="GError">GError</link> **error);
30
 
<link linkend="void">void</link>                <link linkend="dbus-g-thread-init">dbus_g_thread_init</link>                  (void);
31
 
<link linkend="DBusGConnection">DBusGConnection</link>*    <link linkend="dbus-g-connection-open">dbus_g_connection_open</link>              (const <link linkend="gchar">gchar</link> *address,
32
 
                                                         <link linkend="GError">GError</link> **error);
33
 
<link linkend="DBusGConnection">DBusGConnection</link>*    <link linkend="dbus-g-connection-ref">dbus_g_connection_ref</link>               (<link linkend="DBusGConnection">DBusGConnection</link> *connection);
34
 
<link linkend="void">void</link>                <link linkend="dbus-g-connection-unref">dbus_g_connection_unref</link>             (<link linkend="DBusGConnection">DBusGConnection</link> *connection);
35
 
<link linkend="void">void</link>                <link linkend="dbus-g-connection-flush">dbus_g_connection_flush</link>             (<link linkend="DBusGConnection">DBusGConnection</link> *connection);
36
 
<link linkend="DBusConnection">DBusConnection</link>*     <link linkend="dbus-g-connection-get-connection">dbus_g_connection_get_connection</link>    (<link linkend="DBusGConnection">DBusGConnection</link> *gconnection);
37
 
<link linkend="void">void</link>                <link linkend="dbus-g-connection-register-g-object">dbus_g_connection_register_g_object</link> (<link linkend="DBusGConnection">DBusGConnection</link> *connection,
38
 
                                                         const <link linkend="char">char</link> *at_path,
39
 
                                                         <link linkend="GObject">GObject</link> *object);
40
 
<link linkend="void">void</link>                <link linkend="dbus-g-connection-unregister-g-object">dbus_g_connection_unregister_g_object</link>
41
 
                                                        (<link linkend="DBusGConnection">DBusGConnection</link> *connection,
42
 
                                                         <link linkend="GObject">GObject</link> *object);
43
 
<link linkend="GObject">GObject</link> *           <link linkend="dbus-g-connection-lookup-g-object">dbus_g_connection_lookup_g_object</link>   (<link linkend="DBusGConnection">DBusGConnection</link> *connection,
44
 
                                                         const <link linkend="char">char</link> *at_path);
45
 
</synopsis>
46
 
</refsynopsisdiv>
47
 
 
48
 
 
49
 
 
50
 
 
51
 
 
52
 
 
53
 
 
54
 
 
55
 
 
56
 
<refsect1 id="dbus-glib-DBusGConnection.description" role="desc">
57
 
<title role="desc.title">Description</title>
58
 
<para>
59
 
A <link linkend="DBusGConnection"><type>DBusGConnection</type></link> is a boxed type abstracting a DBusConnection.</para>
60
 
<para>
61
 
</para>
62
 
</refsect1>
63
 
 
64
 
<refsect1 id="dbus-glib-DBusGConnection.details" role="details">
65
 
<title role="details.title">Details</title>
66
 
<refsect2 id="DBusGConnection" role="struct">
67
 
<title>DBusGConnection</title>
68
 
<indexterm zone="DBusGConnection"><primary sortas="DBusGConnection">DBusGConnection</primary></indexterm><programlisting>typedef struct _DBusGConnection DBusGConnection;</programlisting>
69
 
<para>
70
 
</para></refsect2>
71
 
<refsect2 id="dbus-g-bus-get" role="function">
72
 
<title>dbus_g_bus_get ()</title>
73
 
<indexterm zone="dbus-g-bus-get"><primary sortas="dbus_g_bus_get">dbus_g_bus_get</primary></indexterm><programlisting><link linkend="DBusGConnection">DBusGConnection</link>*    dbus_g_bus_get                      (<link linkend="DBusBusType">DBusBusType</link> type,
74
 
                                                         <link linkend="GError">GError</link> **error);</programlisting>
75
 
<para>
76
 
Returns a connection to the given bus. The connection is a global variable
77
 
shared with other callers of this function.
78
 
</para>
79
 
<para>
80
 
(Internally, calls <link linkend="dbus-bus-get"><function>dbus_bus_get()</function></link> then calls
81
 
<link linkend="dbus-connection-setup-with-g-main"><function>dbus_connection_setup_with_g_main()</function></link> on the result.)</para>
82
 
<para>
83
 
</para><variablelist role="params">
84
 
<varlistentry><term><parameter>type</parameter>&#160;:</term>
85
 
<listitem><simpara> bus type
86
 
</simpara></listitem></varlistentry>
87
 
<varlistentry><term><parameter>error</parameter>&#160;:</term>
88
 
<listitem><simpara> address where an error can be returned.
89
 
</simpara></listitem></varlistentry>
90
 
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> a DBusConnection
91
 
</simpara></listitem></varlistentry>
92
 
</variablelist></refsect2>
93
 
<refsect2 id="dbus-g-thread-init" role="function">
94
 
<title>dbus_g_thread_init ()</title>
95
 
<indexterm zone="dbus-g-thread-init"><primary sortas="dbus_g_thread_init">dbus_g_thread_init</primary></indexterm><programlisting><link linkend="void">void</link>                dbus_g_thread_init                  (void);</programlisting>
96
 
<para>
97
 
Initializes the D-BUS thread system.
98
 
This function may only be called
99
 
once and must be called prior to calling any
100
 
other function in the D-BUS API.</para>
101
 
<para>
102
 
</para></refsect2>
103
 
<refsect2 id="dbus-g-connection-open" role="function">
104
 
<title>dbus_g_connection_open ()</title>
105
 
<indexterm zone="dbus-g-connection-open"><primary sortas="dbus_g_connection_open">dbus_g_connection_open</primary></indexterm><programlisting><link linkend="DBusGConnection">DBusGConnection</link>*    dbus_g_connection_open              (const <link linkend="gchar">gchar</link> *address,
106
 
                                                         <link linkend="GError">GError</link> **error);</programlisting>
107
 
<para>
108
 
Returns a connection to the given address.
109
 
</para>
110
 
<para>
111
 
(Internally, calls <link linkend="dbus-connection-open"><function>dbus_connection_open()</function></link> then calls
112
 
<link linkend="dbus-connection-setup-with-g-main"><function>dbus_connection_setup_with_g_main()</function></link> on the result.)</para>
113
 
<para>
114
 
</para><variablelist role="params">
115
 
<varlistentry><term><parameter>address</parameter>&#160;:</term>
116
 
<listitem><simpara> address of the connection to open
117
 
</simpara></listitem></varlistentry>
118
 
<varlistentry><term><parameter>error</parameter>&#160;:</term>
119
 
<listitem><simpara> address where an error can be returned.
120
 
</simpara></listitem></varlistentry>
121
 
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> a DBusConnection
122
 
</simpara></listitem></varlistentry>
123
 
</variablelist></refsect2>
124
 
<refsect2 id="dbus-g-connection-ref" role="function">
125
 
<title>dbus_g_connection_ref ()</title>
126
 
<indexterm zone="dbus-g-connection-ref"><primary sortas="dbus_g_connection_ref">dbus_g_connection_ref</primary></indexterm><programlisting><link linkend="DBusGConnection">DBusGConnection</link>*    dbus_g_connection_ref               (<link linkend="DBusGConnection">DBusGConnection</link> *connection);</programlisting>
127
 
<para>
128
 
Increment refcount on a <link linkend="DBusGConnection"><type>DBusGConnection</type></link></para>
129
 
<para>
130
 
</para><variablelist role="params">
131
 
<varlistentry><term><parameter>connection</parameter>&#160;:</term>
132
 
<listitem><simpara>
133
 
</simpara></listitem></varlistentry>
134
 
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> the connection that was ref'd
135
 
</simpara></listitem></varlistentry>
136
 
</variablelist></refsect2>
137
 
<refsect2 id="dbus-g-connection-unref" role="function">
138
 
<title>dbus_g_connection_unref ()</title>
139
 
<indexterm zone="dbus-g-connection-unref"><primary sortas="dbus_g_connection_unref">dbus_g_connection_unref</primary></indexterm><programlisting><link linkend="void">void</link>                dbus_g_connection_unref             (<link linkend="DBusGConnection">DBusGConnection</link> *connection);</programlisting>
140
 
<para>
141
 
Decrement refcount on a <link linkend="DBusGConnection"><type>DBusGConnection</type></link></para>
142
 
<para>
143
 
</para><variablelist role="params">
144
 
<varlistentry><term><parameter>connection</parameter>&#160;:</term>
145
 
<listitem><simpara>
146
 
</simpara></listitem></varlistentry>
147
 
</variablelist></refsect2>
148
 
<refsect2 id="dbus-g-connection-flush" role="function">
149
 
<title>dbus_g_connection_flush ()</title>
150
 
<indexterm zone="dbus-g-connection-flush"><primary sortas="dbus_g_connection_flush">dbus_g_connection_flush</primary></indexterm><programlisting><link linkend="void">void</link>                dbus_g_connection_flush             (<link linkend="DBusGConnection">DBusGConnection</link> *connection);</programlisting>
151
 
<para>
152
 
Blocks until outgoing calls and signal emissions have been sent.</para>
153
 
<para>
154
 
</para><variablelist role="params">
155
 
<varlistentry><term><parameter>connection</parameter>&#160;:</term>
156
 
<listitem><simpara> the <link linkend="DBusGConnection"><type>DBusGConnection</type></link> to flush
157
 
</simpara></listitem></varlistentry>
158
 
</variablelist></refsect2>
159
 
<refsect2 id="dbus-g-connection-get-connection" role="function">
160
 
<title>dbus_g_connection_get_connection ()</title>
161
 
<indexterm zone="dbus-g-connection-get-connection"><primary sortas="dbus_g_connection_get_connection">dbus_g_connection_get_connection</primary></indexterm><programlisting><link linkend="DBusConnection">DBusConnection</link>*     dbus_g_connection_get_connection    (<link linkend="DBusGConnection">DBusGConnection</link> *gconnection);</programlisting>
162
 
<para>
163
 
Get the <link linkend="DBusConnection"><type>DBusConnection</type></link> corresponding to this <link linkend="DBusGConnection"><type>DBusGConnection</type></link>.
164
 
The return value does not have its refcount incremented.</para>
165
 
<para>
166
 
</para><variablelist role="params">
167
 
<varlistentry><term><parameter>gconnection</parameter>&#160;:</term>
168
 
<listitem><simpara>  a <link linkend="DBusGConnection"><type>DBusGConnection</type></link>
169
 
</simpara></listitem></varlistentry>
170
 
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> <link linkend="DBusConnection"><type>DBusConnection</type></link> 
171
 
</simpara></listitem></varlistentry>
172
 
</variablelist></refsect2>
173
 
<refsect2 id="dbus-g-connection-register-g-object" role="function">
174
 
<title>dbus_g_connection_register_g_object ()</title>
175
 
<indexterm zone="dbus-g-connection-register-g-object"><primary sortas="dbus_g_connection_register_g_object">dbus_g_connection_register_g_object</primary></indexterm><programlisting><link linkend="void">void</link>                dbus_g_connection_register_g_object (<link linkend="DBusGConnection">DBusGConnection</link> *connection,
176
 
                                                         const <link linkend="char">char</link> *at_path,
177
 
                                                         <link linkend="GObject">GObject</link> *object);</programlisting>
178
 
<para>
179
 
Registers a <link linkend="GObject"><type>GObject</type></link> at the given path. Properties, methods, and signals
180
 
of the object can then be accessed remotely. Methods are only available
181
 
if method introspection data has been added to the object's class
182
 
with <link linkend="dbus-g-object-type-install-info"><function>dbus_g_object_type_install_info()</function></link>.
183
 
</para>
184
 
<para>
185
 
The registration will be cancelled if either the <link linkend="DBusConnection"><type>DBusConnection</type></link> or
186
 
the <link linkend="GObject"><type>GObject</type></link> gets finalized, or if <link linkend="dbus-g-connection-unregister-g-object"><function>dbus_g_connection_unregister_g_object()</function></link>
187
 
is used.
188
 
</para>
189
 
<para>
190
 
Note: If an object is registered multiple times, the first registration
191
 
takes priority for cases such as turning an object into an object path.</para>
192
 
<para>
193
 
</para><variablelist role="params">
194
 
<varlistentry><term><parameter>connection</parameter>&#160;:</term>
195
 
<listitem><simpara> the D-BUS connection
196
 
</simpara></listitem></varlistentry>
197
 
<varlistentry><term><parameter>at_path</parameter>&#160;:</term>
198
 
<listitem><simpara> the path where the object will live (the object's name)
199
 
</simpara></listitem></varlistentry>
200
 
<varlistentry><term><parameter>object</parameter>&#160;:</term>
201
 
<listitem><simpara> the object
202
 
</simpara></listitem></varlistentry>
203
 
</variablelist></refsect2>
204
 
<refsect2 id="dbus-g-connection-unregister-g-object" role="function">
205
 
<title>dbus_g_connection_unregister_g_object ()</title>
206
 
<indexterm zone="dbus-g-connection-unregister-g-object"><primary sortas="dbus_g_connection_unregister_g_object">dbus_g_connection_unregister_g_object</primary></indexterm><programlisting><link linkend="void">void</link>                dbus_g_connection_unregister_g_object
207
 
                                                        (<link linkend="DBusGConnection">DBusGConnection</link> *connection,
208
 
                                                         <link linkend="GObject">GObject</link> *object);</programlisting>
209
 
<para>
210
 
Removes <parameter>object</parameter> from the bus. Properties, methods, and signals
211
 
of the object can no longer be accessed remotely.</para>
212
 
<para>
213
 
</para><variablelist role="params">
214
 
<varlistentry><term><parameter>connection</parameter>&#160;:</term>
215
 
<listitem><simpara> the D-BUS connection
216
 
</simpara></listitem></varlistentry>
217
 
<varlistentry><term><parameter>object</parameter>&#160;:</term>
218
 
<listitem><simpara> the object
219
 
</simpara></listitem></varlistentry>
220
 
</variablelist></refsect2>
221
 
<refsect2 id="dbus-g-connection-lookup-g-object" role="function">
222
 
<title>dbus_g_connection_lookup_g_object ()</title>
223
 
<indexterm zone="dbus-g-connection-lookup-g-object"><primary sortas="dbus_g_connection_lookup_g_object">dbus_g_connection_lookup_g_object</primary></indexterm><programlisting><link linkend="GObject">GObject</link> *           dbus_g_connection_lookup_g_object   (<link linkend="DBusGConnection">DBusGConnection</link> *connection,
224
 
                                                         const <link linkend="char">char</link> *at_path);</programlisting>
225
 
<para>
226
 
FIXME</para>
227
 
<para>
228
 
</para><variablelist role="params">
229
 
<varlistentry><term><parameter>connection</parameter>&#160;:</term>
230
 
<listitem><simpara> a <link linkend="DBusGConnection"><type>DBusGConnection</type></link>
231
 
</simpara></listitem></varlistentry>
232
 
<varlistentry><term><parameter>at_path</parameter>&#160;:</term>
233
 
<listitem><simpara> path
234
 
</simpara></listitem></varlistentry>
235
 
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> the object at path <parameter>at_path</parameter>
236
 
</simpara></listitem></varlistentry>
237
 
</variablelist></refsect2>
238
 
 
239
 
</refsect1>
240
 
 
241
 
 
242
 
 
243
 
<refsect1 id="dbus-glib-DBusGConnection.see-also">
244
 
<title>See Also</title>
245
 
#DBusConnection
246
 
</refsect1>
247
 
 
248
 
</refentry>