~ubuntu-branches/ubuntu/oneiric/dbus-glib/oneiric-updates

« back to all changes in this revision

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

  • Committer: Bazaar Package Importer
  • Author(s): Sebastian Dröge
  • Date: 2007-07-06 14:00:42 UTC
  • mfrom: (1.1.3 upstream)
  • Revision ID: james.westby@ubuntu.com-20070706140042-zh5qmx99npmoe454
Tags: 0.74-1
* New upstream release.
* debian/rules:
  + Update shlibs to >= 0.74 because of new API.
* debian/control:
  + Use ${binary:Version} to make lintian happy.

Show diffs side-by-side

added added

removed removed

Lines of Context:
28
28
 
29
29
 
30
30
 
31
 
            <link linkend="DBusGMethodInfo">DBusGMethodInfo</link>;
32
 
            <link linkend="DBusGMethodInvocation">DBusGMethodInvocation</link>;
33
 
<link linkend="gchar">gchar</link>*      <link linkend="dbus-g-method-get-sender">dbus_g_method_get_sender</link>        (<link linkend="DBusGMethodInvocation">DBusGMethodInvocation</link> *context);
34
 
<link linkend="DBusMessage">DBusMessage</link>* <link linkend="dbus-g-method-get-reply">dbus_g_method_get_reply</link>        (<link linkend="DBusGMethodInvocation">DBusGMethodInvocation</link> *context);
35
 
<link linkend="void">void</link>        <link linkend="dbus-g-method-send-reply">dbus_g_method_send_reply</link>        (<link linkend="DBusGMethodInvocation">DBusGMethodInvocation</link> *context,
36
 
                                             <link linkend="DBusMessage">DBusMessage</link> *reply);
37
 
<link linkend="void">void</link>        <link linkend="dbus-g-method-return">dbus_g_method_return</link>            (<link linkend="DBusGMethodInvocation">DBusGMethodInvocation</link> *context,
38
 
                                             ...);
39
 
<link linkend="void">void</link>        <link linkend="dbus-g-method-return-error">dbus_g_method_return_error</link>      (<link linkend="DBusGMethodInvocation">DBusGMethodInvocation</link> *context,
40
 
                                             <link linkend="GError">GError</link> *error);
 
31
                    <link linkend="DBusGMethodInfo">DBusGMethodInfo</link>;
 
32
                    <link linkend="DBusGMethodInvocation">DBusGMethodInvocation</link>;
 
33
<link linkend="gchar">gchar</link>*              <link linkend="dbus-g-method-get-sender">dbus_g_method_get_sender</link>            (<link linkend="DBusGMethodInvocation">DBusGMethodInvocation</link> *context);
 
34
<link linkend="DBusMessage">DBusMessage</link>*        <link linkend="dbus-g-method-get-reply">dbus_g_method_get_reply</link>             (<link linkend="DBusGMethodInvocation">DBusGMethodInvocation</link> *context);
 
35
<link linkend="void">void</link>                <link linkend="dbus-g-method-send-reply">dbus_g_method_send_reply</link>            (<link linkend="DBusGMethodInvocation">DBusGMethodInvocation</link> *context,
 
36
                                                         <link linkend="DBusMessage">DBusMessage</link> *reply);
 
37
<link linkend="void">void</link>                <link linkend="dbus-g-method-return">dbus_g_method_return</link>                (<link linkend="DBusGMethodInvocation">DBusGMethodInvocation</link> *context,
 
38
                                                         ...);
 
39
<link linkend="void">void</link>                <link linkend="dbus-g-method-return-error">dbus_g_method_return_error</link>          (<link linkend="DBusGMethodInvocation">DBusGMethodInvocation</link> *context,
 
40
                                                         <link linkend="GError">GError</link> *error);
41
41
</synopsis>
42
42
</refsynopsisdiv>
43
43
 
99
99
</para></refsect2>
100
100
<refsect2>
101
101
<title><anchor id="dbus-g-method-get-sender" role="function"/>dbus_g_method_get_sender ()</title>
102
 
<indexterm><primary>dbus_g_method_get_sender</primary></indexterm><programlisting><link linkend="gchar">gchar</link>*      dbus_g_method_get_sender        (<link linkend="DBusGMethodInvocation">DBusGMethodInvocation</link> *context);</programlisting>
 
102
<indexterm><primary>dbus_g_method_get_sender</primary></indexterm><programlisting><link linkend="gchar">gchar</link>*              dbus_g_method_get_sender            (<link linkend="DBusGMethodInvocation">DBusGMethodInvocation</link> *context);</programlisting>
103
103
<para>
104
104
Get the sender of a message so we can send a
105
105
"reply" later (i.e. send a message directly
106
 
to a service which invoked the method at a 
 
106
to a service which invoked the method at a
107
107
later time).</para>
108
108
<para>
109
109
 
111
111
<varlistentry><term><parameter>context</parameter>&nbsp;:</term>
112
112
<listitem><simpara> the method context
113
113
</simpara></listitem></varlistentry>
114
 
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> the unique name of teh sender
 
114
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> the unique name of the sender. It
 
115
is up to the caller to free the returned string.
115
116
</simpara></listitem></varlistentry>
116
117
</variablelist></refsect2>
117
118
<refsect2>
118
119
<title><anchor id="dbus-g-method-get-reply" role="function"/>dbus_g_method_get_reply ()</title>
119
 
<indexterm><primary>dbus_g_method_get_reply</primary></indexterm><programlisting><link linkend="DBusMessage">DBusMessage</link>* dbus_g_method_get_reply        (<link linkend="DBusGMethodInvocation">DBusGMethodInvocation</link> *context);</programlisting>
 
120
<indexterm><primary>dbus_g_method_get_reply</primary></indexterm><programlisting><link linkend="DBusMessage">DBusMessage</link>*        dbus_g_method_get_reply             (<link linkend="DBusGMethodInvocation">DBusGMethodInvocation</link> *context);</programlisting>
120
121
<para>
121
122
Get the reply message to append reply values
122
123
Used as a sidedoor when you can't generate dbus values
132
133
</variablelist></refsect2>
133
134
<refsect2>
134
135
<title><anchor id="dbus-g-method-send-reply" role="function"/>dbus_g_method_send_reply ()</title>
135
 
<indexterm><primary>dbus_g_method_send_reply</primary></indexterm><programlisting><link linkend="void">void</link>        dbus_g_method_send_reply        (<link linkend="DBusGMethodInvocation">DBusGMethodInvocation</link> *context,
136
 
                                             <link linkend="DBusMessage">DBusMessage</link> *reply);</programlisting>
 
136
<indexterm><primary>dbus_g_method_send_reply</primary></indexterm><programlisting><link linkend="void">void</link>                dbus_g_method_send_reply            (<link linkend="DBusGMethodInvocation">DBusGMethodInvocation</link> *context,
 
137
                                                         <link linkend="DBusMessage">DBusMessage</link> *reply);</programlisting>
137
138
<para>
138
139
Used as a sidedoor when you can't generate dbus values
139
140
of the correct type due to glib binding limitations</para>
149
150
</variablelist></refsect2>
150
151
<refsect2>
151
152
<title><anchor id="dbus-g-method-return" role="function"/>dbus_g_method_return ()</title>
152
 
<indexterm><primary>dbus_g_method_return</primary></indexterm><programlisting><link linkend="void">void</link>        dbus_g_method_return            (<link linkend="DBusGMethodInvocation">DBusGMethodInvocation</link> *context,
153
 
                                             ...);</programlisting>
 
153
<indexterm><primary>dbus_g_method_return</primary></indexterm><programlisting><link linkend="void">void</link>                dbus_g_method_return                (<link linkend="DBusGMethodInvocation">DBusGMethodInvocation</link> *context,
 
154
                                                         ...);</programlisting>
154
155
<para>
155
156
Send a return message for a given method invocation, with arguments.
156
157
This function also frees the sending context.</para>
168
169
</variablelist></refsect2>
169
170
<refsect2>
170
171
<title><anchor id="dbus-g-method-return-error" role="function"/>dbus_g_method_return_error ()</title>
171
 
<indexterm><primary>dbus_g_method_return_error</primary></indexterm><programlisting><link linkend="void">void</link>        dbus_g_method_return_error      (<link linkend="DBusGMethodInvocation">DBusGMethodInvocation</link> *context,
172
 
                                             <link linkend="GError">GError</link> *error);</programlisting>
 
172
<indexterm><primary>dbus_g_method_return_error</primary></indexterm><programlisting><link linkend="void">void</link>                dbus_g_method_return_error          (<link linkend="DBusGMethodInvocation">DBusGMethodInvocation</link> *context,
 
173
                                                         <link linkend="GError">GError</link> *error);</programlisting>
173
174
<para>
174
175
Send a error message for a given method invocation.
175
176
This function also frees the sending context.</para>