gupnp-service.xml

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

<?xml version="1.0"?>
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN" "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd">
<refentry id="GUPnPService">
<refmeta>
<refentrytitle role="top_of_page" id="GUPnPService.top_of_page">GUPnPService</refentrytitle>
<manvolnum>3</manvolnum>
<refmiscinfo>GUPNP Library</refmiscinfo>
</refmeta>

<refnamediv>
<refname>GUPnPService</refname>
<refpurpose>Class for service implementations.</refpurpose>
<!--[<xref linkend="desc" endterm="desc.title"/>]-->
</refnamediv>

<refsynopsisdiv id="GUPnPService.synopsis" role="synopsis">
<title role="synopsis.title">Synopsis</title>

<synopsis>
                    <link linkend="GUPnPService-struct">GUPnPService</link>;
                    <link linkend="GUPnPServiceAction">GUPnPServiceAction</link>;
const <link linkend="char">char</link>*         <link linkend="gupnp-service-action-get-name">gupnp_service_action_get_name</link>       (<link linkend="GUPnPServiceAction">GUPnPServiceAction</link> *action);
<link linkend="GList">GList</link>*              <link linkend="gupnp-service-action-get-locales">gupnp_service_action_get_locales</link>    (<link linkend="GUPnPServiceAction">GUPnPServiceAction</link> *action);
<link linkend="void">void</link>                <link linkend="gupnp-service-action-get">gupnp_service_action_get</link>            (<link linkend="GUPnPServiceAction">GUPnPServiceAction</link> *action,
                                                         ...);
<link linkend="void">void</link>                <link linkend="gupnp-service-action-get-valist">gupnp_service_action_get_valist</link>     (<link linkend="GUPnPServiceAction">GUPnPServiceAction</link> *action,
                                                         <link linkend="va-list">va_list</link> var_args);
<link linkend="void">void</link>                <link linkend="gupnp-service-action-get-value">gupnp_service_action_get_value</link>      (<link linkend="GUPnPServiceAction">GUPnPServiceAction</link> *action,
                                                         const <link linkend="char">char</link> *argument,
                                                         <link linkend="GValue">GValue</link> *value);
<link linkend="void">void</link>                <link linkend="gupnp-service-action-set">gupnp_service_action_set</link>            (<link linkend="GUPnPServiceAction">GUPnPServiceAction</link> *action,
                                                         ...);
<link linkend="void">void</link>                <link linkend="gupnp-service-action-set-valist">gupnp_service_action_set_valist</link>     (<link linkend="GUPnPServiceAction">GUPnPServiceAction</link> *action,
                                                         <link linkend="va-list">va_list</link> var_args);
<link linkend="void">void</link>                <link linkend="gupnp-service-action-set-value">gupnp_service_action_set_value</link>      (<link linkend="GUPnPServiceAction">GUPnPServiceAction</link> *action,
                                                         const <link linkend="char">char</link> *argument,
                                                         const <link linkend="GValue">GValue</link> *value);
<link linkend="void">void</link>                <link linkend="gupnp-service-action-return">gupnp_service_action_return</link>         (<link linkend="GUPnPServiceAction">GUPnPServiceAction</link> *action);
<link linkend="void">void</link>                <link linkend="gupnp-service-action-return-error">gupnp_service_action_return_error</link>   (<link linkend="GUPnPServiceAction">GUPnPServiceAction</link> *action,
                                                         <link linkend="guint">guint</link> error_code,
                                                         const <link linkend="char">char</link> *error_description);
<link linkend="void">void</link>                <link linkend="gupnp-service-notify">gupnp_service_notify</link>                (<link linkend="GUPnPService">GUPnPService</link> *service,
                                                         ...);
<link linkend="void">void</link>                <link linkend="gupnp-service-notify-valist">gupnp_service_notify_valist</link>         (<link linkend="GUPnPService">GUPnPService</link> *service,
                                                         <link linkend="va-list">va_list</link> var_args);
<link linkend="void">void</link>                <link linkend="gupnp-service-notify-value">gupnp_service_notify_value</link>          (<link linkend="GUPnPService">GUPnPService</link> *service,
                                                         const <link linkend="char">char</link> *variable,
                                                         const <link linkend="GValue">GValue</link> *value);
<link linkend="void">void</link>                <link linkend="gupnp-service-freeze-notify">gupnp_service_freeze_notify</link>         (<link linkend="GUPnPService">GUPnPService</link> *service);
<link linkend="void">void</link>                <link linkend="gupnp-service-thaw-notify">gupnp_service_thaw_notify</link>           (<link linkend="GUPnPService">GUPnPService</link> *service);
<link linkend="void">void</link>                <link linkend="gupnp-service-signals-autoconnect">gupnp_service_signals_autoconnect</link>   (<link linkend="GUPnPService">GUPnPService</link> *service,
                                                         <link linkend="gpointer">gpointer</link> user_data,
                                                         <link linkend="GError">GError</link> **error);
</synopsis>
</refsynopsisdiv>

<refsect1 id="GUPnPService.object-hierarchy" role="object_hierarchy">
<title role="object_hierarchy.title">Object Hierarchy</title>
<synopsis>
  <link linkend="GObject">GObject</link>
   +----<link linkend="GUPnPServiceInfo">GUPnPServiceInfo</link>
         +----GUPnPService
</synopsis>

</refsect1>





<refsect1 id="GUPnPService.properties" role="properties">
<title role="properties.title">Properties</title>
<synopsis>
  &quot;<link linkend="GUPnPService--root-device">root-device</link>&quot;              <link linkend="GUPnPRootDevice">GUPnPRootDevice</link>*      : Read / Write / Construct Only
</synopsis>
</refsect1>

<refsect1 id="GUPnPService.signals" role="signal_proto">
<title role="signal_proto.title">Signals</title>
<synopsis>
  &quot;<link linkend="GUPnPService-action-invoked">action-invoked</link>&quot;                                 : Run Last / Has Details
  &quot;<link linkend="GUPnPService-notify-failed">notify-failed</link>&quot;                                  : Run Last
  &quot;<link linkend="GUPnPService-query-variable">query-variable</link>&quot;                                 : Run Last / Has Details
</synopsis>
</refsect1>


<refsect1 id="GUPnPService.description" role="desc">
<title role="desc.title">Description</title>
<para>
<link linkend="GUPnPService"><type>GUPnPService</type></link> allows for handling incoming actions and state variable
notification. <link linkend="GUPnPService"><type>GUPnPService</type></link> implements the <link linkend="GUPnPServiceInfo"><type>GUPnPServiceInfo</type></link> interface.</para>
<para>

</para>
</refsect1>

<refsect1 id="GUPnPService.details" role="details">
<title role="details.title">Details</title>
<refsect2 id="GUPnPService-struct" role="struct">
<title>GUPnPService</title>
<indexterm zone="GUPnPService-struct"><primary>GUPnPService</primary></indexterm><programlisting>typedef struct _GUPnPService GUPnPService;</programlisting>
<para>
This struct contains private data only, and should be accessed using the
functions below.</para>
<para>

</para></refsect2>
<refsect2 id="GUPnPServiceAction" role="struct">
<title>GUPnPServiceAction</title>
<indexterm zone="GUPnPServiceAction"><primary>GUPnPServiceAction</primary></indexterm><programlisting>typedef struct _GUPnPServiceAction GUPnPServiceAction;</programlisting>
<para>
Opaque structure for holding in-progress action data.</para>
<para>

</para></refsect2>
<refsect2 id="gupnp-service-action-get-name" role="function">
<title>gupnp_service_action_get_name ()</title>
<indexterm zone="gupnp-service-action-get-name"><primary>gupnp_service_action_get_name</primary></indexterm><programlisting>const <link linkend="char">char</link>*         gupnp_service_action_get_name       (<link linkend="GUPnPServiceAction">GUPnPServiceAction</link> *action);</programlisting>
<para>
Get the name of <parameter>action</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><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> The name of <parameter>action</parameter>
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="gupnp-service-action-get-locales" role="function">
<title>gupnp_service_action_get_locales ()</title>
<indexterm zone="gupnp-service-action-get-locales"><primary>gupnp_service_action_get_locales</primary></indexterm><programlisting><link linkend="GList">GList</link>*              gupnp_service_action_get_locales    (<link linkend="GUPnPServiceAction">GUPnPServiceAction</link> *action);</programlisting>
<para>
Get an ordered (preferred first) <link linkend="GList"><type>GList</type></link> of locales preferred by
the client. Free list and elements after use.</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><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> A <link linkend="GList"><type>GList</type></link> of <link linkend="char"><type>char</type></link>* locale names.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="gupnp-service-action-get" role="function">
<title>gupnp_service_action_get ()</title>
<indexterm zone="gupnp-service-action-get"><primary>gupnp_service_action_get</primary></indexterm><programlisting><link linkend="void">void</link>                gupnp_service_action_get            (<link linkend="GUPnPServiceAction">GUPnPServiceAction</link> *action,
                                                         ...);</programlisting>
<para>
Retrieves the specified action arguments.</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 argument name, argument type, and argument value
location, terminated with <link linkend="NULL:CAPS"><literal>NULL</literal></link>.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="gupnp-service-action-get-valist" role="function">
<title>gupnp_service_action_get_valist ()</title>
<indexterm zone="gupnp-service-action-get-valist"><primary>gupnp_service_action_get_valist</primary></indexterm><programlisting><link linkend="void">void</link>                gupnp_service_action_get_valist     (<link linkend="GUPnPServiceAction">GUPnPServiceAction</link> *action,
                                                         <link linkend="va-list">va_list</link> var_args);</programlisting>
<para>
See <link linkend="gupnp-service-action-get"><function>gupnp_service_action_get()</function></link>; this version takes a va_list for