gupnp-service.xml

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

use by language bindings.</para>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>action</parameter>&nbsp;:</term>
<listitem><simpara> A <link linkend="GUPnPServiceAction"><type>GUPnPServiceAction</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>var_args</parameter>&nbsp;:</term>
<listitem><simpara> va_list of tuples of argument name, argument type, and argument
value location.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="gupnp-service-action-get-value" role="function">
<title>gupnp_service_action_get_value ()</title>
<indexterm zone="gupnp-service-action-get-value"><primary>gupnp_service_action_get_value</primary></indexterm><programlisting><link linkend="void">void</link>                gupnp_service_action_get_value      (<link linkend="GUPnPServiceAction">GUPnPServiceAction</link> *action,
                                                         const <link linkend="char">char</link> *argument,
                                                         <link linkend="GValue">GValue</link> *value);</programlisting>
<para>
Retrieves the value of <parameter>argument</parameter> into <parameter>value</parameter>.</para>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>action</parameter>&nbsp;:</term>
<listitem><simpara> A <link linkend="GUPnPServiceAction"><type>GUPnPServiceAction</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>argument</parameter>&nbsp;:</term>
<listitem><simpara> The name of the argument to retrieve
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>value</parameter>&nbsp;:</term>
<listitem><simpara> The <link linkend="GValue"><type>GValue</type></link> to store the value of the argument, initialized
to the correct type.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="gupnp-service-action-set" role="function">
<title>gupnp_service_action_set ()</title>
<indexterm zone="gupnp-service-action-set"><primary>gupnp_service_action_set</primary></indexterm><programlisting><link linkend="void">void</link>                gupnp_service_action_set            (<link linkend="GUPnPServiceAction">GUPnPServiceAction</link> *action,
                                                         ...);</programlisting>
<para>
Sets the specified action return values.</para>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>action</parameter>&nbsp;:</term>
<listitem><simpara> A <link linkend="GUPnPServiceAction"><type>GUPnPServiceAction</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>...</parameter>&nbsp;:</term>
<listitem><simpara> tuples of return value name, return value type, and
actual return value, terminated with <link linkend="NULL:CAPS"><literal>NULL</literal></link>.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="gupnp-service-action-set-valist" role="function">
<title>gupnp_service_action_set_valist ()</title>
<indexterm zone="gupnp-service-action-set-valist"><primary>gupnp_service_action_set_valist</primary></indexterm><programlisting><link linkend="void">void</link>                gupnp_service_action_set_valist     (<link linkend="GUPnPServiceAction">GUPnPServiceAction</link> *action,
                                                         <link linkend="va-list">va_list</link> var_args);</programlisting>
<para>
See <link linkend="gupnp-service-action-set"><function>gupnp_service_action_set()</function></link>; this version takes a va_list for
use by language bindings.</para>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>action</parameter>&nbsp;:</term>
<listitem><simpara> A <link linkend="GUPnPServiceAction"><type>GUPnPServiceAction</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>var_args</parameter>&nbsp;:</term>
<listitem><simpara> va_list of tuples of return value name, return value type, and
actual return value.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="gupnp-service-action-set-value" role="function">
<title>gupnp_service_action_set_value ()</title>
<indexterm zone="gupnp-service-action-set-value"><primary>gupnp_service_action_set_value</primary></indexterm><programlisting><link linkend="void">void</link>                gupnp_service_action_set_value      (<link linkend="GUPnPServiceAction">GUPnPServiceAction</link> *action,
                                                         const <link linkend="char">char</link> *argument,
                                                         const <link linkend="GValue">GValue</link> *value);</programlisting>
<para>
Sets the value of <parameter>argument</parameter> to <parameter>value</parameter>.</para>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>action</parameter>&nbsp;:</term>
<listitem><simpara> A <link linkend="GUPnPServiceAction"><type>GUPnPServiceAction</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>argument</parameter>&nbsp;:</term>
<listitem><simpara> The name of the return value to retrieve
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>value</parameter>&nbsp;:</term>
<listitem><simpara> The <link linkend="GValue"><type>GValue</type></link> to store the return value
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="gupnp-service-action-return" role="function">
<title>gupnp_service_action_return ()</title>
<indexterm zone="gupnp-service-action-return"><primary>gupnp_service_action_return</primary></indexterm><programlisting><link linkend="void">void</link>                gupnp_service_action_return         (<link linkend="GUPnPServiceAction">GUPnPServiceAction</link> *action);</programlisting>
<para>
Return succesfully.</para>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>action</parameter>&nbsp;:</term>
<listitem><simpara> A <link linkend="GUPnPServiceAction"><type>GUPnPServiceAction</type></link>
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="gupnp-service-action-return-error" role="function">
<title>gupnp_service_action_return_error ()</title>
<indexterm zone="gupnp-service-action-return-error"><primary>gupnp_service_action_return_error</primary></indexterm><programlisting><link linkend="void">void</link>                gupnp_service_action_return_error   (<link linkend="GUPnPServiceAction">GUPnPServiceAction</link> *action,
                                                         <link linkend="guint">guint</link> error_code,
                                                         const <link linkend="char">char</link> *error_description);</programlisting>
<para>
Return <parameter>error_code</parameter>.</para>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>action</parameter>&nbsp;:</term>
<listitem><simpara> A <link linkend="GUPnPServiceAction"><type>GUPnPServiceAction</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>error_code</parameter>&nbsp;:</term>
<listitem><simpara> The error code
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>error_description</parameter>&nbsp;:</term>
<listitem><simpara> The error description, or <link linkend="NULL:CAPS"><literal>NULL</literal></link> if <parameter>error_code</parameter> is
one of <link linkend="GUPNP-CONTROL-ERROR-INVALID-ACTION:CAPS"><type>GUPNP_CONTROL_ERROR_INVALID_ACTION</type></link>,
<link linkend="GUPNP-CONTROL-ERROR-INVALID-ARGS:CAPS"><type>GUPNP_CONTROL_ERROR_INVALID_ARGS</type></link>, <link linkend="GUPNP-CONTROL-ERROR-OUT-OF-SYNC:CAPS"><type>GUPNP_CONTROL_ERROR_OUT_OF_SYNC</type></link> or
<link linkend="GUPNP-CONTROL-ERROR-ACTION-FAILED:CAPS"><type>GUPNP_CONTROL_ERROR_ACTION_FAILED</type></link>, in which case a description is
provided automatically.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="gupnp-service-notify" role="function">
<title>gupnp_service_notify ()</title>
<indexterm zone="gupnp-service-notify"><primary>gupnp_service_notify</primary></indexterm><programlisting><link linkend="void">void</link>                gupnp_service_notify                (<link linkend="GUPnPService">GUPnPService</link> *service,
                                                         ...);</programlisting>
<para>
Notifies listening clients that the properties listed in <parameter>Varargs</parameter>
have changed to the specified values.</para>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>service</parameter>&nbsp;:</term>
<listitem><simpara> A <link linkend="GUPnPService"><type>GUPnPService</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>...</parameter>&nbsp;:</term>
<listitem><simpara> Tuples of variable name, variable type, and variable value,
terminated with <link linkend="NULL:CAPS"><literal>NULL</literal></link>.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="gupnp-service-notify-valist" role="function">
<title>gupnp_service_notify_valist ()</title>
<indexterm zone="gupnp-service-notify-valist"><primary>gupnp_service_notify_valist</primary></indexterm><programlisting><link linkend="void">void</link>                gupnp_service_notify_valist         (<link linkend="GUPnPService">GUPnPService</link> *service,
                                                         <link linkend="va-list">va_list</link> var_args);</programlisting>
<para>
See <link linkend="gupnp-service-notify"><function>gupnp_service_notify()</function></link>; this version takes a va_list for
use by language bindings.</para>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>service</parameter>&nbsp;:</term>
<listitem><simpara> A <link linkend="GUPnPService"><type>GUPnPService</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>var_args</parameter>&nbsp;:</term>
<listitem><simpara> A va_list of tuples of variable name, variable type, and variable
value, terminated with <link linkend="NULL:CAPS"><literal>NULL</literal></link>.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="gupnp-service-notify-value" role="function">
<title>gupnp_service_notify_value ()</title>
<indexterm zone="gupnp-service-notify-value"><primary>gupnp_service_notify_value</primary></indexterm><programlisting><link linkend="void">void</link>                gupnp_service_notify_value          (<link linkend="GUPnPService">GUPnPService</link> *service,
                                                         const <link linkend="char">char</link> *variable,
                                                         const <link linkend="GValue">GValue</link> *value);</programlisting>
<para>
Notifies listening clients that <parameter>variable</parameter> has changed to <parameter>value</parameter>.</para>
<para>