gupnp-service-info.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="GUPnPServiceInfo">
<refmeta>
<refentrytitle role="top_of_page" id="GUPnPServiceInfo.top_of_page">GUPnPServiceInfo</refentrytitle>
<manvolnum>3</manvolnum>
<refmiscinfo>GUPNP Library</refmiscinfo>
</refmeta>

<refnamediv>
<refname>GUPnPServiceInfo</refname>
<refpurpose>Base abstract class for querying service information.</refpurpose>
<!--[<xref linkend="desc" endterm="desc.title"/>]-->
</refnamediv>

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

<synopsis>
                    <link linkend="GUPnPServiceInfo-struct">GUPnPServiceInfo</link>;
<link linkend="void">void</link>                (<link linkend="GUPnPServiceIntrospectionCallback">*GUPnPServiceIntrospectionCallback</link>)
                                                        (<link linkend="GUPnPServiceInfo">GUPnPServiceInfo</link> *info,
                                                         <link linkend="GUPnPServiceIntrospection">GUPnPServiceIntrospection</link> *introspection,
                                                         const <link linkend="GError">GError</link> *error,
                                                         <link linkend="gpointer">gpointer</link> user_data);
<link linkend="GUPnPContext">GUPnPContext</link>*       <link linkend="gupnp-service-info-get-context">gupnp_service_info_get_context</link>      (<link linkend="GUPnPServiceInfo">GUPnPServiceInfo</link> *info);
const <link linkend="char">char</link>*         <link linkend="gupnp-service-info-get-location">gupnp_service_info_get_location</link>     (<link linkend="GUPnPServiceInfo">GUPnPServiceInfo</link> *info);
const <link linkend="SoupURI">SoupURI</link>*      <link linkend="gupnp-service-info-get-url-base">gupnp_service_info_get_url_base</link>     (<link linkend="GUPnPServiceInfo">GUPnPServiceInfo</link> *info);
const <link linkend="char">char</link>*         <link linkend="gupnp-service-info-get-udn">gupnp_service_info_get_udn</link>          (<link linkend="GUPnPServiceInfo">GUPnPServiceInfo</link> *info);
const <link linkend="char">char</link>*         <link linkend="gupnp-service-info-get-service-type">gupnp_service_info_get_service_type</link> (<link linkend="GUPnPServiceInfo">GUPnPServiceInfo</link> *info);
<link linkend="char">char</link>*               <link linkend="gupnp-service-info-get-id">gupnp_service_info_get_id</link>           (<link linkend="GUPnPServiceInfo">GUPnPServiceInfo</link> *info);
<link linkend="char">char</link>*               <link linkend="gupnp-service-info-get-scpd-url">gupnp_service_info_get_scpd_url</link>     (<link linkend="GUPnPServiceInfo">GUPnPServiceInfo</link> *info);
<link linkend="char">char</link>*               <link linkend="gupnp-service-info-get-control-url">gupnp_service_info_get_control_url</link>  (<link linkend="GUPnPServiceInfo">GUPnPServiceInfo</link> *info);
<link linkend="char">char</link>*               <link linkend="gupnp-service-info-get-event-subscription-url">gupnp_service_info_get_event_subscription_url</link>
                                                        (<link linkend="GUPnPServiceInfo">GUPnPServiceInfo</link> *info);
<link linkend="GUPnPServiceIntrospection">GUPnPServiceIntrospection</link>* <link linkend="gupnp-service-info-get-introspection">gupnp_service_info_get_introspection</link>
                                                        (<link linkend="GUPnPServiceInfo">GUPnPServiceInfo</link> *info,
                                                         <link linkend="GError">GError</link> **error);
<link linkend="void">void</link>                <link linkend="gupnp-service-info-get-introspection-async">gupnp_service_info_get_introspection_async</link>
                                                        (<link linkend="GUPnPServiceInfo">GUPnPServiceInfo</link> *info,
                                                         <link linkend="GUPnPServiceIntrospectionCallback">GUPnPServiceIntrospectionCallback</link> callback,
                                                         <link linkend="gpointer">gpointer</link> user_data);
</synopsis>
</refsynopsisdiv>

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

</refsect1>





<refsect1 id="GUPnPServiceInfo.properties" role="properties">
<title role="properties.title">Properties</title>
<synopsis>
  &quot;<link linkend="GUPnPServiceInfo--context">context</link>&quot;                  <link linkend="GUPnPContext">GUPnPContext</link>*         : Read / Write / Construct Only
  &quot;<link linkend="GUPnPServiceInfo--document">document</link>&quot;                 <link linkend="XmlDocWrapper">XmlDocWrapper</link>*        : Write / Construct Only
  &quot;<link linkend="GUPnPServiceInfo--element">element</link>&quot;                  <link linkend="gpointer">gpointer</link>              : Write / Construct Only
  &quot;<link linkend="GUPnPServiceInfo--location">location</link>&quot;                 <link linkend="gchar">gchar</link>*                : Read / Write / Construct Only
  &quot;<link linkend="GUPnPServiceInfo--service-type">service-type</link>&quot;             <link linkend="gchar">gchar</link>*                : Read / Write / Construct Only
  &quot;<link linkend="GUPnPServiceInfo--udn">udn</link>&quot;                      <link linkend="gchar">gchar</link>*                : Read / Write / Construct Only
  &quot;<link linkend="GUPnPServiceInfo--url-base">url-base</link>&quot;                 <link linkend="gpointer">gpointer</link>              : Read / Write / Construct Only
</synopsis>
</refsect1>



<refsect1 id="GUPnPServiceInfo.description" role="desc">
<title role="desc.title">Description</title>
<para>
The <link linkend="GUPnPDeviceInfo"><type>GUPnPDeviceInfo</type></link> base abstract class provides methods for querying
service information.</para>
<para>

</para>
</refsect1>

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

</para></refsect2>
<refsect2 id="GUPnPServiceIntrospectionCallback" role="function">
<title>GUPnPServiceIntrospectionCallback ()</title>
<indexterm zone="GUPnPServiceIntrospectionCallback"><primary>GUPnPServiceIntrospectionCallback</primary></indexterm><programlisting><link linkend="void">void</link>                (*GUPnPServiceIntrospectionCallback)
                                                        (<link linkend="GUPnPServiceInfo">GUPnPServiceInfo</link> *info,
                                                         <link linkend="GUPnPServiceIntrospection">GUPnPServiceIntrospection</link> *introspection,
                                                         const <link linkend="GError">GError</link> *error,
                                                         <link linkend="gpointer">gpointer</link> user_data);</programlisting>
<para>
Callback notifying that <parameter>introspection</parameter> for <parameter>info</parameter> has been obtained.</para>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>info</parameter>&nbsp;:</term>
<listitem><simpara> The <link linkend="GUPnPServiceInfo"><type>GUPnPServiceInfo</type></link> introspection was requested for
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>introspection</parameter>&nbsp;:</term>
<listitem><simpara> The new <link linkend="GUPnPServiceIntrospection"><type>GUPnPServiceIntrospection</type></link> object, or NULL
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>error</parameter>&nbsp;:</term>
<listitem><simpara> The <link linkend="GError"><type>GError</type></link> that occurred, or NULL
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>user_data</parameter>&nbsp;:</term>
<listitem><simpara> User data
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="gupnp-service-info-get-context" role="function">
<title>gupnp_service_info_get_context ()</title>
<indexterm zone="gupnp-service-info-get-context"><primary>gupnp_service_info_get_context</primary></indexterm><programlisting><link linkend="GUPnPContext">GUPnPContext</link>*       gupnp_service_info_get_context      (<link linkend="GUPnPServiceInfo">GUPnPServiceInfo</link> *info);</programlisting>
<para>
Get the <link linkend="GUPnPContext"><type>GUPnPContext</type></link> associated with <parameter>info</parameter>.</para>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>info</parameter>&nbsp;:</term>
<listitem><simpara> A <link linkend="GUPnPServiceInfo"><type>GUPnPServiceInfo</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> A <link linkend="GUPnPContext"><type>GUPnPContext</type></link>.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="gupnp-service-info-get-location" role="function">
<title>gupnp_service_info_get_location ()</title>
<indexterm zone="gupnp-service-info-get-location"><primary>gupnp_service_info_get_location</primary></indexterm><programlisting>const <link linkend="char">char</link>*         gupnp_service_info_get_location     (<link linkend="GUPnPServiceInfo">GUPnPServiceInfo</link> *info);</programlisting>
<para>
Get the location of the device description file.</para>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>info</parameter>&nbsp;:</term>
<listitem><simpara> A <link linkend="GUPnPServiceInfo"><type>GUPnPServiceInfo</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> A constant string.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="gupnp-service-info-get-url-base" role="function">
<title>gupnp_service_info_get_url_base ()</title>
<indexterm zone="gupnp-service-info-get-url-base"><primary>gupnp_service_info_get_url_base</primary></indexterm><programlisting>const <link linkend="SoupURI">SoupURI</link>*      gupnp_service_info_get_url_base     (<link linkend="GUPnPServiceInfo">GUPnPServiceInfo</link> *info);</programlisting>
<para>
Get the URL base of this service.</para>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>info</parameter>&nbsp;:</term>
<listitem><simpara> A <link linkend="GUPnPServiceInfo"><type>GUPnPServiceInfo</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> A constant <link linkend="SoupURI"><type>SoupURI</type></link>.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="gupnp-service-info-get-udn" role="function">
<title>gupnp_service_info_get_udn ()</title>
<indexterm zone="gupnp-service-info-get-udn"><primary>gupnp_service_info_get_udn</primary></indexterm><programlisting>const <link linkend="char">char</link>*         gupnp_service_info_get_udn          (<link linkend="GUPnPServiceInfo">GUPnPServiceInfo</link> *info);</programlisting>
<para>
Get the Unique Device Name of the containing device.</para>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>info</parameter>&nbsp;:</term>
<listitem><simpara> A <link linkend="GUPnPServiceInfo"><type>GUPnPServiceInfo</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> A constant string.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="gupnp-service-info-get-service-type" role="function">
<title>gupnp_service_info_get_service_type ()</title>
<indexterm zone="gupnp-service-info-get-service-type"><primary>gupnp_service_info_get_service_type</primary></indexterm><programlisting>const <link linkend="char">char</link>*         gupnp_service_info_get_service_type (<link linkend="GUPnPServiceInfo">GUPnPServiceInfo</link> *info);</programlisting>