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

<refnamediv>
<refname>GUPnPServiceIntrospection</refname>
<refpurpose>Service introspection class.</refpurpose>
<!--[<xref linkend="desc" endterm="desc.title"/>]-->
</refnamediv>

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

<synopsis>
enum                <link linkend="GUPnPServiceActionArgDirection">GUPnPServiceActionArgDirection</link>;
                    <link linkend="GUPnPServiceActionArgInfo">GUPnPServiceActionArgInfo</link>;
                    <link linkend="GUPnPServiceActionInfo">GUPnPServiceActionInfo</link>;
                    <link linkend="GUPnPServiceStateVariableInfo">GUPnPServiceStateVariableInfo</link>;
                    <link linkend="GUPnPServiceIntrospection-struct">GUPnPServiceIntrospection</link>;
const <link linkend="GList">GList</link>*        <link linkend="gupnp-service-introspection-list-action-names">gupnp_service_introspection_list_action_names</link>
                                                        (<link linkend="GUPnPServiceIntrospection">GUPnPServiceIntrospection</link> *introspection);
const <link linkend="GList">GList</link>*        <link linkend="gupnp-service-introspection-list-actions">gupnp_service_introspection_list_actions</link>
                                                        (<link linkend="GUPnPServiceIntrospection">GUPnPServiceIntrospection</link> *introspection);
const <link linkend="GUPnPServiceActionInfo">GUPnPServiceActionInfo</link>* <link linkend="gupnp-service-introspection-get-action">gupnp_service_introspection_get_action</link>
                                                        (<link linkend="GUPnPServiceIntrospection">GUPnPServiceIntrospection</link> *introspection,
                                                         const <link linkend="gchar">gchar</link> *action_name);
const <link linkend="GList">GList</link>*        <link linkend="gupnp-service-introspection-list-state-variable-names">gupnp_service_introspection_list_state_variable_names</link>
                                                        (<link linkend="GUPnPServiceIntrospection">GUPnPServiceIntrospection</link> *introspection);
const <link linkend="GList">GList</link>*        <link linkend="gupnp-service-introspection-list-state-variables">gupnp_service_introspection_list_state_variables</link>
                                                        (<link linkend="GUPnPServiceIntrospection">GUPnPServiceIntrospection</link> *introspection);
const <link linkend="GUPnPServiceStateVariableInfo">GUPnPServiceStateVariableInfo</link>* <link linkend="gupnp-service-introspection-get-state-variable">gupnp_service_introspection_get_state_variable</link>
                                                        (<link linkend="GUPnPServiceIntrospection">GUPnPServiceIntrospection</link> *introspection,
                                                         const <link linkend="gchar">gchar</link> *variable_name);
</synopsis>
</refsynopsisdiv>

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

</refsect1>





<refsect1 id="GUPnPServiceIntrospection.properties" role="properties">
<title role="properties.title">Properties</title>
<synopsis>
  &quot;<link linkend="GUPnPServiceIntrospection--scpd">scpd</link>&quot;                     <link linkend="gpointer">gpointer</link>              : Write / Construct Only
</synopsis>
</refsect1>



<refsect1 id="GUPnPServiceIntrospection.description" role="desc">
<title role="desc.title">Description</title>
<para>
The <link linkend="GUPnPServiceIntrospection"><type>GUPnPServiceIntrospection</type></link> class provides methods for service
introspection based on information contained in its service description
document (SCPD). There is no constructor provided for this class, please use
<link linkend="gupnp-service-info-get-introspection"><type>gupnp_service_info_get_introspection</type></link> or
<link linkend="gupnp-service-info-get-introspection-async"><type>gupnp_service_info_get_introspection_async</type></link> to create an
<link linkend="GUPnPServiceIntrospection"><type>GUPnPServiceIntrospection</type></link> object for a specific service.
</para>
<para>
Note that all the introspection information is retreived from the service
description document (SCPD) provided by the service and hence can not be
guaranteed to be complete. A UPnP service is required to provide an SCPD but
unfortunately, many services either do not provide this document or the
document does not provide any or all of the introspection information.
</para>
<para>
This class exposes internals of the UPnP protocol and should not need
to be used for regular device or control point development.</para>
<para>

</para>
</refsect1>

<refsect1 id="GUPnPServiceIntrospection.details" role="details">
<title role="details.title">Details</title>
<refsect2 id="GUPnPServiceActionArgDirection" role="enum">
<title>enum GUPnPServiceActionArgDirection</title>
<indexterm zone="GUPnPServiceActionArgDirection"><primary>GUPnPServiceActionArgDirection</primary></indexterm><programlisting>typedef enum
{
        GUPNP_SERVICE_ACTION_ARG_DIRECTION_IN,
        GUPNP_SERVICE_ACTION_ARG_DIRECTION_OUT
} GUPnPServiceActionArgDirection;
</programlisting>
<para>
Represents the direction of a service state variable.</para>
<para>

</para><variablelist role="enum">
<varlistentry id="GUPNP-SERVICE-ACTION-ARG-DIRECTION-IN:CAPS" role="constant">
<term><literal>GUPNP_SERVICE_ACTION_ARG_DIRECTION_IN</literal></term>
<listitem><simpara> An "in" variable, to the service.
</simpara></listitem>
</varlistentry>
<varlistentry id="GUPNP-SERVICE-ACTION-ARG-DIRECTION-OUT:CAPS" role="constant">
<term><literal>GUPNP_SERVICE_ACTION_ARG_DIRECTION_OUT</literal></term>
<listitem><simpara> An "out" variable, from the service.
</simpara></listitem>
</varlistentry>
</variablelist></refsect2>
<refsect2 id="GUPnPServiceActionArgInfo" role="struct">
<title>GUPnPServiceActionArgInfo</title>
<indexterm zone="GUPnPServiceActionArgInfo"><primary>GUPnPServiceActionArgInfo</primary></indexterm><programlisting>typedef struct {
        char                          *name;
        GUPnPServiceActionArgDirection direction;
        char                          *related_state_variable;
        gboolean                       retval;
} GUPnPServiceActionArgInfo;
</programlisting>
<para>
This structure contains information about the argument of service action.</para>
<para>

</para><variablelist role="struct">
<varlistentry>
<term><link linkend="char">char</link>&nbsp;*<structfield>name</structfield>;</term>
<listitem><simpara> The name of the action argument.
</simpara></listitem>
</varlistentry>
<varlistentry>
<term><link linkend="GUPnPServiceActionArgDirection">GUPnPServiceActionArgDirection</link>&nbsp;<structfield>direction</structfield>;</term>
<listitem><simpara> The direction of the action argument.
</simpara></listitem>
</varlistentry>
<varlistentry>
<term><link linkend="char">char</link>&nbsp;*<structfield>related_state_variable</structfield>;</term>
<listitem><simpara> The name of the state variable associated with this
argument.
</simpara></listitem>
</varlistentry>
<varlistentry>
<term><link linkend="gboolean">gboolean</link>&nbsp;<structfield>retval</structfield>;</term>
<listitem><simpara> Whether this argument is the return value of the action.
</simpara></listitem>
</varlistentry>
</variablelist></refsect2>
<refsect2 id="GUPnPServiceActionInfo" role="struct">
<title>GUPnPServiceActionInfo</title>
<indexterm zone="GUPnPServiceActionInfo"><primary>GUPnPServiceActionInfo</primary></indexterm><programlisting>typedef struct {
        char  *name;
        GList *arguments; /* list of #GUPnPServiceActionArgInfo */
} GUPnPServiceActionInfo;
</programlisting>
<para>
This structure contains information about a service action.</para>
<para>

</para><variablelist role="struct">
<varlistentry>
<term><link linkend="char">char</link>&nbsp;*<structfield>name</structfield>;</term>
<listitem><simpara> The name of the action argument.
</simpara></listitem>
</varlistentry>
<varlistentry>
<term><link linkend="GList">GList</link>&nbsp;*<structfield>arguments</structfield>;</term>
<listitem><simpara> A GList of all the arguments
(of type <link linkend="GUPnPServiceActionArgInfo"><type>GUPnPServiceActionArgInfo</type></link>) of this action.
</simpara></listitem>
</varlistentry>
</variablelist></refsect2>
<refsect2 id="GUPnPServiceStateVariableInfo" role="struct">
<title>GUPnPServiceStateVariableInfo</title>
<indexterm zone="GUPnPServiceStateVariableInfo"><primary>GUPnPServiceStateVariableInfo</primary></indexterm><programlisting>typedef struct {
        char    *name;
        gboolean send_events;
        gboolean is_numeric;
        GType    type;
        GValue   default_value;
        GValue   minimum;
        GValue   maximum;
        GValue   step;
        GList   *allowed_values;
} GUPnPServiceStateVariableInfo;
</programlisting>
<para>
This structure contains information about service state variable.</para>