gupnp-control-point.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="GUPnPControlPoint">
<refmeta>
<refentrytitle role="top_of_page" id="GUPnPControlPoint.top_of_page">GUPnPControlPoint</refentrytitle>
<manvolnum>3</manvolnum>
<refmiscinfo>GUPNP Library</refmiscinfo>
</refmeta>

<refnamediv>
<refname>GUPnPControlPoint</refname>
<refpurpose>Class for resource discovery.</refpurpose>
<!--[<xref linkend="desc" endterm="desc.title"/>]-->
</refnamediv>

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

<synopsis>
                    <link linkend="GUPnPControlPoint-struct">GUPnPControlPoint</link>;
<link linkend="GUPnPControlPoint">GUPnPControlPoint</link>*  <link linkend="gupnp-control-point-new">gupnp_control_point_new</link>             (<link linkend="GUPnPContext">GUPnPContext</link> *context,
                                                         const <link linkend="char">char</link> *target);
<link linkend="GUPnPControlPoint">GUPnPControlPoint</link>*  <link linkend="gupnp-control-point-new-full">gupnp_control_point_new_full</link>        (<link linkend="GUPnPContext">GUPnPContext</link> *context,
                                                         <link linkend="GUPnPResourceFactory">GUPnPResourceFactory</link> *factory,
                                                         const <link linkend="char">char</link> *target);
<link linkend="GUPnPResourceFactory">GUPnPResourceFactory</link>* <link linkend="gupnp-control-point-get-resource-factory">gupnp_control_point_get_resource_factory</link>
                                                        (<link linkend="GUPnPControlPoint">GUPnPControlPoint</link> *control_point);
<link linkend="GUPnPContext">GUPnPContext</link>*       <link linkend="gupnp-control-point-get-context">gupnp_control_point_get_context</link>     (<link linkend="GUPnPControlPoint">GUPnPControlPoint</link> *control_point);
const <link linkend="GList">GList</link>*        <link linkend="gupnp-control-point-list-device-proxies">gupnp_control_point_list_device_proxies</link>
                                                        (<link linkend="GUPnPControlPoint">GUPnPControlPoint</link> *control_point);
const <link linkend="GList">GList</link>*        <link linkend="gupnp-control-point-list-service-proxies">gupnp_control_point_list_service_proxies</link>
                                                        (<link linkend="GUPnPControlPoint">GUPnPControlPoint</link> *control_point);
</synopsis>
</refsynopsisdiv>

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

</refsect1>





<refsect1 id="GUPnPControlPoint.properties" role="properties">
<title role="properties.title">Properties</title>
<synopsis>
  &quot;<link linkend="GUPnPControlPoint--resource-factory">resource-factory</link>&quot;         <link linkend="GUPnPResourceFactory">GUPnPResourceFactory</link>*  : Read / Write / Construct Only
</synopsis>
</refsect1>

<refsect1 id="GUPnPControlPoint.signals" role="signal_proto">
<title role="signal_proto.title">Signals</title>
<synopsis>
  &quot;<link linkend="GUPnPControlPoint-device-proxy-available">device-proxy-available</link>&quot;                         : Run Last
  &quot;<link linkend="GUPnPControlPoint-device-proxy-unavailable">device-proxy-unavailable</link>&quot;                       : Run Last
  &quot;<link linkend="GUPnPControlPoint-service-proxy-available">service-proxy-available</link>&quot;                        : Run Last
  &quot;<link linkend="GUPnPControlPoint-service-proxy-unavailable">service-proxy-unavailable</link>&quot;                      : Run Last
</synopsis>
</refsect1>


<refsect1 id="GUPnPControlPoint.description" role="desc">
<title role="desc.title">Description</title>
<para>
<link linkend="GUPnPControlPoint"><type>GUPnPControlPoint</type></link> handles device and service discovery. After creating
a control point and activating it using <link linkend="gssdp-resource-browser-set-active"><function>gssdp_resource_browser_set_active()</function></link>,
the ::device-proxy-available, ::service-proxy-available,
::device-proxy-unavailable and ::service-proxy-unavailable signals will
be emitted whenever the availability of a device or service matching
the specified discovery target changes.</para>
<para>

</para>
</refsect1>

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

</para></refsect2>
<refsect2 id="gupnp-control-point-new" role="function">
<title>gupnp_control_point_new ()</title>
<indexterm zone="gupnp-control-point-new"><primary>gupnp_control_point_new</primary></indexterm><programlisting><link linkend="GUPnPControlPoint">GUPnPControlPoint</link>*  gupnp_control_point_new             (<link linkend="GUPnPContext">GUPnPContext</link> *context,
                                                         const <link linkend="char">char</link> *target);</programlisting>
<para>
Create a new <link linkend="GUPnPControlPoint"><type>GUPnPControlPoint</type></link> with the specified <parameter>context</parameter> and <parameter>target</parameter>.
</para>
<para>
<parameter>target</parameter> should be a service or device name, such as
<literal>urn:schemas-upnp-org:service:WANIPConnection:1</literal> or
<literal>urn:schemas-upnp-org:device:MediaRenderer:1</literal>.</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>target</parameter>&nbsp;:</term>
<listitem><simpara> The search target
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> A new <link linkend="GUPnPControlPoint"><type>GUPnPControlPoint</type></link> object.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="gupnp-control-point-new-full" role="function">
<title>gupnp_control_point_new_full ()</title>
<indexterm zone="gupnp-control-point-new-full"><primary>gupnp_control_point_new_full</primary></indexterm><programlisting><link linkend="GUPnPControlPoint">GUPnPControlPoint</link>*  gupnp_control_point_new_full        (<link linkend="GUPnPContext">GUPnPContext</link> *context,
                                                         <link linkend="GUPnPResourceFactory">GUPnPResourceFactory</link> *factory,
                                                         const <link linkend="char">char</link> *target);</programlisting>
<para>
Create a new <link linkend="GUPnPControlPoint"><type>GUPnPControlPoint</type></link> with the specified <parameter>context</parameter>, <parameter>factory</parameter> and
<parameter>target</parameter>.
</para>
<para>
<parameter>target</parameter> should be a service or device name, such as
<literal>urn:schemas-upnp-org:service:WANIPConnection:1</literal> or
<literal>urn:schemas-upnp-org:device:MediaRenderer:1</literal>.</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>target</parameter>&nbsp;:</term>
<listitem><simpara> The search target
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> A new <link linkend="GUPnPControlPoint"><type>GUPnPControlPoint</type></link> object.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="gupnp-control-point-get-resource-factory" role="function">
<title>gupnp_control_point_get_resource_factory ()</title>
<indexterm zone="gupnp-control-point-get-resource-factory"><primary>gupnp_control_point_get_resource_factory</primary></indexterm><programlisting><link linkend="GUPnPResourceFactory">GUPnPResourceFactory</link>* gupnp_control_point_get_resource_factory
                                                        (<link linkend="GUPnPControlPoint">GUPnPControlPoint</link> *control_point);</programlisting>
<para>
Get the <link linkend="GUPnPResourceFactory"><type>GUPnPResourceFactory</type></link> used by the <parameter>control_point</parameter>.</para>
<para>