gupnp-service-proxy.xml

另一 UPNP SDK 支持在UNIX/LINUX上运行。 UPnP是一种网络协议

</para><variablelist role="params">
<varlistentry><term><parameter>proxy</parameter>&nbsp;:</term>
<listitem><simpara> The <link linkend="GUPnPServiceProxy"><type>GUPnPServiceProxy</type></link> <parameter>action</parameter> is called from
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>action</parameter>&nbsp;:</term>
<listitem><simpara> The <link linkend="GUPnPServiceProxyAction"><type>GUPnPServiceProxyAction</type></link> in progress
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>user_data</parameter>&nbsp;:</term>
<listitem><simpara> User data
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="GUPnPServiceProxyNotifyCallback" role="function">
<title>GUPnPServiceProxyNotifyCallback ()</title>
<indexterm zone="GUPnPServiceProxyNotifyCallback"><primary>GUPnPServiceProxyNotifyCallback</primary></indexterm><programlisting><link linkend="void">void</link>                (*GUPnPServiceProxyNotifyCallback)  (<link linkend="GUPnPServiceProxy">GUPnPServiceProxy</link> *proxy,
                                                         const <link linkend="char">char</link> *variable,
                                                         <link linkend="GValue">GValue</link> *value,
                                                         <link linkend="gpointer">gpointer</link> user_data);</programlisting>
<para>
Callback notifying that the state variable <parameter>variable</parameter> on <parameter>proxy</parameter> has changed to
<parameter>value</parameter>.</para>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>proxy</parameter>&nbsp;:</term>
<listitem><simpara> The <link linkend="GUPnPServiceProxy"><type>GUPnPServiceProxy</type></link> the notification originates from
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>variable</parameter>&nbsp;:</term>
<listitem><simpara> The name of the variable being notified
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>value</parameter>&nbsp;:</term>
<listitem><simpara> The <link linkend="GValue"><type>GValue</type></link> of the variable being notified
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>user_data</parameter>&nbsp;:</term>
<listitem><simpara> User data
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="gupnp-service-proxy-send-action" role="function">
<title>gupnp_service_proxy_send_action ()</title>
<indexterm zone="gupnp-service-proxy-send-action"><primary>gupnp_service_proxy_send_action</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link>            gupnp_service_proxy_send_action     (<link linkend="GUPnPServiceProxy">GUPnPServiceProxy</link> *proxy,
                                                         const <link linkend="char">char</link> *action,
                                                         <link linkend="GError">GError</link> **error,
                                                         ...);</programlisting>
<para>
Sends action <parameter>action</parameter> with parameters <parameter>Varargs</parameter> to the service exposed by
<parameter>proxy</parameter> synchronously. If an error occurred, <parameter>error</parameter> will be set. In case of
a UPnPError the error code will be the same in <parameter>error</parameter>.</para>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>proxy</parameter>&nbsp;:</term>
<listitem><simpara> A <link linkend="GUPnPServiceProxy"><type>GUPnPServiceProxy</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>action</parameter>&nbsp;:</term>
<listitem><simpara> An action
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>error</parameter>&nbsp;:</term>
<listitem><simpara> The location where to store any error, or <link linkend="NULL:CAPS"><literal>NULL</literal></link>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>...</parameter>&nbsp;:</term>
<listitem><simpara> tuples of in parameter name, in paramater type, and in parameter
value, followed by <link linkend="NULL:CAPS"><literal>NULL</literal></link>, and then tuples of out paramater name,
out parameter type, and out parameter value location, terminated with <link linkend="NULL:CAPS"><literal>NULL</literal></link>
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> <link linkend="TRUE:CAPS"><literal>TRUE</literal></link> if sending the action was succesful.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="gupnp-service-proxy-send-action-valist" role="function">
<title>gupnp_service_proxy_send_action_valist ()</title>
<indexterm zone="gupnp-service-proxy-send-action-valist"><primary>gupnp_service_proxy_send_action_valist</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link>            gupnp_service_proxy_send_action_valist
                                                        (<link linkend="GUPnPServiceProxy">GUPnPServiceProxy</link> *proxy,
                                                         const <link linkend="char">char</link> *action,
                                                         <link linkend="GError">GError</link> **error,
                                                         <link linkend="va-list">va_list</link> var_args);</programlisting>
<para>
See <link linkend="gupnp-service-proxy-send-action"><function>gupnp_service_proxy_send_action()</function></link>; this version takes a va_list for
use by language bindings.</para>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>proxy</parameter>&nbsp;:</term>
<listitem><simpara> A <link linkend="GUPnPServiceProxy"><type>GUPnPServiceProxy</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>action</parameter>&nbsp;:</term>
<listitem><simpara> An action
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>error</parameter>&nbsp;:</term>
<listitem><simpara> The location where to store any error, or <link linkend="NULL:CAPS"><literal>NULL</literal></link>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>var_args</parameter>&nbsp;:</term>
<listitem><simpara> va_list of tuples of in parameter name, in paramater type, and in
parameter value, followed by <link linkend="NULL:CAPS"><literal>NULL</literal></link>, and then tuples of out paramater name,
out parameter type, and out parameter value location
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> <link linkend="TRUE:CAPS"><literal>TRUE</literal></link> if sending the action was succesful.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="gupnp-service-proxy-send-action-hash" role="function">
<title>gupnp_service_proxy_send_action_hash ()</title>
<indexterm zone="gupnp-service-proxy-send-action-hash"><primary>gupnp_service_proxy_send_action_hash</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link>            gupnp_service_proxy_send_action_hash
                                                        (<link linkend="GUPnPServiceProxy">GUPnPServiceProxy</link> *proxy,
                                                         const <link linkend="char">char</link> *action,
                                                         <link linkend="GError">GError</link> **error,
                                                         <link linkend="GHashTable">GHashTable</link> *in_hash,
                                                         <link linkend="GHashTable">GHashTable</link> *out_hash);</programlisting>
<para>
See <link linkend="gupnp-service-proxy-send-action"><function>gupnp_service_proxy_send_action()</function></link>; this version takes a pair of
<link linkend="GHashTable"><type>GHashTable</type></link><!-- -->s for runtime determined parameter lists.</para>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>proxy</parameter>&nbsp;:</term>
<listitem><simpara> A <link linkend="GUPnPServiceProxy"><type>GUPnPServiceProxy</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>action</parameter>&nbsp;:</term>
<listitem><simpara> An action
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>error</parameter>&nbsp;:</term>
<listitem><simpara> The location where to store any error, or <link linkend="NULL:CAPS"><literal>NULL</literal></link>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>in_hash</parameter>&nbsp;:</term>
<listitem><simpara> A <link linkend="GHashTable"><type>GHashTable</type></link> of in parameter name and <link linkend="GValue"><type>GValue</type></link> pairs
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>out_hash</parameter>&nbsp;:</term>
<listitem><simpara> A <link linkend="GHashTable"><type>GHashTable</type></link> of out parameter name and initialized
<link linkend="GValue"><type>GValue</type></link> pairs
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> <link linkend="TRUE:CAPS"><literal>TRUE</literal></link> if sending the action was succesful.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="gupnp-service-proxy-begin-action" role="function">
<title>gupnp_service_proxy_begin_action ()</title>
<indexterm zone="gupnp-service-proxy-begin-action"><primary>gupnp_service_proxy_begin_action</primary></indexterm><programlisting><link linkend="GUPnPServiceProxyAction">GUPnPServiceProxyAction</link>* gupnp_service_proxy_begin_action
                                                        (<link linkend="GUPnPServiceProxy">GUPnPServiceProxy</link> *proxy,
                                                         const <link linkend="char">char</link> *action,
                                                         <link linkend="GUPnPServiceProxyActionCallback">GUPnPServiceProxyActionCallback</link> callback,
                                                         <link linkend="gpointer">gpointer</link> user_data,
                                                         ...);</programlisting>
<para>
Sends action <parameter>action</parameter> with parameters <parameter>Varargs</parameter> to the service exposed by
<parameter>proxy</parameter> asynchronously, calling <parameter>callback</parameter> on completion. From <parameter>callback</parameter>, call
<link linkend="gupnp-service-proxy-end-action"><function>gupnp_service_proxy_end_action()</function></link> to check for errors, to retrieve return
values, and to free the <link linkend="GUPnPServiceProxyAction"><type>GUPnPServiceProxyAction</type></link>.</para>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>proxy</parameter>&nbsp;:</term>
<listitem><simpara> A <link linkend="GUPnPServiceProxy"><type>GUPnPServiceProxy</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>action</parameter>&nbsp;:</term>
<listitem><simpara> An action
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>callback</parameter>&nbsp;:</term>
<listitem><simpara> The callback to call when sending the action has succeeded
or failed
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>user_data</parameter>&nbsp;:</term>
<listitem><simpara> User data for <parameter>callback</parameter>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>...</parameter>&nbsp;:</term>
<listitem><simpara> tuples of in parameter name, in paramater type, and in parameter