1 <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
4 <meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
5 <title>GDBusInterface</title>
6 <meta name="generator" content="DocBook XSL Stylesheets V1.76.1">
7 <link rel="home" href="index.html" title="GIO Reference Manual">
8 <link rel="up" href="gdbus-convenience.html" title="Highlevel D-Bus Support">
9 <link rel="prev" href="gio-Watching-Bus-Names.html" title="Watching Bus Names">
10 <link rel="next" href="GDBusInterfaceSkeleton.html" title="GDBusInterfaceSkeleton">
11 <meta name="generator" content="GTK-Doc V1.18 (XML mode)">
12 <link rel="stylesheet" href="style.css" type="text/css">
14 <body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
15 <table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="2">
17 <td><a accesskey="p" href="gio-Watching-Bus-Names.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
18 <td><a accesskey="u" href="gdbus-convenience.html"><img src="up.png" width="24" height="24" border="0" alt="Up"></a></td>
19 <td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td>
20 <th width="100%" align="center">GIO Reference Manual</th>
21 <td><a accesskey="n" href="GDBusInterfaceSkeleton.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
23 <tr><td colspan="5" class="shortcuts">
24 <a href="#GDBusInterface.synopsis" class="shortcut">Top</a>
26 <a href="#GDBusInterface.description" class="shortcut">Description</a>
28 <a href="#GDBusInterface.object-hierarchy" class="shortcut">Object Hierarchy</a>
30 <a href="#GDBusInterface.prerequisites" class="shortcut">Prerequisites</a>
32 <a href="#GDBusInterface.implementations" class="shortcut">Known Implementations</a>
35 <div class="refentry">
36 <a name="GDBusInterface"></a><div class="titlepage"></div>
37 <div class="refnamediv"><table width="100%"><tr>
39 <h2><span class="refentrytitle"><a name="GDBusInterface.top_of_page"></a>GDBusInterface</span></h2>
40 <p>GDBusInterface — Base type for D-Bus interfaces</p>
42 <td valign="top" align="right"></td>
44 <div class="refsynopsisdiv">
45 <a name="GDBusInterface.synopsis"></a><h2>Synopsis</h2>
46 <pre class="synopsis">
47 #include <gio/gio.h>
49 <a class="link" href="GDBusInterface.html#GDBusInterface-struct" title="GDBusInterface">GDBusInterface</a>;
50 struct <a class="link" href="GDBusInterface.html#GDBusInterfaceIface" title="struct GDBusInterfaceIface">GDBusInterfaceIface</a>;
51 <a class="link" href="gio-D-Bus-Introspection-Data.html#GDBusInterfaceInfo"><span class="returnvalue">GDBusInterfaceInfo</span></a> * <a class="link" href="GDBusInterface.html#g-dbus-interface-get-info" title="g_dbus_interface_get_info ()">g_dbus_interface_get_info</a> (<em class="parameter"><code><a class="link" href="GDBusInterface.html" title="GDBusInterface"><span class="type">GDBusInterface</span></a> *interface_</code></em>);
52 <a class="link" href="GDBusObject.html" title="GDBusObject"><span class="returnvalue">GDBusObject</span></a> * <a class="link" href="GDBusInterface.html#g-dbus-interface-get-object" title="g_dbus_interface_get_object ()">g_dbus_interface_get_object</a> (<em class="parameter"><code><a class="link" href="GDBusInterface.html" title="GDBusInterface"><span class="type">GDBusInterface</span></a> *interface_</code></em>);
53 <a class="link" href="GDBusObject.html" title="GDBusObject"><span class="returnvalue">GDBusObject</span></a> * <a class="link" href="GDBusInterface.html#g-dbus-interface-dup-object" title="g_dbus_interface_dup_object ()">g_dbus_interface_dup_object</a> (<em class="parameter"><code><a class="link" href="GDBusInterface.html" title="GDBusInterface"><span class="type">GDBusInterface</span></a> *interface_</code></em>);
54 <span class="returnvalue">void</span> <a class="link" href="GDBusInterface.html#g-dbus-interface-set-object" title="g_dbus_interface_set_object ()">g_dbus_interface_set_object</a> (<em class="parameter"><code><a class="link" href="GDBusInterface.html" title="GDBusInterface"><span class="type">GDBusInterface</span></a> *interface_</code></em>,
55 <em class="parameter"><code><a class="link" href="GDBusObject.html" title="GDBusObject"><span class="type">GDBusObject</span></a> *object</code></em>);
58 <div class="refsect1">
59 <a name="GDBusInterface.object-hierarchy"></a><h2>Object Hierarchy</h2>
60 <pre class="synopsis">
65 <div class="refsect1">
66 <a name="GDBusInterface.prerequisites"></a><h2>Prerequisites</h2>
68 GDBusInterface requires
69 <a href="./../gobject/gobject/gobject-The-Base-Object-Type.html#GObject">GObject</a>.</p>
71 <div class="refsect1">
72 <a name="GDBusInterface.implementations"></a><h2>Known Implementations</h2>
74 GDBusInterface is implemented by
75 <a class="link" href="GDBusInterfaceSkeleton.html" title="GDBusInterfaceSkeleton">GDBusInterfaceSkeleton</a> and <a class="link" href="GDBusProxy.html" title="GDBusProxy">GDBusProxy</a>.</p>
77 <div class="refsect1">
78 <a name="GDBusInterface.description"></a><h2>Description</h2>
80 The <a class="link" href="GDBusInterface.html" title="GDBusInterface"><span class="type">GDBusInterface</span></a> type is the base type for D-Bus interfaces both
81 on the service side (see <a class="link" href="GDBusInterfaceSkeleton.html" title="GDBusInterfaceSkeleton"><span class="type">GDBusInterfaceSkeleton</span></a>) and client side
82 (see <a class="link" href="GDBusProxy.html" title="GDBusProxy"><span class="type">GDBusProxy</span></a>).
85 <div class="refsect1">
86 <a name="GDBusInterface.details"></a><h2>Details</h2>
87 <div class="refsect2">
88 <a name="GDBusInterface-struct"></a><h3>GDBusInterface</h3>
89 <pre class="programlisting">typedef struct _GDBusInterface GDBusInterface;</pre>
91 Base type for D-Bus interfaces.
93 <p class="since">Since 2.30</p>
96 <div class="refsect2">
97 <a name="GDBusInterfaceIface"></a><h3>struct GDBusInterfaceIface</h3>
98 <pre class="programlisting">struct GDBusInterfaceIface {
99 GTypeInterface parent_iface;
101 /* Virtual Functions */
102 GDBusInterfaceInfo *(*get_info) (GDBusInterface *interface_);
103 GDBusObject *(*get_object) (GDBusInterface *interface_);
104 void (*set_object) (GDBusInterface *interface_,
105 GDBusObject *object);
106 GDBusObject *(*dup_object) (GDBusInterface *interface_);
110 Base type for D-Bus interfaces.
112 <div class="variablelist"><table border="0">
113 <col align="left" valign="top">
116 <td><p><span class="term"><a href="./../gobject/gobject/gobject-Type-Information.html#GTypeInterface"><span class="type">GTypeInterface</span></a> <em class="structfield"><code><a name="GDBusInterfaceIface.parent-iface"></a>parent_iface</code></em>;</span></p></td>
117 <td>The parent interface.</td>
120 <td><p><span class="term"><em class="structfield"><code><a name="GDBusInterfaceIface.get-info"></a>get_info</code></em> ()</span></p></td>
121 <td>Returns a <a class="link" href="gio-D-Bus-Introspection-Data.html#GDBusInterfaceInfo"><span class="type">GDBusInterfaceInfo</span></a>. See <a class="link" href="GDBusInterface.html#g-dbus-interface-get-info" title="g_dbus_interface_get_info ()"><code class="function">g_dbus_interface_get_info()</code></a>.</td>
124 <td><p><span class="term"><em class="structfield"><code><a name="GDBusInterfaceIface.get-object"></a>get_object</code></em> ()</span></p></td>
125 <td>Gets the enclosing <a class="link" href="GDBusObject.html" title="GDBusObject"><span class="type">GDBusObject</span></a>. See <a class="link" href="GDBusInterface.html#g-dbus-interface-get-object" title="g_dbus_interface_get_object ()"><code class="function">g_dbus_interface_get_object()</code></a>.</td>
128 <td><p><span class="term"><em class="structfield"><code><a name="GDBusInterfaceIface.set-object"></a>set_object</code></em> ()</span></p></td>
129 <td>Sets the enclosing <a class="link" href="GDBusObject.html" title="GDBusObject"><span class="type">GDBusObject</span></a>. See <a class="link" href="GDBusInterface.html#g-dbus-interface-set-object" title="g_dbus_interface_set_object ()"><code class="function">g_dbus_interface_set_object()</code></a>.</td>
132 <td><p><span class="term"><em class="structfield"><code><a name="GDBusInterfaceIface.dup-object"></a>dup_object</code></em> ()</span></p></td>
133 <td>Gets a reference to the enclosing <a class="link" href="GDBusObject.html" title="GDBusObject"><span class="type">GDBusObject</span></a>. See <a class="link" href="GDBusInterface.html#g-dbus-interface-dup-object" title="g_dbus_interface_dup_object ()"><code class="function">g_dbus_interface_dup_object()</code></a>. Added in 2.32.</td>
137 <p class="since">Since 2.30</p>
140 <div class="refsect2">
141 <a name="g-dbus-interface-get-info"></a><h3>g_dbus_interface_get_info ()</h3>
142 <pre class="programlisting"><a class="link" href="gio-D-Bus-Introspection-Data.html#GDBusInterfaceInfo"><span class="returnvalue">GDBusInterfaceInfo</span></a> * g_dbus_interface_get_info (<em class="parameter"><code><a class="link" href="GDBusInterface.html" title="GDBusInterface"><span class="type">GDBusInterface</span></a> *interface_</code></em>);</pre>
144 Gets D-Bus introspection information for the D-Bus interface
145 implemented by <em class="parameter"><code>interface_</code></em>.
147 <div class="variablelist"><table border="0">
148 <col align="left" valign="top">
151 <td><p><span class="term"><em class="parameter"><code>interface_</code></em> :</span></p></td>
152 <td>An exported D-Bus interface.</td>
155 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
156 <td>A <a class="link" href="gio-D-Bus-Introspection-Data.html#GDBusInterfaceInfo"><span class="type">GDBusInterfaceInfo</span></a>. Do not free. <span class="annotation">[<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>]</span>
161 <p class="since">Since 2.30</p>
164 <div class="refsect2">
165 <a name="g-dbus-interface-get-object"></a><h3>g_dbus_interface_get_object ()</h3>
166 <pre class="programlisting"><a class="link" href="GDBusObject.html" title="GDBusObject"><span class="returnvalue">GDBusObject</span></a> * g_dbus_interface_get_object (<em class="parameter"><code><a class="link" href="GDBusInterface.html" title="GDBusInterface"><span class="type">GDBusInterface</span></a> *interface_</code></em>);</pre>
168 Gets the <a class="link" href="GDBusObject.html" title="GDBusObject"><span class="type">GDBusObject</span></a> that <em class="parameter"><code>interface_</code></em> belongs to, if any.
172 <div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;">
173 <h3 class="title">Warning</h3>It is not safe to use the returned object if <em class="parameter"><code>interface_</code></em>
174 or the returned object is being used from other threads. See
175 <a class="link" href="GDBusInterface.html#g-dbus-interface-dup-object" title="g_dbus_interface_dup_object ()"><code class="function">g_dbus_interface_dup_object()</code></a> for a thread-safe
179 <div class="variablelist"><table border="0">
180 <col align="left" valign="top">
183 <td><p><span class="term"><em class="parameter"><code>interface_</code></em> :</span></p></td>
184 <td>An exported D-Bus interface.</td>
187 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
188 <td>A <a class="link" href="GDBusObject.html" title="GDBusObject"><span class="type">GDBusObject</span></a> or <a href="./../glib/glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>. The returned
189 reference belongs to <em class="parameter"><code>interface_</code></em> and should not be freed. <span class="annotation">[<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>]</span>
194 <p class="since">Since 2.30</p>
197 <div class="refsect2">
198 <a name="g-dbus-interface-dup-object"></a><h3>g_dbus_interface_dup_object ()</h3>
199 <pre class="programlisting"><a class="link" href="GDBusObject.html" title="GDBusObject"><span class="returnvalue">GDBusObject</span></a> * g_dbus_interface_dup_object (<em class="parameter"><code><a class="link" href="GDBusInterface.html" title="GDBusInterface"><span class="type">GDBusInterface</span></a> *interface_</code></em>);</pre>
201 Gets the <a class="link" href="GDBusObject.html" title="GDBusObject"><span class="type">GDBusObject</span></a> that <em class="parameter"><code>interface_</code></em> belongs to, if any.
203 <div class="variablelist"><table border="0">
204 <col align="left" valign="top">
207 <td><p><span class="term"><em class="parameter"><code>interface_</code></em> :</span></p></td>
208 <td>An exported D-Bus interface.</td>
211 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
212 <td>A <a class="link" href="GDBusObject.html" title="GDBusObject"><span class="type">GDBusObject</span></a> or <a href="./../glib/glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>. The returned
213 reference should be freed with <a href="./../gobject/gobject/gobject-The-Base-Object-Type.html#g-object-unref"><code class="function">g_object_unref()</code></a>. <span class="annotation">[<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span>
218 <p class="since">Since 2.32</p>
221 <div class="refsect2">
222 <a name="g-dbus-interface-set-object"></a><h3>g_dbus_interface_set_object ()</h3>
223 <pre class="programlisting"><span class="returnvalue">void</span> g_dbus_interface_set_object (<em class="parameter"><code><a class="link" href="GDBusInterface.html" title="GDBusInterface"><span class="type">GDBusInterface</span></a> *interface_</code></em>,
224 <em class="parameter"><code><a class="link" href="GDBusObject.html" title="GDBusObject"><span class="type">GDBusObject</span></a> *object</code></em>);</pre>
226 Sets the <a class="link" href="GDBusObject.html" title="GDBusObject"><span class="type">GDBusObject</span></a> for <em class="parameter"><code>interface_</code></em> to <em class="parameter"><code>object</code></em>.
229 Note that <em class="parameter"><code>interface_</code></em> will hold a weak reference to <em class="parameter"><code>object</code></em>.
231 <div class="variablelist"><table border="0">
232 <col align="left" valign="top">
235 <td><p><span class="term"><em class="parameter"><code>interface_</code></em> :</span></p></td>
236 <td>An exported D-Bus interface.</td>
239 <td><p><span class="term"><em class="parameter"><code>object</code></em> :</span></p></td>
240 <td>A <a class="link" href="GDBusObject.html" title="GDBusObject"><span class="type">GDBusObject</span></a> or <a href="./../glib/glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>.</td>
244 <p class="since">Since 2.30</p>
250 Generated by GTK-Doc V1.18</div>