gupnp-service-proxy.xml

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

<listitem><simpara> A <link linkend="GHashTable"><type>GHashTable</type></link> of out parameter name and initialised <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> on success.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="gupnp-service-proxy-cancel-action" role="function">
<title>gupnp_service_proxy_cancel_action ()</title>
<indexterm zone="gupnp-service-proxy-cancel-action"><primary>gupnp_service_proxy_cancel_action</primary></indexterm><programlisting><link linkend="void">void</link>                gupnp_service_proxy_cancel_action   (<link linkend="GUPnPServiceProxy">GUPnPServiceProxy</link> *proxy,
                                                         <link linkend="GUPnPServiceProxyAction">GUPnPServiceProxyAction</link> *action);</programlisting>
<para>
Cancels <parameter>action</parameter>, freeing the <parameter>action</parameter> handle.</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> A <link linkend="GUPnPServiceProxyAction"><type>GUPnPServiceProxyAction</type></link> handle
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="gupnp-service-proxy-add-notify" role="function">
<title>gupnp_service_proxy_add_notify ()</title>
<indexterm zone="gupnp-service-proxy-add-notify"><primary>gupnp_service_proxy_add_notify</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link>            gupnp_service_proxy_add_notify      (<link linkend="GUPnPServiceProxy">GUPnPServiceProxy</link> *proxy,
                                                         const <link linkend="char">char</link> *variable,
                                                         <link linkend="GType">GType</link> type,
                                                         <link linkend="GUPnPServiceProxyNotifyCallback">GUPnPServiceProxyNotifyCallback</link> callback,
                                                         <link linkend="gpointer">gpointer</link> user_data);</programlisting>
<para>
Sets up <parameter>callback</parameter> to be called whenever a change notification for
<parameter>variable</parameter> is recieved.</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>variable</parameter>&nbsp;:</term>
<listitem><simpara> The variable to add notification for
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>type</parameter>&nbsp;:</term>
<listitem><simpara> The type of the variable
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>callback</parameter>&nbsp;:</term>
<listitem><simpara> The callback to call when <parameter>variable</parameter> changes
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>user_data</parameter>&nbsp;:</term>
<listitem><simpara> User data for <parameter>callback</parameter>
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> <link linkend="TRUE:CAPS"><literal>TRUE</literal></link> on success.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="gupnp-service-proxy-remove-notify" role="function">
<title>gupnp_service_proxy_remove_notify ()</title>
<indexterm zone="gupnp-service-proxy-remove-notify"><primary>gupnp_service_proxy_remove_notify</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link>            gupnp_service_proxy_remove_notify   (<link linkend="GUPnPServiceProxy">GUPnPServiceProxy</link> *proxy,
                                                         const <link linkend="char">char</link> *variable,
                                                         <link linkend="GUPnPServiceProxyNotifyCallback">GUPnPServiceProxyNotifyCallback</link> callback,
                                                         <link linkend="gpointer">gpointer</link> user_data);</programlisting>
<para>
Cancels the variable change notification for <parameter>callback</parameter> and <parameter>user_data</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>variable</parameter>&nbsp;:</term>
<listitem><simpara> The variable to add notification for
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>callback</parameter>&nbsp;:</term>
<listitem><simpara> The callback to call when <parameter>variable</parameter> changes
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>user_data</parameter>&nbsp;:</term>
<listitem><simpara> User data for <parameter>callback</parameter>
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> <link linkend="TRUE:CAPS"><literal>TRUE</literal></link> on success.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="gupnp-service-proxy-set-subscribed" role="function">
<title>gupnp_service_proxy_set_subscribed ()</title>
<indexterm zone="gupnp-service-proxy-set-subscribed"><primary>gupnp_service_proxy_set_subscribed</primary></indexterm><programlisting><link linkend="void">void</link>                gupnp_service_proxy_set_subscribed  (<link linkend="GUPnPServiceProxy">GUPnPServiceProxy</link> *proxy,
                                                         <link linkend="gboolean">gboolean</link> subscribed);</programlisting>
<para>
(Un)subscribes to this service.
</para>
<para>
Note that the relevant messages are not immediately sent but queued.
If you want to unsubcribe from this service because the application
is quitting, rely on automatic synchronised unsubscription on object
destruction instead.</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>subscribed</parameter>&nbsp;:</term>
<listitem><simpara> <link linkend="TRUE:CAPS"><literal>TRUE</literal></link> to subscribe to this service
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="gupnp-service-proxy-get-subscribed" role="function">
<title>gupnp_service_proxy_get_subscribed ()</title>
<indexterm zone="gupnp-service-proxy-get-subscribed"><primary>gupnp_service_proxy_get_subscribed</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link>            gupnp_service_proxy_get_subscribed  (<link linkend="GUPnPServiceProxy">GUPnPServiceProxy</link> *proxy);</programlisting>
<para>
Returns if we are subscribed to this service.</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><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> <link linkend="TRUE:CAPS"><literal>TRUE</literal></link> if we are subscribed to this service, otherwise <link linkend="FALSE:CAPS"><literal>FALSE</literal></link>.
</simpara></listitem></varlistentry>
</variablelist></refsect2>

</refsect1>
<refsect1 id="GUPnPServiceProxy.property-details" role="property_details">
<title role="property_details.title">Property Details</title>
<refsect2 id="GUPnPServiceProxy--subscribed"><title>The <literal>&quot;subscribed&quot;</literal> property</title>
<indexterm zone="GUPnPServiceProxy--subscribed"><primary>GUPnPServiceProxy:subscribed</primary></indexterm><programlisting>  &quot;subscribed&quot;               <link linkend="gboolean">gboolean</link>              : Read / Write</programlisting>
<para>
Whether we are subscribed to this service.</para>
<para>

</para><para>Default value: FALSE</para>
</refsect2>

</refsect1>

<refsect1 id="GUPnPServiceProxy.signal-details" role="signals">
<title role="signals.title">Signal Details</title>
<refsect2 id="GUPnPServiceProxy-subscription-lost"><title>The <literal>&quot;subscription-lost&quot;</literal> signal</title>
<indexterm zone="GUPnPServiceProxy-subscription-lost"><primary>GUPnPServiceProxy::subscription-lost</primary></indexterm><programlisting><link linkend="void">void</link>                user_function                      (<link linkend="GUPnPServiceProxy">GUPnPServiceProxy</link> *proxy,
                                                        <link linkend="gpointer">gpointer</link>           error,
                                                        <link linkend="gpointer">gpointer</link>           user_data)      : Run Last</programlisting>
<para>
Emitted whenever the subscription to this service has been lost due
to an error condition.</para>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>proxy</parameter>&nbsp;:</term>
<listitem><simpara> The <link linkend="GUPnPServiceProxy"><type>GUPnPServiceProxy</type></link> that received the signal
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>error</parameter>&nbsp;:</term>
<listitem><simpara> A pointer to a <link linkend="GError"><type>GError</type></link> describing why the subscription has
been lost
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>user_data</parameter>&nbsp;:</term>
<listitem><simpara>user data set when the signal handler was connected.</simpara></listitem></varlistentry>
</variablelist></refsect2>
</refsect1>



</refentry>