gupnp-root-device.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="GUPnPRootDevice">
<refmeta>
<refentrytitle role="top_of_page" id="GUPnPRootDevice.top_of_page">GUPnPRootDevice</refentrytitle>
<manvolnum>3</manvolnum>
<refmiscinfo>GUPNP Library</refmiscinfo>
</refmeta>

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

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

<synopsis>
                    <link linkend="GUPnPRootDevice-struct">GUPnPRootDevice</link>;
<link linkend="GUPnPRootDevice">GUPnPRootDevice</link>*    <link linkend="gupnp-root-device-new">gupnp_root_device_new</link>               (<link linkend="GUPnPContext">GUPnPContext</link> *context,
                                                         const <link linkend="char">char</link> *relative_location);
<link linkend="GUPnPRootDevice">GUPnPRootDevice</link>*    <link linkend="gupnp-root-device-new-full">gupnp_root_device_new_full</link>          (<link linkend="GUPnPContext">GUPnPContext</link> *context,
                                                         <link linkend="GUPnPResourceFactory">GUPnPResourceFactory</link> *factory,
                                                         <link linkend="xmlDoc">xmlDoc</link> *description_doc,
                                                         const <link linkend="char">char</link> *relative_location);
<link linkend="void">void</link>                <link linkend="gupnp-root-device-set-available">gupnp_root_device_set_available</link>     (<link linkend="GUPnPRootDevice">GUPnPRootDevice</link> *root_device,
                                                         <link linkend="gboolean">gboolean</link> available);
<link linkend="gboolean">gboolean</link>            <link linkend="gupnp-root-device-get-available">gupnp_root_device_get_available</link>     (<link linkend="GUPnPRootDevice">GUPnPRootDevice</link> *root_device);
const <link linkend="char">char</link>*         <link linkend="gupnp-root-device-get-relative-location">gupnp_root_device_get_relative_location</link>
                                                        (<link linkend="GUPnPRootDevice">GUPnPRootDevice</link> *root_device);
</synopsis>
</refsynopsisdiv>

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

</refsect1>





<refsect1 id="GUPnPRootDevice.properties" role="properties">
<title role="properties.title">Properties</title>
<synopsis>
  &quot;<link linkend="GUPnPRootDevice--available">available</link>&quot;                <link linkend="gboolean">gboolean</link>              : Read / Write
  &quot;<link linkend="GUPnPRootDevice--description-doc">description-doc</link>&quot;          <link linkend="gpointer">gpointer</link>              : Write / Construct Only
  &quot;<link linkend="GUPnPRootDevice--relative-location">relative-location</link>&quot;        <link linkend="gchar">gchar</link>*                : Read / Write / Construct Only
</synopsis>
</refsect1>



<refsect1 id="GUPnPRootDevice.description" role="desc">
<title role="desc.title">Description</title>
<para>
<link linkend="GUPnPRootDevice"><type>GUPnPRootDevice</type></link> allows for implementing root devices.</para>
<para>

</para>
</refsect1>

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

</para></refsect2>
<refsect2 id="gupnp-root-device-new" role="function">
<title>gupnp_root_device_new ()</title>
<indexterm zone="gupnp-root-device-new"><primary>gupnp_root_device_new</primary></indexterm><programlisting><link linkend="GUPnPRootDevice">GUPnPRootDevice</link>*    gupnp_root_device_new               (<link linkend="GUPnPContext">GUPnPContext</link> *context,
                                                         const <link linkend="char">char</link> *relative_location);</programlisting>
<para>
Create a new <link linkend="GUPnPRootDevice"><type>GUPnPRootDevice</type></link> object, automatically downloading and
parsing <parameter>relative_location</parameter>.</para>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>context</parameter>&nbsp;:</term>
<listitem><simpara> The <link linkend="GUPnPContext"><type>GUPnPContext</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>relative_location</parameter>&nbsp;:</term>
<listitem><simpara> Location of the description file for this device,
relative to the HTTP root
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> A new <parameter>GUPnPRootDevice</parameter> object.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="gupnp-root-device-new-full" role="function">
<title>gupnp_root_device_new_full ()</title>
<indexterm zone="gupnp-root-device-new-full"><primary>gupnp_root_device_new_full</primary></indexterm><programlisting><link linkend="GUPnPRootDevice">GUPnPRootDevice</link>*    gupnp_root_device_new_full          (<link linkend="GUPnPContext">GUPnPContext</link> *context,
                                                         <link linkend="GUPnPResourceFactory">GUPnPResourceFactory</link> *factory,
                                                         <link linkend="xmlDoc">xmlDoc</link> *description_doc,
                                                         const <link linkend="char">char</link> *relative_location);</programlisting>
<para>
Create a new <link linkend="GUPnPRootDevice"><type>GUPnPRootDevice</type></link>, automatically downloading and parsing
<parameter>relative_location</parameter> if <parameter>description_doc</parameter> is <link linkend="NULL:CAPS"><literal>NULL</literal></link>.</para>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>context</parameter>&nbsp;:</term>
<listitem><simpara> A <link linkend="GUPnPContext"><type>GUPnPContext</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>factory</parameter>&nbsp;:</term>
<listitem><simpara> A <link linkend="GUPnPResourceFactory"><type>GUPnPResourceFactory</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>description_doc</parameter>&nbsp;:</term>
<listitem><simpara> Pointer to the device description document, or <link linkend="NULL:CAPS"><literal>NULL</literal></link>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>relative_location</parameter>&nbsp;:</term>
<listitem><simpara> Location of the description file for this device,
relative to the HTTP root
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> A new <link linkend="GUPnPRootDevice"><type>GUPnPRootDevice</type></link> object.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="gupnp-root-device-set-available" role="function">
<title>gupnp_root_device_set_available ()</title>
<indexterm zone="gupnp-root-device-set-available"><primary>gupnp_root_device_set_available</primary></indexterm><programlisting><link linkend="void">void</link>                gupnp_root_device_set_available     (<link linkend="GUPnPRootDevice">GUPnPRootDevice</link> *root_device,
                                                         <link linkend="gboolean">gboolean</link> available);</programlisting>
<para>
Controls whether or not <parameter>root_device</parameter> is available (announcing
its presence).</para>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>root_device</parameter>&nbsp;:</term>
<listitem><simpara> A <link linkend="GUPnPRootDevice"><type>GUPnPRootDevice</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>available</parameter>&nbsp;:</term>
<listitem><simpara> <link linkend="TRUE:CAPS"><literal>TRUE</literal></link> if <parameter>root_device</parameter> should be available
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="gupnp-root-device-get-available" role="function">
<title>gupnp_root_device_get_available ()</title>
<indexterm zone="gupnp-root-device-get-available"><primary>gupnp_root_device_get_available</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link>            gupnp_root_device_get_available     (<link linkend="GUPnPRootDevice">GUPnPRootDevice</link> *root_device);</programlisting>
<para>
Get whether or not <parameter>root_device</parameter> is available (announcing its presence).</para>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>root_device</parameter>&nbsp;:</term>
<listitem><simpara> A <link linkend="GUPnPRootDevice"><type>GUPnPRootDevice</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> <link linkend="TRUE:CAPS"><literal>TRUE</literal></link> if <parameter>root_device</parameter> is available, <link linkend="FALSE:CAPS"><literal>FALSE</literal></link> otherwise.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="gupnp-root-device-get-relative-location" role="function">
<title>gupnp_root_device_get_relative_location ()</title>
<indexterm zone="gupnp-root-device-get-relative-location"><primary>gupnp_root_device_get_relative_location</primary></indexterm><programlisting>const <link linkend="char">char</link>*         gupnp_root_device_get_relative_location
                                                        (<link linkend="GUPnPRootDevice">GUPnPRootDevice</link> *root_device);</programlisting>
<para>
Get the relative location of <parameter>root_device</parameter>.</para>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>root_device</parameter>&nbsp;:</term>
<listitem><simpara> A <link linkend="GUPnPRootDevice"><type>GUPnPRootDevice</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> The relative location of <parameter>root_device</parameter>.
</simpara></listitem></varlistentry>
</variablelist></refsect2>

</refsect1>
<refsect1 id="GUPnPRootDevice.property-details" role="property_details">
<title role="property_details.title">Property Details</title>
<refsect2 id="GUPnPRootDevice--available"><title>The <literal>&quot;available&quot;</literal> property</title>
<indexterm zone="GUPnPRootDevice--available"><primary>GUPnPRootDevice:available</primary></indexterm><programlisting>  &quot;available&quot;                <link linkend="gboolean">gboolean</link>              : Read / Write</programlisting>
<para>
TRUE if this device is available.</para>
<para>

</para><para>Default value: FALSE</para>
</refsect2>
<refsect2 id="GUPnPRootDevice--description-doc"><title>The <literal>&quot;description-doc&quot;</literal> property</title>
<indexterm zone="GUPnPRootDevice--description-doc"><primary>GUPnPRootDevice:description-doc</primary></indexterm><programlisting>  &quot;description-doc&quot;          <link linkend="gpointer">gpointer</link>              : Write / Construct Only</programlisting>
<para>
Pointer to description document. Constructor property.</para>
<para>

</para></refsect2>
<refsect2 id="GUPnPRootDevice--relative-location"><title>The <literal>&quot;relative-location&quot;</literal> property</title>
<indexterm zone="GUPnPRootDevice--relative-location"><primary>GUPnPRootDevice:relative-location</primary></indexterm><programlisting>  &quot;relative-location&quot;        <link linkend="gchar">gchar</link>*                : Read / Write / Construct Only</programlisting>
<para>
Relative location.</para>
<para>

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

</refsect1>




</refentry>