gupnp-service.xml

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

</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>variable</parameter>&nbsp;:</term>
<listitem><simpara> The name of the variable to notify
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>value</parameter>&nbsp;:</term>
<listitem><simpara> The value of the variable
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="gupnp-service-freeze-notify" role="function">
<title>gupnp_service_freeze_notify ()</title>
<indexterm zone="gupnp-service-freeze-notify"><primary>gupnp_service_freeze_notify</primary></indexterm><programlisting><link linkend="void">void</link>                gupnp_service_freeze_notify         (<link linkend="GUPnPService">GUPnPService</link> *service);</programlisting>
<para>
Causes new notifications to be queued up until <link linkend="gupnp-service-thaw-notify"><function>gupnp_service_thaw_notify()</function></link>
is called.</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>
</variablelist></refsect2>
<refsect2 id="gupnp-service-thaw-notify" role="function">
<title>gupnp_service_thaw_notify ()</title>
<indexterm zone="gupnp-service-thaw-notify"><primary>gupnp_service_thaw_notify</primary></indexterm><programlisting><link linkend="void">void</link>                gupnp_service_thaw_notify           (<link linkend="GUPnPService">GUPnPService</link> *service);</programlisting>
<para>
Sends out any pending notifications, and stops queuing of new ones.</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>
</variablelist></refsect2>
<refsect2 id="gupnp-service-signals-autoconnect" role="function">
<title>gupnp_service_signals_autoconnect ()</title>
<indexterm zone="gupnp-service-signals-autoconnect"><primary>gupnp_service_signals_autoconnect</primary></indexterm><programlisting><link linkend="void">void</link>                gupnp_service_signals_autoconnect   (<link linkend="GUPnPService">GUPnPService</link> *service,
                                                         <link linkend="gpointer">gpointer</link> user_data,
                                                         <link linkend="GError">GError</link> **error);</programlisting>
<para>
A convenience function that attempts to connect all possible
<link linkend="GUPnPService-action-invoked"><type>"action-invoked"</type></link> and <link linkend="GUPnPService-query-variable"><type>"query-variable"</type></link> signals to
appropriate callbacks for the service <parameter>service</parameter>. It uses service introspection
and GModule's introspective features. It is very simillar to
<link linkend="glade-xml-signal-autoconnect"><function>glade_xml_signal_autoconnect()</function></link> except that it attempts to guess the names of
the signal handlers on its own.
</para>
<para>
For this function to do its magic, the application must name the callback
functions for <link linkend="GUPnPService-action-invoked"><type>"action-invoked"</type></link> signals by striping the CamelCase
off the action names and either prepend "on_" or append "_cb" to them. Same
goes for <link linkend="GUPnPService-query-variable"><type>"query-variable"</type></link> signals, except that "query_" should
be prepended to the variable name. For example, callback function for
"GetSystemUpdateID" action should be either named as
"get_system_update_id_cb" or "on_get_system_update_id" and callback function
for the query of "SystemUpdateID" state variable should be named
"query_system_update_id_cb" or "on_query_system_update_id".
</para>
<para>
Note that this function will not work correctly if GModule is not supported
on the platform or introspection is not available for service <parameter>service</parameter>.
</para>
<para>
WARNING: This function can not and therefore does not guarantee that the
resulting signal connections will be correct as it depends heavily on a
particular naming schemes described above.</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>user_data</parameter>&nbsp;:</term>
<listitem><simpara> the data to pass to each of the callbacks
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>error</parameter>&nbsp;:</term>
<listitem><simpara> return location for a <link linkend="GError"><type>GError</type></link>, or <link linkend="NULL:CAPS"><literal>NULL</literal></link>
</simpara></listitem></varlistentry>
</variablelist></refsect2>

</refsect1>
<refsect1 id="GUPnPService.property-details" role="property_details">
<title role="property_details.title">Property Details</title>
<refsect2 id="GUPnPService--root-device"><title>The <literal>&quot;root-device&quot;</literal> property</title>
<indexterm zone="GUPnPService--root-device"><primary>GUPnPService:root-device</primary></indexterm><programlisting>  &quot;root-device&quot;              <link linkend="GUPnPRootDevice">GUPnPRootDevice</link>*      : Read / Write / Construct Only</programlisting>
<para>
The containing <link linkend="GUPnPRootDevice"><type>GUPnPRootDevice</type></link>.</para>
<para>

</para></refsect2>

</refsect1>

<refsect1 id="GUPnPService.signal-details" role="signals">
<title role="signals.title">Signal Details</title>
<refsect2 id="GUPnPService-action-invoked"><title>The <literal>&quot;action-invoked&quot;</literal> signal</title>
<indexterm zone="GUPnPService-action-invoked"><primary>GUPnPService::action-invoked</primary></indexterm><programlisting><link linkend="void">void</link>                user_function                      (<link linkend="GUPnPService">GUPnPService</link>       *service,
                                                        <link linkend="GUPnPServiceAction">GUPnPServiceAction</link> *action,
                                                        <link linkend="gpointer">gpointer</link>            user_data)      : Run Last / Has Details</programlisting>
<para>
Emitted whenever an action is invoked. Handler should process
<parameter>action</parameter>.</para>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>service</parameter>&nbsp;:</term>
<listitem><simpara> The <link linkend="GUPnPService"><type>GUPnPService</type></link> that received the signal
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>action</parameter>&nbsp;:</term>
<listitem><simpara> The invoked <link linkend="GUPnPAction"><type>GUPnPAction</type></link>
</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><refsect2 id="GUPnPService-notify-failed"><title>The <literal>&quot;notify-failed&quot;</literal> signal</title>
<indexterm zone="GUPnPService-notify-failed"><primary>GUPnPService::notify-failed</primary></indexterm><programlisting><link linkend="void">void</link>                user_function                      (<link linkend="GUPnPService">GUPnPService</link> *service,
                                                        <link linkend="gpointer">gpointer</link>      callback_url,
                                                        <link linkend="gpointer">gpointer</link>      reason,
                                                        <link linkend="gpointer">gpointer</link>      user_data)         : Run Last</programlisting>
<para>
Emitted whenever notification of a client fails.</para>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>service</parameter>&nbsp;:</term>
<listitem><simpara> The <link linkend="GUPnPService"><type>GUPnPService</type></link> that received the signal
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>callback_url</parameter>&nbsp;:</term>
<listitem><simpara> The callback URL
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>reason</parameter>&nbsp;:</term>
<listitem><simpara> A pointer to a <link linkend="GError"><type>GError</type></link> describing why the notify failed
</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><refsect2 id="GUPnPService-query-variable"><title>The <literal>&quot;query-variable&quot;</literal> signal</title>
<indexterm zone="GUPnPService-query-variable"><primary>GUPnPService::query-variable</primary></indexterm><programlisting><link linkend="void">void</link>                user_function                      (<link linkend="GUPnPService">GUPnPService</link> *service,
                                                        <link linkend="gchar">gchar</link>        *variable,
                                                        <link linkend="gpointer">gpointer</link>      value,
                                                        <link linkend="gpointer">gpointer</link>      user_data)      : Run Last / Has Details</programlisting>
<para>
Emitted whenever <parameter>service</parameter> needs to know the value of <parameter>variable</parameter>.
Handler should fill <parameter>value</parameter> with the value of <parameter>variable</parameter>.</para>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>service</parameter>&nbsp;:</term>
<listitem><simpara> The <link linkend="GUPnPService"><type>GUPnPService</type></link> that received the signal
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>variable</parameter>&nbsp;:</term>
<listitem><simpara> The variable that is being queried
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>value</parameter>&nbsp;:</term>
<listitem><simpara> The location of the <link linkend="GValue"><type>GValue</type></link> of the variable
</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>